Comma Comments API

Threaded, optionally text-anchored comments and replies.

GitHub OpenAPI

Operations 5

GET /reports/{id}/comments List comment threads #
POST /reports/{id}/comments Leave a comment #
PATCH /comments/{id} Resolve or reopen a thread #
GET /comments/{id}/replies List replies in a thread #
POST /comments/{id}/replies Reply to a thread #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/commareports-com:commareports-com-comments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

commareports-com-comments-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Commareports Com Comments API
  version: 1.0.0
  contact:
    url: https://commareports.com/contact
  description: 'Operations tagged Comments across 2 of this provider''s published API definitions: commareports-com-openapi.json, commareports-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://commareports.com/api/v1
security:
- commaApiToken: []
tags:
- name: Comments
  description: Threaded, optionally text-anchored comments and replies.
paths:
  /reports/{id}/comments:
    parameters:
    - $ref: '#/components/parameters/ReportId'
    get:
      tags:
      - Comments
      operationId: listComments
      summary: List comment threads
      description: 'All comments with replies, anchors, and resolve state, oldest first. Cursor-paginated: pass the previous page''s opaque `nextCursor` to fetch the next page. Each comment embeds up to 50 replies; `replies_truncated` marks a thread with more (read it via `GET /comments/{id}/replies`). Scope: `comments:read`.'
      parameters:
      - name: cursor
        in: query
        schema:
          type: string
        description: Opaque `nextCursor` from the previous page.
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 200
          default: 50
      responses:
        '200':
          description: A page of comments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentsPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      tags:
      - Comments
      operationId: createComment
      summary: Leave a comment
      description: 'Create a top-level comment, optionally anchored to a text range (`anchor_text` + `anchor_prefix`/`anchor_suffix`) or a block (`block_id`). Requires comment access on the report (`can_comment_report`) — 403 otherwise. Fires `comment.created` (and `comment.mentioned` per unique @handle) webhooks. Scope: `comments:write`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentCreateRequest'
      responses:
        '201':
          description: Comment created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentCreated'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
  /comments/{id}:
    parameters:
    - $ref: '#/components/parameters/CommentId'
    patch:
      tags:
      - Comments
      operationId: setCommentStatus
      summary: Resolve or reopen a thread
      description: 'Set `status` to `open` or `resolved`. Allowed for the comment''s author, the report''s owner, or a report admin — 403 otherwise. Scope: `comments:write`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                  - open
                  - resolved
              required:
              - status
      responses:
        '200':
          description: Updated status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                    - open
                    - resolved
                  updated_at:
                    type: string
                    format: date-time
                required:
                - id
                - status
                - updated_at
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
  /comments/{id}/replies:
    parameters:
    - $ref: '#/components/parameters/CommentId'
    get:
      tags:
      - Comments
      operationId: listReplies
      summary: List replies in a thread
      description: 'Replies oldest first, capped at 200. Scope: `comments:read`.'
      responses:
        '200':
          description: Replies.
          content:
            application/json:
              schema:
                type: object
                properties:
                  replies:
                    type: array
                    items:
                      $ref: '#/components/schemas/Reply'
                required:
                - replies
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      tags:
      - Comments
      operationId: createReply
      summary: Reply to a thread
      description: 'Requires comment access on the parent report. Scope: `comments:write`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
              required:
              - body
      responses:
        '201':
          description: Reply created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  body:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                required:
                - id
                - body
                - created_at
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
components:
  responses:
    Unauthorized:
      description: Missing, invalid, revoked, or expired token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token missing the required scope, or no access to the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: 'Rate limit exceeded. Rate limit: per-token sliding window (plan-aware — Free 60 req/min, Pro 600, Team/Enterprise 6000 by default); 429 responses carry a Retry-After header.'
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found (also returned instead of 403 where existence must not leak).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Malformed body or invalid field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    CommentAuthor:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
          description: null for agent / system (auto-changelog) comments.
        name:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
      required:
      - id
    CommentsPage:
      type: object
      properties:
        comments:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as ?cursor= to fetch the next page; null when exhausted.
      required:
      - comments
      - nextCursor
    Anchor:
      type: object
      properties:
        text:
          type: string
        prefix:
          type:
          - string
          - 'null'
        suffix:
          type:
          - string
          - 'null'
      required:
      - text
    CommentCreated:
      type: object
      properties:
        id:
          type: string
          format: uuid
        body:
          type: string
        status:
          type: string
          enum:
          - open
          - resolved
        created_at:
          type: string
          format: date-time
      required:
      - id
      - body
      - status
      - created_at
    Comment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        body:
          type: string
        status:
          type: string
          enum:
          - open
          - resolved
        author:
          $ref: '#/components/schemas/CommentAuthor'
        author_type:
          type: string
          enum:
          - user
          - agent
          - system
        block_id:
          type:
          - string
          - 'null'
        anchor:
          oneOf:
          - $ref: '#/components/schemas/Anchor'
          - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        replies:
          type: array
          items:
            $ref: '#/components/schemas/Reply'
        replies_truncated:
          type: boolean
          description: True when the thread has more than the 50 embedded replies.
      required:
      - id
      - body
      - status
      - author
      - created_at
      - updated_at
      - replies
    Reply:
      type: object
      properties:
        id:
          type: string
          format: uuid
        body:
          type: string
        author:
          $ref: '#/components/schemas/CommentAuthor'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - id
      - body
      - author
      - created_at
      - updated_at
    CommentCreateRequest:
      type: object
      properties:
        body:
          type: string
        block_id:
          type: string
          description: Anchor to a block element id.
        anchor_text:
          type: string
          description: Exact text the comment anchors to.
        anchor_prefix:
          type: string
          description: Disambiguating text before the anchor.
        anchor_suffix:
          type: string
          description: Disambiguating text after the anchor.
      required:
      - body
    Error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
  parameters:
    CommentId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Comment id.
    ReportId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Report id.
  securitySchemes:
    commaApiToken:
      type: http
      scheme: bearer
      bearerFormat: comma_sk_…
      description: Comma personal API token (Settings → API tokens). Scoped, revocable, optionally expiring. The same token also authenticates the MCP server at /api/mcp.
    supabaseSessionJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase user-session access token — the signed-in browser path. Only accepted where an operation explicitly lists it.
x-refined-from:
- commareports-com-openapi.json
- commareports-com-openapi.yml