---
title: "Queue up to 100 domains (500 on Agency/Network) for the same audit /api/v1/scan runs; worked at minutes 17 past each hour UTC; optional signed https webhook on completion"
method: POST
path: "/api/batch"
---

# Queue up to 100 domains (500 on Agency/Network) for the same audit /api/v1/scan runs; worked at minutes 17 past each hour UTC; optional signed https webhook on completion

`POST /api/batch`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/batch`
- Auth: one of:
  - API key in header `x-crawlcheck-key`
  - HTTP bearer

## Headers

- `x-crawlcheck-key` string, required

## Request body

- object
  - `domains` string[], required
  - `webhook` string, uri: https; receives batch.done signed x-crawlcheck-signature: sha256=HMAC-SHA256(key, body)

## Response `202`

{id, state, counts, rejected, next_window, url}

- object, nullable
  - `ok` boolean, nullable
  - `id` string, nullable
  - `state` string, nullable
  - `counts` object, nullable
    - `total` number, nullable
    - `queued` number, nullable
    - `done` number, nullable
    - `failed` number, nullable
  - `rejected` unknown[], nullable
    - unknown
  - `charged` number, nullable
  - `next_window` string, nullable
  - `url` string, nullable

## Other responses

- `400`: No valid domains or bad webhook
- `404`: No valid licence key
- `413`: Over the per-batch limit
- `429`: A batch is already running for this key

---

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