Skip to content
Boomin Boomin Developers

Platform API

The Platform API is for server-side automation and coding agents.

Use it when you want an agent to create units, manage pages, inspect programs, or run safe platform smoke tests without giving it a full dashboard session.

Auth

Section titled “Auth”

Send a private platform token:

Authorization: Bearer sk_boomin_live_...

The API checks:

  • Token hash.
  • Token status.
  • Expiration.
  • Owning organization.
  • Required scope.

Current base URL

Section titled “Current base URL”

The CLI currently uses:

https://cloud.boomin.ai/api:xX_v8KtJ

Token management still uses the dashboard app API because creating, rotating, and revoking tokens requires a logged-in Boomin user. Private token execution uses the dedicated Platform API group above.

API reference

Section titled “API reference”

Open the interactive reference:

Section titled “Recommended agent smoke”
Terminal window
npx boominjs token create \
  --name "Agent Smoke" \
  --scopes org:read,units:read,units:create,units:delete


npx boominjs platform smoke --read-only --token sk_boomin_live_...
npx boominjs platform smoke --write --cleanup --token sk_boomin_live_...
npx boominjs platform smoke --all-scopes --cleanup --json

The all-scope smoke command exercises every registered V1 scope through POST /scopes_exec on the Platform API base. It is designed for agents: it proves the scope is enforceable, audited, and wired into the rate-limit/idempotency surface without requiring every product-specific CRUD surface to be used in the same smoke run.