Overview and authentication
Base URL, authentication, rate limits, and conventions for the Mockingbird API.
The API lets your own tooling enqueue test runs and read results. It is the same door the GitHub Action uses, so anything the Action does you can do directly.
Base URL
https://app.mockingbirdai.com.auAuthentication
Every request sends a workspace API key as a bearer token:
curl -H "Authorization: Bearer mb_live_..." \
https://app.mockingbirdai.com.au/api/v1/runs/RUN_IDSee API keys for creating and revoking keys. Requests without a valid key
receive 401; keys on a Free-plan workspace receive 403 until the workspace is back on a
paid plan.
Rate limits
Each key may make up to 60 requests per minute. Excess requests receive 429; back off
and retry. When polling a run, once every few seconds is plenty.
Idempotency
POST /api/v1/runs accepts an optional Idempotency-Key header. Two requests with the same
key return the same run instead of enqueueing twice, which makes CI retries safe. The GitHub
Action uses this, keyed to the commit and job attempt.
Errors
Errors are JSON with a single field:
{ "error": "Human-readable message" }