Skip to content

Admin Pin

POST
/ratchet/admin/tasks/{name}/pin
curl --request POST \
--url http://localhost:8000/ratchet/admin/tasks/example/pin \
--header 'Content-Type: application/json' \
--data '"example"'

Pin a registered task to the teacher at runtime (body {reason}): nothing of it is stored or trained on.

name
required
Name
string
x-api-key
Any of:
string
Media typeapplication/json
Body

Example generated

example

Successful Response

Media typeapplication/json
Response Admin Pin Ratchet Admin Tasks Name Pin Post
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"
}
]
}