Skip to main content
POST
Add review note

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

projectId
string
required

The project id.

Required string length: 1 - 200

Body

application/json
compositionId
string
required

composition.id from the transcript read.

Required string length: 1 - 200
revisionId
string
required

The immutable revision the note is anchored to: composition.headRevisionId from the transcript read.

Required string length: 1 - 200
body
string
required

The note, plain text, up to 2000 characters.

Required string length: 1 - 2000
outputSecond
number

Seconds on the composition output clock the note is about; omit for a note on the whole cut.

Required range: 0 <= x <= 86400
parentId
string

Reply to this note: comments[].id from a read.

Required string length: 1 - 160

Response

Success.

success
boolean
required
comment
object
required
{key}
any