Assets

List all assets

get

Get a listing of all the assets in the database

Query parameters

drive_idstring · uuidRequired

The id of the drive we want to get assets for

pageany ofOptional

The page to query

Default: 0

integerOptional

or

nullOptional

limitany ofOptional

The limit that is fetched per page

Default: 20

integerOptional

or

nullOptional

sort_by_sizeany ofOptional

Sort the assets by size

Default: false

booleanOptional

or

nullOptional

Responses

200

A list of all assets

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "name": "text",
    "extension": "text",
    "updated": "2025-08-11T14:17:12.477Z",
    "created": "2025-08-11T14:17:12.477Z",
    "type": "IMAGE",
    "signature": 1,
    "size_bytes": 1,
    "is_fs_draft_blob": true,
    "is_fs_null_blob": true,
    "rating": 1,
    "ai_indexed": true,
    "system_metadata": {},
    "custom_metadata": {},
    "preview_images": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "frame": 1
      }
    ],
    "proxy": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "audio_proxy": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "category": "text",
    "palette": [
      [
        1
      ]
    ],
    "ocr": "text",
    "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
    "faces_present": true,
    "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",
    "text_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": {},
    "integration_data": {}
  }
]

Update an asset's metadata value

put

Update an asset's metadata attribute value

Path parameters

asset_idstring · uuidRequired

The id of the asset to be updated

metadata_attribute_idany ofRequired

The id of the metadata attribute to update

stringOptional

or

string · uuidOptional

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

drive_idstring · uuidRequired

The id of the drive this asset is in

metadata_attribute_valueany ofOptional

The new value for the metadata attribute. Not passing this will remove the value.

anyOptional

or

nullOptional

Responses

200

The updated asset

application/json

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /assets/{asset_id}/metadata/{metadata_attribute_id}/value HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata_attribute_value": null
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "name": "text",
  "extension": "text",
  "updated": "2025-08-11T14:17:12.477Z",
  "created": "2025-08-11T14:17:12.477Z",
  "type": "IMAGE",
  "signature": 1,
  "size_bytes": 1,
  "is_fs_draft_blob": true,
  "is_fs_null_blob": true,
  "rating": 1,
  "ai_indexed": true,
  "system_metadata": {},
  "custom_metadata": {},
  "preview_images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  ],
  "proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "audio_proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "category": "text",
  "palette": [
    [
      1
    ]
  ],
  "ocr": "text",
  "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
  "faces_present": true,
  "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",
  "text_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": {},
  "integration_data": {}
}

Bulk update asset metadata attributes

put

Either pass in asset_ids/metadata_attributes OR assets.

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

asset_idsany ofOptional

The id of the assets to be updated

string · uuid[]Optional

or

nullOptional

metadata_attributesany ofOptional

The id and values of the metadata attributes to update

or

nullOptional

asset_ids_with_metadata_attributesany ofOptional

The asset ids and their corresponding metadata attributes to update

or

nullOptional

drive_idstring · uuidRequired

The id of the drive this asset is in

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /assets/bulk/metadata/values HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "asset_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "metadata_attributes": [
    {
      "id": "text",
      "value": null,
      "append": false
    }
  ],
  "asset_ids_with_metadata_attributes": [
    {
      "asset_id": "123e4567-e89b-12d3-a456-426614174000",
      "metadata_attributes": [
        {
          "id": "text",
          "value": null,
          "append": false
        }
      ]
    }
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000"
}

[
  {
    "asset_id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_metadata_attribute_ids": [
      "text"
    ]
  }
]

Get all the collections an asset belongs to

get

Get all the collections an asset belongs to

Path parameters

asset_idstring · uuidRequired

The asset to get the collections from

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/collections?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_by": {
      "name": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "settings": {
      "card_size": 1,
      "thumbnail_view": "text",
      "view": "text",
      "metadata_attribute_ids": [
        "text"
      ]
    },
    "is_public_enabled": true,
    "allowed_actions": [
      "manage"
    ],
    "icon_type": "color",
    "icon": "text",
    "icon_attachment": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "drive_id": "123e4567-e89b-12d3-a456-426614174000",
      "uploader_id": "123e4567-e89b-12d3-a456-426614174000",
      "uploaded": true,
      "name": "text",
      "mime_type": "text",
      "size": 1,
      "download_url": "text"
    },
    "background_image": "text",
    "background_image_attachment": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "drive_id": "123e4567-e89b-12d3-a456-426614174000",
      "uploader_id": "123e4567-e89b-12d3-a456-426614174000",
      "uploaded": true,
      "name": "text",
      "mime_type": "text",
      "size": 1,
      "download_url": "text"
    },
    "preview_image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  }
]

Set the collections for an asset

post

Set the collections for an asset

Path parameters

asset_idstring · uuidRequired

The id of the asset to update

Body

drive_idstring · uuidRequired

The id of the drive this asset is in

collection_idsstring · uuid[]Required

The collection ids to add asset to (every other collection should remove asset)

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/collections HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "collection_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Get the usage of all assets for analytics

get

Query parameters

drive_idstring · uuidRequired

The id of the drive we get asset usage for

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/usage?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

{
  "num_assets": 1,
  "num_ai_assets": 1,
  "bytes": 1,
  "types": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "collections": 1
}

Get all the faces for an asset

get

Get all the faces an asset contains

Path parameters

asset_idstring · uuidRequired

The asset to get the faces for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/faces?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

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

Get the transcription for an asset if it exists

get

Get the transcription utterances for an asset if it exists

Path parameters

asset_idstring · uuidRequired

The asset to get the transcription for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany of

or

nullOptional

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/utterances?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  {
    "speaker": "text",
    "start": 1,
    "end": 1,
    "text": "text",
    "words": [
      {
        "start": 1,
        "end": 1,
        "text": "text"
      }
    ]
  }
]

Get the transcription for an asset if it exists

get

Get the transcription segments for an asset if it exists

Path parameters

asset_idstring · uuidRequired

The asset to get the transcription for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany of

or

nullOptional

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/segments?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  {
    "start": 1,
    "end": 1,
    "text": "text"
  }
]

Get the transcription for an asset if it exists

get

Path parameters

asset_idstring · uuidRequired

The asset to get the transcription for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

typestring · enumOptional

The type of transcription to get

Default: vttPossible values:

authorizationany ofOptional

The authorization token to use to fetch the preview

stringOptional

or

nullOptional

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/file?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

No content

Get the metadata for an asset

get

Get the metadata for an asset

Path parameters

asset_idstring · uuidRequired

The asset to get the metadata for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseobject · ResponseGetMetadataAssetsAssetIdMetadataGet

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/metadata?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

{}

Get all comments for an asset

get

Get all comments for an asset

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Query parameters

drive_idstring · uuidOptional

The id of the drive this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

A list of all comments for the asset

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/comments HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "asset_id": "123e4567-e89b-12d3-a456-426614174000",
    "content": "text",
    "author": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "text",
      "avatar_url": "text"
    },
    "created": "2025-08-11T14:17:12.477Z",
    "updated": "2025-08-11T14:17:12.477Z",
    "resolved": true,
    "is_public": true,
    "parent_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": 1,
    "replies": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "asset_id": "123e4567-e89b-12d3-a456-426614174000",
        "content": "text",
        "author": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "avatar_url": "text"
        },
        "created": "2025-08-11T14:17:12.477Z",
        "updated": "2025-08-11T14:17:12.477Z",
        "resolved": true,
        "is_public": true,
        "parent_id": "123e4567-e89b-12d3-a456-426614174000",
        "timestamp": 1,
        "replies": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "asset_id": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "author": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "email": "text",
              "avatar_url": "text"
            },
            "created": "2025-08-11T14:17:12.477Z",
            "updated": "2025-08-11T14:17:12.477Z",
            "resolved": true,
            "is_public": true,
            "parent_id": "123e4567-e89b-12d3-a456-426614174000",
            "timestamp": 1,
            "replies": "[Circular Reference]",
            "mentions": [
              {
                "user_id": "text",
                "text": "text",
                "start_index": 1,
                "end_index": 1,
                "user_name": ""
              }
            ],
            "reactions": [
              {
                "users": [
                  {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text",
                    "email": "text",
                    "avatar_url": "text",
                    "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                  }
                ],
                "content": "text",
                "count": 1
              }
            ],
            "anchor": {
              "x": 1,
              "y": 1
            }
          }
        ],
        "mentions": [
          {
            "user_id": "text",
            "text": "text",
            "start_index": 1,
            "end_index": 1,
            "user_name": ""
          }
        ],
        "reactions": [
          {
            "users": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text",
                "email": "text",
                "avatar_url": "text",
                "comment_id": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "content": "text",
            "count": 1
          }
        ],
        "anchor": {
          "x": 1,
          "y": 1
        }
      }
    ],
    "mentions": [
      {
        "user_id": "text",
        "text": "text",
        "start_index": 1,
        "end_index": 1,
        "user_name": ""
      }
    ],
    "reactions": [
      {
        "users": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "avatar_url": "text",
            "comment_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "content": "text",
        "count": 1
      }
    ],
    "anchor": {
      "x": 1,
      "y": 1
    }
  }
]

Add a comment to an asset

post

Add a comment to an asset

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

drive_idstring · uuidOptional

The id of the drive this asset is in

commentstringRequired

The comment to add to the asset

mentionsany ofOptional

The mentions in the comment

Default: []

or

nullOptional

timestampany ofOptional

The timestamp of the comment from the start of the video

numberOptional

or

nullOptional

is_publicbooleanOptional

Whether the comment is public or not

Default: true

urlstringRequired

The url of the comment

anchorany ofOptional

The anchor of the comment

or

nullOptional

Responses

200

The comment

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/comments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "text",
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "timestamp": 1,
  "is_public": true,
  "url": "text",
  "anchor": {
    "x": 1,
    "y": 1
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asset_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "author": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text"
  },
  "created": "2025-08-11T14:17:12.477Z",
  "updated": "2025-08-11T14:17:12.477Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "asset_id": "123e4567-e89b-12d3-a456-426614174000",
      "content": "text",
      "author": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "avatar_url": "text"
      },
      "created": "2025-08-11T14:17:12.477Z",
      "updated": "2025-08-11T14:17:12.477Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "asset_id": "123e4567-e89b-12d3-a456-426614174000",
          "content": "text",
          "author": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "avatar_url": "text"
          },
          "created": "2025-08-11T14:17:12.477Z",
          "updated": "2025-08-11T14:17:12.477Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "replies": [
            "[Circular Reference]"
          ],
          "mentions": [
            {
              "user_id": "text",
              "text": "text",
              "start_index": 1,
              "end_index": 1,
              "user_name": ""
            }
          ],
          "reactions": [
            {
              "users": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "email": "text",
                  "avatar_url": "text",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          }
        }
      ],
      "mentions": [
        {
          "user_id": "text",
          "text": "text",
          "start_index": 1,
          "end_index": 1,
          "user_name": ""
        }
      ],
      "reactions": [
        {
          "users": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "email": "text",
              "avatar_url": "text",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      }
    }
  ],
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "reactions": [
    {
      "users": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "avatar_url": "text",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  }
}

Update a comment

put

Update a comment

Path parameters

asset_idstring · uuidRequired

The id of the asset that the comment is on

comment_idstring · uuidRequired

The id of the comment to update

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

drive_idstring · uuidRequired

The id of the drive this comment is in

contentany ofOptional

The comment to add to the asset

stringOptional

or

nullOptional

mentionsany ofOptional

The mentions in the comment

or

nullOptional

is_publicbooleanOptional

Whether the comment is public or not

urlstringRequired

The url of the comment

Responses

200

The comment

application/json

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /assets/{asset_id}/comments/{comment_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "is_public": true,
  "url": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asset_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "author": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text"
  },
  "created": "2025-08-11T14:17:12.477Z",
  "updated": "2025-08-11T14:17:12.477Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "asset_id": "123e4567-e89b-12d3-a456-426614174000",
      "content": "text",
      "author": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "avatar_url": "text"
      },
      "created": "2025-08-11T14:17:12.477Z",
      "updated": "2025-08-11T14:17:12.477Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "asset_id": "123e4567-e89b-12d3-a456-426614174000",
          "content": "text",
          "author": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "avatar_url": "text"
          },
          "created": "2025-08-11T14:17:12.477Z",
          "updated": "2025-08-11T14:17:12.477Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "replies": [
            "[Circular Reference]"
          ],
          "mentions": [
            {
              "user_id": "text",
              "text": "text",
              "start_index": 1,
              "end_index": 1,
              "user_name": ""
            }
          ],
          "reactions": [
            {
              "users": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "email": "text",
                  "avatar_url": "text",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          }
        }
      ],
      "mentions": [
        {
          "user_id": "text",
          "text": "text",
          "start_index": 1,
          "end_index": 1,
          "user_name": ""
        }
      ],
      "reactions": [
        {
          "users": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "email": "text",
              "avatar_url": "text",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      }
    }
  ],
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "reactions": [
    {
      "users": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "avatar_url": "text",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  }
}

Delete a comment

delete

Delete a comment

Path parameters

asset_idstring · uuidRequired

The id of the asset that the comment is on

comment_idstring · uuidRequired

The id of the comment to delete

Query parameters

drive_idstring · uuidRequired

The id of the drive this comment is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /assets/{asset_id}/comments/{comment_id}?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

No content

Update a comment to be resolved or not

put

Update a comment's resolve status

Path parameters

asset_idstring · uuidRequired

The id of the asset that the comment is on

comment_idstring · uuidRequired

The id of the comment to update

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

drive_idany ofOptional

The id of the drive this comment is in

string · uuidOptional

or

nullOptional

resolvedany ofOptional

Whether the comment is resolved

booleanOptional

or

nullOptional

Responses

200

The comment

application/json

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /assets/{asset_id}/comments/{comment_id}/resolve HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "resolved": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asset_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "author": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text"
  },
  "created": "2025-08-11T14:17:12.477Z",
  "updated": "2025-08-11T14:17:12.477Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "asset_id": "123e4567-e89b-12d3-a456-426614174000",
      "content": "text",
      "author": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "avatar_url": "text"
      },
      "created": "2025-08-11T14:17:12.477Z",
      "updated": "2025-08-11T14:17:12.477Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "asset_id": "123e4567-e89b-12d3-a456-426614174000",
          "content": "text",
          "author": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "avatar_url": "text"
          },
          "created": "2025-08-11T14:17:12.477Z",
          "updated": "2025-08-11T14:17:12.477Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "replies": [
            "[Circular Reference]"
          ],
          "mentions": [
            {
              "user_id": "text",
              "text": "text",
              "start_index": 1,
              "end_index": 1,
              "user_name": ""
            }
          ],
          "reactions": [
            {
              "users": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "email": "text",
                  "avatar_url": "text",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          }
        }
      ],
      "mentions": [
        {
          "user_id": "text",
          "text": "text",
          "start_index": 1,
          "end_index": 1,
          "user_name": ""
        }
      ],
      "reactions": [
        {
          "users": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "email": "text",
              "avatar_url": "text",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      }
    }
  ],
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "reactions": [
    {
      "users": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "avatar_url": "text",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  }
}

React to a comment

put

React to a comment

Path parameters

asset_idstring · uuidRequired

The id of the asset that the comment is on

comment_idstring · uuidRequired

The id of the comment to react to

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

drive_idstring · uuidRequired

The id of the drive this comment is in

reaction_to_addany ofOptional

The reaction to add to the comment. Either pass this or reaction_to_remove

stringOptional

or

nullOptional

reaction_to_removeany ofOptional

The id of the reaction to remove. Either pass this or reaction_to_add

string · uuidOptional

or

nullOptional

Responses

200

The comment

application/json

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /assets/{asset_id}/comments/{comment_id}/react HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "reaction_to_add": "text",
  "reaction_to_remove": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asset_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "author": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text"
  },
  "created": "2025-08-11T14:17:12.477Z",
  "updated": "2025-08-11T14:17:12.477Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "asset_id": "123e4567-e89b-12d3-a456-426614174000",
      "content": "text",
      "author": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "avatar_url": "text"
      },
      "created": "2025-08-11T14:17:12.477Z",
      "updated": "2025-08-11T14:17:12.477Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "asset_id": "123e4567-e89b-12d3-a456-426614174000",
          "content": "text",
          "author": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "avatar_url": "text"
          },
          "created": "2025-08-11T14:17:12.477Z",
          "updated": "2025-08-11T14:17:12.477Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "replies": [
            "[Circular Reference]"
          ],
          "mentions": [
            {
              "user_id": "text",
              "text": "text",
              "start_index": 1,
              "end_index": 1,
              "user_name": ""
            }
          ],
          "reactions": [
            {
              "users": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "email": "text",
                  "avatar_url": "text",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          }
        }
      ],
      "mentions": [
        {
          "user_id": "text",
          "text": "text",
          "start_index": 1,
          "end_index": 1,
          "user_name": ""
        }
      ],
      "reactions": [
        {
          "users": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "email": "text",
              "avatar_url": "text",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      }
    }
  ],
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "reactions": [
    {
      "users": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "avatar_url": "text",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  }
}

Reply to a comment

post

Reply to a comment

Path parameters

asset_idstring · uuidRequired

The id of the asset that the comment is on

comment_idstring · uuidRequired

The id of the comment to reply to

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Body

drive_idstring · uuidRequired

The id of the drive this comment is in

contentstringRequired

The content of the comment to add to the asset

mentionsany ofOptional

The mentions in the comment

Default: []

or

nullOptional

urlstringRequired

The url of the comment

Responses

200

The comment

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/comments/{comment_id}/reply HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "url": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asset_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "author": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text"
  },
  "created": "2025-08-11T14:17:12.477Z",
  "updated": "2025-08-11T14:17:12.477Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "asset_id": "123e4567-e89b-12d3-a456-426614174000",
      "content": "text",
      "author": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "avatar_url": "text"
      },
      "created": "2025-08-11T14:17:12.477Z",
      "updated": "2025-08-11T14:17:12.477Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "asset_id": "123e4567-e89b-12d3-a456-426614174000",
          "content": "text",
          "author": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "avatar_url": "text"
          },
          "created": "2025-08-11T14:17:12.477Z",
          "updated": "2025-08-11T14:17:12.477Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "replies": [
            "[Circular Reference]"
          ],
          "mentions": [
            {
              "user_id": "text",
              "text": "text",
              "start_index": 1,
              "end_index": 1,
              "user_name": ""
            }
          ],
          "reactions": [
            {
              "users": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "email": "text",
                  "avatar_url": "text",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          }
        }
      ],
      "mentions": [
        {
          "user_id": "text",
          "text": "text",
          "start_index": 1,
          "end_index": 1,
          "user_name": ""
        }
      ],
      "reactions": [
        {
          "users": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "email": "text",
              "avatar_url": "text",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      }
    }
  ],
  "mentions": [
    {
      "user_id": "text",
      "text": "text",
      "start_index": 1,
      "end_index": 1,
      "user_name": ""
    }
  ],
  "reactions": [
    {
      "users": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "text",
          "avatar_url": "text",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  }
}

Get all mentionable users on comments for an asset

get

Get all mentionable users on comments for an asset

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

A list of mentionable users on comments for the asset

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/mentionable-users?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text"
  }
]

Get a signed download URL for an asset's data

get

Get a signed download URL for an asset's data based on the origin type

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

origin_typestring · enumRequired

The origin of the asset's data to fetch

Possible values:

namestringOptional

The name of the file to download as

downloadbooleanOptional

Whether to download the file or view it inline

Default: true

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

A signed download URL

application/json

Responsestring

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/download?drive_id=123e4567-e89b-12d3-a456-426614174000&origin_type=SOURCE HTTP/1.1
Host: 
Accept: */*

text

Get an asset from its path

get

Get an asset from its path

Query parameters

pathstringRequired

The path of the asset to retrieve

drive_idstring · uuidRequired

The id of the drive this asset is in

share_idstring · uuidOptional

The id of the share this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

The asset

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/path?path=text&drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "name": "text",
  "extension": "text",
  "updated": "2025-08-11T14:17:12.477Z",
  "created": "2025-08-11T14:17:12.477Z",
  "type": "IMAGE",
  "signature": 1,
  "size_bytes": 1,
  "is_fs_draft_blob": true,
  "is_fs_null_blob": true,
  "rating": 1,
  "ai_indexed": true,
  "system_metadata": {},
  "custom_metadata": {},
  "preview_images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  ],
  "proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "audio_proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "category": "text",
  "palette": [
    [
      1
    ]
  ],
  "ocr": "text",
  "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
  "faces_present": true,
  "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",
  "text_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": {},
  "integration_data": {}
}

Get an asset

get

Get an asset

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

share_idstring · uuidOptional

The id of the share this asset is in

Header parameters

collection-idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

The asset

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /assets/{asset_id}?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "name": "text",
  "extension": "text",
  "updated": "2025-08-11T14:17:12.477Z",
  "created": "2025-08-11T14:17:12.477Z",
  "type": "IMAGE",
  "signature": 1,
  "size_bytes": 1,
  "is_fs_draft_blob": true,
  "is_fs_null_blob": true,
  "rating": 1,
  "ai_indexed": true,
  "system_metadata": {},
  "custom_metadata": {},
  "preview_images": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  ],
  "proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "audio_proxy": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "category": "text",
  "palette": [
    [
      1
    ]
  ],
  "ocr": "text",
  "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
  "faces_present": true,
  "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",
  "text_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": {},
  "integration_data": {}
}