Quickstart
Create an API key, check who it acts as, upload a document, start a proposal from a solicitation, and ask Arthur about it. Each step is one call.
1. Create a key
Email support@bidauthor.com from an owner's address to have your organization's first key issued, with the scopes you need (documents:write, rfp:write and agent:invoke cover this guide). Further keys can be minted from code with POST /api-keys. The secret starts with ba_live_ and is shown once.
2. Check the key
GET /me returns the organization, key and user the key acts as.
3. Pick a workspace
Reads default to the organization's default workspace. A key that spans the organization must name a workspace on every write with X-Workspace-ID; a key bound to one workspace always writes there.
4. Upload a document
Documents are what Arthur writes from. The file is indexed in the background; poll GET /documents/{document_id} until processing_status is complete.
5. Start a proposal
Send the solicitation's files. Each file's kind is guessed from its name and corrected once its text is read; the response returns the proposal id at once.
Follow progress with GET /rfp/proposals/{proposal_id}: read_state reports the reading, and items and tasks fill in as requirements are found.
6. Ask Arthur
Create a chat, then send a message and wait for the answer. For long runs, use the streaming route POST /chat/{chat_id}/messages instead.
The response holds the persisted assistant_message, the run_id of the work Arthur did, and terminal, the reason the run stopped.
Next
- Authentication: key types, scopes and headers.
- Errors: the error envelope and every code.
- API reference: every endpoint with its parameters and examples.