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
audio
string
required

Public HTTPS URL of the audio file. Maximum duration 15 minutes; maximum size 300 MB. Common formats include WAV, MP3, and FLAC.

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

Optional language hints. Omit for automatic detection. Simplified Chinese is cmn-Hans-CN.

Available options:
af-ZA,
am-ET,
ar-EG,
hy-AM,
as-IN,
az-AZ,
be-BY,
bn-BD,
bn-IN,
bs-BA,
bg-BG,
rup-BG,
my-MM,
yue-Hant-HK,
ca-ES,
ceb,
km-KH,
hr-HR,
cs-CZ,
da-DK,
nl-NL,
en-AU,
en-GB,
en-IN,
en-US,
et-EE,
fa-IR,
fil-PH,
fi-FI,
fr-FR,
fr-CA,
gl-ES,
ka-GE,
de-DE,
el-GR,
gu-IN,
ha-NG,
he-IL,
hi-IN,
hu-HU,
is-IS,
id-ID,
it-IT,
ja-JP,
jv-ID,
kea-CV,
kn-IN,
kk-KZ,
ko-KR,
ky-KG,
lv-LV,
ln-CD,
lt-LT,
mk-MK,
ms-MY,
ml-IN,
mt-MT,
cmn-Hans-CN,
mr-IN,
mn-MN,
ne-NP,
nb-NO,
or-IN,
pl-PL,
pt-BR,
pt-PT,
pa-IN,
pa-Guru-IN,
ro-RO,
ru-RU,
sr-RS,
sd-Arab-IN,
sk-SK,
sl-SI,
es-419,
es-ES,
es-US,
sw-KE,
sv-SE,
tg-TJ,
te-IN,
th-TH,
tr-TR,
uk-UA,
uz-UZ,
vi-VN
custom_vocabulary
string[]

Optional terms that bias recognition, such as brand names and proper nouns. Up to 1000 items. Works best when language_codes is also set.

Maximum array length: 1000
Minimum string length: 1
diarization
boolean

When true, label speakers (up to 8). Cannot be combined with mode=smart. Attribution for three or more speakers is experimental.

word_timestamp
boolean

When true, include word-level timestamps. Cannot be combined with mode=smart.

mode
enum<string>
default:verbatim

verbatim keeps speech as spoken, including filler words. smart applies dictation-style formatting such as punctuation and numbers. smart cannot be used with word_timestamp or diarization.

Available options:
verbatim,
smart

Response

Task submitted successfully. Poll GET /api/v1/tasks/{task_id} until the task completes; the transcription appears in result.resources. See Common API: Query Task Result and STT Result Schema.

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 and STT Result Schema.