Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orbitsearch.com/llms.txt

Use this file to discover all available pages before exploring further.

Use the Orbit developer dashboard to inspect your credit balance and per-key usage. For request-time tracking, every successful metered API response includes your remaining balance in the X-Developer-API-Credits-Remaining header. 
X-Developer-API-Credits-Remaining: 47

​
Dashboard usage view

The dashboard shows:
FieldWhat it means
AllowanceTotal credits available for the current billing period
UsedCredits consumed so far this period
RemainingCredits still available before requests fail with developer_api_credits_insufficient
Recent activityRecent metered requests and credit adjustments
Per-key usageCredit usage grouped by API key display identifier
Credit accounting is subject-based. Personal API keys draw from your user account. Organization API keys draw from the organization that owns the key.

​
Request-time tracking

Read X-Developer-API-Credits-Remaining after successful search and profile-read requests to keep your application aware of the current balance without calling a separate management endpoint. 
const remaining = response.headers.get("X-Developer-API-Credits-Remaining");
Requests that fail validation, authentication, rate limits, or system errors do not consume credits. Searches or profile reads that return no result are refunded automatically.
Developer API keys cannot call key-management or usage endpoints. Public integrations should use dashboard-issued sk_orb_... keys for search/profile API calls, and use the dashboard for key and usage management.