Retrieve video embeddings

curl https://api.twelvelabs.io/v1.3/embed/tasks/663da73b31cdd0c1f638a8e6 \
     -H "x-api-key: <apiKey>"

{
  "_id": "663e16ac4d11aff765088b3a",
  "created_at": "2024-03-01T00:00:00Z",
  "model_name": "marengo3.0",
  "status": "ready",
  "video_embedding": {
    "metadata": {
      "duration": 18,
      "input_filename": "01.mp4",
      "video_clip_length": 6,
      "video_embedding_scope": [
        "clip",
        "video"
      ]
    },
    "segments": [
      {
        "embedding_option": "visual",
        "embedding_scope": "clip",
        "end_offset_sec": 6,
        "float": [
          -0.060086973,
          0.016479108
        ],
        "start_offset_sec": 0
      },
      {
        "embedding_option": "visual",
        "embedding_scope": "clip",
        "end_offset_sec": 12,
        "float": [
          -0.056660935,
          0.012404642
        ],
        "start_offset_sec": 6
      },
      {
        "embedding_option": "visual",
        "embedding_scope": "video",
        "end_offset_sec": 12,
        "float": [
          -0.05971131,
          -0.00859428
        ],
        "start_offset_sec": 0
      },
      {
        "embedding_option": "audio",
        "embedding_scope": "clip",
        "end_offset_sec": 6,
        "float": [
          -0.060086973,
          0.016479108
        ],
        "start_offset_sec": 0
      },
      {
        "embedding_option": "audio",
        "embedding_scope": "clip",
        "end_offset_sec": 12,
        "float": [
          -0.056660935,
          0.012404642
        ],
        "start_offset_sec": 6
      },
      {
        "embedding_option": "audio",
        "embedding_scope": "clip",
        "end_offset_sec": 18,
        "float": [
          -0.05971131,
          -0.00859428
        ],
        "start_offset_sec": 12
      },
      {
        "embedding_option": "audio",
        "embedding_scope": "video",
        "end_offset_sec": 12,
        "float": [
          -0.05971131,
          -0.00859428
        ],
        "start_offset_sec": 0
      }
    ]
  }
}

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

Authentication

x-api-keystring

Your API key.

Note

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

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

Path parameters

task_idstringRequired

The unique identifier of your video embedding task.

Query parameters

embedding_optionlist of enumsOptional

Specifies which types of embeddings to retrieve. Values: visual, audio, transcription. For details, see the Embedding options section.

Note

The platform returns all available embeddings when you omit this parameter.

Specifies which types of embeddings to retrieve. Values: `visual`, `audio`, `transcription`. For details, see the [Embedding options](/v1.3/docs/concepts/modalities#embedding-options) section. <Note title="Note"> The platform returns all available embeddings when you omit this parameter. </Note>

Allowed values:

Response

Video embeddings have successfully been retrieved.

_idstring

The unique identifier of the video embedding task.

created_atstringformat: "date-time"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was created.

model_namestring

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

statusstring

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

updated_atstringformat: "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_embeddingobject

Errors

400

Bad Request Error