Overview

Ratchet gateway 0.4.0

The HTTP API of the Ratchet gateway (ratchet.gateway:app), generated from the code with python docs-site/scripts/export-reference.py. The chat route speaks OpenAI’s format, so any OpenAI SDK works. Examples, error envelopes and access levels are in the hand-written API guide. Mock-only demo controls answer 404 in live mode, and in live mode most /ratchet/* routes need an admin or dashboard key unless the dashboard is public.

Information

• License: Apache-2.0
• OpenAPI version: 3.1.0

Operations

GET

/v1/models

POST

/v1/chat/completions

POST

/v1/ratchet/feedback

POST

/v1/ratchet/no-train

DELETE

/v1/ratchet/no-train

DELETE

/v1/ratchet/examples

GET

/v1/ratchet/requests/{request_id}

GET

/healthz

GET

/livez

GET

/readyz

GET

/metrics

GET

/ratchet/stats

GET

/ratchet/requests/{request_id}

GET

/ratchet/bom

POST

/ratchet/redact

GET

/ratchet/bom/public-key

GET

/ratchet/versions/{vid}/bom

GET

/ratchet/versions/{vid}/certificate

POST

/ratchet/versions/{vid}/proof

GET

/ratchet/versions/{vid}/heldout

GET

/ratchet/cost

POST

/ratchet/cost/endpoint

GET

/ratchet/replay

GET

/ratchet/replay/frontier

GET

/ratchet/receipts

GET

/ratchet/receipts/{period}

GET

/ratchet/receipts/{period}/proof/{request_id}

GET

/ratchet/receipts/{period}/leaves

GET

/ratchet/tasks

GET

/ratchet/tasks/{name}

PUT

/ratchet/tasks/{name}

DELETE

/ratchet/tasks/{name}

POST

/ratchet/tasks/validate

POST

/ratchet/admin/privacy/erase

GET

/ratchet/admin/export/{kind}

GET

/ratchet/admin/versions

GET

/ratchet/admin/flags

POST

/ratchet/admin/versions/{vid}/rollback

POST

/ratchet/admin/versions/{vid}/retire

POST

/ratchet/admin/versions/{vid}/promote

POST

/ratchet/admin/student/disable

POST

/ratchet/admin/student/enable

POST

/ratchet/admin/releases/freeze

POST

/ratchet/admin/releases/unfreeze

POST

/ratchet/admin/training/pause

POST

/ratchet/admin/training/resume

PUT

/ratchet/admin/settings

POST

/ratchet/admin/tasks/{name}/pin

DELETE

/ratchet/admin/tasks/{name}/pin

POST

/ratchet/admin/tick

GET

/ratchet/admin/audit-log

POST

/ratchet/demo/day

POST

/ratchet/demo/break-next

POST

/ratchet/demo/student-outage

GET

/ratchet/demo/sample-example

POST

/ratchet/demo/reset

GET

/scout/examples

GET

/scout/status

POST

/scout/judge

DELETE

/scout/judge

GET

/scout/stream

POST

/scout/run

GET

/

GET

/dashboard

GET

/scout

GET

/lite

GET

/lite/dashboard

GET

/lite/scout