Skip to main content
GET
/
api
/
datasets
/
{dataset_id}
/
filesystem
Get Dataset Filesystem
curl --request GET \
  --url https://api.example.com/api/datasets/{dataset_id}/filesystem \
  --header 'Authorization: Bearer <token>'
{
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "root_path": "<string>",
  "root": {
    "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>"
  },
  "total_files": 123,
  "total_directories": 123,
  "total_bytes": 123,
  "max_depth": 123,
  "max_entries": 123,
  "max_files_per_dir": 123,
  "source_kind": "dataset",
  "source_label": "<string>",
  "extension_counts": {},
  "truncated": false
}

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

depth
integer
default:3
Required range: 1 <= x <= 8
max_entries
integer
default:600
Required range: 50 <= x <= 5000
max_files_per_dir
integer
default:6
Required range: 0 <= x <= 50
version_id
string | null

Dataset view version ("active" default, "original", or explicit version id)

Cookies

antidote_session
string | null

Response

Successful Response

dataset_id
string
required
dataset_name
string
required
root_path
string
required
root
FileTreeNode · object
required
total_files
integer
required
total_directories
integer
required
total_bytes
integer
required
max_depth
integer
required
max_entries
integer
required
max_files_per_dir
integer
required
source_kind
enum<string>
default:dataset
Available options:
dataset,
import_staging
source_label
string | null
extension_counts
Extension Counts · object
truncated
boolean
default:false