---
title: "Start Crawl"
method: POST
path: "/api/v1/crawl"
---

# Start Crawl

`POST /api/v1/crawl`

## Request

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

Crawl a site once, without making a project for it.

The crawl is a project underneath -- hidden, kept for a day, with the
same sitemap reading, ladder, scope rules and formats a project run
has -- so `POST /crawl/{id}/keep` turns this one job into a watched
project with its pages and its first run already in place. Answers
202 with the id to poll at `GET /crawl/{id}`; `webhook` is told
instead.

## Headers

- `authorization` string, nullable
- `x-mesharc-tenant` string, nullable

## Request body

- CrawlRequest
  - `url` string, required
  - `limit` integer, nullable
  - `maxDepth` integer, nullable
  - `includePaths` string[], nullable
  - `excludePaths` string[], nullable
  - `allowSubdomains` boolean, nullable
  - `useSitemap` boolean, nullable
  - `sitemapMode` string, nullable
  - `crawlMode` string, nullable
  - `maxAge` integer, nullable
  - `maxTier` string, nullable
  - `delay` integer, nullable
  - `concurrency` integer, nullable
  - `respectRobots` boolean, nullable
  - `scrapeOptions` object, nullable
  - `webhook` union
    - object
    - string
  - `config` object, nullable
  - `destination` string, nullable

## Response `202`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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