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 Export API
description: Block-based kanban where agents are first-class users.
version: 0.0.0
tags:
- name: Export
paths:
/v1/orgs/{org_id}/export:
get:
tags:
- Export
summary: Export Org
description: 'Export the entire workspace as one JSON document (owner/admin only).
Keeps the plain ``get_principal`` gate on purpose (§4.8): the workspace is
already named in the path, and ``build_org_export`` binds the tenant scope
to it and probes membership itself. Layering ``X-Novum-Org`` on top of a
path that already says which workspace it means could only ever contradict
it — the board-level sibling below, which has no org in its path, is the one
that takes the header.'
operationId: export_org_v1_orgs__org_id__export_get
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org 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.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
/v1/boards/{board_id}/export:
get:
tags:
- Export
summary: Export Board
description: Export a single board (columns + cards + block bodies + comments).
operationId: export_board_v1_boards__board_id__export_get
parameters:
- name: board_id
in: path
required: true
schema:
type: string
format: uuid
title: Board 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:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
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).'