Skip to main content
The dashboard endpoint. Returns the same payload that console.bytespike.ai/dashboard renders on first paint: balance, allowed-model roster, per-model quota caps, and basic profile bits. Calling it is free and never debits credits.

When to use

  • Boot a custom dashboard / status bar that mirrors the console
  • Verify which models the current key can call without enumerating /v1/models first
  • Surface balance + low-balance flag in IDE extensions / agents

Request

x-api-key: $BYTESPIKE_API_KEY also works. No body.

Response

Response fields

Errors

The endpoint is free; no 402 path. 429 is theoretically possible but the per-key cap is ~600/min — only realistic during a key-rotation hammer.

Example — low-balance gate

Pair with POST /me/webhooks and subscribe to system.balance.notify.dispatched to be paged instead of polling.