API reference - clickproof

The /api/v1 endpoints let any CI system or script do what the clickproof-ai/run-tests Action does: upload a build, run a project’s tests, and poll for the verdict.

Base URL

https://clickproof.app/api/v1

Until a custom domain is attached, use the Cloudflare Workers URL for your environment — the exact base URL is shown in Integrations → GitHub in the dashboard, already filled into the generated snippet.

Authentication

Every request is authenticated with a team API key in the Authorization header. See Authentication.

Authorization: Bearer cp_live_xxxxxxxxxxxx

Endpoints

Method	Path	Description
`POST`	`/projects/{id}/build`	Upload a build
`POST`	`/projects/{id}/runs`	Run tests
`GET`	`/runs/{id}`	Get a run

Errors

Errors return a JSON body with an error message and the appropriate status code.

Status	Meaning
`401`	Missing or invalid API key
`402`	Run quota exceeded for the current plan
`404`	Project or run not found (or not owned by your team)
`400`	Bad request — e.g. no build uploaded, or no tests to run

⌘I