Skip to main content
GET
Download a transcription
Returns the result as a file using MyVocal fields and formatting. Downloads use the original transcription result; later edits in the workspace do not overwrite this API result.

Path

string
required
The task to download.

Query

string
default:"txt"
txt, json, srt, segmented_json, html, docx or pdf; txt when omitted. The live list is returned by capabilities as downloadFormats. Any listed format can be downloaded whether or not it was named in exportFormats; the exportOptions entry submitted for that format applies.
string
required
API key for authentication.

Response

The file bytes with Content-Disposition: attachment and Cache-Control: no-store. txt is one block per segment: a header with the time range (timed segments only) and the speaker label, then the text; includeTimestamps: false / includeSpeakers: false remove those header parts. json is the bare transcription view (no code/message/data envelope); srt contains timed segments only, so an untimed result gives an empty file. The other formats are the rendered exports. Reading or re-downloading is free.
Only COMPLETED tasks can be downloaded; any other status, including the terminal PARTIAL, returns RESULT_NOT_READY. Read a PARTIAL task’s confirmed text from Get a transcription. An unsupported format returns EXPORT_FORMAT_UNAVAILABLE. Ownership is re-checked on every request.