REST API endpoint reference.
The Crawlux REST API ships Q4 2026. Below: the planned endpoint surface, request/response shapes and authentication patterns. Subject to refinement during the early access period. Base URL: https://api.crawlux.com/v1/.
// Status
Q4 2026 ship date, early access opens 2 weeks before.
The API is not live today. Audits currently run via the Crawlux web dashboard with JSON output downloadable per audit (see audit JSON reference) and optional webhook callbacks on completion (see webhooks reference). The REST API will allow programmatic audit triggering, status polling, result retrieval and webhook configuration. Email [email protected] with subject "API Waitlist" to join early access.
// Section 01 · Audit endpoints
Trigger, retrieve and list audits.
/auditsTrigger a new audit for a domain. Returns the audit_id and initial status. Audit runs asynchronously; poll GET /audits/{audit_id} or configure a webhook for completion.
Body: domain (required), tier (free/pro/team, defaults to account tier), webhook_url (optional, overrides default webhook).
/audits/{audit_id}Retrieve a specific audit by ID. Returns the full audit JSON if completed, or a status object (queued, running, failed) if not yet complete.
Response: full audit JSON or status envelope. Schema documented in the audit JSON reference.
/auditsList all audits in your workspace. Supports pagination via limit and cursor parameters. Filter by status, domain, date range. Returns audit summaries (audit_id, domain, score, completed_at) not full JSON.
Query: limit (default 50, max 200), cursor, status, domain, completed_after, completed_before.
/audits/{audit_id}/findingsRetrieve only the findings array for an audit. Lighter response than the full audit JSON. Useful for surfacing specific findings in dashboards without loading the full audit context.
/audits/{audit_id}/pdfDownload the white-label PDF report (Pro and Team tiers only). Returns a signed URL valid for 60 minutes. Free tier audits do not have PDF reports.
// Section 02 · Webhook endpoints
Configure and manage webhooks programmatically.
/webhooksConfigure a webhook endpoint. Body: url (required), events (array of audit.completed, audit.failed, audit.retried), secret (auto-generated if omitted, used for HMAC signature).
/webhooks/{webhook_id}Remove a webhook configuration. Subsequent audit completions will not POST to the removed webhook URL. Existing audits are not affected.
/webhooksList all configured webhooks in your workspace. Returns webhook_id, url, events array and created_at (does not return the signing secret).
// Section 03 · Account endpoints
Usage and account state.
/usageRetrieve current period usage. Returns audits used this period, audits remaining, period reset date and tier limits. Useful for usage dashboards and quota-aware automation.
// Section 04 · Example request
Trigger an audit and poll for completion.
# 1. Trigger a new audit
curl -X POST https://api.crawlux.com/v1/audits \
-H "Authorization: Bearer crl_live_8f3k29vJ7nQa4b8c92eP3kqM" \
-H "Content-Type: application/json" \
-d '{"domain": "example-protocol.io", "tier": "team"}'
# Response: 202 Accepted
# {"audit_id": "aud_8f3k29vJ7nQ", "status": "queued", "estimated_completion": "2026-04-29T08:17:00Z"}
# 2. Poll for completion (or use a webhook instead)
curl https://api.crawlux.com/v1/audits/aud_8f3k29vJ7nQ \
-H "Authorization: Bearer crl_live_8f3k29vJ7nQa4b8c92eP3kqM"
# Response: 200 OK with full audit JSON (see /docs/audit-json/)// Related docs
Where to go from here.
- Authentication — Bearer token format and test vs live keys
- Rate limits — per-tier quotas and rate-limit headers
- Error reference — full error code catalog
- SDKs — Node and Python typed wrappers
Run a free audit and download the JSON
The fastest way to evaluate the audit JSON for integration: run a real audit on your own domain and inspect the output. Free first audit per domain.
JSON output live · Webhooks live · API Q4 2026 · 2-week early access window