NovumOS Automations API
The automations API from NovumOS — 4 operation(s) for automations.
Operations 7
POST
/v1/orgs/{org_id}/automations/{automation_id}/runs/{run_id}:replay
Replay Automation Run Endpoint
#
The automations API from NovumOS — 4 operation(s) for automations.
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-automations-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 Automations API
description: Block-based kanban where agents are first-class users.
version: 0.0.0
tags:
- name: Automations
paths:
/v1/orgs/{org_id}/automations:
get:
tags:
- Automations
summary: List Automations Endpoint
description: List the org's automations, newest first (keyset pagination). Admin/owner-only.
operationId: list_automations_endpoint_v1_orgs__org_id__automations_get
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org 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.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_AutomationResponse_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
post:
tags:
- Automations
summary: Create Automation Endpoint
description: 'Create an automation rule (§20.8). Admin/owner-only.
The body''s ``trigger`` / ``actions`` are validated (event_type ∈
KNOWN_EVENT_TYPES; non-empty actions with known ``type``) — the schema rejects
a malformed body with 422 before the service, which re-validates for parity
with the MCP path. A ``notify`` action''s ``params`` may set ``recipient``
(``owner`` default | ``assignees``) and ``channels`` (any of ``comment``
default | ``in_app`` | ``email``); unknown values are rejected at write time
(422). Omitting both keys preserves the historical comment-to-owner behavior.'
operationId: create_automation_endpoint_v1_orgs__org_id__automations_post
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.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAutomationRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
/v1/orgs/{org_id}/automations/{automation_id}:
get:
tags:
- Automations
summary: Get Automation Endpoint
description: Fetch one automation. Admin/owner-only. Cross-org → ``404`` (no leak).
operationId: get_automation_endpoint_v1_orgs__org_id__automations__automation_id__get
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org Id
- name: automation_id
in: path
required: true
schema:
type: string
format: uuid
title: Automation 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:
$ref: '#/components/schemas/AutomationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
patch:
tags:
- Automations
summary: Update Automation Endpoint
description: 'Update / toggle an automation (§20.8). Admin/owner-only.
Only the fields the client sent are changed (``model_dump(exclude_unset=True)``
forwards an explicit ``null`` but not an absent key). ``is_active`` supports the
enable/disable toggle.'
operationId: update_automation_endpoint_v1_orgs__org_id__automations__automation_id__patch
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org Id
- name: automation_id
in: path
required: true
schema:
type: string
format: uuid
title: Automation 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.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAutomationRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
delete:
tags:
- Automations
summary: Delete Automation Endpoint
description: Delete an automation (§20.8). Admin/owner-only. Cross-org → ``404``.
operationId: delete_automation_endpoint_v1_orgs__org_id__automations__automation_id__delete
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org Id
- name: automation_id
in: path
required: true
schema:
type: string
format: uuid
title: Automation 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:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
/v1/orgs/{org_id}/automations/{automation_id}/runs:
get:
tags:
- Automations
summary: List Automation Runs Endpoint
description: List one automation's run ledger, newest first (§20.8). Admin/owner-only.
operationId: list_automation_runs_endpoint_v1_orgs__org_id__automations__automation_id__runs_get
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org Id
- name: automation_id
in: path
required: true
schema:
type: string
format: uuid
title: Automation 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.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_AutomationRunResponse_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
/v1/orgs/{org_id}/automations/{automation_id}/runs/{run_id}:replay:
post:
tags:
- Automations
summary: Replay Automation Run Endpoint
description: 'Re-arm a terminal-failed run (§20.6.2). Admin/owner-only.
Resets the run to ``pending`` + ``next_retry_at=now()`` in place (dedup_key
preserved, NO new row); a non-terminal-failed run → ``409``; a run under
another automation/org → ``404``. The executor (NOV-281) drains the reset run.'
operationId: replay_automation_run_endpoint_v1_orgs__org_id__automations__automation_id__runs__run_id__replay_post
parameters:
- name: org_id
in: path
required: true
schema:
type: string
format: uuid
title: Org Id
- name: automation_id
in: path
required: true
schema:
type: string
format: uuid
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run 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:
$ref: '#/components/schemas/AutomationRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- IntegrationToken: []
components:
schemas:
AutomationResponse:
properties:
object:
type: string
title: Object
default: automation
id:
type: string
format: uuid
title: Id
org_id:
type: string
format: uuid
title: Org Id
board_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Board Id
name:
type: string
title: Name
is_active:
type: boolean
title: Is Active
trigger:
additionalProperties: true
type: object
title: Trigger
conditions:
items: {}
type: array
title: Conditions
actions:
items: {}
type: array
title: Actions
run_as_agent_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Run As Agent Id
created_time:
type: string
format: date-time
title: Created Time
last_edited_time:
type: string
format: date-time
title: Last Edited Time
type: object
required:
- id
- org_id
- board_id
- name
- is_active
- trigger
- conditions
- actions
- run_as_agent_id
- created_time
- last_edited_time
title: AutomationResponse
CreateAutomationRequest:
properties:
name:
type: string
maxLength: 200
minLength: 1
title: Name
board_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Board Id
trigger:
additionalProperties: true
type: object
title: Trigger
conditions:
items: {}
type: array
title: Conditions
actions:
items: {}
type: array
title: Actions
run_as_agent_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Run As Agent Id
type: object
required:
- name
- trigger
- actions
title: CreateAutomationRequest
description: Body for ``POST /v1/orgs/{org_id}/automations`` (§20.8).
PaginatedResponse_AutomationResponse_:
properties:
object:
type: string
title: Object
default: list
results:
items:
$ref: '#/components/schemas/AutomationResponse'
type: array
title: Results
has_more:
type: boolean
title: Has More
default: false
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
page_size:
type: integer
title: Page Size
default: 25
type: object
required:
- results
title: PaginatedResponse[AutomationResponse]
PaginatedResponse_AutomationRunResponse_:
properties:
object:
type: string
title: Object
default: list
results:
items:
$ref: '#/components/schemas/AutomationRunResponse'
type: array
title: Results
has_more:
type: boolean
title: Has More
default: false
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
page_size:
type: integer
title: Page Size
default: 25
type: object
required:
- results
title: PaginatedResponse[AutomationRunResponse]
UpdateAutomationRequest:
properties:
name:
anyOf:
- type: string
maxLength: 200
minLength: 1
- type: 'null'
title: Name
board_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Board Id
trigger:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Trigger
conditions:
anyOf:
- items: {}
type: array
- type: 'null'
title: Conditions
actions:
anyOf:
- items: {}
type: array
- type: 'null'
title: Actions
run_as_agent_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Run As Agent Id
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
type: object
title: UpdateAutomationRequest
description: 'Body for ``PATCH /v1/orgs/{org_id}/automations/{id}`` (§20.8).
Every field is optional — a client sends only what it changes. ``is_active``
supports the enable/disable toggle. Fields the client omits are left untouched
(the router forwards only ``model_dump(exclude_unset=True)`` to the service, so
an explicit ``null`` is distinguishable from an absent key).'
AutomationRunResponse:
properties:
object:
type: string
title: Object
default: automation_run
id:
type: string
format: uuid
title: Id
automation_id:
type: string
format: uuid
title: Automation Id
org_id:
type: string
format: uuid
title: Org Id
card_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Card Id
source_sequence:
type: integer
title: Source Sequence
status:
type: string
title: Status
attempts:
type: integer
title: Attempts
next_retry_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Next Retry At
chain_depth:
type: integer
title: Chain Depth
action_results:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Action Results
created_time:
type: string
format: date-time
title: Created Time
type: object
required:
- id
- automation_id
- org_id
- card_id
- source_sequence
- status
- attempts
- next_retry_at
- chain_depth
- action_results
- created_time
title: AutomationRunResponse
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).'