Retrieve the status of a video embedding task

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.

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/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.

Authentication

x-api-keystring

Your API key.

Note

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

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path parameters

task_idstringRequired

The unique identifier of your video embedding task.

Response

The status of your video embedding task has been retrieved.

_idstring or null

The unique identifier of the video embedding task.

statusstring or null

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

model_namestring or null

The name of the video understanding model the platform used to create the embedding.

video_embeddingobject or null

An object containing the metadata associated with the embedding.

1	{
2	"_id": "6641c0efc70bb578439bd909",
3	"status": "processing",
4	"model_name": "Marengo-retrieval-2.7",
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	}

Authentication

Note

Path parameters

Response

Errors

Note