Developer documentation
This section is for automation: uploading results from CI, calling a public REST API, using a CLI, or connecting an MCP client.
Available today
Section titled “Available today”- Product usage is documented under Guides.
- REST base path: integrators and the web app MUST call
/api/v1(for exampleGET /api/v1/health). Unversioned/api/...routes return404 not_found. - API authentication — organization-scoped API tokens (
Authorization: Bearer) for CI and scripts; session cookies remain for the web app. - REST API reference — overview (base URL, errors, pagination).
- Interactive API reference (v1) — OpenAPI 3.1 viewer.
Topic status
Section titled “Topic status”| Topic | Status |
|---|---|
| API authentication | Available |
| REST API reference (overview) | Available |
| Interactive reference (v1) | Available |
| CI reporters / result upload | Planned |
| Probara CLI | Planned |
| MCP server | Planned |
When each capability ships, this section will include authentication steps, examples, and stable endpoint documentation generated from the shared Zod contracts in the monorepo.