Import files | TwelveLabs

curl -X POST https://api.twelvelabs.io/v1.3/connections/665f0a2c9b1e4d0012a3f7c9/imports \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "source_id": "1AbCDef_drive_file_id_x"
    }
  ]
}'

{
  "_id": "665f0afe9b1e4d0012a3f7d0",
  "has_failures": true,
  "items": [
    {
      "source_id": "1AbCDef_drive_file_id_x",
      "action": "created",
      "asset_id": "665f0b1f9b1e4d0012a3f7e1",
      "status": "processing"
    },
    {
      "source_id": "2XyZGhi_drive_file_id_y",
      "action": "skipped",
      "asset_id": "665f0b1f9b1e4d0012a3f7e2",
      "status": "ready"
    },
    {
      "source_id": "3PqRStu_drive_file_id_z",
      "action": "retried",
      "asset_id": "665f0b1f9b1e4d0012a3f7e3",
      "status": "processing"
    },
    {
      "source_id": "4LmNOpq_drive_file_id_w",
      "action": "rejected",
      "error": {
        "code": "source_unavailable",
        "message": "The file could not be accessed."
      }
    }
  ]
}

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. For each newly imported file, the platform creates an asset in the processing status and fetches the file asynchronously. If you import a file that was already imported through this account, the platform returns the existing asset with its current status, without fetching the file again. If the earlier fetch had failed, the platform fetches the file again. The response contains one entry per requested file, in request order. Use the action field of each entry to identify which files were newly imported and which were already imported.

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. For each newly imported file, the platform creates an asset in the `processing` status and fetches the file asynchronously. If you import a file that was already imported through this account, the platform returns the existing asset with its current status, without fetching the file again. If the earlier fetch had failed, the platform fetches the file again. The response contains one entry per requested file, in request order. Use the `action` field of each entry to identify which files were newly imported and which were already imported.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

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>

Path parameters

connection_idstringRequired

The unique identifier of the connection to import through.

Request

This endpoint expects an object.

itemslist of objectsRequired

The files to import. Provide an array of one item for a single import, or multiple items for a batch import. A maximum of 100 items can be imported per request. The source_id field of each item must be unique within a request.

Response

The import request has been accepted. The response contains one item per requested file, in request order. Use the action field of each item to identify which files were newly imported and which were already imported. An accepted item includes the identifier and status of its asset. A rejected item includes an error object instead, and omits both. The has_failures field is true when at least one item was rejected. A rejected item does not fail the request; the response is 202 even when no item is accepted.

The import request has been accepted. The response contains one item per requested file, in request order. Use the `action` field of each item to identify which files were newly imported and which were already imported. An accepted item includes the identifier and status of its asset. A rejected item includes an `error` object instead, and omits both. The `has_failures` field is `true` when at least one item was rejected. A rejected item does not fail the request; the response is `202` even when no item is accepted.

_idstringOptional

The unique identifier of the import created for this request.

has_failuresbooleanOptional

Whether at least one item was rejected before an asset was created. When true, inspect the error object of each item to identify the rejected ones. An item the platform skipped as a duplicate is not a failure.

itemslist of objectsOptional

One entry per requested file, in request order, with its action value and the current status of its asset.

Errors

400

Bad Request Error

404

Not Found Error

409

Conflict Error