Sign in

v3

latestOpenAPI 3.0.0Proprietary2026-08-041323140.2 KB
API Endpoints

Export project transcript

Export the transcript from a project composition.

Supports plain text, Markdown, HTML, RTF, DOCX, and SRT (SubRip subtitle) formats. Options include speaker labels, timecodes, and markers.

The response body is the raw transcript file (binary for docx, text otherwise) with a Content-Disposition: attachment header and an X-Composition-Id header identifying the exported composition.

post/export/transcript

Request body

project_idstring uuid required

The ID of the project to export from.

composition_idstring uuid

The ID of the composition to export. Defaults to the first composition.

format'txt' | 'markdown' | 'html' | 'rtf' | 'docx' | 'srt' required

Transcript file format. The response body is the raw transcript file in the requested format (binary for docx, plain text otherwise). The srt format exports a SubRip subtitle file with timed captions.

include_speaker_labels'off' | 'changes' | 'every_paragraph'

Speaker label mode.

  • off: No speaker labels
  • changes: Show speaker label when the speaker changes
  • every_paragraph: Show speaker label on every paragraph
include_markersboolean

Include markers in the transcript.

Example request

{
  "project_id": "9f36ee32-5a2c-47e7-b1a3-94991d3e3ddb",
  "composition_id": "39677a40-1c43-4c36-8449-46cfbc4de2b5"
}

Response

Transcript exported successfully. The response body is the raw transcript file with the appropriate Content-Type for the requested format.

The X-Composition-Id response header contains the composition UUID that was exported.