| url |
Public http(s) URL of the audio file for transcription. File upload is not supported. |
string |
Yes |
- |
| keyterm |
Key terms to bias transcription toward (product names, proper nouns). Max 100 terms, each up to 50 characters. |
string[] |
No |
- |
| audio_format |
Format hint for raw/headerless audio only. Do not set for MP3/WAV/etc. Requires sample_rate when set. |
string |
No |
pcm, mulaw, alaw |
| channels |
Number of channels for multichannel raw audio (2–8). Container formats are usually auto-detected. |
integer |
No |
- |
| diarize |
When true, enables speaker diarization; words include speaker ids. |
boolean |
No |
true, false |
| filler_words |
When true, keep filler words (uh/um/er) in the transcript. |
boolean |
No |
true, false |
| format |
When true, enables Inverse Text Normalization (e.g. spoken numbers to written form). Requires language. |
boolean |
No |
true, false |
| language |
Language code for Inverse Text Normalization when format=true. Required when format is true. |
string |
No |
ar, cs, da, nl, en, fil, fr, de, hi, id, it, ja, ko, mk, ms, fa, pl, pt, ro, ru, es, sv, th, tr, vi |
| multichannel |
When true, transcribes each audio channel independently. |
boolean |
No |
true, false |
| sample_rate |
Sample rate in Hz for raw audio. Required when audio_format is set. |
integer |
No |
8000, 16000, 22050, 24000, 44100, 48000 |
