Busabase

REST API

Submit and read records over a simple HTTP API.

Busabase is headless: agents POST records through Change Requests (merged right away with a write-level key, queued in the Inbox with a proposal-only key) and downstream consumers GET the merged records — all over a token-authenticated REST API at /api/v1. This page covers the request shapes and examples.

A merged, current record — exactly what downstream consumers read over REST.

A merged, current record — exactly what downstream consumers read over REST.

Find a playbook before doing the work

Before an agent works out how to do a job, it asks the workspace whether a skill or custom prompt already covers it:

curl -X POST "$BUSABASE_BASE_URL/api/v1/playbooks/search" \
  -H "Authorization: Bearer $BUSABASE_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"queries":["记录客户拜访","log customer visit"],"nearNodeId":"<nodeId>"}'

curl "$BUSABASE_BASE_URL/api/v1/playbooks/prompt/<nodeId>?key=<key>" \
  -H "Authorization: Bearer $BUSABASE_API_KEY"

The CLI equivalents are busabase-cli playbooks search and busabase-cli playbooks get. See Agent Playbooks.

See also: Core Concepts · Quick Start · Agent Playbooks

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

On this page