Skip to content

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.

  • Product usage is documented under Guides.
  • REST base path: integrators and the web app MUST call /api/v1 (for example GET /api/v1/health). Unversioned /api/... routes return 404 not_found.
  • API authentication — organization-scoped API tokens (Authorization: Bearer) for CI and scripts; session cookies remain for the web app. The MCP endpoint additionally accepts OAuth 2.1 access tokens for interactive clients.
  • 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/mcp with 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.
TopicStatus
API authenticationAvailable
REST API reference (overview)Available
Interactive reference (v1)Available
MCP serverAvailable
MCP tool referenceAvailable
CI reporters / result uploadPlanned
Probara CLIPlanned

When each remaining capability ships, this section will include authentication steps, examples, and stable endpoint documentation generated from the shared Zod contracts in the monorepo.