Skip to content

POST /api/v1/comments

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Create Comment

: create a comment, resolve @mentions, record agent mentions as an agent action.

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/comments" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"body_markdown":"<body_markdown>","target_guid":"<target_guid>","target_kind":"<target_kind>"}'

The contract carries no example for this response; schema: CommentRead. Field-level shape: interactive explorer.

CommentRead — Successful Response

FieldTypeDescription
author_idinteger
body_markdownstring
createtimestring
deletedboolean
guidinteger
mentionsarray of object
target_guidinteger
target_kindstring
updatetimestring
ParameterInRequiredTypeDefaultConstraintsDescription
Idempotency-Keyheadernostring—uuidOptional.
FieldTypeRequiredDescription
body_markdownstringyes
target_guidintegeryes
target_kindstringyes
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.