API ReferenceComments

Create a Comment

Leave a Comment on an Asset

Path parameters

asset_idstringRequiredformat: "uuid"

Request

Comment to create or update
textstringRequired
The body of the comment.
annotationstringOptional
Serialized list of geometry and/or drawing data. Learn more [here](https://developer.frame.io/docs/workflows-assets/working-with-annotations)
pageintegerOptional

Page number for a comment (documents only).

timestampdoubleOptional

Timestamp for the comment, in frames, starting at 0.

Comments can “global” to an asset in which you don’t provide the timestamp, or if you’re reviewing a “document” like a PDF then you would use page instead of timestamp to identify where the comment belongs.

durationintegerOptional

Used to produce range-based comments, this is the duration measured in frames.

privatebooleanOptional

Set to true to make your comment a “Team-only Comment” that won’t be visible to anonymous reviewers or Collaborators.

pitchintegerOptionalDeprecated

Pitch measurement for the comment (360deg video only).

yawintegerOptionalDeprecated

Yaw measurement for the comment (360deg video only).

Response

Comment success response
annotationstring or null
completedboolean or null
completed_atstring or null
completer_idstring or nullformat: "uuid"
has_repliesboolean or null
idstring or nullformat: "uuid"
like_countinteger or null
ownerobject or null
User model
owner_idstring or nullformat: "uuid"
textstring or null
timestampinteger or null

Errors