Transcription

Transcribe a recording

Changed on

Requires run. Turns a short voice recording into text, as the app's dictation does. Send the audio itself as the request body with its type in Content-Type (audio/wav, audio/webm, audio/ogg, audio/mpeg, audio/mp4, audio/aac or audio/flac), at most 10 MiB. Optional language (a BCP 47 tag, or multi) sets the spoken language. Returns the transcript, the recognizer's confidence and each word's timing. Charged to the workspace's credits per second of audio; a workspace that cannot pay is refused with 402 before the audio is heard. Requests are rate-limited per person (429 with Retry-After).

<sub>Scope: run</sub>

post/v3/organizations/{orgId}/transcribe

Request

  • Base URL
    https://api.reasonmachines.com
  • URL
    https://api.reasonmachines.com/v3/organizations/{orgId}/transcribe
  • Auth
    HTTP bearer

Query parameters

languagestring

Spoken language as a BCP 47 tag such as en or en-US, or multi to detect it.

Request body audio/wav

string binary required

Response

The transcript.

transcriptstring required

What was said; empty when nothing was recognized.

confidencenumber nullable

The recognizer's confidence from 0 to 1.

Changes