Skip to content

API & reference

Embeddings

POST
/v1/embeddings
curl --request POST \
--url http://localhost:8000/v1/embeddings \
--header 'Content-Type: application/json' \
--data '{}'

Embeddings, passed through to RATCHET_EMBEDDINGS_MODEL: no cascade, no student, nothing stored (_embed). Checks run in this order: API key (401), the endpoint on (404 unsupported_endpoint under RATCHET_EMBEDDINGS_BASE=off), the body read, JSON and validation (400), the model (404 under RATCHET_MODEL_POLICY=strict), the daily quota (429).

x-api-key
Any of:
string
api-key
Any of:
string
Media typeapplication/json
object

Example generated

{}

Successful Response

Media typeapplication/json

Example generated

example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}