---
title: "Retrieve video information"
method: GET
path: "/indexes/{index-id}/videos/{video-id}"
tags: ["indexes > videos"]
---

# Retrieve video information

`GET /indexes/{index-id}/videos/{video-id}`

<Info> This method will be deprecated in a future version. New implementations should use the [Retrieve an indexed asset](/v1.3/api-reference/index-content/retrieve) method.</Info>

This method retrieves information about the specified video.

## Path parameters

- `index-id` string, required
- `video-id` string, required

## Query parameters

- `embedding_option` IndexesIndexIdVideosVideoIdGetParametersEmbeddingOptionSchemaItems[]
- `transcription` boolean

## Headers

- `x-api-key` string, required

## Response `200`

The specified video information has successfully been retrieved.

- IndexesVideosRetrieveResponse200
  - `_id` string — The unique identifier of the video.
  - `asset_id` string — The unique identifier of the associated asset.
  - `created_at` string — A string indicating the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the video indexing task was created.
  - `updated_at` string — A string indicating the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the corresponding video indexing task was last updated. The platform updates this field every time the corresponding video indexing task transitions to a different state.
  - `indexed_at` string — A string indicating the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the video indexing task has been completed.
  - `system_metadata` IndexesIndexIdVideosVideoIdGetResponsesContentApplicationJsonSchemaSystemMetadata — System-generated metadata about the video.
    - `duration` number, double
    - `filename` string
    - `fps` number, double
    - `height` integer
    - `width` integer
  - `user_metadata` UserMetadata — Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings and values are one of `string`, `integer`, `float`, or `boolean`. **Example**: ```JSON "user_metadata": { "category": "recentlyAdded", "batchNumber": 5, "rating": 9.3, "needsReview": true } ``` <Note title="Note"> To store other types of data, such as objects or arrays, convert your data into string values before sending it. </Note>
  - `hls` HLSObject — The platform returns this object only for the videos that you uploaded with the `enable_video_stream` parameter set to `true`.
    - `video_url` string — A string representing the URL of the video. You can then use this URL to access the stream over the <a href="https://en.wikipedia.org/wiki/HTTP_Live_Streaming" target="_blank">HLS</a> protocol.
    - `thumbnail_urls` string[] — An array containing the URL of the thumbnail.
    - `status` 'PROCESSING' | 'COMPLETE' | 'CANCELED' | 'ERROR' — A string representing the encoding status of the video file from its original format to a streamable format. **Values**: - `PROCESSING`: Video is currently being encoded and is not yet ready for streaming - `COMPLETE`: Encoding has successfully finished and the video is ready for streaming - `CANCELED`: Encoding was manually canceled before completion - `ERROR`: An error occurred during the encoding process
    - `updated_at` string — A string indicating the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the encoding status was last updated.
  - `embedding` IndexesIndexIdVideosVideoIdGetResponsesContentApplicationJsonSchemaEmbedding — Contains the embedding and the associated information. The platform returns this field when the `embedding_option` parameter is specified in the request.
    - `model_name` string — The name of the video understanding model used to create the embedding.
    - `video_embedding` IndexesIndexIdVideosVideoIdGetResponsesContentApplicationJsonSchemaEmbeddingVideoEmbedding — An object that contains the embeddings.
      - `segments` VideoSegment[] — An array of objects that contains the embeddings for each individual segment.
        - `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.
  - `transcription` TranscriptionDataItems[] — An array of objects that contains the transcription. For each time range for which the platform finds spoken words, it returns an object that contains the fields below. If the platform doesn't find any spoken words, the `data` field is set to `null`.
    - `start` number, double — The start of the time range, expressed in seconds.
    - `end` number, double — The end of the time range, expressed in seconds.
    - `value` string — Text representing the spoken words within this time range.

## Other responses

- `400` — The request has failed.
- `404` — The specified resource does not exist.

---

[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/a332164b8c23/schema)