Skip to main content
GET
/
api
/
datasets
/
{dataset_id}
/
filesystem
/
children
Get Dataset Filesystem Children
curl --request GET \
  --url https://api.example.com/api/datasets/{dataset_id}/filesystem/children \
  --header 'Authorization: Bearer <token>'
{
  "dataset_id": "<string>",
  "path": "<string>",
  "children": [
    {
      "name": "<string>",
      "path": "<string>",
      "depth": 123,
      "file_count": 0,
      "total_bytes": 0,
      "has_children": false,
      "sample_files": [
        {
          "name": "<string>",
          "size_bytes": 123,
          "extension": "<string>",
          "path": "<string>"
        }
      ],
      "children": "<array>"
    }
  ],
  "sample_files": [
    {
      "name": "<string>",
      "size_bytes": 123,
      "extension": "<string>",
      "path": "<string>"
    }
  ],
  "total_files": 0,
  "total_dirs": 0
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

dataset_id
string
required

Query Parameters

path
string
default:""

Folder path relative to dataset root

max_files_per_dir
integer
default:5
Required range: 0 <= x <= 50
version_id
string | null

Cookies

antidote_session
string | null

Response

Successful Response

dataset_id
string
required
path
string
required
children
FileTreeNode · object[]
sample_files
FileSample · object[]
total_files
integer
default:0
total_dirs
integer
default:0