API reference

CrawlDex API

Use the API to resolve what a user wants, inspect whether a website task is agent-doable, preflight the route before acting, and report redacted outcomes after the run.

OpenAPI JSON OpenAPI YAML

Contract OpenAPI machine-readable spec

Loop 4 calls resolve -> inspect -> preflight -> report

Evidence redacted no secrets or private data

Copy this

OpenAPI endpoint

GET /openapi.json

https://crawldex.com/openapi.json

Give this URL to an agent, SDK generator, API client, or documentation tool when it needs the full CrawlDex contract.

What it is for

Agent task reliability

Resolveturn a plain-English request into a canonical task keyGET

Inspectread scores, blockers, freshness, and success criteria for a taskGET

Preflightdecide whether an agent should proceed, keep a human present, or avoidPOST

Reportsubmit bounded, redacted outcome evidence after the attemptPOST

Before acting

Preflight a route

POST /api/v1/preflight

curl -sS -X POST https://crawldex.com/api/v1/preflight \
  -H "content-type: application/json" \
  -d '{
    "site": "example.com",
    "task": "subscriptions.cancel"
  }'

After acting

Report an outcome

POST /api/v1/runs

curl -sS -X POST https://crawldex.com/api/v1/runs \
  -H "content-type: application/json" \
  -H "x-crawldex-agent-key: $CRAWLDEX_AGENT_KEY" \
  -d '{
    "site": "example.com",
    "task": "subscriptions.cancel",
    "outcome": "success",
    "friction": [],
    "steps": 12,
    "duration_sec": 90
  }'

Do not submit passwords, cookies, payment data, private screenshots, or unredacted user content.

Endpoints

Common entry points

resolve intent inspect task categories JSON operating map account options