Get

Retrieves file/directory information or downloads a file.

Path parameter

path: the path to the file/directory relative to the user data root (default value is ”/”, the user data root directory itself)

Query parameters

option: controls the behavior of the API
- default (None): retrieves file/directory information Returns a Content Pydantic object containing information on the target path
- “download”: downloads a file (directory download is not possible) Streams the file content or does the download and returns nothing, depending on the client request

GET

api

contents

{path}

curl --request GET \
  --url https://your-engine-url/fm/api/v1/contents/{path} \
  --header 'Authorization: <api-key>'

{
  "content_info": {
    "name": "",
    "format": "<string>",
    "path": "",
    "type": "file",
    "size": 123,
    "writable": true,
    "content": "<any>",
    "created_at": "0001-01-01T00:00:00",
    "updated_at": "0001-01-01T00:00:00"
  },
  "root": "/home/jovyan"
}

Authorizations

Authorization

string

header

required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Path Parameters

path

string

required

Query Parameters

option

string

show_hidden_files

boolean

default:true

Response

200

application/json

Successful Response

The response is of type object.

curl --request GET \
  --url https://your-engine-url/fm/api/v1/contents/{path} \
  --header 'Authorization: <api-key>'

{
  "content_info": {
    "name": "",
    "format": "<string>",
    "path": "",
    "type": "file",
    "size": 123,
    "writable": true,
    "content": "<any>",
    "created_at": "0001-01-01T00:00:00",
    "updated_at": "0001-01-01T00:00:00"
  },
  "root": "/home/jovyan"
}

Get

Retrieves file/directory information or downloads a file.

Path parameter

path: the path to the file/directory relative to the user data root (default value is ”/”, the user data root directory itself)

Query parameters

option: controls the behavior of the API
- default (None): retrieves file/directory information Returns a Content Pydantic object containing information on the target path
- “download”: downloads a file (directory download is not possible) Streams the file content or does the download and returns nothing, depending on the client request

GET

api

contents

{path}

curl --request GET \
  --url https://your-engine-url/fm/api/v1/contents/{path} \
  --header 'Authorization: <api-key>'

{
  "content_info": {
    "name": "",
    "format": "<string>",
    "path": "",
    "type": "file",
    "size": 123,
    "writable": true,
    "content": "<any>",
    "created_at": "0001-01-01T00:00:00",
    "updated_at": "0001-01-01T00:00:00"
  },
  "root": "/home/jovyan"
}

Authorizations

Authorization

string

header

required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Path Parameters

path

string

required

Query Parameters

option

string

show_hidden_files

boolean

default:true

Response

200

application/json

Successful Response

The response is of type object.

curl --request GET \
  --url https://your-engine-url/fm/api/v1/contents/{path} \
  --header 'Authorization: <api-key>'

{
  "content_info": {
    "name": "",
    "format": "<string>",
    "path": "",
    "type": "file",
    "size": 123,
    "writable": true,
    "content": "<any>",
    "created_at": "0001-01-01T00:00:00",
    "updated_at": "0001-01-01T00:00:00"
  },
  "root": "/home/jovyan"
}

Authorizations

Path Parameters

Query Parameters

Response

FAQs

Authorizations

Path Parameters

Query Parameters

Response