Skip to content

List text annotations on an asset

GET
/assets/{id}/text-annotations

Returns the asset’s text annotations, oldest first, in one list with no paging. Each is a top-level comment whose annotation_type is text-range, with its range and style in annotation_data and any commentary in body. Deleted annotations are left out.

Every live annotation is returned, whoever wrote it and whether or not it’s resolved; filtering by resolved is up to you. Replies aren’t included, and there’s no route for replying to an annotation.

You need to be signed in and allowed to read the asset’s content, not just see it listed: you’re its owner, it’s public, it’s a team asset of a team you belong to, or you hold content.read.all or system.admin. Mature assets also follow the mature settings, except for their owner and system.admin. An asset you can’t read answers 404, as one that doesn’t exist or is deleted does. No capability is needed.

id
required
string format: uuid

The asset’s id.

The asset’s text annotations, oldest first.

Array<object>

One comment. A reply has parent_id; root_id is the first comment in its thread and depth counts how far down the thread it is (0 for a top-level comment). Annotations also carry annotation_type and annotation_data.

A comment written on this instance has author_user_ref; one received from a paired instance has peer_id and actor_uri instead. Fields with no value are left out.

object
id
required
string format: uuid
target_kind
required
string
Allowed values: post asset collection
target_id
required
string format: uuid
parent_id
string format: uuid
nullable
root_id
required
string format: uuid
depth
required
integer
author_user_ref

The local user who wrote the comment. Left out for comments received from another instance.

integer format: int64
nullable
body
required
string
body_html
required

Normally an empty string: no endpoint except the seed endpoint stores HTML here, comments from other instances don’t carry any, and the web app shows body as plain text. The seed endpoint stores its value unchecked, so don’t display this field as HTML.

string
annotation_type
string
nullable
Allowed values: point rect timestamp frame whiteboard text-range
annotation_data
object
key
additional properties
any
like_count
required
integer format: int64
edited_at
string format: date-time
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
peer_id

The paired instance a received comment came from. Left out for comments written on this instance.

string format: uuid
nullable
actor_uri

The author’s address on their home instance, for example https://studio-b.example/users/bob. Left out for comments written on this instance.

string
nullable
display_name

The remote author’s display name. It’s often left out, even for received comments; when it is, show the host and user name from actor_uri instead.

string
nullable

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed