---
title: "Retrieve video embeddings"
method: GET
path: "/embed/tasks/{task_id}"
tags: ["embed > tasks"]
---

# Retrieve video embeddings

`GET /embed/tasks/{task_id}`

This method retrieves embeddings for a specific video embedding task. Ensure the task status is `ready` before invoking this method. Refer to the [Retrieve the status of a video embedding tasks](/v1.3/api-reference/create-embeddings-v1/video-embeddings/retrieve-video-embedding-task-status) page for instructions on checking the task status.

## Path parameters

- `task_id` string, required

## Query parameters

- `embedding_option` EmbedTasksTaskIdGetParametersEmbeddingOptionSchemaItems[]

## Headers

- `x-api-key` string, required

## Response `200`

Video embeddings have successfully been retrieved.

- EmbedTasksRetrieveResponse200 — A video embedding task that describes the status of the task and the metadata about the video.
  - `_id` string — The unique identifier of the video embedding task.
  - `model_name` string — The name of the video understanding model the platform used to create the embedding.
  - `status` string — A string indicating the status of the video indexing task. It can take one of the following values: `processing`, `ready` or `failed`.
  - `created_at` string, date-time — A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was created.
  - `updated_at` string, date-time — A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was last updated.
  - `video_embedding` EmbedTasksTaskIdGetResponsesContentApplicationJsonSchemaVideoEmbedding — An object containing the metadata associated with the embedding.
    - `metadata` VideoEmbeddingMetadata — An object containing metadata associated with the embedding.
      - `input_url` string — The URL of the media file used to generate the embedding. Present if a URL was provided in the request.
      - `input_filename` string — The name of the media file used to generate the embedding. Present if a file was provided in the request.
      - `video_clip_length` number, double — The duration for each clip in seconds, as specified in the request. Note that the platform automatically truncates video segments shorter than 2 seconds. For a 31-second video divided into 6-second segments, the final 1-second segment will be truncated. This truncation only applies to the last segment if it does not meet the minimum length requirement of 2 seconds.
      - `video_embedding_scope` string[] — The scope you've specified in the request.
      - `duration` number, double — The total duration of the video in seconds.
    - `segments` VideoSegment[] — An array of objects containing the embeddings for each video segment and the associated information.
      - `float` number[] — An array of floating point numbers representing the embedding. You can use this array with cosine similarity for various downstream tasks. Note that the example response was truncated for brevity.
      - `start_offset_sec` number, double — The start time in seconds from the beginning of the file.
      - `end_offset_sec` number, double — The end time in seconds from the beginning of the file.
      - `embedding_option` string — The type of the embedding.
      - `embedding_scope` string — The scope of the video embedding.

## Other responses

- `400` — The request has failed.

---

[API](https://skmtc.net/twelvelabs/apis/twelvelabs-api.md) · [All operations](https://skmtc.net/twelvelabs/apis/twelvelabs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/twelvelabs/twelvelabs-api/revisions/5dbd6e8473c9/schema)
