NovumOS Comments API
The comments API from NovumOS — 2 operation(s) for comments.
The comments API from NovumOS — 2 operation(s) for comments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/novumos-app:novumos-app-comments-api"
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.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: NovumOS Comments API
description: Block-based kanban where agents are first-class users.
version: 0.0.0
tags:
- name: Comments
paths:
/v1/comments:
get:
tags:
- Comments
summary: List Comments
description: 'List comments on a card.
Accepts ``block_id`` as a Notion-shape alias for ``card_id`` (NOV-63 B5).
Notion''s API uses ``GET /v1/comments?block_id=`` to list
page-level comments — content-forge does this verbatim. We treat the
two parameters as equivalent so a Notion-shape client works unchanged.
If both are present, ``card_id`` wins.'
operationId: list_comments_v1_comments_get
parameters:
- name: card_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Card Id
- name: block_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Block Id
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 25
title: Page Size
- name: start_cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Start Cursor
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
- name: X-Novum-Org
in: header
required: false
schema:
type: string
format: uuid
description: 'Optional. Selects the workspace this request acts in. An integration token is **pinned** to its own workspace, so a conflicting value returns `404`. For a browser session the value is re-checked against live membership on every request: it can only ever narrow to a workspace you already belong to, never widen. Omit it to act in the session''s active workspace.'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Comments V1 Comments Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
post:
tags:
- Comments
summary: Create Comment
operationId: create_comment_v1_comments_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCommentRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CommentResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
parameters:
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
- name: X-Novum-Org
in: header
required: false
schema:
type: string
format: uuid
description: 'Optional. Selects the workspace this request acts in. An integration token is **pinned** to its own workspace, so a conflicting value returns `404`. For a browser session the value is re-checked against live membership on every request: it can only ever narrow to a workspace you already belong to, never widen. Omit it to act in the session''s active workspace.'
/v1/comments/{comment_id}:
patch:
tags:
- Comments
summary: Update Comment
description: 'Patch a comment. ``If-Match: "v17"`` against the etag honored (spec §8.1).'
operationId: update_comment_v1_comments__comment_id__patch
parameters:
- name: comment_id
in: path
required: true
schema:
type: string
format: uuid
title: Comment Id
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
- name: X-Novum-Org
in: header
required: false
schema:
type: string
format: uuid
description: 'Optional. Selects the workspace this request acts in. An integration token is **pinned** to its own workspace, so a conflicting value returns `404`. For a browser session the value is re-checked against live membership on every request: it can only ever narrow to a workspace you already belong to, never widen. Omit it to act in the session''s active workspace.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCommentRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CommentResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
delete:
tags:
- Comments
summary: Delete Comment
description: 'Soft-archive a comment. ``If-Match: "v17"`` honored when supplied.'
operationId: delete_comment_v1_comments__comment_id__delete
parameters:
- name: comment_id
in: path
required: true
schema:
type: string
format: uuid
title: Comment Id
- name: X-Board-Version
in: header
required: true
schema:
type: string
default: '2026-06-19'
description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
- name: X-Novum-Org
in: header
required: false
schema:
type: string
format: uuid
description: 'Optional. Selects the workspace this request acts in. An integration token is **pinned** to its own workspace, so a conflicting value returns `404`. For a browser session the value is re-checked against live membership on every request: it can only ever narrow to a workspace you already belong to, never widen. Omit it to act in the session''s active workspace.'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
components:
schemas:
CommentResponse:
properties:
object:
type: string
title: Object
default: comment
id:
type: string
format: uuid
title: Id
card_id:
type: string
format: uuid
title: Card Id
author_user_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Author User Id
body:
items:
additionalProperties: true
type: object
type: array
title: Body
is_archived:
type: boolean
title: Is Archived
is_edited:
type: boolean
title: Is Edited
created_time:
type: string
format: date-time
title: Created Time
last_edited_time:
type: string
format: date-time
title: Last Edited Time
etag:
type: integer
title: Etag
parent:
additionalProperties: true
type: object
title: Parent
readOnly: true
created_by:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Created By
readOnly: true
rich_text:
items:
additionalProperties: true
type: object
type: array
title: Rich Text
readOnly: true
additionalProperties: false
type: object
required:
- id
- card_id
- body
- is_archived
- is_edited
- created_time
- last_edited_time
- etag
- parent
- created_by
- rich_text
title: CommentResponse
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
CreateCommentRequest:
properties:
card_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Card Id
body:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Body
additionalProperties: true
type: object
title: CreateCommentRequest
description: "Comment-create accepts both native and Notion-shape payloads (NOV-63 B5).\n\nNative: ``{\"card_id\": \"<uuid>\", \"body\": [<block>, …]}``\nNotion: ``{\"parent\": {\"page_id\": \"<uuid>\"}, \"rich_text\": [<rt>, …]}``\n\nThe Notion-shape input is normalized at validation time:\n\n- ``parent.page_id`` → ``card_id``\n- ``rich_text`` segments concatenated into a single paragraph block\n ``[{\"object\": \"block\", \"type\": \"paragraph\", \"paragraph\":\n {\"rich_text\": [...], \"color\": \"default\"}}]``.\n\nMixed payloads (both shapes present) prefer the native fields and log\nnothing — the API is permissive on extras because pydantic discards\nthem once normalization completes."
UpdateCommentRequest:
properties:
body:
items:
additionalProperties: true
type: object
type: array
title: Body
additionalProperties: false
type: object
required:
- body
title: UpdateCommentRequest
securitySchemes:
IntegrationToken:
type: http
scheme: bearer
description: 'Integration token. Mint one in the app under **Settings → Integrations** and paste the `nov_…` value here. It is sent as `Authorization: Bearer nov_…`, the same credential the API enforces. Browser session cookies are NOT used by try-it-out (the cookie flow additionally requires an `X-CSRF-Token` header this page cannot mint).'