API reference

One URL for the API description.

Where the Boita API lives for people and agents: the OpenAPI 3.1 document, the endpoint reference, TypeScript and Python SDKs, webhooks and the event stream.

OpenAPI 3.1 document: https://boita.io/openapi.json (this site, refreshed with every deploy) · https://api.boita.io/v1/openapi.json (live from the API)
Endpoint reference: /docs/api: every operation grouped by tag with parameters, schemas, scopes and examples in curl, TypeScript and Python. Version 1.0.0.
Base URL and auth: https://api.boita.io/v1; Authorization: Bearer boita_sk_… with a scoped workspace API key from the Developers page (Pro and above). Errors are { error: { code, message, details } }.
SDKs: npm install @boita/sdk (TypeScript) and pip install boita (Python), generated from the OpenAPI document; the developers page has install and usage.
Webhooks and events: Signed webhooks (HMAC-SHA256, retried) and a polling event stream at GET /workspaces/{ws}/events; the catalogue is on the developers page.
Workflow platforms: REST hooks for Zapier, Make and n8n; Slack and Teams apps on Studio and above. See integrations.
Machine-readable site: /llms.txt, /llms-full.txt, /sitemap.xml, /changelog.json.

Contact for API questions: support@boita.io.

Build on Boita.

API keys, webhooks and the SDKs are included from Pro. Create a sandbox workspace to try calls against throwaway data.

Open the developers page