Orbit Blocks API
Block vocabulary — composable UI + workflow units to discover and configure
Block vocabulary — composable UI + workflow units to discover and configure
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-blocks-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 Blocks API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Blocks
description: Block vocabulary — composable UI + workflow units to discover and configure
paths:
/api/v1/blocks:
get:
parameters:
- in: query
name: q
required: false
schema:
type: string
description: Natural-language BM25 query, e.g. `"button"`, `"send webhook"`. Omit for plain browse + filter.
- in: query
name: kind
required: false
schema:
type: string
enum:
- component
- node
- integration
- database
- action
- trigger
description: Block kind. `component` is a UI primitive; `node` / `integration` / `database` are workflow units; `action` / `trigger` are the operations an integration provides.
- in: query
name: node
required: false
schema:
type: string
description: Restrict to the actions/triggers of one node, e.g. `github`.
- in: query
name: category
required: false
schema:
type: string
description: Restrict to a palette category, e.g. `forms`, `layout`.
- in: query
name: limit
required: false
schema:
type: integer
minimum: 1
maximum: 100
description: Max rows returned. 1–100, default 20.
- in: query
name: offset
required: false
schema:
type: integer
minimum: 0
description: Result offset for pagination. Default 0.
responses:
'200':
description: Matching blocks in the slim search shape.
content:
application/json:
schema:
title: BlockList
description: List envelope. `limit` and `offset` echo the query; v1 omits a total count — detect end-of-results when `data.length < limit`.
type: object
properties:
data:
type: array
items:
title: BlockMatch
description: Slim search hit. Read the full spec via GET /blocks/{slug}.
type: object
properties:
slug:
description: URL-safe handle, unique within its kind. The path param on GET /blocks/{slug}.
type: string
kind:
description: Block kind.
type: string
title:
description: Human-readable display name.
type: string
description:
description: One-line summary for tooltips and ranking.
type: string
node:
description: Owning node slug for `action` / `trigger` blocks, e.g. `github`.
type: string
required:
- slug
- kind
- title
- description
additionalProperties: false
limit:
type: integer
offset:
type: integer
required:
- data
- limit
- offset
additionalProperties: false
tags:
- Blocks
summary: Search and browse the block vocabulary
description: 'Returns the blocks the caller can reach.
Search semantics:
• Pass `q` for BM25 full-text ranking across title, slug, description, and keywords.
• Omit `q` to plain-browse with `kind`/`node`/`category` filters.
• Combine `q` with filters to scope the search.
Use `?node=&kind=action` to list one integration''s actions.
Pagination is offset-based; the response omits a total count. Detect end-of-results when `data.length < limit`.'
operationId: getApiV1Blocks
x-operation-id-source: derived
/api/v1/blocks/{slug}:
get:
parameters:
- in: path
name: slug
required: true
schema:
type: string
description: The block's kebab-case slug, from a previous search hit.
responses:
'200':
description: The block.
content:
application/json:
schema:
title: Block
description: A composable unit — UI component or workflow node/integration/action.
type: object
properties:
description:
description: Tagline plus 1–2 prose sentences.
type: string
category:
description: Palette category, e.g. `forms`, `layout`.
type: string
anatomy:
description: Compound-component grammar — sub-parts and their composition rules. {} for atomic blocks.
type: object
additionalProperties: {}
slug:
description: URL-safe handle, unique within its kind.
type: string
node:
description: Owning node slug for `action` / `trigger` blocks.
type: string
component:
description: React renderer dispatch key in PascalCase, e.g. `Button`. Absent for non-renderable blocks.
type: string
title:
description: Human-readable display name.
type: string
kind:
description: Block kind.
type: string
body:
description: 'Kind-specific extras: component nesting/defaults; action outputs/annotations. {} when none.'
type: object
additionalProperties: {}
props:
description: The block's prop surface — a vector of setter descriptors (or a JSON-Schema map for some kinds). [] / {} when it has none.
anyOf:
- type: array
items: {}
- type: object
additionalProperties: {}
required:
- slug
- kind
- title
- description
- props
- anatomy
- body
additionalProperties: false
'404':
description: No block matches the slug.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Blocks
summary: Get one block
description: Reads the full block for the slug in the path — `props` (JSON Schema), `anatomy` (compound-part grammar), and `body` (nesting/defaults for components, outputs/annotations for actions).
operationId: getApiV1BlocksBySlug
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