assets

Retrieve the transcription of an asset

Changed on

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.

get/assets/{asset_id}/transcription

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/assets/{asset_id}/transcription
  • Auth: API key in header x-api-key

Path parameters

asset_idstring required

The unique identifier of the asset.

Query parameters

includeAssetsAssetIdTranscriptionGetParametersIncludeSchemaItems[]

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.

Response

The transcription status and the requested transcriptions have been successfully retrieved.

status'pending' | 'processing' | 'ready' | 'failed' required

Indicates the current status of the transcription.

Values:

  • pending: The platform has not started transcribing the asset.
  • processing: The platform is transcribing the asset.
  • ready: The transcription is available.
  • failed: The platform could not transcribe the asset. The error field describes the reason.

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id retrieve-transcription removed and replaced with assets_retrieve_transcription