Skip to content

Delete Task

DELETE
/ratchet/tasks/{name}
curl --request DELETE \
--url http://localhost:8000/ratchet/tasks/example

Remove an API task or an auto task. Its stored examples stay, for provenance; requests that name it then get the unknown-task policy (RATCHET_UNKNOWN_TASKS), and a request with a response_format schema registers its auto task again, from that request’s schema (ADR 0042).

name
required
Name
string
x-api-key
Any of:
string

Successful Response

Media typeapplication/json
Response Delete Task Ratchet Tasks Name Delete
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"
}
]
}