Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
tasks

Retrieve a video indexing task

<Info>This method will be removed in a future version.</Info>

This method retrieves a video indexing task.

get/tasks/{task_id}

Path parameters

task_idstring required

The unique identifier of the video indexing task to retrieve.

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>

Response

The specified video indexing task has successfully been retrieved.

_idstring

A string representing the unique identifier of the task. It is assigned by the platform when a new task is created.

video_idstring

A string representing the unique identifier of the video associated with the specified video indexing task.

created_atstring

A string indicating the date and time, in the RFC RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the task was created.

updated_atstring

A string indicating the date and time, in the RFC RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the task object was last updated. The platform updates this field every time the video indexing task transitions to a different state.

statusstring

A string indicating the status of the video indexing task. See the Task object page for a list of possible statuses.

index_idstring

A string representing the unique identifier of the index to which the video must be uploaded.