NovumOS Playbooks API

The playbooks API from NovumOS — 2 operation(s) for playbooks.

GitHub OpenAPI

Operations 5

GET /v1/orgs/{org_id}/playbooks List Playbooks Endpoint #
POST /v1/orgs/{org_id}/playbooks Create Playbook Endpoint #
GET /v1/orgs/{org_id}/playbooks/{playbook_id} Get Playbook Endpoint #
PATCH /v1/orgs/{org_id}/playbooks/{playbook_id} Update Playbook Endpoint #
DELETE /v1/orgs/{org_id}/playbooks/{playbook_id} Delete Playbook Endpoint #

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/novumos-app:novumos-app-playbooks-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. 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 Specification

novumos-app-playbooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NovumOS Playbooks API
  description: Block-based kanban where agents are first-class users.
  version: 0.0.0
tags:
- name: Playbooks
paths:
  /v1/orgs/{org_id}/playbooks:
    get:
      tags:
      - Playbooks
      summary: List Playbooks Endpoint
      description: List the org's Playbooks, newest first (keyset pagination). Admin/owner-only.
      operationId: list_playbooks_endpoint_v1_orgs__org_id__playbooks_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_PlaybookResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - IntegrationToken: []
    post:
      tags:
      - Playbooks
      summary: Create Playbook Endpoint
      description: 'Create a Playbook (§23.4). Admin/owner-only.


        The body''s ``steps`` (non-empty, each with a ``prompt_md``) and ``output_target``

        (``append_body`` | ``replace_body``) are validated — the schema rejects a

        malformed body with 422 before the service, which re-validates for parity with

        the MCP path. ``on_success_move_to`` is the column a card advances to on success.'
      operationId: create_playbook_endpoint_v1_orgs__org_id__playbooks_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/CreatePlaybookRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - IntegrationToken: []
  /v1/orgs/{org_id}/playbooks/{playbook_id}:
    get:
      tags:
      - Playbooks
      summary: Get Playbook Endpoint
      description: Fetch one Playbook. Admin/owner-only. Cross-org → ``404`` (no leak).
      operationId: get_playbook_endpoint_v1_orgs__org_id__playbooks__playbook_id__get
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      - name: playbook_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Playbook 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/PlaybookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - IntegrationToken: []
    patch:
      tags:
      - Playbooks
      summary: Update Playbook Endpoint
      description: 'Update a Playbook (§23.4). 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). ``steps`` / ``output_target``

        are re-validated.'
      operationId: update_playbook_endpoint_v1_orgs__org_id__playbooks__playbook_id__patch
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      - name: playbook_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Playbook 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/UpdatePlaybookRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - IntegrationToken: []
    delete:
      tags:
      - Playbooks
      summary: Delete Playbook Endpoint
      description: Delete a Playbook (§23.4). Admin/owner-only. Cross-org → ``404``.
      operationId: delete_playbook_endpoint_v1_orgs__org_id__playbooks__playbook_id__delete
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      - name: playbook_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Playbook 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: []
components:
  schemas:
    PlaybookResponse:
      properties:
        object:
          type: string
          title: Object
          default: playbook
        id:
          type: string
          format: uuid
          title: Id
        org_id:
          type: string
          format: uuid
          title: Org Id
        name:
          type: string
          title: Name
        steps:
          items: {}
          type: array
          title: Steps
        output_target:
          type: string
          title: Output Target
        on_success_move_to:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: On Success Move To
        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
      - name
      - steps
      - output_target
      - on_success_move_to
      - created_time
      - last_edited_time
      title: PlaybookResponse
    PaginatedResponse_PlaybookResponse_:
      properties:
        object:
          type: string
          title: Object
          default: list
        results:
          items:
            $ref: '#/components/schemas/PlaybookResponse'
          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[PlaybookResponse]
    CreatePlaybookRequest:
      properties:
        name:
          type: string
          title: Name
        steps:
          items: {}
          type: array
          title: Steps
        output_target:
          type: string
          title: Output Target
          default: append_body
        on_success_move_to:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: On Success Move To
      type: object
      required:
      - name
      - steps
      title: CreatePlaybookRequest
      description: Body for ``POST /v1/orgs/{org_id}/playbooks`` (§23.4).
    UpdatePlaybookRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        steps:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          title: Steps
        output_target:
          anyOf:
          - type: string
          - type: 'null'
          title: Output Target
        on_success_move_to:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: On Success Move To
      type: object
      title: UpdatePlaybookRequest
      description: 'Body for ``PATCH /v1/orgs/{org_id}/playbooks/{id}`` (§23.4).


        Every field is optional — a client sends only what it changes. Fields the client

        omits are left untouched (the router forwards only ``model_dump(exclude_unset=

        True)``, so an explicit ``null`` clearing ``on_success_move_to`` is

        distinguishable from an absent key).'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  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).'