API overview

Base URL, authentication, response format, errors, and pagination.

OpenAPI specification Import the spec directly into Postman, Insomnia, or any OpenAPI-compatible tool. Download openapi.yaml

Base URL

All endpoints are under:

https://api.cache-boost.com/v1

Pass your API key as a Bearer token in every request:

Authorization: Bearer cb_live_YOUR_KEY

See Authentication for how to create keys and manage scopes.

All responses are JSON. Successful responses return the resource object directly for single resources, or an array for collections.

[
  { "id": 1, "domain": "www.example.com", "validated": true, ... },
  { "id": 2, "domain": "blog.example.com", "validated": false, ... }
]

Paginated endpoints (e.g. GET /runs) wrap results in a data array with limit and offset:

{
  "data": [ ... ],
  "limit": 20,
  "offset": 0
}

Errors return a JSON object with an error string:

{
  "error": "Invalid or expired API key."
}

HTTP status	Meaning
`401`	Missing or invalid API key
`403`	Key lacks the required scope
`404`	Resource not found or not accessible with this key
`409`	Conflict (e.g. boost already running, duplicate sitemap)
`422`	Validation error (invalid field value)
`500`	Server error

The GET /runs endpoint accepts limit (default: 20, max: 100) and offset query parameters:

GET /v1/runs?limit=50&offset=100