> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trieve.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# OpenAI compatible embeddings route
> OpenAI compatible route. Returns a 424 status code if the model is not an embedding model.
Generating an embedding from a dense embedding model
```json Raw JSON theme={null}
{
"encoding_format": "float",
"input": "string",
"model": "null",
"user": "null"
}
```
```sh curl theme={null}
curl -X POST \
-H "Content-Type: application/json"\
-d '{"input": "test input"}' \
--url http://$ENDPOINT/v1/embeddings
```
```py python theme={null}
import requests
endpoint = ""
requests.post(f"{endpoint}/v1/embeddings", json={
"input": ["test input", "test input 2"]
});
## or
requests.post(f"{endpoint}/v1/embeddings", json={
"input": "test single input"
});
```
```json 200 Embeddings theme={null}
{
"data": [
{
"embedding": [
0.038483415,
-0.00076982786,
-0.020039458
...
],
"index": 0,
"object": "embedding"
},
{
"embedding": [
0.038483415,
-0.00076982786,
-0.020039458
...
],
"index": 1,
"object": "embedding"
},
...
],
"model": "thenlper/gte-base",
"object": "list",
"usage": {
"prompt_tokens": 512,
"total_tokens": 512
}
}
```
```json 413 theme={null}
{
"error": "Batch size error",
"error_type": "validation"
}
```
```json 422 theme={null}
{
"error": "Tokenization error",
"error_type": "validation"
}
```
```json 424 theme={null}
{
"error": "Inference failed",
"error_type": "backend"
}
```
```json 429 theme={null}
{
"error": "Model is overloaded",
"error_type": "overloaded"
}
```
Inputs that need to be embedded
The name of the prompt that should be used by for encoding. If not set, no prompt will be applied.
Must be a key in the `sentence-transformers` configuration prompts dictionary.
For example if `prompt_name` is **"doc"** then the sentence **"How to get fast inference?"** will be encoded as **"doc: How to get fast inference?"** because the prompt text will be prepended before any text to encode.
Automatically truncate inputs that are longer than the maximum supported size