Twelve LabsInstall

Summary

Retrieve detailed information about a specific video within a given index, optionally including its transcription.

Inputs

• Index ID (required) — The identifier of the index containing the video to retrieve.
• Video ID (required) — The identifier of the video to retrieve.
• Include Transcription — Whether to include the video's transcription data in the response; defaults to false.

Output shape

a single record containing metadata about the specified video, including properties such as duration, frame rate, and resolution, and optionally transcription data.

The response structure depends on whether transcription inclusion is requested. Errors return an error object. The operation requires valid Index ID and Video ID parameters.

Examples

Example 1: Retrieve video details without transcription

Set 'Index ID' and 'Video ID' parameters to target the specific video, leave 'Include Transcription' as false or unset.

Example 2: Retrieve video details with transcription

Set 'Index ID' and 'Video ID' parameters and enable 'Include Transcription' to true to receive video metadata along with its transcription.