Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API 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.
openapi: 3.2.0
info:
title: Crawlcheck Io Observe 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 Observe 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: Observe
paths:
/api/observe/enroll:
post:
operationId: enrolObserver
summary: 'Enrol an independent observer (open observer protocol v1): an Ed25519 key, an…'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- request
- sig
properties:
request:
type: object
sig:
type: string
responses:
'200':
description: enrolled (or already enrolled with this key)
'400':
description: OK
content:
application/json:
examples:
worked:
summary: Captured from production on 2026-10-02; an unsigned body is refused before anything is stored; a signed enrolment (spec and fixtures at /docs/observer-protocol) answers 200 with observer_id, kid and network.
value:
ok: false
error: request.kind must be crawlcheck-observer-enrolment, v 1
trace_id: 2eec10b32826dec5dc54de84871aef3f
span_id: b7101d6ff1558742
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
error:
type:
- string
- 'null'
trace_id:
type:
- string
- 'null'
span_id:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'403':
description: the signature does not prove the key
'409':
description: the id is bound to another key
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s -X POST \\\n -H \"content-type: application/json\" \\\n -d '{\"observer_id\":\"ind:example\"}' \\\n 'https://crawlcheck.io/api/observe/enroll'"
security: []
x-auth: public; no credential read
x-crawlcheck-budget:
request_body_max: 1048576
tags:
- Observe
servers:
- url: https://crawlcheck.io
/api/observe/check:
post:
operationId: checkObservation
summary: Run the Worker's own checks on an observation or enrolment without storing it…
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: shape, key_matches_directory, signature, ok
content:
application/json:
examples:
worked:
summary: Captured from production on 2026-10-02; nothing is stored; each check names what failed.
value:
kind: crawlcheck-observer-check
type: observation
stored: false
checked_against: no directory entry
shape: false
key_matches_directory: null
signature: null
ok: false
schema:
type:
- object
- 'null'
properties:
kind:
type:
- string
- 'null'
type:
type:
- string
- 'null'
stored:
type:
- boolean
- 'null'
checked_against:
type:
- string
- 'null'
shape:
type:
- boolean
- 'null'
key_matches_directory: {}
signature: {}
ok:
type:
- boolean
- 'null'
additionalProperties: true
x-schema-source: worked-example
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s -X POST \\\n -H \"content-type: application/json\" \\\n -d '{\"observer_id\":\"ind:example\"}' \\\n 'https://crawlcheck.io/api/observe/check'"
security: []
x-auth: public; no credential read
x-crawlcheck-budget:
request_body_max: 1048576
tags:
- Observe
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