BuildPulse
BuildPulse Platform API
The public REST API for BuildPulse CI analytics. Read your test submissions, per-run test results, flaky test inventory, per-test disruption history, and organization usage, and embed SVG flakiness and coverage badges. Read-only, token-authenticated, and described by an OpenAPI 3.1 spec.
Base URL
https://platform.buildpulse.ioAuthentication
Create an API token in BuildPulse under Organization Settings → API Tokens (shown once), then send it on every request. Tokens require an active plan with API access.
Authorization: Bearer bp_<64-hex>Authorization: token <token> is accepted as well for legacy clients.
Endpoints
| Method | Path | What it returns |
|---|---|---|
GET | /health | Liveness probe, no auth: {"status":"ok"}. |
GET | /api | Validates the token; 204 on success. |
GET | /api/me/organizations | Organizations the current token can scope requests to. |
GET | /api/me/repositories | Repositories the current organization can see. |
GET | /api/v1/usage | Current-month test-result usage against the plan limit; never rate-restricted. |
GET | /api/repos/{owner}/{name}/submissions | Recent CI runs (test result sets) for a repository, keyset-paginated. |
GET | /api/repos/{owner}/{name}/submissions/{submission_id}/tests | Per-test results for one CI run; status=failed for the red set. |
GET | /api/repos/{owner}/{name}/tests | Disruptive (flaky) tests for a repository, 14-day window, structured q= filter. |
GET | /api/tests/{id}/results | The last 10 disruption events for one test. |
GET | /api/v1/flaky/tests | Flaky test inventory (quarantined by default) with optional field expansion via include=. |
GET | /api/v1/flaky/badges | SVG flakiness badge for a repository. |
GET | /api/v1/coverage/badges | SVG coverage badge for a repository. |
POST | /webhooks/github | GitHub App webhook ingress (HMAC-verified). Not a customer-callable endpoint. |
Full parameters, response schemas, and worked examples are in the interactive API reference and the OpenAPI 3.1 spec.
For AI agents
The BuildPulse MCP server exposes this API as nine tools for
Claude, ChatGPT, Cursor, and any Model Context Protocol client. Hosted endpoint:
https://mcp.buildpulse.io/mcp (Streamable HTTP, OAuth). Stdio package:
npx -y @buildpulse/mcp. Machine-readable summaries of this API live at
/llms.txt and /llms-full.txt.
Links
- API referenceInteractive OpenAPI explorer
- MCP serverInstall in Claude, ChatGPT, Cursor, VS Code
- openapi.yamlOpenAPI 3.1 contract
- llms.txtShort index for LLMs
- llms-full.txtFull prose reference for LLMs
- docs.buildpulse.ioProduct guides and setup
- buildpulse.ioFlaky test detection, runners, coverage, engineering metrics
- PricingPlans with API and MCP access
- GitHub: buildpulse-mcpOpen-source MCP server
- support@buildpulse.ioQuestions and access requests