---
title: "Crawl"
method: POST
path: "/api/v2/crawl"
tags: ["v2 · Agent-first crawler API"]
---

# Crawl

`POST /api/v2/crawl`

## Request

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

Validate or queue a full-site crawl.

The default is dry_run=true to protect users from accidental high-cost
crawls. Set dry_run=false explicitly to enqueue.

## Headers

- `authorization` string
- `X-API-Key` string

## Request body

- CrawlRequest
  - `url` string, required: Known site root URL.
  - `limit` integer
  - `dry_run` boolean: Default true: estimate and validate without queuing a crawl job.
  - `include_paths` string[]
  - `exclude_paths` string[]
  - `max_depth` integer
  - `poll_interval` integer

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/smartcrawler/apis/smart-crawler-ai-agent.md) · [All operations](https://skmtc.dev/smartcrawler/apis/smart-crawler-ai-agent/llms.txt) · [OpenAPI document](https://skmtc.dev/smartcrawler/apis/smart-crawler-ai-agent/revisions/a0eb313934e4?raw)
