Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
imports

Import files

This method imports one or more files from the connected provider account into the platform as assets. Video files can be up to 10 GB, audio files up to 4 GB, and images up to 32 MB. Each newly imported file creates an asset in the processing status and is downloaded asynchronously. If you import a file that was already imported through this account, the platform returns the existing asset with its current status, which may be ready, without downloading the file again. The response returns one entry per requested file, in request order.

post/connections/{connection_id}/imports

Path parameters

connection_idstring required

The unique identifier of the connection to import through.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

Response

The import request has been accepted. The response returns one item per requested file, in request order. An accepted item includes the asset_id and status fields. A rejected item includes an error object instead and omits those fields. The has_failures field is true when any item was rejected.

_idstring

The unique identifier of the import created for this request.

has_failuresboolean

Whether any item was rejected before an asset was created. When true, inspect the error object of each item to identify the rejected ones.