> ## Documentation Index > Fetch the complete documentation index at: https://docs.sigmora.org/llms.txt > Use this file to discover all available pages before exploring further. # Read transcript > A composition's transcript, playback media and review notes. The editor's own read. `sources[].words` is the editor document: each word with its source-time span, its state and, when the composition plays it, its output-time span. Play `sources[].playUrl` against source time, or `render.url` against output time when `render.current` is true. Redacted words arrive masked. Paged by words: follow `wordsNextCursor` and merge pages by `assetId`; a cursor from before the composition changed answers 409 `conflict` (`details.reason`: `stale_cursor`), so read again from the first page. Pass the composition's `headRevisionId` back as `baseRevisionId` when editing. Free. ## OpenAPI ````yaml /openapi.json get /v1/projects/{projectId}/transcript openapi: 3.1.0 info: title: Sigmora API version: 1.0.0 description: >- The priced, versioned public API. Every call authenticates with a workspace API key (`Authorization: Bearer sk_live_…`), names the project it files its output under, and reports what it cost. `GET /v1/capabilities` answers what this deployment can serve right now and at what price; anything it reports as unavailable answers 503 `capability_unavailable` rather than 404. servers: - url: https://api.sigmora.org security: - bearerAuth: [] tags: - name: Meta description: What this deployment serves, what it costs, and what you have spent. - name: Projects description: The container every capability files its output under. - name: Sessions description: Durable bindings between an external harness session and one project. - name: Assets description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.' - name: Jobs description: Where every asynchronous capability is collected, whatever produced it. - name: Text description: Scripts, research, articles, translation and question sets. - name: Video description: Narrated renders, footage edits, shorts and moment selection. - name: UGC description: >- Creator-led vertical videos: AI creators, their faces and voices, frames and clips. - name: Editing description: >- Sigma, the editor: conversational turns, granular transcript edits, approvals. - name: 3D description: Animated 3D renders from a description or a photograph. - name: Image description: Thumbnails, sized for the platform they are posted to. - name: Audio description: Generated music and audio engineering in Audiotool projects. - name: Publishing description: Connected destinations and queued posts. - name: Webhooks description: Signed, at-least-once delivery of job and publishing events. - name: Workflows description: Context snapshots, versioned recipes, costed proposals and their runs. - name: Agents description: Describe an outcome and let a bounded plan of capabilities run. - name: Research description: >- Observed hooks, creator outliers and production briefs from saved analyses. - name: Themes description: The canonical content taxonomy, and the niche profiles built on it. - name: Signals description: Evidence-backed trends and scored viral content. - name: Discovery description: Compiled watch plans, their runs, and source freshness. - name: Watchlist description: 'Accounts you watch: their usual reach and the posts that beat it.' - name: Performance description: Your own channels' videos against their usual, and fixes to live videos. - name: Autopilot description: The durable trend-to-distribution workflow and its checkpoints. - name: Campaigns description: Distribution records shared by the API, the dashboard and autopilot. - name: Brands description: >- Cross-platform identities with their own voice, rules and publishing commitments. - name: Products description: What a campaign promotes. paths: /v1/projects/{projectId}/transcript: get: tags: - Projects summary: Read transcript description: >- A composition's transcript, playback media and review notes. The editor's own read. `sources[].words` is the editor document: each word with its source-time span, its state and, when the composition plays it, its output-time span. Play `sources[].playUrl` against source time, or `render.url` against output time when `render.current` is true. Redacted words arrive masked. Paged by words: follow `wordsNextCursor` and merge pages by `assetId`; a cursor from before the composition changed answers 409 `conflict` (`details.reason`: `stale_cursor`), so read again from the first page. Pass the composition's `headRevisionId` back as `baseRevisionId` when editing. Free. operationId: projects.transcript.get parameters: - name: projectId in: path required: true description: The project id. schema: type: string minLength: 1 maxLength: 200 description: The project id. - name: compositionId in: query required: false description: The composition to open; defaults to the project's first. schema: description: The composition to open; defaults to the project's first. type: string minLength: 1 maxLength: 200 - name: wordLimit in: query required: false description: >- At most this many words across all sources (default 1000). Every source is listed on every page with its `wordCount`; merge pages by `assetId`. schema: default: 1000 description: >- At most this many words across all sources (default 1000). Every source is listed on every page with its `wordCount`; merge pages by `assetId`. type: integer minimum: 1 maximum: 2000 - name: wordCursor in: query required: false description: >- 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. schema: description: >- 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. type: string maxLength: 32 responses: '200': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true project: type: object properties: id: type: string title: type: string required: - id - title additionalProperties: {} permissions: type: object properties: canEdit: type: boolean canComment: type: boolean required: - canEdit - canComment additionalProperties: {} composition: type: object properties: id: type: string title: type: string headRevisionId: type: string description: Send back as `baseRevisionId` when editing. required: - id - title - headRevisionId additionalProperties: {} compositions: type: array items: type: object properties: id: type: string title: type: string required: - id - title additionalProperties: {} sources: type: array items: type: object properties: assetId: type: string title: type: string playUrl: description: Single-file media; expiring signed URL. type: - string - 'null' editable: type: boolean wordCount: description: All of this source's words; `words` is one page. type: integer minimum: -9007199254740991 maximum: 9007199254740991 words: type: array items: type: object properties: id: type: string text: type: string start: type: number description: Source time, seconds. end: type: number state: type: string description: '`kept`, `deleted`, `gapped` or `ignored`.' outputStart: description: >- When the composition plays it, its output time. type: - number - 'null' outputEnd: type: - number - 'null' required: - id - text - start - end - state additionalProperties: {} required: - assetId - title - playUrl - editable - words additionalProperties: {} wordsNextCursor: description: >- Send as `wordCursor` for the next page of words; null on the last page. Valid only while the transcript is unchanged. type: - string - 'null' render: anyOf: - type: object properties: id: type: string url: type: string status: type: string current: type: boolean required: - id - url - status - current additionalProperties: {} - type: 'null' comments: type: array items: type: object properties: id: type: string parentId: type: - string - 'null' body: type: string authorDisplayName: type: string mine: type: boolean fromReviewer: type: boolean compositionId: type: string revisionId: type: string outputSecond: type: - number - 'null' createdAt: type: string resolvedAt: type: - string - 'null' required: - id - body - compositionId - revisionId additionalProperties: {} commentsNextCursor: type: - string - 'null' webUrl: type: string required: - success - project - permissions - composition - compositions - sources - render - comments - webUrl additionalProperties: {} '400': description: 'Failure. `code` is one of: invalid_request.' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: 'Failure. `code` is one of: unauthorized.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: 'Failure. `code` is one of: forbidden, origin_not_allowed.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'Failure. `code` is one of: not_found.' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'Failure. `code` is one of: conflict.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: 'Failure. `code` is one of: rate_limited.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'Failure. `code` is one of: upstream_error, internal_error.' content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- Failure. `code` is one of: capability_unavailable, upstream_unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object required: - success - error - code properties: success: const: false error: type: string description: >- Human-readable. Copy may change between releases — do not match on it. code: type: string enum: - invalid_request - unauthorized - forbidden - origin_not_allowed - not_found - conflict - payload_too_large - insufficient_credits - budget_capped - content_not_cleared - rate_limited - capability_unavailable - upstream_unavailable - upstream_error - internal_error description: Stable machine-readable cause. Branch on this. details: description: Optional structured context, e.g. the credits shortfall. requestId: type: string description: >- Identifies this request in our logs. Include it when you contact support. timestamp: type: string format: date-time description: When the failure was produced. securitySchemes: bearerAuth: type: http scheme: bearer description: A workspace API key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.