Sign in
embed > v2

Create sync embeddings

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

Use this method to embed a query for retrieving matching content. With Marengo 3.5, audio and video can be up to 30 seconds. With Marengo 3.0, they can be up to 10 minutes. For longer content, use the POST method of the /embed-v2/tasks endpoint instead.

The content this method accepts depends on the model. With Marengo 3.5, this method accepts only the multi_input input type; provide text, images, audio, or video as media sources. With Marengo 3.0, use the individual input types. For the formats, resolutions, file sizes, and duration limits each model accepts, see the input requirements for Marengo 3.5 or Marengo 3.0.

<Note title="Note"> This method is rate-limited. With Marengo 3.5, the platform counts input tokens for each type of content. A request can exceed a limit before you see an error. For details, see [Input token limits for embedding](/v1.3/docs/get-started/rate-limits#input-token-limits-for-embedding). </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:

  • multi_input: Text and up to 10 media sources, combined into a single embedding. To reference a specific media source from your text, use a placeholder in the following format: <@name>, where name matches the name field of a media source. Marengo 3.5 accepts images, video, and audio as media sources. Marengo 3.0 accepts images.
  • audio: An audio file. Requires Marengo 3.0.
  • video: A video file. Requires Marengo 3.0.
  • image: An image file. Requires Marengo 3.0.
  • text: Text input. Requires Marengo 3.0.
  • text_image: Text and an image. Requires Marengo 3.0.
model_name'marengo3.0' | 'marengo3.5' required

The embedding model to use.

Values:

  • marengo3.5: For details about this version, see the Marengo 3.5 page.
  • marengo3.0: For details about this version, see the Marengo 3.0 page.
auto_truncateboolean

Controls the behavior of the platform when the text in your request exceeds 2,000 tokens. Requires Marengo 3.5.

Values:

  • false: Return a 400 error.
  • true: Truncate your text to fit the limit, and set the usage.truncated field to true in the response.
embedding_uncertaintyboolean

Set this parameter to true to receive a data[].embedding_uncertainty field in the response, representing a per-dimension uncertainty vector with the same length as the embedding array. A higher value shows lower confidence in that dimension. Requires Marengo 3.5.

Set this parameter to true only when your request embeds text only, or media only. Requests that combine text with media sources return a 400 error.

Response

The embeddings have been successfully created.

Changes