Skip to main content
GET
Render a project's subtitles
cue=segment (default) writes one cue per segment, as the web downloads do; cue=line splits long segments into lines, as the dubbed_subtitles snapshot does. Nothing is stored; only untranslated target cues and segments with unusable times (skipped_segment_ids) are skipped. When to use: to get subtitles that match the current transcript (the dubbed_subtitles output is a snapshot of the last dub). Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Plan: subtitle_download. Paid text: on a project created through v3, 409 dub_payment_required until a dub of that project is charged. Required scopes: projects:read Errors: feature_not_in_plan (403), project_not_ready (409), dub_payment_required (409)

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

projects:read

Path Parameters

project_id
string
required

Project id (from createProject or listProjects).

Maximum string length: 64

Query Parameters

language
enum<string>
default:target

Source or target text. Subtitle side.

  • source: the source language
  • target: the target language
Available options:
source,
target
format
enum<string>
default:srt

File format. Subtitle format.

  • srt: SubRip
  • vtt: WebVTT
Available options:
srt,
vtt
speaker_labels
boolean
default:false

Prefix cues with [SPEAKER_NN]:.

cue
enum<string>
default:segment

How cues are cut. How cues are cut.

  • segment: one cue per segment, text as stored
  • line: long segments split into timed lines, as in the dubbed_subtitles snapshot
Available options:
segment,
line

Response

OK: SubtitleFile.

Subtitles rendered from the current transcript. Nothing is stored.

object
enum<string>
required

Always subtitle_file.

Available options:
subtitle_file
language
string
required

Language code.

language_role
enum<string>
required

Subtitle side.

  • source: the source language
  • target: the target language
Available options:
source,
target
format
enum<string>
required

Subtitle format.

  • srt: SubRip
  • vtt: WebVTT
Available options:
srt,
vtt
speaker_labels
boolean
required

Cues are prefixed with [SPEAKER_NN]:.

cue
enum<string>
required

How cues are cut.

  • segment: one cue per segment, text as stored
  • line: long segments split into timed lines, as in the dubbed_subtitles snapshot
Available options:
segment,
line
cue_count
integer<int32>
required

Number of cues.

skipped_segment_ids
string[]
required

Segments dropped because their times are unusable; empty once the timing repair has run.

content
string
required

The rendered file (<= 2 MB).

generated_at
string<date-time>
required

Render time.