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 (max 25 MB).

Minimum string length: 1
Pattern: ^https?://
language
string

ISO-639-1 language hint for transcription.

prompt
string

Optional text to guide the model's style or continue a previous segment.

temperature
number
default:0

Sampling temperature; higher values increase randomness.

Required range: 0 <= x <= 1
response_format
enum<string>
default:verbose_json

Output format. verbose_json recommended for duration and timestamps.

Available options:
json,
text,
srt,
verbose_json,
vtt
timestamp_granularities
enum<string>[]

Timestamp detail levels. Requires response_format=verbose_json when non-empty.

Available options:
word,
segment

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.