Console API Reference
Overview of every Console API resource. Spec-driven detail lives under Reference.
The Console API is served under https://api.surfacedby.com/api/v1/console. Every endpoint requires an X-API-Key header holding a Console key (sk_live_ or sk_test_). The full contract, including request schemas and example responses, is rendered directly from the committed OpenAPI spec under the Reference section.
Resources
- Account: read, update, and bootstrap your Console profile.
- Credits: balance, ledger (JSON and CSV), pack catalog, and checkout URLs.
- Keys: mint, list, and revoke API keys.
- Domains: register the domains you scan so keyword and platform defaults follow them.
- Scans: submit on-demand scans, preview their cost, and manage their lifecycle.
- Usage: rolling-window request counts by date, endpoint, and key.
- Platforms: supported AI platforms and per-query credit costs.
- Webhooks: register delivery endpoints and inspect delivery history.
Rate limits
The Console API is rate-limited per key. The standard X-RateLimit-* response headers are included on every response; a 429 response includes Retry-After.
| Surface | Per minute | Per month |
|---|---|---|
| Business tier (public API) | 60 | 50,000 |
| Professional tier (public API) | 60 | 10,000 |
| Console API (per key) | 120 | 100,000 |
Idempotency
Write endpoints accept an optional Idempotency-Key header. Resubmitting the same key returns the original response rather than duplicating the write. This matters most for POST /scans, where a retry without the key could charge credits twice.
Errors
Errors follow RFC 7807 (application/problem+json). See Errors for the shape. Console-specific types include insufficient_credits (402), key_revoked (401), domain_not_found (404), and service_disabled (503).