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

{
  "data": [
    {
      "_id": "66f537778d9641fe5a0d101f",
      "model_name": "marengo3.0",
      "status": "processing",
      "created_at": "2024-09-26T10:29:19.968Z",
      "video_embedding": {
        "metadata": {
          "input_filename": "01.mp4",
          "video_clip_length": 6,
          "video_embedding_scope": [
            "clip"
          ],
          "duration": 13.4400001
        }
      }
    },
    {
      "_id": "66f535874bd2802fc13293f4",
      "model_name": "marengo3.0",
      "status": "processing",
      "created_at": "2024-09-26T10:21:04.157Z",
      "video_embedding": {
        "metadata": {
          "input_filename": "01.mp4",
          "video_clip_length": 6,
          "video_embedding_scope": [
            "clip"
          ],
          "duration": 13.4400001
        }
      }
    },
    {
      "_id": "66f534fd4bd2802fc13293ee",
      "model_name": "marengo3.0",
      "status": "processing",
      "created_at": "2024-09-26T10:18:44.866Z",
      "video_embedding": {
        "metadata": {
          "input_filename": "01.mp4",
          "video_clip_length": 6,
          "video_embedding_scope": [
            "clip"
          ],
          "duration": 13.4400001
        }
      }
    }
  ],
  "page_info": {
    "limit_per_page": 10,
    "page": 1,
    "total_page": 1,
    "total_results": 3
  }
}

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 objectsOptional

An array that contains up to page_limit embedding tasks.

page_infoobjectOptional

An object that provides information about pagination.

Errors

400

Bad Request Error