Skip to main content
POST

Authorizations

Authorization
string
header
required

Personal API token created in Descript Settings → API Tokens. See the Authentication section for details.

Body

application/json

Transcript export request

Request to export the transcript from a project composition.

project_id
string<uuid>
required

The ID of the project to export from.

Example:

"9f36ee32-5a2c-47e7-b1a3-94991d3e3ddb"

format
enum<string>
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.

Available options:
txt,
markdown,
html,
rtf,
docx,
srt
composition_id
string

Composition to export. If omitted, the first composition in the project is used.

Accepts any of the following formats:

  • A full composition UUID (e.g. 39677a40-1c43-4c36-8449-46cfbc4de2b5)
  • A 5-character short ID from a Descript URL (e.g. 39677)
  • A full Descript project URL (e.g. https://web.descript.com/{project_id}/39677)
Example:

"39677a40-1c43-4c36-8449-46cfbc4de2b5"

include_speaker_labels
enum<string>
default:changes

Speaker label mode.

  • off: No speaker labels
  • changes: Show speaker label when the speaker changes
  • every_paragraph: Show speaker label on every paragraph
Available options:
off,
changes,
every_paragraph
include_markers
boolean
default:false

Include markers in the transcript.

timecodes
object

Timecode options. When provided, timecodes are included in the output.

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.

The response is of type string.