Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
embed > v2

Create sync embeddings

This endpoint synchronously creates embeddings for multimodal content and returns the results immediately in the response.

When to use this endpoint:

  • Create embeddings for text, images, audio, or video content
  • Retrieve immediate results without waiting for background processing
  • Process audio or video content up to 10 minutes in duration

Do not use this endpoint for:

  • Audio or video content longer than 10 minutes. Use the POST method of the /embed-v2/tasks endpoint instead.
<Accordion title="Input requirements"> **Text**: - Maximum length: 500 tokens

Images:

  • Formats: JPEG, PNG
  • Minimum size: 128x128 pixels
  • Maximum file size: 32 MB

Audio and video:

  • Maximum duration: 10 minutes
  • Maximum file size for base64 encoded strings: 36 MB
  • Audio formats: WAV (uncompressed), MP3 (lossy), FLAC (lossless)
  • Video formats: FFmpeg supported formats
  • Video resolution: 360x360 to 5184x2160 pixels
  • Aspect ratio: Between 1:1 and 1:2.4, or between 2.4:1 and 1:1 </Accordion>
<Note title="Note"> This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page. </Note>
post/embed-v2

Headers

x-api-keystring required

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 body

input_type'text' | 'image' | 'text_image' | 'audio' | 'video' | 'multi_input' required

The type of content for the embeddings.

Values:

  • audio: Creates embeddings for an audio file
  • video: Creates embeddings for a video file
  • image: Creates embeddings for an image file
  • text: Creates embeddings for text input
  • text_image: Creates embeddings for text and an image
  • multi_input: Creates a single embedding from up to 10 images. You can optionally include text to provide context. To reference specific images in your text, use placeholders in the following format: <@name>, where name matches the name field of a media source
model_name'marengo3.0' required

The video understanding model to use. Value: "marengo3.0".

Response

Successful request; normal operation