Skip to main content
GET
Get a bounded transcript page

Authorizations

Authorization
string
header
required

API key authentication. Pass your key as a Bearer token. Keys use the format hm_live_<32 hex chars>. Generate keys from your Harmonica dashboard settings.

Path Parameters

id
string<uuid>
required

Query Parameters

format
enum<string>
default:turns
Available options:
turns,
text
limit
integer
default:100

Maximum number of returned segments.

Required range: 1 <= x <= 200
max_chars
integer
default:25000

Maximum transcript-text code points returned. JSON framing and fixed metadata are outside this budget.

Required range: 1000 <= x <= 50000
cursor
string

Opaque revision-bound cursor from the previous transcript page.

Minimum string length: 1
include_speaker_email
boolean
default:false

Owner-only and turns-only. Project-derived requests with true fail closed.

Response

One bounded transcript page

Exactly one bounded transcript page. The server never follows next_cursor automatically.

transcript
object
required
access_basis
enum<string>
required
Available options:
owner,
project
segments
object[]
required
pagination
object
required
text
string

Plain-text rendering returned for format=text. Speaker email is never included.