Reference

Errors

Ohsee uses standard HTTP status codes and returns a JSON body describing what went wrong.

Error shape

Errors return a top-level detail object with a stable error code and a human-readable message. Many responses also include request_id for support.

402 Payment Required
{
  "detail": {
    "error": "insufficient_credits",
    "message": "Your balance is too low for this request.",
    "balance": 3,
    "required": 10,
    "billing_url": "https://ohsee.tech/dashboard/billing"
  }
}

Status codes

StatusMeaning
400Malformed request.
401Missing, malformed, or revoked API key.
402Insufficient credits. Includes balance, required, and billing_url.
403Account disabled or not permitted.
404Job or monitor not found.
422Invalid request parameters.
429Rate limit exceeded.
500Unexpected error. Includes contact and request_id.
503Web discovery temporarily unavailable.
504Request timed out.

Insufficient credits

When your balance cannot cover a request, Ohsee returns 402 with balance, required, and a billing_url so you can top up and retry.

Unexpected errors

Unexpected failures return internal_error. The message never exposes internal systems. Include the request_id when contacting support.

500 Internal Server Error
{
  "detail": {
    "error": "internal_error",
    "message": "There was an error responding to your request. Please try again, or contact hello@blazeddigital.com and include your request id.",
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "contact": "hello@blazeddigital.com"
  }
}
Support: hello@blazeddigital.com