API

The API behind the deploy check and the MCP tools. Every request needs Authorization: Bearer pc_live_…, a key from API and integrations.

Base address: https://www.pagecanary.com/api/v1

Walk a site's main flow

curl -X POST https://www.pagecanary.com/api/v1/walks \
  -H "Authorization: Bearer pc_live_…" -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Returns 202 with walk.id. Add "vercelBypassSecret": "…" for a protected Vercel preview; it's sent only to that site and never stored.

curl https://www.pagecanary.com/api/v1/walks/WALK_ID -H "Authorization: Bearer pc_live_…"

Poll until walk.status is done (or error). A done walk has:

• result: passed, failed, cant-test (a captcha, a login, nothing found) or planned (a form found and filled in, never sent)
• headline and detail: what happened, in plain words
• steps: what the agent did, with at in seconds into the recording
• videoUrl and screenshots

Check a page

curl -X POST https://www.pagecanary.com/api/v1/checks \
  -H "Authorization: Bearer pc_live_…" -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/pricing"}'

Returns check.problems: each with level, title, details and fix. About 20 seconds.

Limits

Free during the beta: 10 walks and 50 page checks per account per day, shared by all of the account's keys. Over the limit, or when the queue is full, the API answers 429 with a message saying why.