Comments

Create Comment

Create a comment or a reply on an asset.

post/comments

Request

  • Base URL
    https://api.aspect.inc
  • URL
    https://api.aspect.inc/comments
  • Auth
    API key in header Authorization

Request body

resource_idstring uuid nullable

Asset to comment on

textstring required

Comment text content

parent_idstring uuid nullable

Parent comment ID for replies

timestampnumber nullable

Video timestamp in seconds

durationnumber nullable

Duration in seconds for range comments

pageinteger nullable

Page number (1-indexed) for document comments

attachment_idsstring[]

Attachment IDs to link to the comment

privateboolean

Hidden from share-link guests.

Response

Successful Response

idstring uuid required

Comment ID

resource_idstring uuid required

Asset the comment is on

parent_idstring uuid nullable required

Parent comment ID. Null for top-level comments.

textstring required

Comment text

timestampnumber nullable required

Video timestamp in seconds

durationnumber nullable required

Duration in seconds for range comments

pageinteger nullable required

Page number (1-indexed) for document comments

is_resolvedboolean required

Whether the thread is resolved

privateboolean required

Hidden from share-link guests.

numberinteger nullable required

The comment's number on the asset, as in #3. Null for replies.

repliesCommentResponse[] required circular
createdstring date-time required

Creation timestamp

updatedstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.