Build on BidAuthor

Everything the dashboard does runs through this API — requirement extraction, grounded answer generation, exports. Versioned at /v1, documented below, changes are additive.

Keys

Mint at Settings → Developers in the dashboard. ba_live_… for production, ba_test_… for sandbox.

Conventions

Bearer auth, X-Workspace-ID on workspace-scoped calls, Idempotency-Key on mutations, typed error envelopes with stable error_codes.

For AI agents

Wiring an agent to respond to solicitations? The agents page covers what a key may do and how the surface is designed for machine callers.

Quickstart

1 · Create a chat

Mutations carry an Idempotency-Key and your workspace id — retries are safe by construction.

curl -X POST https://api.bidauthor.com/v1/chat \
  -H "Authorization: Bearer ba_live_..." \
  -H "X-Workspace-ID: <workspace-id>" \
  -H "Idempotency-Key: create-$(date +%s)" \
  -H "Content-Type: application/json" \
  -d '{"name": "Quickstart"}'

2 · Send a message (SSE stream)

The response streams server-sent events: message deltas, tool calls, and a terminal completion frame.

curl -N -X POST https://api.bidauthor.com/v1/chat/<chat-id>/messages \
  -H "Authorization: Bearer ba_live_..." \
  -H "X-Workspace-ID: <workspace-id>" \
  -H "Idempotency-Key: msg-$(date +%s)" \
  -H "Content-Type: application/json" \
  -d '{"content": "Summarize the documents in this workspace"}'

3 · Check the surface

Unauthenticated liveness probe — useful for SDK connectivity checks.

curl https://api.bidauthor.com/v1/health

Full API reference

Generated live from the OpenAPI spec — what you see here is exactly what the server enforces.

Ready to make your first call?

Create a free account, mint a test key, and run the quickstart against your own workspace.

Get an API key