Orbit Boards API
Exploration boards — an app's cycles, and the board tools an agent draws with
Exploration boards — an app's cycles, and the board tools an agent draws with
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/orbitapps-io:orbitapps-io-boards-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: Orbit Apps Boards API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Boards
description: Exploration boards — an app's cycles, and the board tools an agent draws with
paths:
/api/v1/boards/{id}/tools/{name}:
post:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
- in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
additionalProperties: {}
- type: 'null'
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data: {}
attachments:
description: The kept screenshots, as artifact references.
type: array
items:
type: object
additionalProperties: {}
preview:
description: 'draw_artboard only: the browser check''s first screenshot, base64 in `data`.'
type: object
properties:
mime_type:
type: string
data:
type: string
required:
- mime_type
- data
additionalProperties: false
required:
- data
additionalProperties: false
tags:
- Boards
summary: Run a board tool
description: 'Run one board tool on a cycle, as Explorer runs it, with the JSON body as the tool''s arguments. Each write takes a request_id (a new UUID per change, the same one on retry) and the revision of the node it changes. Tools: create_cards, draw_artboard, read, read_board, read_skill, read_theme, update_node, write_plan. Read the draw-artboards and datastar-artboards skills with read_skill before the first artboard. No agent runs: the caller''s own model does the work.'
operationId: postApiV1BoardsByIdToolsByName
x-operation-id-source: derived
/api/v1/boards/{id}/preview.png:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The PNG.
'404':
description: No such board, or a cycle with no cards.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'503':
description: No screenshot service is configured.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Boards
summary: Picture a board cycle
description: 'A PNG of the whole cycle: every card where it stands, each drawn finding with its newest artboard, each note with its words, and each row''s name. A wide or tall cycle is shown smaller. Requires read:app.'
operationId: getApiV1BoardsByIdPreviewPng
x-operation-id-source: derived
/api/v1/apps/{app_id}/boards:
get:
parameters:
- in: path
name: app_id
required: true
schema:
type: string
format: uuid
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
title: Board
description: One cycle of an app's exploration board.
type: object
properties:
id:
type: string
format: uuid
app_id:
oneOf:
- type: string
format: uuid
- type: 'null'
title:
oneOf:
- type: string
- type: 'null'
cycle:
description: The cycle's number, counted from 1.
oneOf:
- type: integer
- type: 'null'
root_node_id:
description: The cycle's BoardRoot.
oneOf:
- type: string
format: uuid
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- app_id
- title
- cycle
- root_node_id
- created_at
- updated_at
additionalProperties: false
required:
- data
additionalProperties: false
tags:
- Boards
summary: List the app's board cycles
description: Every live cycle of the app's exploration board, in the order they were worked.
operationId: getApiV1AppsByAppIdBoards
x-operation-id-source: derived
post:
parameters:
- in: path
name: app_id
required: true
schema:
type: string
format: uuid
responses:
'201':
content:
application/json:
schema:
title: Board
description: One cycle of an app's exploration board.
type: object
properties:
id:
type: string
format: uuid
app_id:
oneOf:
- type: string
format: uuid
- type: 'null'
title:
oneOf:
- type: string
- type: 'null'
cycle:
description: The cycle's number, counted from 1.
oneOf:
- type: integer
- type: 'null'
root_node_id:
description: The cycle's BoardRoot.
oneOf:
- type: string
format: uuid
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- app_id
- title
- cycle
- root_node_id
- created_at
- updated_at
additionalProperties: false
tags:
- Boards
summary: Start a new board cycle
description: Create an empty cycle after the app's last one. Requires write:app.
operationId: postApiV1AppsByAppIdBoards
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: opaque
description: 'An Orbit api token, sent as `Authorization: Bearer <token>`.
Mint one with the RFC 8628 device-authorization grant (`POST /api/v1/device/code`, then poll `POST /api/v1/device/token`), or from Studio.
Every token carries a scope set from the `[verb resource]` RBAC catalog — `read:app`, `write:deployment`, `manage:secret`, and so on. The full vocabulary is published as `scopes_supported` at `/.well-known/oauth-protected-resource` (RFC 9728) and `/.well-known/oauth-authorization-server` (RFC 8414). Grant an agent the narrowest set that does its job.'
externalDocs:
description: Full documentation
url: https://docs.orbitapps.io
x-id:
- reitit.openapi/default