Faces

Get the individual a face is for

get

Get the individual that a face is for by id

Path parameters

face_idstring · uuidRequired

The id of the face whose individual to get

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

The individual

application/json

idstring · uuidRequired

namestringRequired

labeledany ofOptional

booleanOptional

or

nullOptional

preview_faceany ofOptional

or

nullOptional

preview_imageany ofOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/faces/{face_id}/individual

HTTPcURLJavaScriptPython

GET /faces/{face_id}/individual HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "labeled": true,
  "preview_face": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

Get the asset a face is for

get

Get the asset that a face is for by id

Path parameters

face_idstring · uuidRequired

The id of the face whose asset to get

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

The asset

application/json

Full asset DTO with relationship fields that require eager loading.

idstring · uuidRequired

drive_idstring · uuidRequired

pathstringRequired

namestringRequired

extensionstringRequired

updatedstring · date-timeRequired

createdstring · date-timeRequired

typestring · enumRequiredPossible values:

size_bytesintegerRequired

stack_idany ofOptional

string · uuidOptional

or

nullOptional

stack_numberany ofOptional

integerOptional

or

nullOptional

is_fs_draft_blobbooleanRequired

is_fs_null_blobbooleanRequired

ratingany ofOptional

numberOptional

or

nullOptional

ai_indexedbooleanRequired

system_metadataany ofOptionalDefault: {}

or

nullOptional

custom_metadataany ofOptionalDefault: {}

or

nullOptional

categoryany ofOptional

stringOptional

or

nullOptional

ocrany ofOptional

stringOptional

or

nullOptional

transcription_idany ofOptional

string · uuidOptional

or

nullOptional

faces_presentany ofOptional

booleanOptional

or

nullOptional

content_lengthany ofOptional

integerOptional

or

nullOptional

preview_job_statestring · enumRequired

Enum for asset job states

Possible values:

metadata_job_statestring · enumRequired

Enum for asset job states

Possible values:

core_vision_job_statestring · enumRequired

Enum for asset job states

Possible values:

color_palette_job_statestring · enumRequired

Enum for asset job states

Possible values:

core_audio_job_statestring · enumRequired

Enum for asset job states

Possible values:

audio_job_statestring · enumOptional

Enum for asset job states

Possible values:

facial_recognition_job_statestring · enumRequired

Enum for asset job states

Possible values:

proxy_job_statestring · enumRequired

Enum for asset job states

Possible values:

audio_proxy_job_statestring · enumRequired

Enum for asset job states

Possible values:

transcription_job_statestring · enumRequired

Enum for asset job states

Possible values:

objectsany ofOptional

or

nullOptional

texture_dataany ofOptional

or

nullOptional

integration_dataany ofOptional

or

nullOptional

custom_thumbnailany ofOptional

stringOptional

or

nullOptional

proxyany ofOptional

or

nullOptional

audio_proxyany ofOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/faces/{face_id}/asset

HTTPcURLJavaScriptPython

GET /faces/{face_id}/asset HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "name": "text",
  "extension": "text",
  "updated": "2026-03-09T14:02:29.139Z",
  "created": "2026-03-09T14:02:29.139Z",
  "type": "IMAGE",
  "size_bytes": 1,
  "stack_id": "123e4567-e89b-12d3-a456-426614174000",
  "stack_number": 1,
  "is_fs_draft_blob": true,
  "is_fs_null_blob": true,
  "rating": 1,
  "ai_indexed": true,
  "system_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "custom_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "category": "text",
  "palette": [
    [
      1
    ]
  ],
  "ocr": "text",
  "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
  "faces_present": true,
  "content_length": 1,
  "preview_job_state": "NOT_STARTED",
  "metadata_job_state": "NOT_STARTED",
  "core_vision_job_state": "NOT_STARTED",
  "color_palette_job_state": "NOT_STARTED",
  "core_audio_job_state": "NOT_STARTED",
  "audio_job_state": "NOT_STARTED",
  "facial_recognition_job_state": "NOT_STARTED",
  "proxy_job_state": "NOT_STARTED",
  "audio_proxy_job_state": "NOT_STARTED",
  "transcription_job_state": "NOT_STARTED",
  "objects": [],
  "texture_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "integration_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "preview_images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1,
      "signed_url": "text"
    }
  ],
  "custom_thumbnail": "text",
  "proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "audio_proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

List all unclustered faces

get

Query parameters

drive_idstring · uuidRequired

The drive id to list faces for

pageany ofOptional

The page to query

Default: 0

integerOptional

or

nullOptional

limitany ofOptional

The limit that is fetched per page

Default: 100

integerOptional

or

nullOptional

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

List of all unclustered faces

application/json

idstring · uuidRequired

individual_idany ofOptional

string · uuidOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/faces

HTTPcURLJavaScriptPython

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

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

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get the dynamic views for a drive

get

Get the dynamic views for a drive

Query 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

Successful Response

application/json

idstring · uuidRequired

namestringRequired

filtersany ofOptional

or

nullOptional

columnsany ofOptional

string[]Optional

or

nullOptional

user_idany ofOptional

string · uuidOptional

or

nullOptional

is_lockedany ofOptional

booleanOptional

or

nullOptional

is_privateany ofOptional

booleanOptional

or

nullOptional

display_settingsany ofOptional

or

nullOptional

iconany ofOptional

stringOptional

or

nullOptional

icon_typeany ofOptional

string · enumOptionalPossible values:

or

nullOptional

sortany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/dynamic-views

HTTPcURLJavaScriptPython

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

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

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "filters": [
      {
        "id": null,
        "options": [
          {
            "client_val": "text",
            "server_val": "text",
            "icon": "text"
          }
        ],
        "clause": "is",
        "ignore_options": true
      }
    ],
    "columns": [
      "text"
    ],
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_locked": true,
    "is_private": true,
    "display_settings": {
      "card_size": 1,
      "thumbnail_view": "text",
      "view": "text",
      "metadata_attribute_ids": [
        "text"
      ],
      "flatten_directories": true
    },
    "icon": "text",
    "icon_type": "color",
    "sort": "text"
  }
]

Add a dynamic view for a drive

post

Query parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

namestringRequired

The dynamic view name to update

display_settingsany ofOptional

The dynamic view display settings to update

or

nullOptional

iconany ofOptional

The dynamic view icon to update

stringOptional

or

nullOptional

icon_typeany ofOptional

The dynamic view icon type to update

string · enumOptionalPossible values:

or

nullOptional

is_lockedany ofOptional

If locked, other users cannot modify the dynamic view.

Default: false

booleanOptional

or

nullOptional

is_privateany ofOptional

If private, only the owner can see this dynamic view.

Default: false

booleanOptional

or

nullOptional

filtersany ofOptional

The dynamic view filters to update

Default: []

or

nullOptional

sortany ofOptional

The dynamic view sort to update (include '-' at beginning for descending)

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

post

/dynamic-views

HTTPcURLJavaScriptPython

POST /dynamic-views?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "name": "text",
  "display_settings": {
    "card_size": 1,
    "thumbnail_view": "text",
    "view": "text",
    "metadata_attribute_ids": [
      "text"
    ],
    "flatten_directories": true
  },
  "icon": "text",
  "icon_type": "color",
  "is_locked": false,
  "is_private": false,
  "filters": [
    {
      "id": null,
      "options": [
        {
          "client_val": "text",
          "server_val": "text",
          "icon": "text"
        }
      ],
      "clause": "is",
      "ignore_options": true
    }
  ],
  "sort": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Update a dynamic view for a drive

put

Modify a dynamic view for a drive

Path parameters

dynamic_view_idstring · uuidRequired

Query parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

namestringRequired

The dynamic view name to update

columnsany ofOptional

The dynamic view columns to update

string[]Optional

or

nullOptional

display_settingsany ofOptional

The dynamic view display settings to update

or

nullOptional

iconany ofOptional

The dynamic view icon to update

stringOptional

or

nullOptional

icon_typeany ofOptional

The dynamic view icon type to update

string · enumOptionalPossible values:

or

nullOptional

sortany ofOptional

The dynamic view sort to update (include '-' at beginning for descending)

stringOptional

or

nullOptional

is_lockedany ofOptional

If locked, other users cannot modify the dynamic view.

Default: false

booleanOptional

or

nullOptional

is_privateany ofOptional

If private, only the owner can see this dynamic view.

Default: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

put

/dynamic-views/{dynamic_view_id}

HTTPcURLJavaScriptPython

PUT /dynamic-views/{dynamic_view_id}?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 427

{
  "name": "text",
  "filters": [
    {
      "id": null,
      "options": [
        {
          "client_val": "text",
          "server_val": "text",
          "icon": "text"
        }
      ],
      "clause": "is",
      "ignore_options": true
    }
  ],
  "columns": [
    "text"
  ],
  "display_settings": {
    "card_size": 1,
    "thumbnail_view": "text",
    "view": "text",
    "metadata_attribute_ids": [
      "text"
    ],
    "flatten_directories": true
  },
  "icon": "text",
  "icon_type": "color",
  "sort": "text",
  "is_locked": false,
  "is_private": false,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Delete Dynamic View Route

delete

Path parameters

dynamic_view_idstring · uuidRequired

Query 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

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete

/dynamic-views/{dynamic_view_id}

HTTPcURLJavaScriptPython

DELETE /dynamic-views/{dynamic_view_id}?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

No content

Export dynamic view data

get

Path parameters

dynamic_view_idstring · uuidRequired

export_formatstring · enumRequiredPossible values:

Query parameters

drive_idstring · uuidRequired

osany ofOptional

string · enumOptional

Operating System Enum from the result of platform.system()

Possible values:

or

nullOptional

timezoneany ofOptional

stringOptional

or

nullOptional

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

anyOptional

404

Not found

422

Validation Error

application/json

get

/dynamic-views/{dynamic_view_id}/exports/{export_format}

HTTPcURLJavaScriptPython

GET /dynamic-views/{dynamic_view_id}/exports/{export_format}?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

No content