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
    • Index content
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
      • Create video embeddings
        • The video embedding object
        • POSTCreate a video embedding task
        • GETList video embedding tasks
        • GETRetrieve the status of a video embedding task
        • GETRetrieve video embeddings
      • Create text, image, and audio embeddings
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceCreate embeddings v1Create video embeddings

List video embedding tasks

GET
https://api.twelvelabs.io/v1.3/embed/tasks
GET
/v1.3/embed/tasks
$curl https://api.twelvelabs.io/v1.3/embed/tasks \
>     -H "x-api-key: <apiKey>"
1{
2  "data": [
3    {
4      "_id": "66f537778d9641fe5a0d101f",
5      "model_name": "marengo3.0",
6      "status": "processing",
7      "created_at": "2024-09-26T10:29:19.968Z",
8      "video_embedding": {
9        "metadata": {
10          "duration": 13.4400001,
11          "input_filename": "01.mp4",
12          "video_clip_length": 6,
13          "video_embedding_scope": [
14            "clip"
15          ]
16        }
17      }
18    },
19    {
20      "_id": "66f535874bd2802fc13293f4",
21      "model_name": "marengo3.0",
22      "status": "processing",
23      "created_at": "2024-09-26T10:21:04.157Z",
24      "video_embedding": {
25        "metadata": {
26          "duration": 13.4400001,
27          "input_filename": "01.mp4",
28          "video_clip_length": 6,
29          "video_embedding_scope": [
30            "clip"
31          ]
32        }
33      }
34    },
35    {
36      "_id": "66f534fd4bd2802fc13293ee",
37      "model_name": "marengo3.0",
38      "status": "processing",
39      "created_at": "2024-09-26T10:18:44.866Z",
40      "video_embedding": {
41        "metadata": {
42          "duration": 13.4400001,
43          "input_filename": "01.mp4",
44          "video_clip_length": 6,
45          "video_embedding_scope": [
46            "clip"
47          ]
48        }
49      }
50    }
51  ],
52  "page_info": {
53    "limit_per_page": 10,
54    "page": 1,
55    "total_page": 1,
56    "total_results": 3
57  }
58}
<Note title="Note"> This method will be deprecated in a future version. Migrate to the [Embed API v2](/v1.3/api-reference/create-embeddings-v2) for continued support and access to new features. </Note> This method returns a list of the video embedding tasks in your account. The platform returns your video embedding tasks sorted by creation date, with the newest at the top of the list. <Note title="Notes"> - Video embeddings are stored for seven days. - When you invoke this method without specifying the `started_at` and `ended_at` parameters, the platform returns all the video embedding tasks created within the last seven days. </Note>
Was this page helpful?
Previous

Retrieve the status of a video embedding task

Next
Built with
Note

This method will be deprecated in a future version. Migrate to the Embed API v2 for continued support and access to new features.

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

Notes
  • Video embeddings are stored for seven days.
  • When you invoke this method without specifying the started_at and ended_at parameters, the platform returns all the video embedding tasks created within the last seven days.

Authentication

x-api-keystring

Your API key.

Note

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

Query parameters

started_atstringOptional

Retrieve the embedding tasks that were created after the given date and time, expressed in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).

ended_atstringOptional

Retrieve the embedding tasks that were created before the given date and time, expressed in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).

statusstringOptional

Filter the embedding tasks by their current status.

Values: processing, ready, or failed.

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.

Response

A list of async embedding tasks has successfully been retrieved.
datalist of objects

An array that contains up to page_limit embedding tasks.

page_infoobject
An object that provides information about pagination.

Errors

400
Bad Request Error