Skip to main content
GET
Get Comment

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

comment_id
string<uuid>
required

The ID of the comment to get

Response

Successful Response

API response schema for a single comment with nested replies, reactions, mentions, and attachments

id
string<uuid>
required

Comment ID

resource_id
string<uuid>
required

Asset the comment is on

parent_id
string<uuid> | null
required

Parent comment ID. Null for top-level comments.

text
string
required

Comment text

timestamp
number | null
required

Video timestamp in seconds

duration
number | null
required

Duration in seconds for range comments

page
integer | null
required

Page number (1-indexed) for document comments

is_resolved
boolean
required

Whether the thread is resolved

private
boolean
required

Hidden from share-link guests.

number
integer | null
required

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

user
UserInfo · object | null
required

Comment author. Null if the author's account was deleted.

replies
Replies · array
required

Replies to this comment

reactions
ReactionGroup · object[]
required

Reactions grouped by emoji

mentions
MentionInfo · object[]
required

Users mentioned in the text

attachments
SignedAttachment · object[]
required

Attached files

created
string<date-time>
required

Creation timestamp

updated
string<date-time>
required

Last update timestamp

anchor_position
AnchorPosition · object | null

Where the comment is pinned on the frame, image, or page

annotation
(PenPath · object | LinePath · object | ArrowPath · object | BoxPath · object)[] | null

Shapes drawn on the frame, image, or page

A freehand stroke.

text_highlight
TextHighlight · object | null

The document text the comment highlights