Get Subtitle Result
Retrieves the transcript of a subtitle run using the provided run_id, for every language on the run.
- By default (no query params) you get the structured JSON transcript: one language returns
{ "transcript": [ {start, end, text, speaker}, ... ] }; multiple languages return an object keyed by language ID with that same shape per language. - When you pass
format_typeand/ordata_type, every language on the run is exported. One language returns{ "transcript": <presigned url | raw text> }; multiple languages return an object keyed by language ID, each value{ "transcript": <presigned url | raw text> }. Same parameter values as Get Transcription Result.
run_id returned when you created the subtitle run. The run must have finished processing and must be a subtitle project.formatting_options on Create Subtitle, every language’s segments already follow subtitle timing and length rules. The response shape stays the same; only where each segment starts and ends differs.
Choosing your output
format_type (srt/vtt/txt) and data_type (raw_data/file) use the exact same values as Get Transcription Result. For a single language only, use Get Subtitle Result for Language.
Implementation Example
Understanding the Response Structure
Default: structured transcript (no params)
Single language on the run
Multiple languages on the run
Export: file (data_type=file)
Single language
Multiple languages
transcript is a presigned URL to the rendered file. The file content matches your format_type:
TXT (format_type=txt)
SRT (format_type=srt)
VTT (format_type=vtt)
Export: raw data (data_type=raw_data)
The same rendered content is returned inline as a string (flat for one language, keyed by language ID for many):
Fetching Multiple Runs at Once
Need subtitles for several runs? Use Fetch Subtitle Run Results (POST /apis/sub-results). It accepts the same optional format_type / data_type query params.
Building a Complete Workflow
- Create Subtitle: submit your media for subtitle generation
- Get Subtitle Task Status: determine when your subtitles are ready
Authorizations
The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.
Path Parameters
The unique identifier for the run, which was generated during the subtitle creation process and returned upon task completion. The unique identifier for the run, which was generated during the creation process and returned upon task completion.
Query Parameters
Subtitle format for the transcript export: srt, vtt or txt. When omitted (and data_type is also omitted) the structured JSON transcript is returned instead of an exported file. Applies to every language on the run.
srt, vtt, txt How the exported transcript is returned once format_type/data_type is set: file returns a presigned URL, raw_data returns the raw text. Same values as the dubbing /transcript and transcription-result endpoints. In export mode the effective defaults are format_type=txt, data_type=file. Applies to every language on the run.
raw_data, file Response
Successful Response
- Single Language
- Multiple Languages
One language of a subtitle run: structured dialogue segments by default, or an exported transcript string when format_type/data_type are set.
Structured dialogue array by default; a string (presigned URL for data_type=file, or raw text for data_type=raw_data) in export mode.