CrawlCheck Preflight API

openapi: 3.2.0
info:
  title: Crawlcheck Io Preflight 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 Preflight 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: Preflight
paths:
  /api/v1/preflight/batch:
    post:
      operationId: preflightBatchV1
      summary: 'Batch preflight for answer engines (pfb1, X057): POST {domains: [up to 100…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - domains
              properties:
                domains:
                  type: array
                  items:
                    type: string
                  maxItems: 100
                action:
                  enum:
                  - read
                  - cite
                  - connect
                  - transact
                  - administer
                agent:
                  type: string
                template:
                  type: string
                policy:
                  type: object
                policy_id:
                  type: string
                receipts:
                  enum:
                  - full
                  - compact
                rank:
                  type: boolean
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  domains:
                  - exampletree.com
                  - exampletreepros.com
                  - example-directory.com
                  action: cite
                  agent: MyAnswerBot
      responses:
        '200':
          description: crawlcheck-preflight-batch (signed)
          content:
            application/json:
              examples:
                worked: {}
              schema:
                x-schema-source: worked-example
        '400':
          description: no domains, or more than 100
        '429':
          description: quota
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST ''https://crawlcheck.io/api/v1/preflight/batch'' -H ''content-type: application/json'' -d ''{"domains":["exampletree.com","exampletreepros.com","example-directory.com"],"action":"cite","agent":"MyAnswerBot"}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Preflight
    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