Base URL, conventions, versioning and the resources available.
The BrewMy{Code} REST API gives you programmatic access to everything in the platform.
Base URL: https://api.brewmycode.com/v1
Content-Type: application/json.kb_…, doc_…, qry_…, conv_…, agt_…, run_…, whk_….{ "amount": "1234.50", "currency": "EUR" }.{ "data": [...], "next_cursor": "..." }; see Pagination.| Resource | Purpose |
|---|---|
| Knowledge bases | Create and manage knowledge bases and sources |
| Documents | Upload, list, read and delete documents |
| Queries | Ask questions and receive cited answers |
| Conversations | Multi-turn context |
| Agents | Create, version, promote and trigger agents |
| Runs | Inspect runs, traces and approvals |
| Webhooks | Receive events |
The API is versioned in the path (/v1). Backwards-compatible additions (new fields, new endpoints) happen without a version change. Breaking changes ship as a new version and are announced in the changelog at least 60 days in advance; previous versions are supported for 12 months after a new version is released.
Requests are served from the region of your workspace. EU workspaces use api.brewmycode.com; dedicated deployments receive their own hostname.
Official SDKs: Python (pip install brewmycode) and TypeScript (npm install @brewmycode/sdk). A CLI, bmc, ships with the Python package.