Retrieve the transcription of an asset
This method retrieves the transcription of a video or audio asset. An asset that has a transcription returns 200 with the current transcription status. The endpoint returns 404 when the asset cannot be found or has no transcription.
The platform generates transcriptions asynchronously. Poll this endpoint to monitor the transcription status.
When the status is ready, the response contains the segmentations you requested that the transcription supports. A transcription does not always support every segmentation, so read the segmentations the response returns rather than assuming every requested one is present.
Path parameters
The unique identifier of the asset.
Query parameters
Specifies the transcriptions to return. Each value segments the transcription differently:
- words: One entry for each word.
- sentences: One entry for each chunk the speech recognition model detects as a sentence.
- utterances: One entry for each speaker turn.
Send repeated values, such as the ?include=words&include=utterances query string. The platform also accepts one comma-separated value, such as the ?include=words,utterances query string.
Default: words.
Headers
Your API key.
<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>Response
The transcription status and the requested transcriptions have been successfully retrieved.