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.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The asset’s id.
Responses
Section titled “ Responses ”The asset’s text annotations, oldest first.
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
The local user who wrote the comment. Left out for comments received from another instance.
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.
object
The paired instance a received comment came from. Left out for comments written on this instance.
The author’s address on their home instance, for example https://studio-b.example/users/bob. Left out for comments written on this instance.
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.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Resource not found
object
Human-readable error summary
Example
the request could not be completed