Skip to main content
GET
Read transcript

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

projectId
string
required

The project id.

Required string length: 1 - 200

Query Parameters

compositionId
string

The composition to open; defaults to the project's first.

Required string length: 1 - 200
wordLimit
integer
default:1000

At most this many words across all sources (default 1000). Every source is listed on every page with its wordCount; merge pages by assetId.

Required range: 1 <= x <= 2000
wordCursor
string

The previous page's wordsNextCursor. It is bound to the transcript it paged: once the composition changes (an edit, a new source or transcript), it answers 409 conflict with details.reason stale_cursor; read again from the first page.

Maximum string length: 32

Response

Success.

success
boolean
required
project
object
required
permissions
object
required
composition
object
required
compositions
object[]
required
sources
object[]
required
render
object | null
required
comments
object[]
required
webUrl
string
required
wordsNextCursor
string | null

Send as wordCursor for the next page of words; null on the last page. Valid only while the transcript is unchanged.

commentsNextCursor
string | null
{key}
any