---
title: "API reference"
description: "Use CrawlConsole's public HTTP endpoints and interactive request examples."
section: "API reference"
version: "latest"
locale: "en"
updated: "2026-07-18T20:52:38.000Z"
---

# API reference

Use CrawlConsole's public HTTP endpoints and interactive request examples.

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

## Base URL

```text
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.

```json
{
  "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.