API Overview

Base URL

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

Authentication

All endpoints use HTTP Bearer (API Key):

Authorization: Bearer YOUR_API_KEY

Format: tb_ followed by 32 hexadecimal characters (e.g., tb_a1b2c3d4e5f67890abcdef1234567890).

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
  }
}

Note: A GOOGLE_RPC alternate envelope was previously documented where code and status swapped types (string ↔ number). It is deprecated and not recommended — strongly-typed clients (OpenAPI codegen, Pydantic, serde, encoding/json) will fail to deserialize across the swap. Use the LEGACY format above; future updates keep code: string and status: number stable.

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