{
  "info": {
    "name": "crawlcrawl",
    "description": "crawlcrawl HTTP API \u2014 30 endpoints. Set `api_key` and `base_url` in collection variables.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_postman_id": "crawlcrawl-2026-05"
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.crawlcrawl.com",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "crk_REPLACE_WITH_YOUR_KEY",
      "type": "string"
    },
    {
      "key": "run_id",
      "value": "1",
      "type": "string"
    },
    {
      "key": "page_id",
      "value": "1",
      "type": "string"
    },
    {
      "key": "key_prefix",
      "value": "crk_xxxxxxxx",
      "type": "string"
    },
    {
      "key": "monitor_id",
      "value": "1",
      "type": "string"
    },
    {
      "key": "run_id_new",
      "value": "2",
      "type": "string"
    }
  ],
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{api_key}}",
        "type": "string"
      }
    ]
  },
  "item": [
    {
      "name": "Health",
      "item": [
        {
          "name": "GET /v1/health",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/health",
            "auth": {
              "type": "noauth"
            }
          }
        },
        {
          "name": "GET /v1/ready",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/ready",
            "auth": {
              "type": "noauth"
            }
          }
        },
        {
          "name": "GET /v1/health/cloud",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/health/cloud"
          }
        },
        {
          "name": "GET /v1/cloud/balance",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/cloud/balance"
          }
        }
      ]
    },
    {
      "name": "Scan (synchronous, single URL)",
      "item": [
        {
          "name": "POST /v1/scan \u2014 full",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/scan",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\"\n}"
            }
          }
        },
        {
          "name": "POST /v1/scan \u2014 metadata only (fast)",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/scan",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"metadata_only\": true\n}"
            }
          }
        },
        {
          "name": "POST /v1/scan \u2014 only main content + include links",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/scan",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"only_main_content\": true,\n  \"include_links\": true\n}"
            }
          }
        },
        {
          "name": "POST /v1/scan \u2014 anti-bot via cloud",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/scan",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"cloud_mode\": \"unblocker\"\n}"
            }
          }
        },
        {
          "name": "POST /v1/scan/bulk",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/scan/bulk",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"urls\": [\"https://example.com\", \"https://example.org\"],\n  \"concurrency\": 4\n}"
            }
          }
        }
      ]
    },
    {
      "name": "Crawl (asynchronous, multi-page)",
      "item": [
        {
          "name": "POST /v1/crawls \u2014 start",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/crawls",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"max_pages\": 50,\n  \"depth\": 5,\n  \"respect_robots\": true,\n  \"webhook_url\": \"https://your.app/webhooks/crawl-done\"\n}"
            }
          }
        },
        {
          "name": "POST /v1/crawls \u2014 sitemap mode",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/crawls",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com/sitemap.xml\",\n  \"seed_kind\": \"sitemap\",\n  \"max_pages\": 200\n}"
            }
          }
        },
        {
          "name": "POST /v1/crawls \u2014 exclude paths",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/crawls",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"max_pages\": 100,\n  \"exclude_paths\": [\"/admin/.*\", \"/private/.*\"]\n}"
            }
          }
        },
        {
          "name": "POST /v1/crawls \u2014 recurring monitor (cron + diff webhook)",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/crawls",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://competitor.com/pricing\",\n  \"max_pages\": 1,\n  \"cron\": \"0 */6 * * *\",\n  \"webhook_url\": \"https://you.example.com/changes\",\n  \"webhook_events\": [\"crawl.diff_detected\"],\n  \"return_only_changed\": true\n}"
            }
          }
        },
        {
          "name": "GET /v1/crawls/{id}",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}"
          }
        },
        {
          "name": "DELETE /v1/crawls/{id}",
          "request": {
            "method": "DELETE",
            "url": "{{base_url}}/v1/crawls/{{run_id}}"
          }
        },
        {
          "name": "GET /v1/crawls/{id}/pages",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}/pages?limit=100"
          }
        },
        {
          "name": "GET /v1/crawls/{id}/pages?format=ndjson",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}/pages?format=ndjson&limit=10000"
          }
        },
        {
          "name": "GET /v1/crawls/{id}/pages?format=csv",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}/pages?format=csv"
          }
        },
        {
          "name": "GET /v1/crawls/{id}/links",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}/links"
          }
        },
        {
          "name": "GET /v1/crawls/{id}/orphans",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}/orphans"
          }
        },
        {
          "name": "GET /v1/crawls/{old}/diff/{new} \u2014 diff two runs",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crawls/{{run_id}}/diff/{{run_id_new}}"
          }
        }
      ]
    },
    {
      "name": "Pages",
      "item": [
        {
          "name": "GET /v1/pages/{id}?format=markdown",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/pages/{{page_id}}?format=markdown"
          }
        },
        {
          "name": "GET /v1/pages/{id}?format=full",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/pages/{{page_id}}?format=full"
          }
        },
        {
          "name": "GET /v1/pages/{id}?format=signals",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/pages/{{page_id}}?format=signals"
          }
        }
      ]
    },
    {
      "name": "Cloud passthrough (anti-bot)",
      "item": [
        {
          "name": "POST /v1/cloud/scrape",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/cloud/scrape",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"return_format\": \"markdown\",\n  \"chrome\": false\n}"
            }
          }
        },
        {
          "name": "POST /v1/cloud/crawl",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/cloud/crawl",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"limit\": 20\n}"
            }
          }
        },
        {
          "name": "POST /v1/cloud/search",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/cloud/search",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"query\": \"answer engine optimization\",\n  \"limit\": 10\n}"
            }
          }
        },
        {
          "name": "POST /v1/cloud/links",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/cloud/links",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"limit\": 100\n}"
            }
          }
        },
        {
          "name": "POST /v1/cloud/screenshot",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/cloud/screenshot",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\"\n}"
            }
          }
        }
      ]
    },
    {
      "name": "Self-serve account",
      "item": [
        {
          "name": "GET /v1/usage",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/usage"
          }
        },
        {
          "name": "GET /v1/usage/history?days=30",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/usage/history?days=30"
          }
        },
        {
          "name": "GET /v1/keys",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/keys"
          }
        },
        {
          "name": "POST /v1/keys/rotate",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/keys/rotate",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"label\": \"new key\",\n  \"grace_seconds\": 86400\n}"
            }
          }
        },
        {
          "name": "DELETE /v1/keys/{prefix}",
          "request": {
            "method": "DELETE",
            "url": "{{base_url}}/v1/keys/{{key_prefix}}"
          }
        },
        {
          "name": "GET /v1/webhook/secret",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/webhook/secret"
          }
        },
        {
          "name": "GET /v1/logs?limit=50",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/logs?limit=50"
          }
        }
      ]
    },
    {
      "name": "Utilities",
      "item": [
        {
          "name": "GET /v1/robots-policy?url=...",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/robots-policy?url=https://example.com"
          }
        },
        {
          "name": "POST /v1/llms-txt-build",
          "request": {
            "method": "POST",
            "url": "{{base_url}}/v1/llms-txt-build",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://example.com\",\n  \"max_pages\": 30,\n  \"site_name\": \"Example Inc\",\n  \"summary\": \"Brief tagline for the site\"\n}"
            }
          }
        }
      ]
    },
    {
      "name": "Monitors",
      "item": [
        {
          "name": "GET /v1/crons \u2014 list active monitors",
          "request": {
            "method": "GET",
            "url": "{{base_url}}/v1/crons"
          }
        },
        {
          "name": "DELETE /v1/crons/{id} \u2014 remove monitor",
          "request": {
            "method": "DELETE",
            "url": "{{base_url}}/v1/crons/{{monitor_id}}"
          }
        }
      ]
    }
  ]
}