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. Supported formats: WAV, MP3, FLAC (up to 300 MB).

Minimum string length: 1
Pattern: ^https?://
locales
enum<string>[]

Optional language codes to force recognition. Omit for multi-lingual auto mode.

Maximum array length: 10
Available options:
ar,
as,
bg,
bn,
ca,
cs,
da,
de,
el,
en,
es,
et,
fi,
fr,
gu,
hi,
hu,
id,
it,
ja,
kn,
ko,
lt,
ml,
mr,
nb,
nl,
or,
pa,
pl,
pt,
ro,
ru,
sk,
sl,
sv,
ta,
te,
th,
tr,
uk,
vi,
zh
phrase_list
string[]

Domain phrases for entity biasing (product names, proper nouns).

Maximum array length: 100
Required string length: 1 - 100

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.