Skip to main content
POST
Add captions

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
projectId
string
required

The project to edit.

Required string length: 1 - 200
compositionId
string

The composition to edit; omit for the project's current one.

Required string length: 1 - 200
request
string

The user's words for this edit; shown with the proposal and restored if it is reverted.

Maximum string length: 2000
burnIn
boolean
default:true

true burns transcript captions into the export; false leaves them out.

preset
enum<string>

A named caption look.

Available options:
editorial,
clean,
bold,
active-word,
subtle

Response

Success.

success
boolean
required
projectId
string
required
compositionId
string | null
required
summary
string
required
proposals
object[]
required
Maximum array length: 1
details
object
required
{key}
any