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

Retrieve the status of a video embedding task

GET
https://api.twelvelabs.io/v1.3/embed/tasks/:task_id/status
GET
/v1.3/embed/tasks/:task_id/status
$curl https://api.twelvelabs.io/v1.3/embed/tasks/663da73b31cdd0c1f638a8e6/status \
>     -H "x-api-key: <apiKey>"
1{
2  "_id": "6641c0efc70bb578439bd909",
3  "status": "processing",
4  "model_name": "marengo3.0",
5  "video_embedding": {
6    "metadata": {
7      "duration": 18,
8      "input_filename": "01.mp4",
9      "video_clip_length": 6,
10      "video_embedding_scope": [
11        "clip",
12        "video"
13      ]
14    }
15  }
16}
<Note title="Note"> This endpoint 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 retrieves the status of a video embedding task. Check the task status of a video embedding task to determine when you can retrieve the embedding. A task can have one of the following statuses: - `processing`: The platform is creating the embeddings. - `ready`: Processing is complete. Retrieve the embeddings by invoking the [`GET`](/v1.3/api-reference/create-embeddings-v1/video-embeddings/retrieve-video-embeddings) method of the `/embed/tasks/{task_id} endpoint`. - `failed`: The task could not be completed, and the embeddings haven't been created.
Was this page helpful?
Previous

Retrieve video embeddings

Next
Built with
Note

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

This method retrieves the status of a video embedding task. Check the task status of a video embedding task to determine when you can retrieve the embedding.

A task can have one of the following statuses:

  • processing: The platform is creating the embeddings.
  • ready: Processing is complete. Retrieve the embeddings by invoking the GET method of the /embed/tasks/{task_id} endpoint.
  • failed: The task could not be completed, and the embeddings haven’t been created.

Authentication

x-api-keystring

Your API key.

Note

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

Path parameters

task_idstringRequired
The unique identifier of your video embedding task.

Response

The status of your video embedding task has been retrieved.
_idstring
The unique identifier of the video embedding task.
statusstring

A string indicating the status of the video indexing task. It can take one of the following values: processing, ready or failed.

model_namestring
The name of the video understanding model the platform used to create the embedding.
video_embeddingobject
An object containing the metadata associated with the embedding.

Errors

400
Bad Request Error