---
title: "ScrapeGraphAI / Crawl website (start)"
description: "ScrapeGraphAI tool scrapegraphai-crawl-start on looot: input fields, $0.0024 per result, output shape, and code to run it with curl, JavaScript or Python."
sidebar:
  hidden: true
---

{/* Generated by scripts/generate-api-reference.mjs from data/api-reference.json. Do not edit. */}

Starts a crawl from url following links up to maxDepth (default 2), same domain unless allowExternal, converting each page to markdown. Returns a crawl id; poll ScrapeGraphAI / Crawl status, then read pages with ScrapeGraphAI / Crawl pages. maxPages 10-500 sets the price.

- **Tool id:** `scrapegraphai-crawl-start`
- **Provider:** [ScrapeGraphAI](/providers/scrapegraphai)
- **Job:** [Crawl web](/reference/jobs/web-crawl) (`web.crawl`)
- **Price:** $0.0024 per result. A call that fails at the provider costs $0.

## Inputs

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `allowedTypes` | array | yes | MIME types to accept; PDFs are excluded because they bill per page. Use ["text/html"]. |
| `allowExternal` | boolean | no |   |
| `excludePatterns` | array | no |   |
| `fetchConfig` | object | no | Fetch options (stealth is not offered: it adds 5 credits) |
| `formats` | array | yes |   |
| `includePatterns` | array | no |   |
| `maxDepth` | integer | no |   |
| `maxLinksPerPage` | integer | no |   |
| `maxPages` | integer | yes |   |
| `url` | string | yes |   |

## Output

The run's `result` holds the provider's answer. Signed in, `looot inspect scrapegraphai-crawl-start` prints its fields.

## Run it

Every call needs your API token in `LOOOT_TOKEN`; [Sign in](/get-started/sign-in#use-the-token-in-scripts-and-agents) shows how to get one. Each run also needs a new idempotency key, so a retry never pays twice. With `wait: 30` the answer comes back inline when the run ends within 30 seconds. Otherwise you get the running run back: poll `GET /v1/runs/<runId>`.

Example input with placeholder values:

<CodeGroup>

```bash curl
curl -X POST "https://api.looot.ai/v1/runs" \
  -H "Authorization: Bearer $LOOOT_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"endpointId":"scrapegraphai-crawl-start","input":{"url":"https://example.com","formats":[],"maxPages":1,"allowedTypes":[]},"wait":30}'
```

```js JavaScript
const response = await fetch("https://api.looot.ai/v1/runs", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LOOOT_TOKEN}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    endpointId: "scrapegraphai-crawl-start",
    input: {
      url: "https://example.com",
      formats: [],
      maxPages: 1,
      allowedTypes: [],
    },
    wait: 30,
  }),
});
const run = await response.json();
console.log(run.status, run.result);
```

```python Python
import os
import uuid

import requests

response = requests.post(
    "https://api.looot.ai/v1/runs",
    headers={
        "Authorization": f"Bearer {os.environ['LOOOT_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "endpointId": "scrapegraphai-crawl-start",
        "input": {
            "url": "https://example.com",
            "formats": [],
            "maxPages": 1,
            "allowedTypes": [],
        },
        "wait": 30,
    },
    timeout=90,
)
run = response.json()
print(run["status"], run.get("result"))
```

</CodeGroup>

To let looot pick among every provider of this job instead, send `job:web.crawl` as `endpointId`; see [the job page](/reference/jobs/web-crawl).
