Skip to content

API & reference

Responses

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

The stateless subset of the Responses API: the body becomes a chat request (validate_responses_request) and runs the chat path (_serve) with the same checks, task resolution, cascade, quota and storage; the answer comes back as a response object. Ratchet keeps no response state, so what needs it (previous_response_id, conversation, background) and stream are a 400 unsupported_parameter.

x-ratchet-task
Any of:
string
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"
}
]
}