Skip to main content
GET
List transcript segments
Lists segments in start-time order with texts, speaker, status (ready, translating, voicing, translation_failed), dub state (not_dubbed, current, outdated), audio link and ETag. Filters: ids, text (q), speaker, status, dub state, review flag, time window; include=words,variants adds word timings and translation variants. When to use: to read or search the transcript. If the transcript is replaced (restore, subtitle import) a cursor fails with transcript_replaced: restart. Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Pagination: limit (default 100, max 500) and cursor; follow next_cursor until has_more is false. 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), transcript_replaced (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

Query Parameters

limit
integer<int32>
default:100

Page size.

Required range: 1 <= x <= 500
cursor
string

Opaque cursor from next_cursor; keep the same filters on every page.

Maximum string length: 2048
ids
string[]

Up to 100 segment ids.

Required array length: 1 - 100 elements
Maximum string length: 64
speaker_id
string

Only this speaker.

Maximum string length: 11
Pattern: ^SPEAKER_\d{2,3}$
status
enum<string>[]

Comma-separated statuses.

Maximum array length: 4

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>[]

Comma-separated dub states.

Maximum array length: 3

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
needs_attention
boolean

Only flagged (true) or unflagged (false) segments.

from_seconds
number<double>

Segments overlapping [from_seconds, to_seconds).

Required range: x >= 0
to_seconds
number<double>

End of the time window.

Required range: x >= 0
q
string

Only segments whose source or translation text contains this text (1-100 characters, case-insensitive).

Required string length: 1 - 100
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: SegmentList.

A page of Segment (the list envelope shared by every list).

object
enum<string>
required

Always list.

Available options:
list
data
object[]
required

Items of this page.

next_cursor
string | null
required

Pass as cursor for the next page; null on the last page.

has_more
boolean
required

More items exist (a page may hold fewer than limit items while has_more is true).