outline icon

outline

Interact with outline API

Actions107

Comments → Comments Create

AI-generated

Summary

Creates a new comment on a document in Outline.

Inputs

  • documentId (required) — The ID of the document where the comment will be created.
  • text — The content of the comment in markdown format.
  • parentCommentId — The ID of the parent comment to reply to in a thread.
  • data — JSON object containing raw document node body data for the comment.
  • id — An optional custom ID to assign to the comment.
  • requestOptions — Additional request options such as timeout, proxy, batching, or SSL settings.

Output shape

A single object containing the created comment details.

Returns the JSON body sent by the Outline API response.

Examples

Example 1: Create a root-level comment on a document

Set Document Id to 'doc-123' and Text to 'Great documentation!'

Example 2: Create a threaded reply to a parent comment

Set Document Id to 'doc-123', Parent Comment Id to 'comment-456', and Text to 'I agree with this point.'

Links

Discussion