Skip to main content
GET
/
api
/
datasets
/
{dataset_id}
/
filesystem
/
search
Search Dataset Filesystem
curl --request GET \
  --url https://api.example.com/api/datasets/{dataset_id}/filesystem/search \
  --header 'Authorization: Bearer <token>'
{
  "dataset_id": "<string>",
  "query": "<string>",
  "total_matches": 123,
  "returned": 123,
  "truncated": false,
  "results": [
    {
      "path": "<string>",
      "parent_path": "<string>",
      "name": "<string>",
      "extension": "<string>",
      "size_bytes": 123,
      "is_image": 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

q
string
default:""

Filename/folder search query

limit
integer
default:150
Required range: 1 <= x <= 500
scope_path
string | null

Optional folder path relative to dataset root to search within

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
query
string
required
total_matches
integer
required
returned
integer
required
truncated
boolean
default:false
results
DatasetFilesystemSearchItem · object[]