| Access token |
A short-lived bearer token obtained via the OAuth2 client credentials flow. Used for client-side applications to avoid exposing the API key directly. |
| API key |
A secret token used to authenticate requests to the Reson8 API. Scoped to a single client. |
| Confidence score |
The model's natural log-probability for a recognized word — always ≤ 0; values closer to 0 mean higher confidence. To convert to a probability in (0, 1], apply exp(confidence) (e.g. -0.05 → 0.95). Available when include_confidence is enabled. |
| Final result |
A stable transcription that will not change as more audio is received. Indicated by is_final: true. |
| Flush |
A request to force the server to finalize any buffered audio and return a transcript immediately. The server responds with a flush confirmation. |
| Interim result |
A partial transcription that may be revised as more audio is processed. Useful for live feedback during streaming. |
| Phrase boosting |
A technique to boost recognition of specific terms. |
| PCM |
Pulse-code modulation — a raw, uncompressed audio encoding. The pcm_s16le format (16-bit signed, little-endian) is supported when encoding is set explicitly. |
| Session |
An active WebSocket connection during which audio is streamed and transcriptions are returned. |