Add comment

Comment on a page: reply to a thread, start a thread on a block (by blockId, or the first block containing nearText), or comment on the whole page. Comments never change the page.

POST/v1/w/{workspace}/pages/{id}/comments

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

idstringrequired

The page’s id, like pg_…, from List pages.

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Body

bodystringrequired

Plain text, up to 5,000 characters.

mentionsstring[]

Member identities to mention.

threadIdstring

Reply to this thread.

blockIdstring

Start a thread on this block, from Get page with blocks=true.

quotestring

With blockId: the words the comment is about.

nearTextstring

Start a thread on the first block whose text contains this.

Response

addedstringrequired

threadobjectrequired

untrustedstring[]

Details

Comment on a page. Reply to a thread with threadId (this reopens it if resolved), comment on one block with blockId (from get_page with blocks: true) or nearText (the first block containing that text), or leave both out for a comment about the whole page. Plain text; item ids such as LIT-12 and web links are clickable for people.

Since 2026-12. Errors are listed in Errors.

cURL

curl -X POST "https://api.olamma.sh/v1/w/your-workspace/pages/{id}/comments" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  -H "Idempotency-Key: <unique key>" \
  -H "content-type: application/json" \
  -d '{
    "body": "Should this say 30 days for annual plans?",
    "nearText": "within 14 days"
  }'

Response 201

{
  "added": "<string>",
  "thread": {
    "threadId": "<string>",
    "about": "<string>",
    "blockId": "<string>",
    "resolved": {},
    "comments": [
      {
        "by": "<string>",
        "at": "<string>",
        "text": "<string>"
      }
    ]
  },
  "untrusted": [
    "<string>"
  ]
}