Assets

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

Other propertiesanyOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/metadata

HTTPcURLJavaScriptPython

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

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

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidRequired

The id of the drive this asset is in

metadata_attribute_valueany · nullableOptional

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

Responses

200

The updated 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_idstring · uuid · nullableOptional

stack_numberinteger · nullableOptional

is_fs_draft_blobbooleanRequired

is_fs_null_blobbooleanRequired

ratingnumber · nullableOptional

ai_indexedbooleanRequired

categorystring · nullableOptional

ocrstring · nullableOptional

transcription_idstring · uuid · nullableOptional

faces_presentboolean · nullableOptional

content_lengthinteger · nullableOptional

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:

custom_thumbnailstring · nullableOptional

404

Not found

422

Validation Error

application/json

put/assets/{asset_id}/metadata/{metadata_attribute_id}/value

HTTPcURLJavaScriptPython

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

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata_attribute_value": null,
  "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-07-11T08:42:38.872Z",
  "created": "2026-07-11T08:42:38.872Z",
  "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"
  }
}

Bulk update asset metadata attributes

put

Either pass in asset_ids/metadata_attributes OR assets.

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

asset_idsstring · uuid[] · nullableOptional

The id of the assets to be updated

drive_idstring · uuidRequired

The id of the drive this asset is in

Responses

200

Successful Response

application/json

asset_idstring · uuidRequired

updated_metadata_attribute_idsstring[]Required

404

Not found

422

Validation Error

application/json

put/assets/metadata/values

HTTPcURLJavaScriptPython

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

{
  "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",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

A list of all comments for the asset

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/comments

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/comments HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

[
  {
    "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",
      "user_type": "regular"
    },
    "created": "2026-07-11T08:42:38.872Z",
    "updated": "2026-07-11T08:42:38.872Z",
    "resolved": true,
    "is_public": true,
    "parent_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": 1,
    "duration": 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",
          "user_type": "regular"
        },
        "created": "2026-07-11T08:42:38.872Z",
        "updated": "2026-07-11T08:42:38.872Z",
        "resolved": true,
        "is_public": true,
        "parent_id": "123e4567-e89b-12d3-a456-426614174000",
        "timestamp": 1,
        "duration": 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",
              "user_type": "regular"
            },
            "created": "2026-07-11T08:42:38.872Z",
            "updated": "2026-07-11T08:42:38.872Z",
            "resolved": true,
            "is_public": true,
            "parent_id": "123e4567-e89b-12d3-a456-426614174000",
            "timestamp": 1,
            "duration": 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",
                    "user_type": "regular",
                    "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                  }
                ],
                "content": "text",
                "count": 1
              }
            ],
            "anchor": {
              "x": 1,
              "y": 1
            },
            "annotation": [
              {
                "tool": "text",
                "color": "text",
                "size": 1,
                "xs": [
                  1
                ],
                "ys": [
                  1
                ]
              }
            ],
            "is_copied": false,
            "attachments": [
              {
                "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"
              }
            ]
          }
        ],
        "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",
                "user_type": "regular",
                "comment_id": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "content": "text",
            "count": 1
          }
        ],
        "anchor": {
          "x": 1,
          "y": 1
        },
        "annotation": [
          {
            "tool": "text",
            "color": "text",
            "size": 1,
            "xs": [
              1
            ],
            "ys": [
              1
            ]
          }
        ],
        "is_copied": false,
        "attachments": [
          {
            "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"
          }
        ]
      }
    ],
    "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",
            "user_type": "regular",
            "comment_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "content": "text",
        "count": 1
      }
    ],
    "anchor": {
      "x": 1,
      "y": 1
    },
    "annotation": [
      {
        "tool": "text",
        "color": "text",
        "size": 1,
        "xs": [
          1
        ],
        "ys": [
          1
        ]
      }
    ],
    "is_copied": false,
    "attachments": [
      {
        "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"
      }
    ]
  }
]

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidOptional

The id of the drive this asset is in

commentstringRequired

The comment to add to the asset

timestampnumber · nullableOptional

The timestamp of the comment from the start of the video

durationnumber · nullableOptional

The duration of the comment timestamp in seconds (for range based comments)

is_publicbooleanOptional

Whether the comment is public or not

Default: true

urlstringRequired

The url of the comment

attachment_tokensstring[] · nullableOptional

JWT tokens for attachments to link to this comment

Responses

200

The comment

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/comments

HTTPcURLJavaScriptPython

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

{
  "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,
  "duration": 1,
  "is_public": true,
  "url": "text",
  "anchor": {
    "x": 1,
    "y": 1
  },
  "annotation": [
    {
      "tool": "text",
      "color": "text",
      "size": 1,
      "xs": [
        1
      ],
      "ys": [
        1
      ]
    }
  ],
  "attachment_tokens": [
    "text"
  ],
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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",
    "user_type": "regular"
  },
  "created": "2026-07-11T08:42:38.872Z",
  "updated": "2026-07-11T08:42:38.872Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "duration": 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",
        "user_type": "regular"
      },
      "created": "2026-07-11T08:42:38.872Z",
      "updated": "2026-07-11T08:42:38.872Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "duration": 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",
            "user_type": "regular"
          },
          "created": "2026-07-11T08:42:38.872Z",
          "updated": "2026-07-11T08:42:38.872Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "duration": 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",
                  "user_type": "regular",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          },
          "annotation": [
            {
              "tool": "text",
              "color": "text",
              "size": 1,
              "xs": [
                1
              ],
              "ys": [
                1
              ]
            }
          ],
          "is_copied": false,
          "attachments": [
            {
              "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"
            }
          ]
        }
      ],
      "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",
              "user_type": "regular",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      },
      "annotation": [
        {
          "tool": "text",
          "color": "text",
          "size": 1,
          "xs": [
            1
          ],
          "ys": [
            1
          ]
        }
      ],
      "is_copied": false,
      "attachments": [
        {
          "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"
        }
      ]
    }
  ],
  "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",
          "user_type": "regular",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  },
  "annotation": [
    {
      "tool": "text",
      "color": "text",
      "size": 1,
      "xs": [
        1
      ],
      "ys": [
        1
      ]
    }
  ],
  "is_copied": false,
  "attachments": [
    {
      "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"
    }
  ]
}

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidRequired

The id of the drive this comment is in

contentstring · nullableOptional

The comment to add to the asset

is_publicbooleanOptional

Whether the comment is public or not

urlstringRequired

The url of the comment

timestampnumber · nullableOptional

The timestamp of the comment from the start of the video. delete with -1

durationnumber · nullableOptional

The duration of the comment timestamp in seconds (for range based comments). delete with -1

Responses

200

The comment

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

put/assets/{asset_id}/comments/{comment_id}

HTTPcURLJavaScriptPython

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

{
  "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",
  "timestamp": 1,
  "duration": 1,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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",
    "user_type": "regular"
  },
  "created": "2026-07-11T08:42:38.872Z",
  "updated": "2026-07-11T08:42:38.872Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "duration": 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",
        "user_type": "regular"
      },
      "created": "2026-07-11T08:42:38.872Z",
      "updated": "2026-07-11T08:42:38.872Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "duration": 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",
            "user_type": "regular"
          },
          "created": "2026-07-11T08:42:38.872Z",
          "updated": "2026-07-11T08:42:38.872Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "duration": 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",
                  "user_type": "regular",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          },
          "annotation": [
            {
              "tool": "text",
              "color": "text",
              "size": 1,
              "xs": [
                1
              ],
              "ys": [
                1
              ]
            }
          ],
          "is_copied": false,
          "attachments": [
            {
              "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"
            }
          ]
        }
      ],
      "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",
              "user_type": "regular",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      },
      "annotation": [
        {
          "tool": "text",
          "color": "text",
          "size": 1,
          "xs": [
            1
          ],
          "ys": [
            1
          ]
        }
      ],
      "is_copied": false,
      "attachments": [
        {
          "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"
        }
      ]
    }
  ],
  "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",
          "user_type": "regular",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  },
  "annotation": [
    {
      "tool": "text",
      "color": "text",
      "size": 1,
      "xs": [
        1
      ],
      "ys": [
        1
      ]
    }
  ],
  "is_copied": false,
  "attachments": [
    {
      "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"
    }
  ]
}

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete/assets/{asset_id}/comments/{comment_id}

HTTPcURLJavaScriptPython

DELETE /assets/{asset_id}/comments/{comment_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

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuid · nullableOptional

The id of the drive this comment is in

resolvedboolean · nullableOptional

Whether the comment is resolved

urlstringRequired

The url of the comment with REPLACE_COMMENT_ID_ON_SERVER placeholder

Responses

200

The comment

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

put/assets/{asset_id}/comments/{comment_id}/resolve

HTTPcURLJavaScriptPython

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

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "resolved": true,
  "url": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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",
    "user_type": "regular"
  },
  "created": "2026-07-11T08:42:38.872Z",
  "updated": "2026-07-11T08:42:38.872Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "duration": 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",
        "user_type": "regular"
      },
      "created": "2026-07-11T08:42:38.872Z",
      "updated": "2026-07-11T08:42:38.872Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "duration": 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",
            "user_type": "regular"
          },
          "created": "2026-07-11T08:42:38.872Z",
          "updated": "2026-07-11T08:42:38.872Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "duration": 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",
                  "user_type": "regular",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          },
          "annotation": [
            {
              "tool": "text",
              "color": "text",
              "size": 1,
              "xs": [
                1
              ],
              "ys": [
                1
              ]
            }
          ],
          "is_copied": false,
          "attachments": [
            {
              "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"
            }
          ]
        }
      ],
      "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",
              "user_type": "regular",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      },
      "annotation": [
        {
          "tool": "text",
          "color": "text",
          "size": 1,
          "xs": [
            1
          ],
          "ys": [
            1
          ]
        }
      ],
      "is_copied": false,
      "attachments": [
        {
          "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"
        }
      ]
    }
  ],
  "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",
          "user_type": "regular",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  },
  "annotation": [
    {
      "tool": "text",
      "color": "text",
      "size": 1,
      "xs": [
        1
      ],
      "ys": [
        1
      ]
    }
  ],
  "is_copied": false,
  "attachments": [
    {
      "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"
    }
  ]
}

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidRequired

The id of the drive this comment is in

contentstringRequired

The content of the comment to add to the asset

urlstringRequired

The url of the comment

Responses

200

The comment

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/comments/{comment_id}/reply

HTTPcURLJavaScriptPython

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

{
  "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",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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",
    "user_type": "regular"
  },
  "created": "2026-07-11T08:42:38.872Z",
  "updated": "2026-07-11T08:42:38.872Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "duration": 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",
        "user_type": "regular"
      },
      "created": "2026-07-11T08:42:38.872Z",
      "updated": "2026-07-11T08:42:38.872Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "duration": 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",
            "user_type": "regular"
          },
          "created": "2026-07-11T08:42:38.872Z",
          "updated": "2026-07-11T08:42:38.872Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "duration": 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",
                  "user_type": "regular",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          },
          "annotation": [
            {
              "tool": "text",
              "color": "text",
              "size": 1,
              "xs": [
                1
              ],
              "ys": [
                1
              ]
            }
          ],
          "is_copied": false,
          "attachments": [
            {
              "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"
            }
          ]
        }
      ],
      "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",
              "user_type": "regular",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      },
      "annotation": [
        {
          "tool": "text",
          "color": "text",
          "size": 1,
          "xs": [
            1
          ],
          "ys": [
            1
          ]
        }
      ],
      "is_copied": false,
      "attachments": [
        {
          "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"
        }
      ]
    }
  ],
  "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",
          "user_type": "regular",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  },
  "annotation": [
    {
      "tool": "text",
      "color": "text",
      "size": 1,
      "xs": [
        1
      ],
      "ys": [
        1
      ]
    }
  ],
  "is_copied": false,
  "attachments": [
    {
      "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"
    }
  ]
}

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidRequired

The id of the drive this comment is in

reaction_to_addstring · nullableOptional

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

reaction_to_removestring · uuid · nullableOptional

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

Responses

200

The comment

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

put/assets/{asset_id}/comments/{comment_id}/react

HTTPcURLJavaScriptPython

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

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

{
  "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",
    "user_type": "regular"
  },
  "created": "2026-07-11T08:42:38.872Z",
  "updated": "2026-07-11T08:42:38.872Z",
  "resolved": true,
  "is_public": true,
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": 1,
  "duration": 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",
        "user_type": "regular"
      },
      "created": "2026-07-11T08:42:38.872Z",
      "updated": "2026-07-11T08:42:38.872Z",
      "resolved": true,
      "is_public": true,
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "duration": 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",
            "user_type": "regular"
          },
          "created": "2026-07-11T08:42:38.872Z",
          "updated": "2026-07-11T08:42:38.872Z",
          "resolved": true,
          "is_public": true,
          "parent_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp": 1,
          "duration": 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",
                  "user_type": "regular",
                  "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "content": "text",
              "count": 1
            }
          ],
          "anchor": {
            "x": 1,
            "y": 1
          },
          "annotation": [
            {
              "tool": "text",
              "color": "text",
              "size": 1,
              "xs": [
                1
              ],
              "ys": [
                1
              ]
            }
          ],
          "is_copied": false,
          "attachments": [
            {
              "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"
            }
          ]
        }
      ],
      "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",
              "user_type": "regular",
              "comment_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "content": "text",
          "count": 1
        }
      ],
      "anchor": {
        "x": 1,
        "y": 1
      },
      "annotation": [
        {
          "tool": "text",
          "color": "text",
          "size": 1,
          "xs": [
            1
          ],
          "ys": [
            1
          ]
        }
      ],
      "is_copied": false,
      "attachments": [
        {
          "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"
        }
      ]
    }
  ],
  "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",
          "user_type": "regular",
          "comment_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "content": "text",
      "count": 1
    }
  ],
  "anchor": {
    "x": 1,
    "y": 1
  },
  "annotation": [
    {
      "tool": "text",
      "color": "text",
      "size": 1,
      "xs": [
        1
      ],
      "ys": [
        1
      ]
    }
  ],
  "is_copied": false,
  "attachments": [
    {
      "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"
    }
  ]
}

Start the upload process for a comment attachment

post

Start the upload process for a comment attachment

Path parameters

asset_idstring · uuidRequired

The id of the asset to create the attachment for

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidRequired

The id of the drive to create the attachment for

namestringRequired

The name of the attachment to be created

mime_typestringRequired

The mime type of the attachment to be created

sizeintegerRequired

The size of the attachment to be created

comment_idstring · uuidRequired

The id of the comment to attach to

Responses

200

Successful Response

application/json

idstring · uuidRequired

drive_idstring · uuidRequired

uploader_idstring · uuidRequired

uploadedbooleanRequired

namestringRequired

mime_typestringRequired

sizeintegerRequired

upload_urlstringRequired

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/comments/attachments

HTTPcURLJavaScriptPython

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

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "mime_type": "text",
  "size": 1,
  "comment_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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,
  "upload_url": "text"
}

Mark the upload of a comment attachment as complete

post

Mark the upload of a comment attachment as complete

Path parameters

asset_idstring · uuidRequired

The id of the asset to mark the attachment uploaded for

attachment_idstring · uuidRequired

The id of the attachment to mark as uploaded

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidRequired

The id of the drive to mark the attachment uploaded for

Responses

200

Successful Response

application/json

idstring · uuidRequired

drive_idstring · uuidRequired

uploader_idstring · uuidRequired

uploadedbooleanRequired

namestringRequired

mime_typestringRequired

sizeintegerRequired

download_urlstringRequired

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/comments/attachments/{attachment_id}

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/comments/attachments/{attachment_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 97

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

{
  "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"
}

Paste comments from another asset

post

Paste all comments from source asset to target asset

Path parameters

asset_idstring · uuidRequired

The id of the asset to paste comments to

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

source_asset_idstring · uuidRequired

The id of the asset to copy comments from

drive_idstring · uuidRequired

The id of the drive

Responses

200

List of newly created comments

application/json

idstring · uuidRequired

asset_idstring · uuid · nullableRequired

contentstringRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

resolvedbooleanRequired

is_publicbooleanRequired

parent_idstring · uuid · nullableRequired

timestampnumber · nullableRequired

durationnumber · nullableRequired

is_copiedbooleanOptionalDefault: false

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/comments/paste

HTTPcURLJavaScriptPython

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

{
  "source_asset_id": "123e4567-e89b-12d3-a456-426614174000",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "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",
      "user_type": "regular"
    },
    "created": "2026-07-11T08:42:38.872Z",
    "updated": "2026-07-11T08:42:38.872Z",
    "resolved": true,
    "is_public": true,
    "parent_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": 1,
    "duration": 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",
          "user_type": "regular"
        },
        "created": "2026-07-11T08:42:38.872Z",
        "updated": "2026-07-11T08:42:38.872Z",
        "resolved": true,
        "is_public": true,
        "parent_id": "123e4567-e89b-12d3-a456-426614174000",
        "timestamp": 1,
        "duration": 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",
              "user_type": "regular"
            },
            "created": "2026-07-11T08:42:38.872Z",
            "updated": "2026-07-11T08:42:38.872Z",
            "resolved": true,
            "is_public": true,
            "parent_id": "123e4567-e89b-12d3-a456-426614174000",
            "timestamp": 1,
            "duration": 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",
                    "user_type": "regular",
                    "comment_id": "123e4567-e89b-12d3-a456-426614174000"
                  }
                ],
                "content": "text",
                "count": 1
              }
            ],
            "anchor": {
              "x": 1,
              "y": 1
            },
            "annotation": [
              {
                "tool": "text",
                "color": "text",
                "size": 1,
                "xs": [
                  1
                ],
                "ys": [
                  1
                ]
              }
            ],
            "is_copied": false,
            "attachments": [
              {
                "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"
              }
            ]
          }
        ],
        "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",
                "user_type": "regular",
                "comment_id": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "content": "text",
            "count": 1
          }
        ],
        "anchor": {
          "x": 1,
          "y": 1
        },
        "annotation": [
          {
            "tool": "text",
            "color": "text",
            "size": 1,
            "xs": [
              1
            ],
            "ys": [
              1
            ]
          }
        ],
        "is_copied": false,
        "attachments": [
          {
            "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"
          }
        ]
      }
    ],
    "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",
            "user_type": "regular",
            "comment_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "content": "text",
        "count": 1
      }
    ],
    "anchor": {
      "x": 1,
      "y": 1
    },
    "annotation": [
      {
        "tool": "text",
        "color": "text",
        "size": 1,
        "xs": [
          1
        ],
        "ys": [
          1
        ]
      }
    ],
    "is_copied": false,
    "attachments": [
      {
        "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"
      }
    ]
  }
]

Export comments in various formats

get

Export all comments for an asset in the specified format

Path parameters

asset_idstring · uuidRequired

The id of the asset to export comments for

Query parameters

typestring · enumRequired

The type of export to generate

Possible values:

drive_idstring · uuidOptional

The id of the drive this asset is in

authorizationstring · nullableOptional

The authorization token to use to fetch the export

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Exported comments file

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/comments/export

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/comments/export?type=csv HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

No content

Get the transcription utterances 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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

speakerstringRequired

startnumberRequired

endnumberRequired

textstringRequired

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/transcription/utterances

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/utterances?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

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

Get the transcription segments 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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

startnumberRequired

endnumberRequired

textstringRequired

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/transcription/segments

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/segments?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

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

Export the transcription as a file 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:

authorizationstring · nullableOptional

The authorization token to use to fetch the preview

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/transcription/file

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/file?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

Get AI-generated conversation starters for the transcript

get

Generate 3 pertinent conversation starters based on the transcript content using LeMuR AI.

Path parameters

asset_idstring · uuidRequired

The asset to get suggestions for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

suggestionsstring[]Required

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/transcription/suggestions

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/transcription/suggestions?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

{
  "suggestions": [
    "text"
  ]
}

Chat with the transcript using LeMuR AI

post

Chat with the transcript using AssemblyAI's LeMuR (powered by Claude 3.5 Sonnet). The AI will provide timestamps in [MM:SS] or [HH:MM:SS] format that can be clicked in the UI.

Path parameters

asset_idstring · uuidRequired

The asset to chat with the transcription for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

responsestringRequired

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/transcription/chat

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/transcription/chat?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "request": {
    "message": "text",
    "conversation_history": [
      {
        "role": "user",
        "content": "text"
      }
    ]
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "response": "text"
}

Get all preview images for an asset with signed urls

get

Get all preview images for an asset, including signed URLs for each preview image.

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

idstring · uuidRequired

frameintegerRequired

signed_urlstring · nullableOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/previews

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/previews?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",
    "frame": 1,
    "signed_url": "text"
  }
]

Get the usage of a drive's assets for analytics

get

Query parameters

drive_idstring · uuidRequired

The id of the drive we get asset usage for

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

num_assetsintegerRequired

num_ai_assetsintegerRequired

bytesintegerRequired

collectionsintegerRequired

404

Not found

422

Validation Error

application/json

get/assets/usage

HTTPcURLJavaScriptPython

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

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

{
  "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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

idstring · uuidRequired

individual_idstring · uuid · nullableOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/faces

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/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 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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

A list of mentionable users on comments for the asset

application/json

idstring · uuidRequired

namestringRequired

emailstringRequired

avatar_urlstringRequired

user_typestring · enumRequiredPossible values:

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/mentionable-users

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/mentionable-users?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",
    "email": "text",
    "avatar_url": "text",
    "user_type": "regular"
  }
]

Clip a video between two timestamps (hybrid head re-encode + tail copy)

get

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

start_timenumberRequired

The start time of the clip in seconds

end_timenumberRequired

The end time of the clip in seconds

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/clip

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/clip?drive_id=123e4567-e89b-12d3-a456-426614174000&start_time=1&end_time=1 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

No content

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

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

A signed download URL

application/json

stringOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/download

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/download?drive_id=123e4567-e89b-12d3-a456-426614174000&origin_type=SOURCE HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

text

Get an asset source by redirecting to the signed url

get

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

namestringOptional

The name of the file to download as

authorizationstring · nullableOptional

The authorization token to use to fetch the preview

shade-collection-idstring · uuid · nullableOptional

The collection id to authorize against, if not provided will use the default collection for the user.

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

A signed download URL

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}/source

HTTPcURLJavaScriptPython

GET /assets/{asset_id}/source?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

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

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

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_idstring · uuid · nullableOptional

stack_numberinteger · nullableOptional

is_fs_draft_blobbooleanRequired

is_fs_null_blobbooleanRequired

ratingnumber · nullableOptional

ai_indexedbooleanRequired

categorystring · nullableOptional

ocrstring · nullableOptional

transcription_idstring · uuid · nullableOptional

faces_presentboolean · nullableOptional

content_lengthinteger · nullableOptional

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:

custom_thumbnailstring · nullableOptional

404

Not found

422

Validation Error

application/json

get/assets/path

HTTPcURLJavaScriptPython

GET /assets/path?path=text&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",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "name": "text",
  "extension": "text",
  "updated": "2026-07-11T08:42:38.872Z",
  "created": "2026-07-11T08:42:38.872Z",
  "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"
  }
}

Bulk update asset metadata attributes

put

Either pass in asset_ids/metadata_attributes OR assets.

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

asset_idsstring · uuid[] · nullableOptional

The id of the assets to be updated

drive_idstring · uuidRequired

The id of the drive this asset is in

Responses

200

Successful Response

application/json

asset_idstring · uuidRequired

updated_metadata_attribute_idsstring[]Required

404

Not found

422

Validation Error

application/json

put/assets/bulk/metadata/values

HTTPcURLJavaScriptPython

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

{
  "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",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

Get all assets for a stack

get

Path parameters

stack_idstring · uuidRequired

The id of the stack to retrieve assets for

Query parameters

directory_pathstringRequired

The directory path that the stack is located under

drive_idstring · uuidRequired

The id of the drive this stack is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

A list of assets for the stack

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_idstring · uuid · nullableOptional

stack_numberinteger · nullableOptional

is_fs_draft_blobbooleanRequired

is_fs_null_blobbooleanRequired

ratingnumber · nullableOptional

ai_indexedbooleanRequired

categorystring · nullableOptional

ocrstring · nullableOptional

transcription_idstring · uuid · nullableOptional

faces_presentboolean · nullableOptional

content_lengthinteger · nullableOptional

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:

custom_thumbnailstring · nullableOptional

404

Not found

422

Validation Error

application/json

get/assets/stack/{stack_id}

HTTPcURLJavaScriptPython

GET /assets/stack/{stack_id}?directory_path=text&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",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "name": "text",
    "extension": "text",
    "updated": "2026-07-11T08:42:38.872Z",
    "created": "2026-07-11T08:42:38.872Z",
    "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"
    }
  }
]

Create a new stack from a list of assets

post

Create a new stack from a list of assets

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

asset_idsstring · uuid[]Required

List of asset IDs to create a stack from

drive_idstring · uuidRequired

The id of the drive these assets are in

Responses

200

The ID of the created stack

application/json

string · uuidOptional

404

Not found

422

Validation Error

application/json

post/assets/stack

HTTPcURLJavaScriptPython

POST /assets/stack HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 150

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

123e4567-e89b-12d3-a456-426614174000

Add an asset to a stack

post

Add an asset to a stack

Path parameters

asset_idstring · uuidRequired

The id of the asset to add to the stack

Query parameters

target_asset_idstring · uuidRequired

The id of an asset in the stack to add the asset to

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

The stack number of the added asset

application/json

integerOptional

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/stack

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/stack?target_asset_id=123e4567-e89b-12d3-a456-426614174000&drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

1

Remove an asset from its stack

delete

Remove an asset from its stack

Path parameters

asset_idstring · uuidRequired

The id of the asset to remove from its stack

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Whether the asset was removed from the stack

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete/assets/{asset_id}/stack

HTTPcURLJavaScriptPython

DELETE /assets/{asset_id}/stack?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

Move an asset to a new position within its stack

put

Move an asset to a new position within its stack

Path parameters

asset_idstring · uuidRequired

The id of the asset to move within the stack

Query parameters

new_stack_numberintegerRequired

The new stack number position for the asset

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Whether the asset was successfully moved

application/json

anyOptional

404

Not found

422

Validation Error

application/json

put/assets/{asset_id}/stack/move

HTTPcURLJavaScriptPython

PUT /assets/{asset_id}/stack/move?new_stack_number=1&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

Rerun transcription for an asset

post

Rerun transcription for an asset. If the asset was previously completed with no dialogue, it will skip the dialogue classifier.

Path parameters

asset_idstring · uuidRequired

The id of the asset to rerun transcription for

Query parameters

drive_idstring · uuidRequired

The id of the drive this asset is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Success status

application/json

Other propertiesstringOptional

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/transcription-override

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/transcription-override?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

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

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

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

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

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_idstring · uuid · nullableOptional

stack_numberinteger · nullableOptional

is_fs_draft_blobbooleanRequired

is_fs_null_blobbooleanRequired

ratingnumber · nullableOptional

ai_indexedbooleanRequired

categorystring · nullableOptional

ocrstring · nullableOptional

transcription_idstring · uuid · nullableOptional

faces_presentboolean · nullableOptional

content_lengthinteger · nullableOptional

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:

custom_thumbnailstring · nullableOptional

404

Not found

422

Validation Error

application/json

get/assets/{asset_id}

HTTPcURLJavaScriptPython

GET /assets/{asset_id}?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",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "name": "text",
  "extension": "text",
  "updated": "2026-07-11T08:42:38.872Z",
  "created": "2026-07-11T08:42:38.872Z",
  "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"
  }
}

Set Custom Thumbnail

post

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

drive_idstring · uuidOptional

The id of the drive this asset is in

attachment_tokenstringOptional

JWT tokens for attachments to link to this thumbnail

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

post/assets/{asset_id}/custom-thumbnail

HTTPcURLJavaScriptPython

POST /assets/{asset_id}/custom-thumbnail HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 123

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

No content

Reset Custom Thumbnail

delete

Path parameters

asset_idstring · uuidRequired

The id of the asset to retrieve

Query parameters

drive_idstring · uuidRequired

The id of the drive this attachment is in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

application/json

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete/assets/{asset_id}/custom-thumbnail

HTTPcURLJavaScriptPython

DELETE /assets/{asset_id}/custom-thumbnail?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