Create a comment or reply

POST/v1/comments

Creates a thread root (`deck` + `slide_index` + `anchor`) or a reply (`parent`). If `external_id` is provided and already exists in the org, the existing comment's body is updated instead (200).

Requires an API key (bearer), scoped to the active org. Supports idempotency keys.

Body parameters

bodystringrequiredmax 5000 chars
parentstringoptional
Reply to this comment.
deckstringoptional
artifactstringoptional
Version the anchor was made on.
slide_indexintegeroptionalmin 0
anchorobject | object | nulloptional
external_idstringoptionalmax 200 chars
metadataobjectoptional
Arbitrary key/value map; merge-on-write (§6).

Returns

200The upserted (already-existing) comment.
201The newly created comment.

Failures use the standard error envelope with a closed set of codes.

Terminal

renza comments create deck_2a9f… \
  --body "This number looks off." \
  --slide-index 2 \
  --external-id review-note-1

POST /v1/comments

curl https://api.renza.io/v1/comments \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "body": "This number looks off.",
  "parent": "com_5d2a…",
  "deck": "deck_2a9f…",
  "artifact": "art_7c1b…",
  "slide_index": 2,
  "anchor": {
    "kind": "element",
    "ref": "h2#title",
    "refKind": "id",
    "x": 0.5,
    "y": 0.5
  },
  "external_id": "review-note-1"
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

const renza = createRenzaClient({ apiKey: process.env.RENZA_API_KEY! });

const comment = await renza.comments.create({
  body: "This number looks off.",
  parent: "com_5d2a…",
  deck: "deck_2a9f…",
  artifact: "art_7c1b…",
  slide_index: 2,
  anchor: {
    kind: "element",
    ref: "h2#title",
    refKind: "id",
    x: 0.5,
    y: 0.5,
  },
  external_id: "review-note-1",
});

Response 200

{
  "id": "com_5d2a…",
  "object": "comment",
  "deck": "deck_2a9f…",
  "artifact": "art_7c1b…",
  "parent": null,
  "author": "usr_1a2b…",
  "slide_index": 2,
  "anchor": {
    "kind": "element",
    "ref": "h2#title",
    "refKind": "id",
    "x": 0.5,
    "y": 0.5
  },
  "body": "This number looks off — should it be Q3?",
  "resolved": false,
  "resolved_at": "2026-06-19T10:30:00.000Z",
  "resolved_by": null,
  "external_id": "review-note-1",
  "livemode": true,
  "metadata": {},
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}