For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
  • API Reference
    • Manage indexes
    • Upload content
      • Direct uploads
      • Multipart uploads
      • Video indexing tasks
        • The task object
        • POSTCreate a video indexing task
        • GETList video indexing tasks
        • GETRetrieve a video indexing task
        • DELDelete a video indexing task
    • Index content
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceUpload contentVideo indexing tasks

List video indexing tasks

GET
https://api.twelvelabs.io/v1.3/tasks
GET
/v1.3/tasks
$curl https://api.twelvelabs.io/v1.3/tasks \
>     -H "x-api-key: <apiKey>"
1{
2  "data": [
3    {
4      "_id": "62a17bf847f5678267ec10cc",
5      "created_at": "2022-06-09T04:50:00.879Z",
6      "updated_at": "2022-06-09T04:55:57.256Z",
7      "status": "ready",
8      "index_id": "62a0906d47f5678267ec10a6"
9    },
10    {
11      "_id": "62a17bce47f5678267ec10c6",
12      "created_at": "2022-06-09T04:49:20.001Z",
13      "updated_at": "2022-06-09T04:54:10.345Z",
14      "status": "ready",
15      "index_id": "62a0906d47f5678267ec10a6"
16    }
17  ],
18  "page_info": {
19    "limit_per_page": 10,
20    "page": 1,
21    "total_page": 1,
22    "total_results": 2
23  }
24}
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.
Was this page helpful?
Previous

Retrieve a video indexing task

Next
Built with

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>

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

sort_bystringOptionalDefaults 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_optionstringOptionalDefaults to desc
The sorting direction. The following options are available: - `asc` - `desc` **Default**: `desc`.
index_idstringOptional
Filter by the unique identifier of an index.
statuslist of enumsOptional
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 ```
filenamestringOptional
Filter by filename.
durationdoubleOptional
Filter by duration. Expressed in seconds.
widthintegerOptional
Filter by width.
heightintegerOptional
Filter by height.
created_atstringOptional

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_atstringOptional

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.

Response

The video indexing tasks have successfully been retrieved.
datalist of objects

An array that contains up to page_limit tasks.

page_infoobject
An object that provides information about pagination.

Errors

400
Bad Request Error

Your API key.

Note

You can find your API key on the API Keys page.

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.

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

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