Skip to main content
The API pages are generated from the deployed API 0.8.0-rc.1 OpenAPI document. The public origin exposes inclusion, inclusions, and 202 included as provisional observations, plus opt-in outbound inclusion event schemas. The merged platform source emits OpenAPI 3.1 directly. The docs generator preserves it; older OpenAPI 3.0.3 inputs have only their declared format version changed so Mintlify can read JSON Schema null unions. Developer integrations use https://api.gol.network. Consumer application routes in the consolidated catalog use https://consumer-api.gol.network, whose health reports version 0.1.0. Route availability follows the service and its configured integrations; current availability records the hosted developer capabilities. The base URL is https://api.gol.network. Every project route is under /v1/projects/{projectId}, where projectId is your project’s UUID from whoami.

Authentication

Send a project API key as Authorization: Bearer <key> from your server. The key’s scopes decide which routes it may call: Email challenge and session routes are used by the console for developer sign-in. The optional Google session route accepts a Google ID token from a server-side OAuth exchange and links it to the same developer when the email has been verified as current. The console renews sessions on return and revokes them on sign-out. Session tokens and API keys are not interchangeable.

Conventions

  • Amounts are base-10 strings: USDC in 6-decimal base units, gas in wei.
  • Hashes and addresses are 0x hex.
  • Account configuration identifiers are 32-byte hex values returned by account status and gas configuration responses.
  • Owner confirmation routes can answer 202 with observing, included, reverted, orphaned, or mismatch before the selected Base safe head. A signed Alchemy inbound notification can wake an exact-hash Alchemy HTTP receipt, canonical-block, and expected GOL effect check; reconciliation performs the same checks when no hook arrives. Action and claim detail responses expose inclusion and inclusions separately from financial state, receipt, and ledger. The webhook and repeated RPC reads use one Alchemy operator, so they are not independent-provider evidence. Background observation continues through finalized.
  • Errors use one envelope with a stable code; see errors.
The published SDK 0.7.1 wraps the existing public routes with typed clients, split into a browser-safe entry point and a server-only one. It types API 0.7.0’s opt-in inclusion event names and payloads. Use webhooks to subscribe and integrate hosted gas for the complete flow.