CrawlCheck Batch API
The Batch API from CrawlCheck — 2 operation(s) for batch.
The Batch API from CrawlCheck — 2 operation(s) for batch.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-batch-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Crawlcheck Io Batch API
version: '1'
contact:
name: CrawlCheck
url: https://crawlcheck.io/policy
email: hello@crawlcheck.io
license:
name: Terms
url: https://crawlcheck.io/policy
x-core-contract:
promise: 'These operations are the core contract. They stay at /api/v1 and keep answering for at least 180 days after any /api/v2 is announced; their stable fields change only in a new major version, and their provisional fields only after 30 days'' notice, per /docs/api/compatibility. Verifying what they return needs none of these calls: crawlcheck-verify.mjs checks a document on your machine against the published keys (/.well-known/http-message-signatures-directory) and the rotation record, read once with --online or saved for --keys. Everything else documented here is useful but secondary, and may change with the notice its fields'' tags promise.'
operations:
- method: GET
path: /api/v1/resolve
operationId: resolveDomainV1
- method: POST
path: /api/v1/resolve
operationId: resolveBatchV1
- method: POST
path: /api/v1/preflight
operationId: preflightV1
- method: GET
path: /api/v1/decisions/{sha256}
operationId: decisionCheckV1
- method: GET
path: /api/v1/revocations
operationId: revocations
- method: GET
path: /api/v1/visitor
operationId: visitorResolveV1
- method: POST
path: /api/v1/visitor
operationId: visitorResolveBatchV1
- method: GET
path: /api/v1/mcp/scan
operationId: mcpScanUrl
- method: POST
path: /api/v1/mcp/lock/check
operationId: mcpLockCheck
list: https://crawlcheck.io/api/v1/core
description: 'Operations tagged Batch across 2 of this provider''s published API definitions: crawlcheck-io-openapi.json, crawlcheck-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://crawlcheck.io
tags:
- name: Batch
paths:
/api/batch:
post:
operationId: batchSubmit
summary: Queue up to 100 domains (500 on Agency/Network) for the same audit /api/v1/scan…
parameters:
- name: x-crawlcheck-key
in: header
required: true
schema:
type: string
pattern: ^cc_[0-9a-f]{32}$
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- domains
properties:
domains:
type: array
items:
type: string
maxItems: 500
webhook:
type: string
format: uri
description: 'https; receives batch.done signed x-crawlcheck-signature: sha256=HMAC-SHA256(key, body)'
examples:
worked:
summary: The request behind the worked response
value:
domains:
- treeservicedenverllc.com
- terrariumstation.com
webhook: https://example.com/hook
responses:
'202':
description: '{id, state, counts, rejected, next_window, url}'
content:
application/json:
examples:
worked:
summary: Produced by the production Worker code against a stored copy of a real record; ids, keys and tokens are placeholders.
value:
ok: true
id: bxqwfpkzuuxg0h
state: queued
counts:
total: 2
queued: 2
done: 0
failed: 0
rejected: []
charged: 2
next_window: '2026-10-01T03:17:00.000Z'
url: /api/batch/bxqwfpkzuuxg0h
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
id:
type:
- string
- 'null'
state:
type:
- string
- 'null'
counts:
type:
- object
- 'null'
properties:
total:
type:
- number
- 'null'
queued:
type:
- number
- 'null'
done:
type:
- number
- 'null'
failed:
type:
- number
- 'null'
additionalProperties: true
rejected:
type:
- array
- 'null'
items: {}
charged:
type:
- number
- 'null'
next_window:
type:
- string
- 'null'
url:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'400':
description: No valid domains or bad webhook
'404':
description: No valid licence key
'413':
description: Over the per-batch limit
'429':
description: A batch is already running for this key
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s -X POST \\\n -H \"x-crawlcheck-key: $CRAWLCHECK_KEY\" \\\n -H \"content-type: application/json\" \\\n -d '{\"domains\":[\"treeservicedenverllc.com\",\"terrariumstation.com\"],\"webhook\":\"https://example.com/hook\"}' \\\n 'https://crawlcheck.io/api/batch'"
security:
- licenceKey: []
- bearer: []
x-auth: 'a licence key (x-crawlcheck-key or Authorization: Bearer) or the signed-in /manage session; 401 or 403 otherwise'
x-crawlcheck-budget:
request_body_max: 1048576
items: 'domains: up to 100 per batch on Developer and Watch keys, 500 on Agency, Network and Growth (413 over); one active batch per key (409)'
rate_limit: each domain counts as one keyed scan
tags:
- Batch
servers:
- url: https://crawlcheck.io
/api/batch/{id}:
get:
operationId: batchStatus
summary: Batch state and per-domain results (grade, overall, refused, report links)
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: x-crawlcheck-key
in: header
required: true
schema:
type: string
responses:
'200':
description: JSON
content:
application/json:
examples:
worked:
summary: Produced by the production Worker code against a stored copy of a real record; ids, keys and tokens are placeholders.
value:
id: bxqwfpkzuuxg0h
state: queued
created: '2026-10-01T02:29:45.345Z'
started: null
finished: null
counts:
total: 2
queued: 2
done: 0
failed: 0
next_window: '2026-10-01T03:17:00.000Z'
windows_utc_minutes:
- 17
webhook:
url: https://example.com/hook
status: null
rejected: []
items:
- domain: treeservicedenverllc.com
state: queued
id: null
grade: null
overall: null
refused: false
report: null
json: null
error: null
at: null
- domain: terrariumstation.com
state: queued
id: null
grade: null
overall: null
refused: false
report: null
json: null
error: null
at: null
limits:
- Worked in scan windows at minutes 17 past each hour (UTC); a window scans 3 domains at a time for up to 10 minutes, and a batch that does not finish continues in the next window.
- 'Every item is the same audit /api/v1/scan runs and is stored as its own report. A refused item (the site blocked CrawlCheck) is a result, not an error: it carries no grade by design.'
schema:
type:
- object
- 'null'
properties:
id:
type:
- string
- 'null'
state:
type:
- string
- 'null'
created:
type:
- string
- 'null'
started: {}
finished: {}
counts:
type:
- object
- 'null'
properties:
total:
type:
- number
- 'null'
queued:
type:
- number
- 'null'
done:
type:
- number
- 'null'
failed:
type:
- number
- 'null'
additionalProperties: true
next_window:
type:
- string
- 'null'
windows_utc_minutes:
type:
- array
- 'null'
items:
type:
- number
- 'null'
webhook:
type:
- object
- 'null'
properties:
url:
type:
- string
- 'null'
status: {}
additionalProperties: true
rejected:
type:
- array
- 'null'
items: {}
items:
type:
- array
- 'null'
items:
type:
- object
- 'null'
properties:
domain:
type:
- string
- 'null'
state:
type:
- string
- 'null'
id: {}
grade: {}
overall: {}
refused:
type:
- boolean
- 'null'
report: {}
json: {}
error: {}
at: {}
additionalProperties: true
limits:
type:
- array
- 'null'
items:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'404':
description: Unknown id or not your batch
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s \\\n -H \"x-crawlcheck-key: $CRAWLCHECK_KEY\" \\\n 'https://crawlcheck.io/api/batch/bxqwfpkzuuxg0h'"
security:
- licenceKey: []
- bearer: []
x-auth: 'a licence key (x-crawlcheck-key or Authorization: Bearer) or the signed-in /manage session; 401 or 403 otherwise'
tags:
- Batch
servers:
- url: https://crawlcheck.io
components:
securitySchemes:
licenceKey:
type: apiKey
in: header
name: x-crawlcheck-key
description: 'Your licence key: cc_ followed by 32 hex characters. Sent on every keyed call.'
bearer:
type: http
scheme: bearer
description: The same licence key as a Bearer token. Accepted on /api/v1/* and /api/usage.
externalDocs:
url: https://crawlcheck.io/docs/api
description: Human-readable reference
x-refined-from:
- crawlcheck-io-openapi.json
- crawlcheck-io-openapi.yml