CrawlCheck Workflow API
The Workflow API from CrawlCheck — 2 operation(s) for workflow.
Operations 2
POST
/api/workflow/record
Record a fix: finds the newest record that carried the code and the first after…
#
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-workflow-api"
All apis
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.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Crawlcheck Io Workflow 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 Workflow 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: Workflow
paths:
/api/workflow:
get:
operationId: fixChain
summary: 'One finding on one site, end to end: detected, exact evidence, fix recommended…'
parameters:
- name: code
in: query
required: true
schema:
type: string
description: A finding code; the three most common are NO_LLMS_TXT, PAGE_IS_MOSTLY_CODE, STALE_CACHE_SERVED
- name: domain
in: query
schema:
type: string
description: Omit for the exemplar site
- name: fresh
in: query
schema:
type: string
enum:
- '1'
responses:
'200':
description: crawlcheck-fix-chain
content:
application/json:
examples:
worked:
summary: 'A portfolio site, read without a key: ten steps, each a link to its record. Produced by the real Worker code in the build harness: four real scans of the domain re-dated across four days, the chain recorded with a test licence, and a seeded second-observer reading of /llms.txt.'
value:
ok: true
kind: crawlcheck-fix-chain
v: 1
generated_at: '2026-10-01T18:58:20.266Z'
domain: treeservicedenverllc.com
code: NO_LLMS_TXT
title: No llms.txt
share_of_scans: null
state: recorded
steps:
- n: 1
id: detected
label: Problem detected
done: true
at: '2026-09-28T18:57:13.897Z'
record: https://crawlcheck.io/r/mnf2xfcc5r
report_id: mnf2xfcc5r
grade: A
score: 100
finding:
code: NO_LLMS_TXT
path: /llms.txt
severity: 2
title: NO_LLMS_TXT
detail: seeded for the chain test
decision_id: null
explain: https://crawlcheck.io/api/explain?id=mnf2xfcc5r&code=NO_LLMS_TXT
machine_record: https://crawlcheck.io/api/v1/machine-record?id=mnf2xfcc5r
- n: 2
id: evidence
label: Exact evidence shown
done: true
locate: https://crawlcheck.io/api/locate?id=mnf2xfcc5r&finding=NO_LLMS_TXT
bundle: https://crawlcheck.io/api/bundle?id=mnf2xfcc5r
verify: https://crawlcheck.io/api/verify?id=mnf2xfcc5r
evidence: []
note: the locator names the bytes in the stored page that decided the finding; the bundle is the signed, sealed record it sits in
- n: 3
id: fix
label: Fix recommended
done: true
generator: llmsDraft
artifact: https://crawlcheck.io/api/tool/llms?domain=treeservicedenverllc.com&format=txt
plan: https://crawlcheck.io/api/remediate?id=mnf2xfcc5r
guide: https://crawlcheck.io/guides/how-to-write-an-llms-txt-and-verify-it
- n: 4
id: impact
label: Impact projected
done: true
impact: https://crawlcheck.io/api/impact?id=mnf2xfcc5r&fix=llms
what_if: https://crawlcheck.io/api/whatif?id=mnf2xfcc5r
note: the grade formula rerun with this fix's rows cleared, computed from the before record, not measured
- n: 5
id: implemented
label: Implementation recorded
done: true
declared_fix:
kind: declared by the site owner
declared_by: the site owner
declared_at: '2026-09-29T06:57:13.897Z'
fixes:
- published /llms.txt generated from the site's pages
deployed_at: null
deployed_basis: null
in: receipt.declared_fix, inside the signed body
- n: 6
id: rescanned
label: Site rescanned
done: true
at: '2026-09-29T18:57:13.897Z'
record: https://crawlcheck.io/r/3cpv7gcl5t
report_id: 3cpv7gcl5t
grade: A
score: 100
rollback: https://crawlcheck.io/api/rollback?from=mnf2xfcc5r&to=3cpv7gcl5t
finding_absent: true
- n: 7
id: corroborated
label: Corroborated by a second observer
done: false
corroboration: https://crawlcheck.io/api/corroboration?domain=treeservicedenverllc.com
registry: https://crawlcheck.io/.well-known/crawlcheck-observers.json
path: /llms.txt
status: observer_disagreement
observer: gha-azure-1
observed_at: '2026-10-01T06:57:13.897Z'
holds: false
reading: 'the second observer was not served the file (1 identity): the fix does not hold from a second network'
observation: https://crawlcheck.io/api/observation?domain=treeservicedenverllc.com&sha256=e7fc9db7270632a88f2c3af380aebc98efdd7060fbcc2c2b8473de0bece0467a
readings:
- identity: anon
status: 200
bytes: 40000
content_type: text/html
file_present: false
vantage:
provider: GitHub-hosted runner (Microsoft Azure)
asn_org: AS8075 Microsoft
run:
run_id: '1'
- n: 8
id: receipt
label: Signed remediation receipt
done: true
receipt_id: rc1:3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254
receipt: https://crawlcheck.io/api/receipt?id=rc1%3A3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254
verifies: true
verify_offline: node crawlcheck-verify.mjs receipt.json
download: https://crawlcheck.io/api/receipt?id=rc1%3A3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254&download=1
- n: 9
id: watch
label: Regression watch
done: true
certificate: https://crawlcheck.io/certificate/treeservicedenverllc.com
history: https://crawlcheck.io/api/evidence/ledger?domain=treeservicedenverllc.com
watched: true
cadence: twice a day
readings_since: 2
days_since: 2
reappeared: false
newest:
id: cfr2vacuqw
day: '2026-09-30'
grade: A
days_with_code_since: 0
- n: 10
id: outcomes
label: Business outcome tracked
done: false
outcomes: https://crawlcheck.io/api/outcomes?receipt=rc1%3A3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254
owner_only: true
connected: 0
usable: 0
series_total: 10
window_days: 28
after_days_elapsed: 2
done: 8
complete: false
receipt_id: rc1:3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254
reading: Ten steps, each a link to the record that proves it. done:true means the record exists and says what the step claims; a step that is not done says what is missing. Nothing here is asserted without a record behind it.
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
kind:
type:
- string
- 'null'
v:
type:
- number
- 'null'
generated_at:
type:
- string
- 'null'
domain:
type:
- string
- 'null'
code:
type:
- string
- 'null'
title:
type:
- string
- 'null'
share_of_scans: {}
state:
type:
- string
- 'null'
steps:
type:
- array
- 'null'
items:
type:
- object
- 'null'
properties:
n:
type:
- number
- 'null'
id:
type:
- string
- 'null'
label:
type:
- string
- 'null'
done:
type:
- boolean
- 'null'
at:
type:
- string
- 'null'
record:
type:
- string
- 'null'
report_id:
type:
- string
- 'null'
grade:
type:
- string
- 'null'
score:
type:
- number
- 'null'
finding:
type:
- object
- 'null'
properties:
code:
type:
- string
- 'null'
path:
type:
- string
- 'null'
severity:
type:
- number
- 'null'
title:
type:
- string
- 'null'
detail:
type:
- string
- 'null'
decision_id: {}
additionalProperties: true
explain:
type:
- string
- 'null'
machine_record:
type:
- string
- 'null'
locate:
type:
- string
- 'null'
bundle:
type:
- string
- 'null'
verify:
type:
- string
- 'null'
evidence:
type:
- array
- 'null'
items: {}
note:
type:
- string
- 'null'
generator:
type:
- string
- 'null'
artifact:
type:
- string
- 'null'
plan:
type:
- string
- 'null'
guide:
type:
- string
- 'null'
impact:
type:
- string
- 'null'
what_if:
type:
- string
- 'null'
declared_fix:
type:
- object
- 'null'
properties:
kind:
type:
- string
- 'null'
declared_by:
type:
- string
- 'null'
declared_at:
type:
- string
- 'null'
fixes:
type:
- array
- 'null'
items:
type:
- string
- 'null'
deployed_at: {}
deployed_basis: {}
additionalProperties: true
in:
type:
- string
- 'null'
rollback:
type:
- string
- 'null'
finding_absent:
type:
- boolean
- 'null'
corroboration:
type:
- string
- 'null'
registry:
type:
- string
- 'null'
path:
type:
- string
- 'null'
status:
type:
- string
- 'null'
observer:
type:
- string
- 'null'
observed_at:
type:
- string
- 'null'
holds:
type:
- boolean
- 'null'
reading:
type:
- string
- 'null'
observation:
type:
- string
- 'null'
readings:
type:
- array
- 'null'
items:
type:
- object
- 'null'
properties:
identity:
type:
- string
- 'null'
status:
type:
- number
- 'null'
bytes:
type:
- number
- 'null'
content_type:
type:
- string
- 'null'
file_present:
type:
- boolean
- 'null'
additionalProperties: true
vantage:
type:
- object
- 'null'
properties:
provider:
type:
- string
- 'null'
asn_org:
type:
- string
- 'null'
additionalProperties: true
run:
type:
- object
- 'null'
properties:
run_id:
type:
- string
- 'null'
additionalProperties: true
receipt_id:
type:
- string
- 'null'
receipt:
type:
- string
- 'null'
verifies:
type:
- boolean
- 'null'
verify_offline:
type:
- string
- 'null'
download:
type:
- string
- 'null'
certificate:
type:
- string
- 'null'
history:
type:
- string
- 'null'
watched:
type:
- boolean
- 'null'
cadence:
type:
- string
- 'null'
readings_since:
type:
- number
- 'null'
days_since:
type:
- number
- 'null'
reappeared:
type:
- boolean
- 'null'
newest:
type:
- object
- 'null'
properties:
id:
type:
- string
- 'null'
day:
type:
- string
- 'null'
grade:
type:
- string
- 'null'
additionalProperties: true
days_with_code_since:
type:
- number
- 'null'
outcomes:
type:
- string
- 'null'
owner_only:
type:
- boolean
- 'null'
connected:
type:
- number
- 'null'
usable:
type:
- number
- 'null'
series_total:
type:
- number
- 'null'
window_days:
type:
- number
- 'null'
after_days_elapsed:
type:
- number
- 'null'
additionalProperties: true
done:
type:
- number
- 'null'
complete:
type:
- boolean
- 'null'
receipt_id:
type:
- string
- 'null'
reading:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'403':
description: not the domain's owner
'404':
description: no exemplar recorded
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s \\\n 'https://crawlcheck.io/api/workflow?domain=treeservicedenverllc.com&code=NO_LLMS_TXT'"
security: []
x-auth: public; no credential read
tags:
- Workflow
servers:
- url: https://crawlcheck.io
/api/workflow/record:
post:
operationId: recordFixChain
summary: 'Record a fix: finds the newest record that carried the code and the first after…'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- domain
- code
properties:
domain:
type: string
code:
type: string
declared:
type: object
properties:
what:
type: string
by:
type: string
at:
type: string
deployed_at:
type: string
examples:
worked:
summary: The request behind the worked response
value:
domain: treeservicedenverllc.com
code: NO_LLMS_TXT
declared:
what: published /llms.txt generated from the site's pages
by: the site owner
at: '2026-09-28'
responses:
'200':
description: 'recorded: receipt, before, after, corroboration_queued'
content:
application/json:
examples:
worked:
summary: 'Issues the receipt with the declared fix inside the signed body and queues the file for the second observer. Produced by the real Worker code in the build harness: four real scans of the domain re-dated across four days, the chain recorded with a test licence, and a seeded second-observer reading of /llms.txt.'
value:
ok: true
state: recorded
domain: treeservicedenverllc.com
code: NO_LLMS_TXT
receipt:
id: rc1:3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254
url: https://crawlcheck.io/api/receipt?id=rc1%3A3f4777b642f369b2781947572f8c05288a035f9718e5212b1e17d369020ba254
existing: false
before:
id: mnf2xfcc5r
at: '2026-09-28T18:57:13.897Z'
grade: A
score: 100
after:
id: 3cpv7gcl5t
at: '2026-09-29T18:57:13.897Z'
grade: A
score: 100
corroboration_queued: https://treeservicedenverllc.com/llms.txt
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
state:
type:
- string
- 'null'
domain:
type:
- string
- 'null'
code:
type:
- string
- 'null'
receipt:
type:
- object
- 'null'
properties:
id:
type:
- string
- 'null'
url:
type:
- string
- 'null'
existing:
type:
- boolean
- 'null'
additionalProperties: true
before:
type:
- object
- 'null'
properties:
id:
type:
- string
- 'null'
at:
type:
- string
- 'null'
grade:
type:
- string
- 'null'
score:
type:
- number
- 'null'
additionalProperties: true
after:
type:
- object
- 'null'
properties:
id:
type:
- string
- 'null'
at:
type:
- string
- 'null'
grade:
type:
- string
- 'null'
score:
type:
- number
- 'null'
additionalProperties: true
corroboration_queued:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'403':
description: not the domain's owner
'422':
description: 'no before/after pair: open, never seen, or no records'
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 '{\"domain\":\"treeservicedenverllc.com\",\"code\":\"NO_LLMS_TXT\",\"declared\":{\"what\":\"published /llms.txt generated from the site's pages\",\"by\":\"the site owner\",\"at\":\"2026-09-28\"}}' \\\n 'https://crawlcheck.io/api/workflow/record'"
security: []
x-auth: public; no credential read
x-crawlcheck-budget:
request_body_max: 1048576
tags:
- Workflow
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