Get Transcription
AI-generatedSummary
Retrieve details and status for a specific transcription using either a Request ID or a Transcription ID.
Inputs
- lookupBy — Choose whether to locate the transcription by 'requestId' (default) or by 'id' (transcription document ID).
- requestId (required) — The unique request ID generated when submitting a video for transcription. Required when 'Lookup By' is set to Request ID.
- transcriptionId (required) — The Convex document ID of the transcription. Required when 'Lookup By' is set to Transcription ID.
- errorHandling — Optional settings for retry attempts, initial delay, and handling of Retry-After headers on transient API errors.
Output shape
a single record
Returns a JSON object from the
/v1/transcriptionsendpoint containing transcription status, metadata, and generated text if completed.
Examples
Example 1: Fetch transcription status using a Request ID
Set 'Lookup By' to 'Request ID' and provide the 'Request ID' string returned from a previous transcribe operation.
Example 2: Fetch a transcription directly by its Convex ID
Set 'Lookup By' to 'Transcription ID' and provide the target 'Transcription ID'.