Skip to content

Docs Guides API GitHub Live site

Start here

What is Ratchet Why it matters The business case Text-to-SQL adapter Results Quickstart For judges

How it works

The big picture One request's journey Confidence Escalation and audits The ledger Night School The release gate Training on your data Licenses Cost and savings Evidence you can check Proof you can run

Scout

Scout guide Scout reference

Run it

Host on Nebius Deployment Demo VM on Nebius Runbook

Security

Security and safety Threat model

API & reference

HTTP API (generated)

OpenAI-compatible

Overview /v1/modelsGET /v1/models/{model_id}GET /v1/chat/completionsPOST /openai/deployments/{deployment}/chat/completionsPOST /v1/embeddingsPOST /v1/completionsPOST /v1/responsesPOST /v1/moderationsPOST /v1/responses/{response_id}GET /v1/responses/{response_id}POST /v1/responses/{response_id}DELETE

End users and feedback

Overview /v1/ratchet/feedbackPOST /v1/ratchet/no-trainPOST /v1/ratchet/no-trainDELETE /v1/ratchet/examplesDELETE /v1/ratchet/requests/{request_id}GET

Health and metrics

Overview /healthzGET /livezGET /readyzGET /metricsGET

Stats and provenance

Overview /ratchet/statsGET /ratchet/requests/{request_id}GET /ratchet/kpisGET /ratchet/driftGET /ratchet/bomGET /ratchet/redactPOST /ratchet/bom/public-keyGET /ratchet/teacherGET /ratchet/teacher/ackPOST

Versions and evidence

Overview /ratchet/versions/{vid}/bomGET /ratchet/versions/{vid}/certificateGET /ratchet/versions/{vid}/proofPOST /ratchet/versions/{vid}/heldoutGET

Cost

Overview /ratchet/costGET /ratchet/cost/endpointPOST

Ledger replay

Overview /ratchet/replayGET /ratchet/replay/frontierGET

Savings receipts

Overview /ratchet/receiptsGET /ratchet/receipts/{period}GET /ratchet/receipts/{period}/proof/{request_id}GET /ratchet/receipts/{period}/leavesGET

Tasks

Overview /ratchet/tasksGET /ratchet/tasks/{name}GET /ratchet/tasks/{name}PUT /ratchet/tasks/{name}DELETE /ratchet/tasks/validatePOST

Admin

Overview /ratchet/admin/privacy/erasePOST /ratchet/admin/export/{kind}GET /ratchet/admin/versionsGET /ratchet/admin/flagsGET /ratchet/admin/versions/{vid}/rollbackPOST /ratchet/admin/versions/{vid}/retirePOST /ratchet/admin/versions/{vid}/promotePOST /ratchet/admin/student/disablePOST /ratchet/admin/student/enablePOST /ratchet/admin/releases/freezePOST /ratchet/admin/releases/unfreezePOST /ratchet/admin/training/pausePOST /ratchet/admin/training/resumePOST /ratchet/admin/settingsPUT /ratchet/admin/tasks/{name}/pinPOST /ratchet/admin/tasks/{name}/pinDELETE /ratchet/admin/tickPOST /ratchet/admin/audit-logGET

Demo controls (mock only)

Overview /ratchet/demo/dayPOST /ratchet/demo/break-nextPOST /ratchet/demo/student-outagePOST /ratchet/demo/sample-exampleGET /ratchet/demo/teacher-driftPOST /ratchet/demo/resetPOST

Scout

Overview /scout/examplesGET /scout/recordedGET /scout/recorded/{rid}GET /scout/statusGET /scout/judgePOST /scout/judgeDELETE /scout/streamGET /scout/runPOST

Pages

Overview /GET /dashboardGET /scoutGET /liteGET /lite/dashboardGET /lite/scoutGET

HTTP API guide Endpoint map Environment variables Command line Python API Architecture Testing

Help

API & reference

Overview

Ask AI

Open in ChatGPTAsk ChatGPT about this page Open in ClaudeAsk Claude about this page Open in PerplexitySearch with this page as the source

Admin

Section titled “Admin”

Operator actions with an audit trail: versions, switches, pins, erasure and export.

Operations

Section titled “Operations”

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

Was this page right?

Report a problem

Previous/ratchet/tasks/validate Next/ratchet/admin/privacy/erase

Ratchet is open source under Apache-2.0. Simulation numbers come from mock models and are labelled. Built with Starlight, the Lucode theme and React Bits components (MIT + Commons Clause).

On this page

Overview
Admin
Operations

Ratchet is open source under Apache-2.0 (GitHub). These pages are built from the repository’s docs/ folder. Simulation numbers come from mock models and are labelled. Built with Starlight, the Lucode theme and React Bits components (MIT + Commons Clause, kept in docs-site/src/components/rb/).

Docs Guides API GitHub Live site

Start here

What is Ratchet Why it matters The business case Text-to-SQL adapter Results Quickstart For judges

How it works

The big picture One request's journey Confidence Escalation and audits The ledger Night School The release gate Training on your data Licenses Cost and savings Evidence you can check Proof you can run

Scout

Scout guide Scout reference

Run it

Host on Nebius Deployment Demo VM on Nebius Runbook

Security

Security and safety Threat model

API & reference

HTTP API guide Endpoint map Environment variables Command line Python API Architecture Testing

Help