API Overview

Base URL

https://openapi.thunderbit.com/openapi/v1

Authentication

All endpoints use HTTP Bearer (API Key):

Authorization: Bearer YOUR_API_KEY

Get your key from the Thunderbit Dashboard. Keys are revocable and per-environment — never embed a production key in client-side code.

Error envelope

All error responses share the same envelope. By default (LEGACY format):

{
  "success": false,
  "error": {
    "code":    "INVALID_URL",
    "status":  400,
    "message": "The provided URL is not valid",
    "details": null
  }
}

Set the gateway environment variable API_ERROR_FORMAT=GOOGLE_RPC to switch to the Google Cloud / gRPC convention:

{
  "success": false,
  "error": {
    "code":    400,
    "status":  "INVALID_URL",
    "message": "The provided URL is not valid",
    "details": null
  }
}

Clients should read both fields and treat the string-typed one as the canonical error code.

The details field may carry structured context — for example, field-level validation errors as { field: message } pairs returned on INVALID_PARAMETER.

Canonical error codes

Retry strategy reference