Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string
required

Public http(s) URL of the audio file for transcription. File upload is not supported.

Minimum string length: 1
Pattern: ^https?://
​
language
enum<string>

Language code for Inverse Text Normalization when format=true. Required when format is true.

Available options:
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
​
format
boolean
default:false

When true, enables Inverse Text Normalization (e.g. spoken numbers to written form). Requires language.

​
multichannel
boolean
default:false

When true, transcribes each audio channel independently.

​
channels
integer

Number of channels for multichannel raw audio (2–8). Container formats are usually auto-detected.

Required range: 2 <= x <= 8
​
diarize
boolean
default:false

When true, enables speaker diarization; words include speaker ids.

​
keyterm
string[]

Key terms to bias transcription toward (product names, proper nouns). Max 100 terms, each up to 50 characters.

Maximum array length: 100
Maximum string length: 50
​
filler_words
boolean
default:false

When true, keep filler words (uh/um/er) in the transcript.

​
audio_format
enum<string>

Format hint for raw/headerless audio only. Do not set for MP3/WAV/etc. Requires sample_rate when set.

Available options:
pcm,
mulaw,
alaw
​
sample_rate
enum<integer>

Sample rate in Hz for raw audio. Required when audio_format is set.

Available options:
8000,
16000,
22050,
24000,
44100,
48000

Response

Task submitted successfully. Poll GET /api/v1/tasks/{task_id} until the task completes; the transcription result is returned on the task result.

Response object for asynchronous task submission.

​
code
integer
required

Response code, 0 indicates success

Example:

0

​
message
string
required

Response message

Example:

"success"

​
data
object
required

Task submission details. Poll GET /api/v1/tasks/{task_id} until status is success; the transcription appears in result.resources. See Common API: Query Task Result.