Developer documentation
Automate Probara: call the public REST API from CI and scripts, or connect an MCP client so an AI agent can operate projects, suites, cases, runs, and defects directly. Every mutating API operation is gated by an organization permission — a viewer receives 403 forbidden on every write, and some writes (such as creating a project) require an owner/admin role.
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 scripts, and organization app tokens for reporting from CI; session cookies remain for the web app. The MCP endpoint additionally accepts OAuth 2.1 access tokens for interactive clients. - CI integrations — report test results from any CI with an app token (paid plans): choose between the CLI and the Playwright, Jest, Cypress, Vitest and Cucumber reporters.
- CLI — report JUnit XML results from any CI with
@probara/cli. - Playwright reporter — send every Playwright attempt, with its steps and attachments, with
@probara/playwright-reporter. - Jest reporter — send every Jest attempt, with its steps, attachments and links, and run only the tests of a Probara run, with
@probara/jest-reporter. - Cypress reporter — send every Cypress attempt, with its steps, its failure screenshots and links, and run only the tests of a Probara run, with
@probara/cypress-reporter. - Vitest reporter — send every Vitest attempt and repeat, with its steps, attachments and links, and run only the tests of a Probara run, with
@probara/vitest-reporter. - REST API reference — overview (base URL, errors, pagination).
- Interactive API reference (v1) — OpenAPI 3.1 viewer.
- MCP server — connect any MCP-compatible client (Claude.ai, Claude Code, Cursor, ChatGPT) to
https://app.probara.net/mcpwith OAuth 2.1 or an API token. - MCP tool reference — the full generated list of every tool the server exposes, regenerated from the worker registry so it never drifts.
- SCIM provisioning — the SCIM 2.0 endpoint an identity provider calls to provision people and groups, on the Enterprise plan.
- Markdown for agents — every guide and developer page is also served as plain Markdown: replace the trailing slash with
.md(for example/en/developers/authentication.md)./llms.txtlists them all, so a coding agent can read the docs without parsing HTML.
Topic status
Section titled “Topic status”| Topic | Status |
|---|---|
| API authentication | Available |
| REST API reference (overview) | Available |
| Interactive reference (v1) | Available |
| MCP server | Available |
| MCP tool reference | Available |
| CI reporters / result upload | Available |
| Probara CLI | Available |
| SCIM provisioning (Enterprise plan) | Available |
When a new capability ships, this section adds its authentication steps, examples, and stable endpoint documentation generated from the shared Zod contracts in the monorepo.