Skip to content

API

Programmable audits, crawls and tools. Every response includes x-credits-charged and x-credits-remaining. Errors are { error: { code, message, docs_url } }. Cursor pagination, never offset. Spec: /v1/openapi.json.

Auth

Authorization: Bearer cw_live_… Keys live at /account/api. Using this from an agent? Start at /agents. Free and Starter cannot create keys; Pro is $14.99/mo.

Errors

Every error is { error: { code, message, docs_url } }. Rate limits return 429 with Retry-After.

Credits

Headers x-credits-charged and x-credits-remaining are on every response. POST /v1/estimate never charges and never creates a job.

Webhooks

HMAC-SHA256 over id.timestamp.body, headers webhook-id, webhook-timestamp, webhook-signature: v1,<base64>. Same scheme as Dodo.

Paths

PathMethods
/v1/auditsPOST, GET
/v1/audits/{id}GET
/v1/crawlsPOST
/v1/crawls/{id}GET
/v1/crawls/{id}/pagesGET
/v1/crawls/{id}/linksGET
/v1/sitesGET, POST
/v1/sites/{id}GET, PATCH
/v1/tools/ai-crawlersPOST
/v1/tools/schema-validatePOST
/v1/tools/vitalsPOST
/v1/creditsGET
/v1/estimatePOST
/v1/openapi.jsonGET