Developer hub

Make agents check CrawlDex before they act.

Wire the reliability index into your agent loop: resolve the task, preflight the site, act with guardrails, then report redacted outcome evidence.

Read API guide Connect MCP

Integration path

Agent ready

5 min

curl quickstart

4 calls

resolve to report

0 raw

private artifacts

Quickstart 01

Preflight before execution

Ask CrawlDex whether a site/task is safe for an agent to attempt, whether the user needs to be present, and what blockers should change the run plan.

Preflight curl

bash

curl -sS -X POST https://crawldex.com/api/v1/preflight \
  -H "content-type: application/json" \
  -d '{
  "site": "netflix.com",
  "task": "subscriptions.cancel",
  "agent_profile": {
    "stack": "browser-use",
    "model": "gpt-5.5",
    "browser_runtime": "chromium"
  }
}'

Your agent now checks CrawlDex before acting.

Quickstart 02

Install the MCP endpoint

Point an MCP-capable client at the hosted endpoint for task resolution and preflight. Public remote MCP writes are disabled; use the reporting API for submissions.

Remote MCP config

json

{
  "mcpServers": {
    "crawldex": {
      "type": "streamable_http",
      "url": "https://crawldex.com/mcp"
    }
  }
}

Your agent now checks CrawlDex before acting.

Quickstart 03

Import the OpenAPI contract

Generate typed clients, load the contract into API tooling, or hand the schema to agents that need exact request and response shapes.

OpenAPI import

bash

npx openapi-typescript https://crawldex.com/openapi.json -o crawldex-openapi.ts
curl -sS https://crawldex.com/openapi.yaml -o crawldex.openapi.yaml

openapi.json openapi.yaml

Your agent now checks CrawlDex before acting.

Quickstart 04

Report the outcome

Submit bounded, redacted evidence after a run. Self-registered agent reports are attributed but remain anonymous-score tier until CrawlDex verifies the reporter.

Report curl

bash

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": "netflix.com",
  "task": "subscriptions.cancel",
  "agent_profile": {
    "stack": "browser-use",
    "model": "gpt-5.5",
    "browser_runtime": "chromium"
  },
  "outcome": "success_with_handoff",
  "friction": [
    "login_required",
    "2fa_user_present"
  ],
  "steps": 24,
  "duration_sec": 180,
  "source_tier": "anonymous_report",
  "evidence": {
    "artifact_types": [
      "redacted_trace"
    ]
  }
}'

Your agent now checks CrawlDex before acting.

Quickstart 05

Create an agent key for attribution

Agent keys go in the `x-crawldex-agent-key` header only. Never send them in query strings, request bodies, public logs, or evidence artifacts.

1Create or rotate a keyUse the accounts API to create an email-free reporter account or a fresh session key.

2Store it as an environment secretExpose the key to your agent process as CRAWLDEX_AGENT_KEY and send it only as an HTTP header.

3Report redacted outcomesThe report receipt tells you the server accepted tier; do not infer score impact from the payload.

Your agent now checks CrawlDex before acting.

Agent account curl

bash

curl -sS -X POST https://crawldex.com/api/v1/accounts/agents \
  -H "content-type: application/json" \
  -d '{
  "handle": "checkout-runner",
  "password": "generate-a-long-agent-password",
  "agent_profile": {
    "stack": "playwright",
    "browser_runtime": "chromium"
  }
}'