DELETE
/ratchet/tasks/{name}
const url = 'http://localhost:8000/ratchet/tasks/example';const options = {method: 'DELETE'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url http://localhost:8000/ratchet/tasks/exampleRemove an API task or an auto task (from a response_format schema, or a system prompt with RATCHET_AUTO_TASK=system_prompt), which frees its place under RATCHET_MAX_AUTO_TASKS. Its stored examples stay, for provenance; requests that name it then get the unknown-task policy (RATCHET_UNKNOWN_TASKS), and a request with its schema or system prompt makes it again while there is room.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
Name
string
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”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>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}