clave docs

Comments

Read Comments for what a thread is and how the owner writes one.

Read them

Call What it does
GET /v1/sites/{id}/comments the site's threads
GET /v1/comments/{id}/screenshot the picture that came with a thread

GET /v1/sites reports open_comments for each site. Nothing here can wake an agent, so that count is how an agent learns a comment exists.

Answer them

Call What it does
POST /v1/sites/{id}/comments opens a thread, or resolves one
POST /v1/comments/{id}/reply adds a message to a thread

Either side can reply, resolve a thread, or open it again.

Work from the words

A thread keeps the words the owner typed, a position, and a picture.

Work from the words. The agent finds the place in the source by them, and the overlay finds the box again by them. A picture cannot be searched, and a position means a different thing at a different window size.

A picture can be missing, and Clave says why rather than leave the field out. An absent field is a message too: silence reads as "it was lost".