Skip to content

API & reference

Response State

POST
/v1/responses/{response_id}
curl --request POST \
--url http://localhost:8000/v1/responses/example

Retrieving, deleting or cancelling a response, or listing its input items: a 404 unsupported_endpoint, because Ratchet keeps no response state (each response is built for its request and forgotten).

response_id
required
Response Id
string
x-api-key
Any of:
string
api-key
Any of:
string

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