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

async_request_ongoing

iduuidrequired

The id of the asynchronous request.

Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6

client_request_idcopilot_client_request_id (string)

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.

Possible values: <= 128 characters

statusasync_request_status (string)required

Possible values: [ongoing, failed, succeeded]

async_request_failed

iduuidrequired

The id of the asynchronous request.

Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6

client_request_idcopilot_client_request_id (string)

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.

Possible values: <= 128 characters

statusasync_request_status (string)required

Possible values: [ongoing, failed, succeeded]

payload

object

required

error_codeintegerrequired

Example: 422

error_messagestring

Example: We can't generate the note when the transcript is too short.

async_transcription_succeeded

iduuidrequired

The id of the asynchronous request.

Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6

client_request_idcopilot_client_request_id (string)

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.

Possible values: <= 128 characters

statusasync_request_status (string)required

Possible values: [ongoing, failed, succeeded]

payload

object

The generated transcript.

transcript

object[]

required

Array [

textstringrequired

The transcribed text.

Example: Also, I’m allergic to peanuts.

speakercopilot_speaker (string)required

Who said the text in this transcript item.

Possible values: [doctor, patient, unspecified]

Example: doctor

start_offset_msintegerrequired

Start time of this transcription item as the offset, in milliseconds, from the start of the audio file.

Example: 65100

end_offset_msintegerrequired

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: 69300

]

Example (from schema)

{}