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.

Every Orbit account comes with a personal organization created automatically at signup. Personal organizations give you a private space for your own connections and searches. Workspace organizations are shared environments for directories, access grants, and API integrations built on behalf of an organization.
Personal key vs. organization key:
  • Use a personal API key for global public search and personal development.
  • Use an organization API key for directory search and integrations that should meter credits against an organization.

​
Organization API keys

Organization API keys authenticate as the organization rather than as a user. This lets a backend service search organization-owned directories without requiring an end-user session. Create organization keys in the Orbit developer dashboard. Choose the organization that should own the key, select the scopes your integration needs, and copy the raw sk_orb_... value when it appears.
The raw key is shown only once. Store it immediately in your secrets manager. After that, the dashboard only shows safe metadata such as display_key, name, scopes, status, expiration, and last-used timestamps.

​
Key fields

Dashboard key records expose non-secret metadata:
FieldMeaning
display_keySafe prefix/suffix representation, such as sk_orb_a0186...55fd
nameHuman-readable label for the key
scopesAllowed operations, such as search:read and profile:read
environmentOptional environment label for organization keys
last_used_atTimestamp of the most recent successful request
is_activeWhether the key can currently authenticate requests

​
Directory access

Organization keys can search private directory corpora only when access grants allow it. A key must have one of the following:
  • an organization-level grant on the directory
  • a direct API-key grant
If none of those grants match, directory-scoped search returns an authorization error.

​
Search example

Use an organization key exactly like a personal key: pass it as a bearer token. 
curl -X POST "$API_BASE/v2/social/profiles/searches/smart" \
  -H "Authorization: Bearer $ORG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "founders in sf",
    "numUsers": 10,
    "searchScope": { "type": "directory", "directoryId": "DIRECTORY_UUID" }
  }'