Skip to main content
GET
List the segments of a transcript version
When to use: to diff a version against the live transcript. 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: 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
version_number
integer<int32>
required

Transcript version number.

Required range: 1 <= x <= 2147483647

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
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: TranscriptVersionSegmentList.

A page of TranscriptVersionSegment (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).