API reference
Base URL https://<host>/v1. Every endpoint below is generated from the same declarations the API and the OpenAPI document are built from.
Runs
The unit of work, the row you poll, the thing a webhook is about.
POST /v1/runs | Submit a run |
GET /v1/runs | List runs |
GET /v1/runs/{id} | One run |
DELETE /v1/runs/{id} | Delete a run and its media |
POST /v1/runs/{id}/cancel | Stop a run in flight |
GET /v1/runs/{id}/transcript | The transcript, in one format, as text |
POST /v1/runs/{id}/deliver | Send this run to a destination now |
Uploads
Bytes move directly to storage over presigned URLs; this API only registers what landed.
POST /v1/uploads | Open an upload and get a transfer target |
GET /v1/uploads/{id} | State of an upload |
POST /v1/uploads/{id}/parts | Get transfer targets, or record parts that landed |
POST /v1/uploads/{id}/complete | Finish and verify |
DELETE /v1/uploads/{id} | Abort |
Destinations
Where finished transcripts are pushed, signed.
GET /v1/destinations | List destinations |
POST /v1/destinations | Register a destination |
PATCH /v1/destinations/{id} | Update a destination |
DELETE /v1/destinations/{id} | Remove a destination |
POST /v1/destinations/{id}/test | Send a signed test delivery |
GET /v1/destinations/{id}/deliveries | What we sent and what came back |
Health
Liveness and a build marker. Writes nothing.
GET /v1/health | Liveness and a build marker |
Scopes
| Scope | Permits |
|---|---|
runs:read | GET /v1/runsGET /v1/runs/{id}GET /v1/runs/{id}/transcriptPOST /v1/runs/{id}/deliver |
runs:write | POST /v1/runsDELETE /v1/runs/{id}POST /v1/runs/{id}/cancel |
uploads:write | POST /v1/uploadsGET /v1/uploads/{id}POST /v1/uploads/{id}/partsPOST /v1/uploads/{id}/completeDELETE /v1/uploads/{id} |
destinations:read | GET /v1/destinationsGET /v1/destinations/{id}/deliveries |
destinations:write | POST /v1/runs/{id}/deliverPOST /v1/destinationsPATCH /v1/destinations/{id}DELETE /v1/destinations/{id}POST /v1/destinations/{id}/test |