Skip to main content
GET
Get a segment
When to use: before updateSegment, to get the current ETag. Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Paid text: on a project created through v3, 409 dub_payment_required until a dub of that project is charged. Required scopes: transcripts:read Errors: transcript_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

transcripts:read

Path Parameters

project_id
string
required

Project id (from createProject or listProjects).

Maximum string length: 64
segment_id
string
required

Segment id of the live transcript.

Maximum string length: 64

Query Parameters

include
enum<string>[]

Optional fields to fill: words, variants (comma-separated).

Maximum array length: 2

Optional segment fields.

  • words: word timings
  • variants: translation variants
Available options:
words,
variants

Response

OK: Segment.

A transcript segment.

object
enum<string>
required

Always segment.

Available options:
segment
id
string
required

Segment id (re-minted by restore).

project_id
string
required

Project.

start_seconds
number<double>
required

Start (millisecond precision).

end_seconds
number<double>
required

End (millisecond precision).

speaker_id
string | null
required

Speaker (SPEAKER_NN).

speaker_label
string | null
required

Display name of the speaker ("Speaker N" for SPEAKER_{N-1}); null without a speaker.

source
object
required

Text of one side of a segment.

translation
object
required

Text of one side of a segment.

words
object | null
required

With include=words; otherwise null.

needs_attention
boolean
required

User review flag.

status
enum<string>
required

Segment processing status.

  • ready: editable
  • translating: a translation is running
  • voicing: a segment generation is voicing it
  • translation_failed: the last translation failed
Available options:
ready,
translating,
voicing,
translation_failed
dub_state
enum<string>
required

Dub state of a segment.

  • not_dubbed: the project has no dub of this segment
  • current: the dub matches the segment
  • outdated: the next changed_segments dub includes it: voiced, or merged from its current clip
Available options:
not_dubbed,
current,
outdated
audio
object | null
required

Latest clip of the current translation (segment generation or dub), overwritten by each new take; null without the plan feature audio_download. A stable take is a SegmentClip in the job result.

selected_variant_id
string | null
required

Variant whose text equals the translation.

translation_variants
object[] | null
required

With include=variants; otherwise null.

processing_started_at
string<date-time> | null
required

When the running translation or segment generation started.

etag
string
required

Opaque hash of the editable content (times, speaker, texts, review flag, selected variant, audio marker); send it in If-Match on segment edits (mergeSegments: in segments[].etag).