API ReferenceCreate video embeddings

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.

Path parameters

task_idstringRequired

The unique identifier of your video embedding task.

Headers

x-api-keystringRequired

Response

The status of your video embedding task has been retrieved.

_idstringOptional

The unique identifier of the video embedding task.

statusstringOptional

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

model_namestringOptional

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

video_embeddingobjectOptional

An object containing the metadata associated with the embedding.

Errors