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.

API keys let your applications call the Orbit Search API without a user session. Get your first key in the Orbit developer dashboard, then use the resulting sk_orb_... value as the bearer token for search and profile requests.
The raw key is shown only once in the dashboard. Copy it into a secret manager immediately. After you close the modal, Orbit only shows the safe display_key form, such as sk_orb_a0186...55fd.

​
Where to get keys

Use Dashboard → API keys to issue personal and organization-scoped keys.
1

Open the developer dashboard

Sign in to Orbit and go to developer.orbitsearch.com/dashboard/keys.
2

Choose key ownership

Use a personal key for global search and local development. Use an organization key when your integration needs to search directories or other organization-owned corpora.
3

Select scopes

Choose the minimum scopes your integration needs:
  • search:read — call POST /v2/social/profiles/searches/smart
  • profile:read — call GET /v2/developer/profiles/:id
4

Copy and store the raw key

Store the raw sk_orb_... value in your secrets manager or environment configuration.
export ORBIT_API_KEY="sk_orb_REDACTED"
The public developer API does not create your first API key. It starts after you already have a dashboard-issued sk_orb_... key.

​
Key types

Key typeBest forSearch scopes
Personal keyDevelopment, prototypes, global people searchGlobal search only
Organization keyProduction integrations and directory searchGlobal, directory, and directories scopes with matching grants
Personal keys meter credits against your user account. Organization keys meter credits against the organization that owns the key.

​
Using the key

Pass the raw key in the Authorization header: 
curl -X POST "$API_BASE/v2/social/profiles/searches/smart" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"founders in sf","numUsers":10}'

​
Managing keys

Use the dashboard to rotate, revoke, and inspect keys. The dashboard shows non-secret metadata like display_key, name, scopes, status, expiration, and last-used timestamps. It never shows the raw key again after creation. Developer API keys cannot create, list, revoke, or delete other API keys.