Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
tasks

List video indexing tasks

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

This method returns a list of the video indexing tasks in your account. The platform returns your video indexing tasks sorted by creation date, with the newest at the top of the list.

get/tasks

Query parameters

pageinteger

A number that identifies the page to retrieve.

Default: 1.

page_limitinteger

The number of items to return on each page.

Default: 10. Max: 50.

sort_bystring

The field to sort on. The following options are available:

  • updated_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was updated.
  • created_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was created.

Default: created_at.

sort_optionstring

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

index_idstring

Filter by the unique identifier of an index.

statusTasksGetParametersStatusSchemaItems[]

Filter by one or more video indexing task statuses. The following options are available:

  • ready: The video has been successfully uploaded and indexed.
  • uploading: The video is being uploaded.
  • validating: The video is being validated against the prerequisites.
  • pending: The video is pending.
  • queued: The video is queued.
  • indexing: The video is being indexed.
  • failed: The video indexing task failed.

To filter by multiple statuses, specify the status parameter for each value:

status=ready&status=validating
filenamestring

Filter by filename.

durationnumber double

Filter by duration. Expressed in seconds.

widthinteger

Filter by width.

heightinteger

Filter by height.

created_atstring

Filter video indexing tasks by the creation date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the video indexing tasks that were created on the specified date at or after the given time.

updated_atstring

Filter video indexing tasks by the last update date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the video indexing tasks that were updated on the specified date at or after the given time.

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 video indexing tasks have successfully been retrieved.