BuildPulse BuildPulse

BuildPulse Platform API reference

Public REST API for BuildPulse: faster, cheaper CI runners for GitHub Actions, CircleCI and Semaphore, with Test Intelligence built in (flaky-test detection, coverage and CI metrics). Base URL https://platform.buildpulse.io. Every endpoint except /health takes Authorization: Bearer bp_<64-hex> (an API token from Organization Settings → API Tokens; needs a paid Test Intelligence plan or a paid runner subscription). Spec: openapi.yaml. For agents: MCP server, llms.txt, llms-full.txt.

Endpoints at a glance
  • GET /api/v1/runners/usage: runner jobs, minutes, cost, free minutes, p50/p90 duration, queue wait and savings vs GitHub list price; totals plus a per-size breakdown (?from=&to=, default 30 days, max 90).
  • GET /api/v1/runners/configs: the runner sizes and runs-on labels the organization has configured.
  • GET /api/v1/runners/status: whether runners are activated, billing mode, and how to start (3,000 free minutes a month) when they are not.
  • GET /health — Liveness probe, no auth.
  • 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 failures.
  • GET /api/repos/{owner}/{name}/tests — Disruptive (flaky) tests for a repository over the last 14 days, with a 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.
  • GET /api/v1/action/test-status: flaky and quarantined test names for one repository, used by the GitHub Action's job summary; every plan, not counted as API usage.
  • POST /webhooks/github — GitHub App webhook ingress (HMAC-verified); not customer-callable.