Create sync embeddings
Authentication
Request
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>, wherenamematches thenamefield 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.
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.
Controls the behavior of the platform when the text in your request exceeds 2,000 tokens. Requires Marengo 3.5.
Values:
false: Return a400error.true: Truncate your text to fit the limit, and set theusage.truncatedfield totruein the response.
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.
This field is required if the input_type parameter is text.
This field is required if the input_type parameter is image.
This field is required if the input_type parameter is text_image.
This field is required if the input_type parameter is audio.
This field is required if the input_type parameter is video.
This field is required if the input_type parameter is multi_input. It combines text and up to 10 media sources into a single embedding. Provide the input_text field, the media_sources field, or both.
Marengo 3.5 accepts images, video, and audio as media sources. Marengo 3.0 accepts images.
Include text in the input_text field when you combine media sources of different types. For example, a request that combines an image and a video returns a 400 error without text. Media sources of the same type do not require text.
Response headers
The maximum number of requests you can make per rate limit window for this endpoint. For details, see the Rate limits page.
The number of input tokens remaining in the current rate limit window for the type of content named in this header. A synchronous response already counts the tokens the request used. This value can be 0 on a response that succeeded. A 202 response does not yet count the task you submitted.
The number of input tokens remaining in the current rate limit window for the type of content named in this header. A synchronous response already counts the tokens the request used. This value can be 0 on a response that succeeded. A 202 response does not yet count the task you submitted.
The number of input tokens remaining in the current rate limit window for the type of content named in this header. A synchronous response already counts the tokens the request used. This value can be 0 on a response that succeeded. A 202 response does not yet count the task you submitted.
The number of input tokens remaining in the current rate limit window for the type of content named in this header. A synchronous response already counts the tokens the request used. This value can be 0 on a response that succeeded. A 202 response does not yet count the task you submitted.
The number of input tokens remaining in the current rate limit window for the type of content named in this header. A synchronous response already counts the tokens the request used. This value can be 0 on a response that succeeded. A 202 response does not yet count the task you submitted.
Response
Metadata for the media input. Available for the image, text_image, audio, video, and multi_input input types.