Start a run

Groups a CI job or an agent session as one run, with a report for a pull request. Send its id in the Proxy-Mail-QA-Run header of later calls and each adds what it saw: addresses made, emails that arrived and how long after since, the code, a link's site and path (never its query or anything that looks like a token), email checks, counts, and emails that never came or came when none should. Then finish it. Runs are kept 90 days, and the project's people can open them in the app. The GitHub Action (https://proxymail.qa/docs/ci) does all of this for you.

post/v1/runs

Request

Base URL: https://api.proxymail.qa
URL: https://api.proxymail.qa/v1/runs
Auth: HTTP bearer

Request body

namestring

source'ci' | 'agent' | 'api'

Where it runs. Default: agent for keys from an MCP sign-in, api for the rest.

Example request

{
  "name": "Sign-up tests",
  "meta": {
    "repository": "acme/web",
    "agent": "Claude Code"
  }
}

Response

The run

idstring uuid

namestring

source'ci' | 'agent' | 'api'

status'running' | 'passed' | 'failed'

metaobject

started_atstring date-time

finished_atstring date-time nullable

urlstring uri

The run in the app.

Changes

No recorded changes to this operation across all 1 revision of this API.