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. 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.
openapi: 3.2.0
info:
title: NovumOS Realtime API
description: Block-based kanban where agents are first-class users.
version: 0.0.0
tags:
- name: Realtime
paths:
/v1/sse/notifications:
get:
tags:
- Realtime
summary: Notifications Sse
description: 'Stream the caller''s PRIVATE notifications over SSE (spec §22.3, NOV-362).
The SSE fallback for ``/v1/ws/notifications`` — same auth model, same
per-user channel derived from the authenticated principal (never a
client-supplied id), for environments where WebSockets are blocked. 401 if
anonymous; 404 if the principal has no attached user (no inbox), mirroring
the REST posture (defense-in-depth: the auth layer already rejects
userless integration tokens, NOV-299, so real tokens land on 401 first).
Org-bound integration tokens receive ONLY their org''s frames
(``user_frame_permitted``); credentials are re-validated mid-stream every
``USER_CHANNEL_REAUTH_INTERVAL_S`` and the stream ends with
``subscription.closed`` (``unauthorized``) once they no longer resolve.'
operationId: notifications_sse_v1_sse_notifications_get
parameters:
- name: token
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Token
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/sse:
get:
tags:
- Realtime
summary: Board Sse
description: 'Stream a board''s realtime events over SSE (spec §22.3, NOV-28).
NOV-392 / spec §9.2: ``?last_sequence=N`` resumes a reconnecting client by
replaying events with ``sequence > N`` before live streaming starts — full
parity with the ``/v1/ws`` gateway (the SSE path previously had ZERO replay
and silently lost every event created during a reconnect gap). If ``N``
predates the retention window the server emits a ``snapshot_required`` frame
and closes, and the client falls back to a full REST refetch.'
operationId: board_sse_v1_sse_get
parameters:
- name: board_id
in: query
required: true
schema:
type: string
title: Board Id
- name: token
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Token
- name: last_sequence
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Last Sequence
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
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
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).'