API ReferenceCreate video embeddings

Retrieve video embeddings

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 task page for instructions on checking the task status.

Important

The response includes breaking changes that might require updates to your application code. Key differences:

  • The video_embeddings field has been renamed to video_embedding (plural to singular).
  • The embedding vectors are now nested under an array named segments.
  • The metadata field is now nested under video_embedding.

Path parameters

task_idstringRequired

The unique identifier of your video embedding task.

Headers

x-api-keystringRequired

Response

Video embeddings have successfully been retrieved.

_idstringOptional

The unique identifier of the video embedding task.

created_atstringOptional

The date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the video embedding task was created.

engine_namestringOptional

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

statusstringOptional

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

video_embeddingobjectOptional

An object containing the generated embedding vectors and their metadata.

Errors