API Documentation

Errors

What each error status means and what to do about it.

Every error comes back as JSON with a message field in plain English, so you can show it to people as it is.

Status Meaning What to do
401 Unauthorized The API key is missing, wrong or deleted. Check the Authorization header, or create a new key in the dashboard.
402 Payment required REST: not enough credits to start the scan. Nothing was started or charged. The message gives the cost and your balance.
403 Forbidden REST: the API key can only read. Create a key with "Can start scans" ticked to use the endpoints that start scans.
404 Not found REST: the business, keyword or scan id is not in your account (or does not exist). Ids are UUIDs from the list endpoints.
422 Unprocessable REST: a query parameter is not allowed, for example an unknown platform or a limit over the maximum. The answer names the parameter under errors.
503 Service unavailable REST: the search service could not start the scan right now. Nothing was charged; try again in a few minutes.
405 Method not allowed The MCP server only takes POST requests.

The MCP server answers a tool it cannot run with isError set to true and the same kind of message, instead of an HTTP error.