v3
latestOpenAPI 3.1.02026-07-3197486526.1 KBembed
Create embeddings for text, image, and audio
<Note title="Note"> This endpoint will be deprecated in a future version. Migrate to the [Embed API v2](/v1.3/api-reference/create-embeddings-v2) for continued support and access to new features. </Note>This method creates embeddings for text, image, and audio content.
Ensure your media files meet the following requirements:
- Audio files.
- Image files.
Parameters for embeddings:
- Common parameters:
- model_name: The video understanding model you want to use. Example: "marengo3.0".
- Text embeddings:
- text: Text for which to create an embedding.
- Image embeddings:
Provide one of the following:
- image_url: Publicly accessible URL of your image file.
- image_file: Local image file.
- Audio embeddings:
Provide one of the following:
- audio_url: Publicly accessible URL of your audio file.
- audio_file: Local audio file.
post/embed
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>Response
A text embedding has successfully been created.