---
title: "Start Crawl"
method: POST
path: "/v1/crawl"
tags: ["Crawler"]
---

# Start Crawl

`POST /v1/crawl`

## Request

- Base URL: `https://api.scrapegraphai.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.scrapegraphai.com/v1/crawl`
- Auth: none declared

Start a new crawl job.

## Request body

- CrawlJob
  - `url` string, required
  - `depth` integer
  - `breadth` integer, nullable: Maximum number of links to crawl per depth level. If None, unlimited (default). Ignored when sitemap=True.
  - `max_pages` integer, nullable
  - `prompt` string, nullable
  - `schema` object, nullable
  - `rules` CrawlJobRules
    - `exclude` string[], nullable
    - `include_paths` string[], nullable: List of path patterns to include (e.g., ['/products/*', '/blog/*']). If empty, all paths are included.
    - `exclude_paths` string[], nullable: List of path patterns to exclude (e.g., ['/admin/*', '/api/*']). Takes precedence over include_paths.
    - `same_domain` boolean, nullable
  - `sitemap` boolean
  - `render_heavy_js` boolean
  - `extraction_mode` boolean
  - `stealth` boolean: Enable stealth mode to avoid bot detection
  - `mock` boolean
  - `webhook_url` string, nullable: Webhook URL to send the job result to
  - `reader_mode` boolean
  - `wait_ms` integer
  - `country_code` string, nullable: The country code to use for fetching (e.g. US, GB)

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api.md) - [All operations](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api/revisions/a0e42195429f?raw)