---
title: "Crawl a site to Markdown (async job)"
method: POST
path: "/v1/crawl"
---

# Crawl a site to Markdown (async job)

`POST /v1/crawl`

## Request

- Base URL: `https://shotlane.dev`
- URL: `https://shotlane.dev/v1/crawl`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `access_key`

## Request body

- object
  - `url` string, required
  - `limit` integer
  - `max_depth` integer
  - `include` string[]
  - `exclude` string[]
  - `include_subdomains` boolean
  - `sitemap` boolean
  - `respect_robots` boolean
  - `webhook_url` string

## Response `202`

Job started

## Other responses

- `400`: Invalid parameters
- `401`: Invalid API key
- `402`: Out of credits
- `422`: Page could not be rendered

---

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