Transcribe — From audio file asynchronously

POST 
/transcribe-async

Generate a transcript from an audio file. Only audio/* mime types are supported. The maximum duration is 60 minutes.

Request

application/json

Body

required

speech_locale speech_locale (string)required

Possible values: [ENGLISH_US, ENGLISH_UK, SPANISH_ES, SPANISH_MX, FRENCH_FR, ARABIC_EG, ARABIC_LB, ARABIC_MA, ARABIC_SA, ARMENIAN_AM, BENGALI_IN, CANTONESE_CN, CROATIAN_HR, FILIPINO_PH, GERMAN_DE, GREEK_GR, GUJARATI_IN, HEBREW_IL, HINDI_IN, ITALIAN_IT, JAPANESE_JP, KHMER_KH, KOREAN_KR, MANDARIN_CN, PERSIAN_IR, POLISH_PL, PORTUGUESE_PT, PUNJABI_IN, RUSSIAN_RU, SERBIAN_RS, TAMIL_IN, TELUGU_IN, THAI_TH, URDU_IN, VIETNAMESE_VN]

The spoken or written locale of the transcript, representing both the language and its specific regional variant.

file_url stringrequired

The URL of the audio file to download & transcribe.

split_by_sentence boolean

Indicates whether to segment transcription results at sentence boundaries. Default is false, meaning that a single transcript item may encompass multiple sentences, provided they are not delineated by pauses (silence) in the audio.

client_request_id copilot_client_request_id (string)

Possible values: <= 128 characters

An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.

Note: this id must be different for every request. It is recommended to use a randomly generated UUID.

Responses

200

Request received and processing started.

application/json

Schema

Schema

oneOf
ONGOING
id uuidrequired
The id of the asynchronous request.
client_request_id copilot_client_request_id (string)
Possible values: <= 128 characters
An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.
Note: this id must be different for every request. It is recommended to use a randomly generated UUID.
status async_request_status (string)required
Possible values: [ONGOING, FAILED, SUCCEEDED]
FAILED
id uuidrequired
The id of the asynchronous request.
client_request_id copilot_client_request_id (string)
Possible values: <= 128 characters
An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.
Note: this id must be different for every request. It is recommended to use a randomly generated UUID.
status async_request_status (string)required
Possible values: [ONGOING, FAILED, SUCCEEDED]
payload objectrequired
error_code integerrequired
error_message string
SUCCEEDED
id uuidrequired
The id of the asynchronous request.
client_request_id copilot_client_request_id (string)
Possible values: <= 128 characters
An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.
Note: this id must be different for every request. It is recommended to use a randomly generated UUID.
status async_request_status (string)required
Possible values: [ONGOING, FAILED, SUCCEEDED]
payload object
The generated transcript.
transcript object[]required
Transcript items from the audio file.
Array [
text stringrequired
The transcribed text.
speaker_type core_api_speaker (string)
Possible values: [DOCTOR, PATIENT, UNSPECIFIED]
Who said the text in this transcript item.
start_offset_ms integerrequired
Start time of this transcription item as the offset, in milliseconds, from the start of the audio file.
end_offset_ms integerrequired
End time of this transcription item as the offset, in milliseconds, from the start of the audio file. Equals the start_time_ms plus the duration of the related transcribed audio portion.
]

Example (from schema)

{}

Loading...