Getting started
BidAuthor API
The BidAuthor API is the same surface the BidAuthor app runs on: create proposals from a solicitation's files, manage the documents Arthur writes from, ask Arthur questions, and follow the work as it happens. Every request goes to `https://api.bidauthor.com/v1` with an API key.
What you can build
| Domain | What it covers |
|---|---|
| Proposals | A pursuit from the buyer's files to an exported response: package, items, tasks, volumes, sections, versions and exports. Mounted under /v1/rfp. |
| Documents | Your knowledge base: upload files or text, organize them into categories, read their status. |
| Chat | Conversations with Arthur, streamed or answered in one call. |
| Runs | Every piece of background work, with its live stream, context and cancellation. |
| Workspaces and categories | How documents and proposals are grouped inside an organization. |
| Webhooks | Signed callbacks when work finishes. |
| Organization, API keys and billing | Members, invitations, keys, credits and the subscription. |
The API reference lists every endpoint, generated from the live schema at https://api.bidauthor.com/v1/openapi.json.
Conventions
- Base URL:
https://api.bidauthor.com/v1. Every path in these docs is relative to it. - Authentication:
Authorization: Bearer <key>on every call exceptGET /v1/health. See Authentication. - Writes:
POST,PUT,PATCHandDELETEaccept anIdempotency-Keyheader; retries with the same key return the original response. Operations that spend credits require one. - Errors: a JSON envelope with a stable
error_code. Branch on the code, never on the message. See Errors. - Times are ISO-8601 in UTC. IDs are UUIDs.
Naming
Proposal routes live under /v1/rfp/…, the product's original name for a pursuit. The paths are stable; a rename to /v1/proposals/… is planned and will be announced here first.