Skip to content

API & reference

Retrieve Model

GET
/v1/models/{model_id}
curl --request GET \
--url http://localhost:8000/v1/models/example

One model (_model; ratchet:<task> finds ratchet/<task>), or 404 model_not_found. The id may hold a slash: the OpenAI SDK sends ratchet/ticket-triage as ratchet%2Fticket-triage, which arrives decoded.

model_id
required
Model Id
string
x-api-key
Any of:
string
api-key
Any of:
string

Successful Response

Media typeapplication/json
Response Retrieve Model V1 Models Model Id Get
object

Example generated

{}

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"
}
]
}