Release notes

New embedding retrieval options

The Embed API now provides more control over the types of embeddings you retrieve. This is a breaking change that requires updating your code and affects the following endpoints:

• /indexes/:index-id/videos/:video-id: The embed parameter has been deprecated and replaced with the new embedding_option parameter, allowing you to retrieve specific types of embeddings. For details, see the Retrieve video information page.
• /embed/tasks/:task_id: You can now use the optional embedding_option parameter to specify which types of embeddings to retrieve. For details, see the Retrieve video embeddings page.

In the responses from both endpoints, each segment now includes a new field named embedding_option located at video_embedding.segments[].embedding_option, which identifies the type of embedding as either “visual-text” or “audio.”