Assets and entitiesData connectorsImports

Retrieve an import

This method retrieves a single import, including the current status of each asset in the import.

Authentication

x-api-keystring
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 the import belongs to.
import_idstringRequired
The unique identifier of the import to retrieve.

Response

The import has been successfully retrieved.
_idstringOptional
The unique identifier of the import.
connection_idstringOptional
The unique identifier of the connection the files were imported through.
providerenumOptional
The data connector provider.
custom_idstringOptional

The label you supplied when creating the connection, copied when the import was created. Present only when a value is set for the custom_id field.

item_countintegerOptional

The number of files requested in this import. If an imported asset is later deleted, it is omitted from the items array in the Retrieve an import response, so the items array can contain fewer entries than item_count.

created_atstringOptionalformat: "date-time"

The date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the import was created.

itemslist of objectsOptional
One entry per imported file, with the current status of its asset.

Errors

400
Bad Request Error
404
Not Found Error