List video indexing tasks

get

https://api.twelvelabs.io/v1.3/tasks

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Defaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limit

integer

Defaults to 10

The number of items to return on each page.

Default: 10.
Max: 50.

sort_by

string

Defaults to created_at

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_option

string

Defaults to desc

The sorting direction. The following options are available:

asc
desc

Default: desc.

index_id

string

Filter by the unique identifier of an index.

status

array of strings

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

status

Allowed:

filename

string

Filter by filename.

duration

number

Filter by duration. Expressed in seconds.

width

integer

Filter by width.

height

integer

Filter by height.

created_at

string

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_at

string

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-key

string

required

Your API key.

NOTE: You can find your API key on the API Key page.

Responses

200The video indexing tasks have successfully been retrieved.

400The request has failed.