Sign in
Usage > V1 > OpenAI-compatible

Create embeddings (deprecated)

Deprecated route: please use the new full OpenAI-compliant route POST /2/ai/{product_id}/openai/v1/embeddings <br><br> Some models are in beta and may being subject to changes, use GET /1/ai/models to check what model are in beta and see our General Terms and Conditions.

post/1/ai/{product_id}/openai/v1/embeddings

Path parameters

product_idinteger required

AI Tools product identifier: use GET /1/ai to retrieve your product identifier.

Request body

encoding_format'base64' | 'float' nullable

The encoding format of the returned embeddings. Defaults to float.

inputstring required

Input text to embed. Is can be string, array of string, array of int (for tokenize sentence), array of array of int (batch of tokenize sentence)

mode'index' | 'query' nullable

Specify the mode of the embedding request.

modelstring required

Model name to use

task_descriptionstring nullable

Optional set your custom task information in query mode

Example request

{
  "model": "bge_multilingual_gemma2"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.