Reference
API reference
Every endpoint of the Voice API.
The running service also serves interactive OpenAPI docs at /docs and the machine-readable contract at /openapi.json.
| Method | Path | Purpose |
|---|---|---|
POST | /api/v1/voice/parse | Audio → transcript → your schema, validated. ?stream=true for NDJSON progress. Optional sessionId. |
POST | /api/v1/text/parse | The same extraction and validation from text. Optional sessionId. |
GET | /api/v1/schemas | All schemas (latest version of each), built-in and saved. |
POST | /api/v1/schemas | Save a schema version. A saved version never changes (409 on conflicting content). |
POST | /api/v1/schemas/validate | Check a schema without saving it; every error with its path. |
GET | /api/v1/schemas/{name} | One definition (latest, or ?version=). |
GET | /api/v1/schemas/{name}/versions | The versions of a schema. |
DELETE | /api/v1/schemas/{name} | Delete a saved schema (one ?version=, or all). Built-ins are read-only. |
GET | /api/v1/field-types | The field types and their options. |
POST | /api/v1/sessions | Start a session; pins one schema version. |
GET | /api/v1/sessions/{id} | The session's current record and history. |
POST | /api/v1/sessions/{id}/review | Confirm, reject or set field values. |
DELETE | /api/v1/sessions/{id} | Forget a session, transcripts included. |
GET | /api/v1/locales | Supported locales. |
GET | /health | Liveness. |
GET | /ready | Readiness — speech model loaded, language model reachable. |
Deprecated
Kept so existing 1.x clients keep working unchanged:
POST | /api/v1/voice/orders/parse | 1.x. Same engine, 1.x response shape (field `kind`; statuses inferred / incomplete). Use /voice/parse. |
POST | /api/v1/text/orders/parse | 1.x text endpoint. Use /text/parse. |