imports

Retrieve an import

Changed on

This method retrieves a single import. For each file, the response includes the action field, which indicates the outcome of the import operation, and the status field, which reflects the current status of the asset each time you retrieve the import.

get/connections/{connection_id}/imports/{import_id}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/connections/{connection_id}/imports/{import_id}
  • Auth: API key in header x-api-key

Path parameters

connection_idstring required

The unique identifier of the connection to retrieve the import from.

import_idstring required

The unique identifier of the import to retrieve.

Response

The import has been successfully retrieved.

_idstring

The unique identifier of the import.

connection_idstring

The unique identifier of the connection the files were imported through.

provider'google_drive'

The data connector provider.

custom_idstring

The label you supplied when you authorized the connection, copied when the import was created. Present only when you supplied one.

item_countinteger

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

created_atstring date-time

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

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id retrieve-import removed and replaced with imports_retrieve-import