OpenAPI Reference

Busabase publishes a complete OpenAPI specification generated directly from its contracts. Use it to explore every endpoint, generate clients, or import into Postman and Insomnia.

The OpenAPI tab — interactive REST docs and the JSON spec for code generation.

See also: Core Concepts · Quick Start

Connect over HTTP

No Busabase client needs to be installed. Create a read API key, set BUSABASE_API_KEY and BUSABASE_SPACE_ID in your environment, and verify the connection:

curl https://busabase.com/api/v1/auth \
  -H "Authorization: Bearer $BUSABASE_API_KEY" \
  -H "x-busabase-space: $BUSABASE_SPACE_ID"

Confirm the returned account and workspace before doing work. For a local or self-hosted instance, use your server's base URL and its authentication requirements.

• Browse the generated API reference for endpoint parameters and response schemas.
• Download the OpenAPI JSON to generate a client or import it into Postman or Insomnia.
• Read the REST API guide for request examples.

Other ways to connect: Integration overview · CLI · SDK · MCP · OpenAPI / REST · Agent Skills · Webhooks