List files (directory)

GET

serverless

files

list

{dir}

List files (directory)

curl --request GET \
  --url https://api.fal.ai/v1/serverless/files/list/{dir} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/serverless/files/list/{dir}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "path": "datasets/images/cat.jpg",
    "name": "cat.jpg",
    "created_time": "2024-11-08T00:00:00.000Z",
    "updated_time": "2024-11-09T00:00:00.000Z",
    "is_file": true,
    "size": 1250023,
    "checksum_sha256": "b1946ac92492d2347c6235b4d2611184d5c3f1f0f44aa7b27d3b1d5b0f5a6a11"
  }
]

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

Key on the READONLY preset, or any key whose permissions include the ones this API lists. Prefix it with "Key ", e.g. Authorization: Key YOUR_API_KEY

Path Parameters

dir

string

required

Directory path to list

Example:

"datasets/images"

Response

Successfully listed files

path

string

required

Full file or folder path

Example:

"datasets/images/cat.jpg"

name

string

required

Base name of the file or folder

Example:

"cat.jpg"

created_time

string<date-time>

required

Creation timestamp (UTC ISO 8601)

Example:

"2024-11-08T00:00:00.000Z"

updated_time

string<date-time>

required

Last update timestamp (UTC ISO 8601)

Example:

"2024-11-09T00:00:00.000Z"

is_file

boolean

required

True if this item is a file, false if it is a folder

Example:

true

size

number

required

File size in bytes (0 for folders)

Example:

1250023

checksum_sha256

string

Optional SHA256 checksum

Example:

"b1946ac92492d2347c6235b4d2611184d5c3f1f0f44aa7b27d3b1d5b0f5a6a11"

checksum_md5

string

Optional MD5 checksum

Example:

"9e107d9d372bb6826bd81d3542a419d6"

⌘I

List files (directory)

curl --request GET \
  --url https://api.fal.ai/v1/serverless/files/list/{dir} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/serverless/files/list/{dir}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "path": "datasets/images/cat.jpg",
    "name": "cat.jpg",
    "created_time": "2024-11-08T00:00:00.000Z",
    "updated_time": "2024-11-09T00:00:00.000Z",
    "is_file": true,
    "size": 1250023,
    "checksum_sha256": "b1946ac92492d2347c6235b4d2611184d5c3f1f0f44aa7b27d3b1d5b0f5a6a11"
  }
]

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}