CrawlCheck Said API

openapi: 3.2.0
info:
  title: Crawlcheck Io Said 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 Said 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: Said
paths:
  /api/v1/said:
    get:
      operationId: saidV1
      summary: Proof of what a site said on a date (said1).
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
      - name: date
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: text
        in: query
        required: false
        schema:
          type: string
          maxLength: 500
      responses:
        '200':
          description: crawlcheck-said
          content:
            application/json:
              schema:
                type: object
              examples:
                worked:
                  summary: Shape from the build harness on 2026-10-22; the signature block is abbreviated.
                  value:
                    kind: crawlcheck-said
                    v: 1
                    url: https://example.com/robots.txt
                    domain: example.com
                    date_asked: '2026-10-22'
                    observed_at: '2026-10-22T14:02:11.000Z'
                    exact_day: true
                    nearest_before: false
                    report: https://crawlcheck.io/r/abc123def4
                    record_id: abc123def4
                    found: true
                    served:
                      sha256: 9f2c…
                      status: 200
                      content_type: text/plain
                      bytes: 214
                      identity: crawlcheck
                      role: machine_file
                      final_url: https://example.com/robots.txt
                    passage:
                      text: Disallow
                      present: true
                      context: 'user-agent: * disallow: /admin'
                    proof:
                      record_digest:
                        ok: true
                      seal:
                        ok: true
                        root: …
                        date: '2026-10-22'
                      manifest_signature:
                        ok: true
                      manifest_stored:
                        ok: true
                      manifest_sha256: …
                      verify: https://crawlcheck.io/api/verify?id=abc123def4
                      day_root: https://crawlcheck.io/proof/2026-10-22
                    signature:
                      alg: ed25519
                      kid: …
        '404':
          description: no reading held for that URL and date
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/v1/said?url=example.com/robots.txt&date=2026-10-22&text=Disallow'
      security: []
      x-auth: public; no credential read
      tags:
      - Said
    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