Indexing

Check indexing job status for a drive

get

Get the indexing job status for a drive

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

The current indexing job status for the drive

application/json

404

Not found

422

Validation Error

application/json

get

/indexing/job-status/{drive_id}

HTTPcURLJavaScriptPython

GET /indexing/job-status/{drive_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "jobs": [
    {
      "name": "download",
      "to_do": 1
    }
  ]
}

Get the asset roots

get

Get the asset roots

Query parameters

drive_idstring · uuidRequired

The id of the drive we want to add users to

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

The asset roots

application/json

404

Not found

422

Validation Error

application/json

get

/indexing/roots

HTTPcURLJavaScriptPython

GET /indexing/roots?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "created": "2026-01-22T14:03:47.853Z",
    "updated": "2026-01-22T14:03:47.853Z",
    "files_found": 0,
    "size_bytes": 0
  }
]

Add asset roots

post

Add asset roots

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

pathsstring · path[]Required

The paths to add as asset roots

drive_idstring · uuidRequired

The ID of the drive

Responses

200

The ID of the new root

application/json

Responsestring · uuid[]

404

Not found

422

Validation Error

application/json

post

/indexing/roots

HTTPcURLJavaScriptPython

POST /indexing/roots HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "paths": [
    "text"
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  "123e4567-e89b-12d3-a456-426614174000"
]

Remove an asset root

delete

Remove an asset root

Path parameters

root_idstring · uuidRequired

The ID of the root to remove

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

/indexing/roots/{root_id}

HTTPcURLJavaScriptPython

DELETE /indexing/roots/{root_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content