Get an asynchronous transcription

GET 
/transcribe-async/:id

Poll the status —and results if successful— of an asynchronous transcription.

Request

Path Parameters

id uuidrequired
The id of the asynchronous request.
Example: 23A9981B-9E46-4ADB-BB0B-8E406C624540

Responses

200

The asynchronous transcription details.

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...