Skip to content
mistral.rs

embeddings

POST
/v1/embeddings
 
curl --request POST \
  --url https://example.com/v1/embeddings \
  --header 'Content-Type: application/json' \
  --data '{ "dimensions": null, "encoding_format": "float", "input": [ "example" ], "model": "default", "truncate_sequence": null, "user": null }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
dimensions

Truncate embeddings to this dimensionality, if the model supports it.

integer | null
Example 
null
encoding_format
One of:
null
input
required
One of:

Single input string

string
model

Model ID; “default” targets the only loaded model.

string
Example 
default
truncate_sequence

Truncate inputs that exceed the model’s context length instead of erroring.

boolean | null
Example 
null
user
string | null
Example 
null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Embeddings

Media type application/json
object
data
required
Array<object>
object
embedding
required
One of:

Embedding returned as an array of floats

Array<number>
index
required
integer
object
required
string
model
required
string
object
required
string
usage
required
object
prompt_tokens
required
integer format: int32
total_tokens
required
integer format: int32
Example generated
{
  "data": [
    {
      "embedding": [
        1
      ],
      "index": 1,
      "object": "example"
    }
  ],
  "model": "example",
  "object": "example",
  "usage": {
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}