API overview
The Pie API is served from https://api.pie.inc under /v1/ and authenticates with an API key in the X-API-Key header. These are the endpoints customers call most. For every operation and schema, see the interactive API reference.
Most of these also have an MCP tool. See MCP tools. For headers, the response envelope and sign-in errors, see Authentication and Error codes.
Loops
| Method and path | What it does | Notes |
|---|---|---|
POST /v1/loops/trigger | Runs a web Loop from CI/CD | The JSON body names the Loop with scheduleId. For a mobile app, upload the build with POST /v1/app/builds/loop instead. See Trigger from CI. |
Builds
| Method and path | What it does | Notes |
|---|---|---|
POST /v1/app/builds | Uploads a new build | For mobile apps. See Prepare mobile builds. |
POST /v1/app/builds/loop | Uploads a mobile build and runs it through a Loop | Multipart upload. The Loop fires once the build verifies. |
POST /v1/app/builds/code-review | Uploads a build scoped to a pull request or merge request | See Test PRs. |
POST /v1/app/builds/coverage-scan | Uploads a mobile build and triggers a coverage scan after verification | See Coverage scans. |
To list builds or check a build’s verification status, use GET /v1/builds and GET /v1/builds/{buildID} in the full reference.
Coverage scans
| Method and path | What it does | Notes |
|---|---|---|
POST /v1/coverage-scans | Triggers a full coverage scan | Any member can start a scan, and Pie reviews it. See Run a coverage scan. |
Runs
| Method and path | What it does | Notes |
|---|---|---|
POST /v1/runs | Creates a new test run | |
POST /v1/runs/custom | Creates a custom run from test cases you pick plus new ones | |
POST /v1/test-executions | Executes specific test cases | |
GET /v1/runs | Lists the history of test runs | |
GET /v1/runs/{runId} | Returns one run with its execution and suite configuration | |
GET /v1/runs/progress | Returns a run’s progress | Poll it to see whether a run has finished. |
Findings, issues and test cases
| Method and path | What it does | Notes |
|---|---|---|
PATCH /v1/findings | Approves or rejects findings in bulk | |
PATCH /v1/issues | Rejects or dismisses issues in bulk | Use it for bulk triage. You can reject issues, not approve them. |
PATCH /v1/test-cases | Updates test cases in bulk | |
GET /v1/issues/{issueId}/repro-history | Returns an issue’s verification history | Summarizes whether a fix holds, using the issue’s repro test when one exists. |
Everything else
The full reference also covers apps, test cases, test suites, key features, results, scripts, credentials and the build list. Credential endpoints never return passwords. The pages for credentials and execution scripts name the endpoints they use.
Last updated on