snakereach

Reference

Errors.

Every failure is application/problem+json (RFC 9457) with the same four fields, plus url when the failure was about a specific page. One shape to handle, whatever went wrong.

401 response
{
  "type": "https://snakereach.com/errors/authentication-required",
  "title": "Authentication required",
  "status": 401,
  "detail": "Provide your key in the X-API-Key header, or as Authorization: Bearer <key>."
}

title is the machine-stable summary and detail is the human one. Read both. Where a status has several causes, title is what distinguishes them.

Every status

What is not an error

A target site returning 404, 403 or 500 is not an API error. You get a normal Document with that status and whatever content the page had. The API only errors when it could not obtain a response at all, or when policy refused to try.