Create transcription
Create a new transcription.
Authorization
Authorization
RequiredBearer <token>In: header
Request body
application/json
Requiredmodel
RequiredstringThe model to use for the transcription.
50
audio_url
stringThe URL of the audio file to transcribe (cannot be specified if file_id is specified).
file_id
stringThe ID of the uploaded file to transcribe (cannot be specified if audio_url is specified).
language_hints
array<string>Hints for the expected languages in the audio. If language_hints
is not specified, the languages will be detected automatically.
enable_speaker_tags
booleanIdentifies different speakers in the audio and automatically adds speaker tags whenever the speaker changes.
context
stringAn extra context for the transcription. With the context you can hint how words are spelled and formatted.
webhook_url
stringThe URL to which we send webhook requests. The request will be send a transcript is completed or failed.
webhook_auth_header_name
stringThe header name to be sent with the transcript completed or failed webhook requests.
webhook_auth_header_value
stringThe header value to send back with the transcript completed or failed webhook requests for added security.
client_reference_id
stringA string provided by the client to track the uploaded file. It can be an ID, a JSON string, or any other text. This value can be used for reference in future API requests or for internal mapping within the client’s systems. The value does not have to be unique. If not provided, it will remain unspecified.
Response body
201
Created transcription.
id
RequiredstringThe unique identifier of the transcription.
"uuid"
status
RequiredstringThe status of your transcript. Possible values are queued
, processing
, completed
or error
.
created_at
RequiredstringWhen the transcription was created.
"date-time"
model
RequiredstringThe model to use for the transcription.
50
audio_url
stringThe URL of the audio file to transcribe.
file_id
stringThe ID of the uploaded file to transcribe.
filename
RequiredstringName of the file.
language_hints
array<string>Hints for the expected languages in the audio. If language_hints
is not specified, the languages will be detected automatically.
enable_speaker_tags
RequiredbooleanIdentifies different speakers in the audio and automatically adds speaker tags whenever the speaker changes.
context
stringAn extra context for the transcription. With the context you can hint how words are spelled and formatted.
audio_duration_ms
integerThe duration of the audio in milliseconds. The duration will only be available when the file is processed.
error_message
stringThe error message (e.g. audio download failed, invalid audio file).
webhook_url
stringThe URL to which we send webhook requests. The request will be send a transcript is completed or failed.
webhook_auth_header_name
stringThe header name to be sent with the transcript completed or failed webhook requests.
webhook_auth_header_value
stringThe header value to send back with the transcript completed or failed webhook requests for added security.
This value will never be returned in its original form. Instead, a masked value will be shown, such as: "webhook_auth_header_value": "******************"
webhook_status_code
integerThe status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided.
client_reference_id
stringA string provided by the client to track the uploaded file. It can be an ID, a JSON string, or any other text. This value can be used for reference in future API requests or for internal mapping within the client’s systems. The value does not have to be unique. If not provided, it will remain unspecified.
Errors
Created transcription.