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
      • POSTCreate sync embeddings
      • POSTCreate an async embedding task
      • GETList async embedding tasks
      • GETRetrieve task status and results
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceCreate embeddings v2

Retrieve task status and results

GET
https://api.twelvelabs.io/v1.3/embed-v2/tasks/:task_id
GET
/v1.3/embed-v2/tasks/:task_id
$curl https://api.twelvelabs.io/v1.3/embed-v2/tasks/64f8d2c7e4a1b37f8a9c5d12 \
>     -H "x-api-key: <apiKey>"
1{
2  "_id": "64f8d2c7e4a1b37f8a9c5d12",
3  "status": "processing",
4  "data": [
5    {
6      "embedding": [
7        0.111,
8        0.234,
9        -0.567,
10        0.89
11      ]
12    }
13  ]
14}
This method retrieves the status and the results of an async embedding task. **Task statuses**: - `processing`: The platform is creating the embeddings. - `ready`: Processing is complete. Embeddings are available in the response. - `failed`: The task failed. Embeddings were not created. Invoke this method repeatedly until the `status` field is `ready`. When `status` is `ready`, use the embeddings from the response. <Note title="Note"> Embeddings are stored for seven days. </Note>
Was this page helpful?
Previous

Create embeddings v1

Next
Built with

This method retrieves the status and the results of an async embedding task.

Task statuses:

  • processing: The platform is creating the embeddings.
  • ready: Processing is complete. Embeddings are available in the response.
  • failed: The task failed. Embeddings were not created.

Invoke this method repeatedly until the status field is ready. When status is ready, use the embeddings from the response.

Note

Embeddings are stored for seven days.

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>

Path parameters

task_idstringRequired
The unique identifier of the embedding task.

Response

Task status and results retrieved successfully
_idstring
The unique identifier of the embedding task.
statusenum

The current status of the task.

Values:

  • processing: The platform is creating the embeddings
  • ready: Processing is complete. Embeddings are available in the data field
  • failed: The task failed. The data field is null
Allowed values:
datalist of objects or null

An object containing the embedding results, or null otherwise.

created_atstringformat: "date-time"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was created.

updated_atstringformat: "date-time"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was last updated.

metadataobject
Metadata for the media input.
errorobject

An object describing why the embedding task failed. Present only when status is failed. Omitted otherwise.

Errors

404
Not Found Error

Your API key.

Note

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