API reference

The API reference is generated from the OpenAPI document published at openapi.json. Each operation page includes its method, path, inputs, response contract, code examples, and an interactive request builder.

Base URL

https://crawlconsole.com

The first documented endpoints are public, narrowly scoped checkers. Authenticated product and Agent APIs use their own session or bearer-token requirements.

Errors

Endpoints return JSON error bodies with an appropriate HTTP status when input is invalid or the operation fails.

{
  "error": "A valid domain is required."
}

OpenAPI source

The docs navigation and operation pages update from the same OpenAPI file. Add an operation to content/docs/openapi.json to publish a new API page and include it in the documentation sitemap.