API ReferenceCreate embeddings v2

Create an async embedding task

This endpoint creates embeddings for audio and video content asynchronously. <Note title="Note"> This method only supports Marengo version 3.0 or newer. </Note> **When to use this endpoint**: - Process audio or video files longer than 10 minutes - Process files up to 4 hours in duration <Accordion title="Input requirements"> **Video**: - Minimum duration: 4 seconds - Maximum duration: 4 hours - Maximum file size: 4 GB - Formats: [FFmpeg supported formats](https://ffmpeg.org/ffmpeg-formats.html) - Resolution: 360x360 to 5184x2160 pixels - Aspect ratio: Between 1:1 and 1:2.4, or between 2.4:1 and 1:1 **Audio**: - Minimum duration: 4 seconds - Maximum duration: 4 hours - Maximum file size: 2 GB - Formats: WAV (uncompressed), MP3 (lossy), FLAC (lossless) </Accordion> Creating embeddings asynchronously requires three steps: 1. Create a task using this endpoint. The platform returns a task ID. 2. Poll for the status of the task using the [`GET`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings) method of the `/embed-v2/tasks/{task_id}` endpoint. Wait until the status is `ready`. 3. Retrieve the embeddings from the response when the status is `ready` using the [`GET`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings) method of the `/embed-v2/tasks/{task_id}` endpoint. <Note title="Note"> This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page. </Note>

Authentication

x-api-keystring
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>

Request

This endpoint expects an object.
input_typeenumRequired
The type of content for the embeddings. **Values**: - `audio`: Audio files - `video`: Video content
Allowed values:
model_nameenumRequiredDefaults to marengo3.0

The model you wish to use. Only "marengo3.0" is supported.

Allowed values:
audioobjectOptional

This field is required if input_type is audio.

videoobjectOptional

Required if the input_type parameter is video.

Response

An embedding task has successfully been created.
_idstring
The unique identifier of the embedding task
statusenum
The initial status of the embedding task.
Allowed values:
datalist of objects or null

An array of embedding results when status is ready, or null when status is processing or failed.

Errors