Authentication
Create an organization API key and authenticate public API requests.
Use an organization API key for every /public/v1 endpoint. The production base URL is https://api.orbitali.ai/public/v1.
Create a key
- Sign in to the dashboard and select the organization you want to manage.
- Open Settings → API keys. Every organization member can create keys. Only owners and admins can revoke keys.
- Create a named key for your integration. Copy the full key immediately; it is shown only once.
- Store it in your backend's environment or secret manager as
ORBITALI_API_KEY.
Send the full key, not its display prefix:
Authorization: Bearer <your-full-api-key>
Check authentication with a read-only request:
curl --fail-with-body https://api.orbitali.ai/public/v1/agents \
-H "Authorization: Bearer $ORBITALI_API_KEY"
A successful response is 200 with an array; [] means this organization has no agents. A 401 response means the key is missing, invalid, or revoked. A key grants access to its organization; it does not grant access to another organization's resources.
Keep keys on your backend
Do not put API keys in browser JavaScript, mobile bundles, public repositories, URLs, or logs. For browser calling, your backend creates a realtime session and returns its short-lived WebSocket URL to the client.
To rotate a key, create a replacement, update your backend, verify a request, and revoke the old key in Settings. Revocation immediately stops requests using the old key.
Other credentials
| Credential | Purpose |
|---|---|
| Orbitali API key | Your backend calls /public/v1 |
| Organization webhook signing secret | Your receiver verifies timestamped call lifecycle notifications |
| Agent Server Secret | Your webhook verifies Orbitali signatures |
| Tool headers | An HTTP tool authenticates to your own endpoint |
| Dashboard session | Browser access to dashboard-only /v1 routes |
The internal service secret is for Orbitali's own services. It is not a public API credential. Dashboard billing and organization call-webhook settings routes require a dashboard session and cannot be called with an API key. See Call Lifecycle Webhooks.
Continue with API Getting Started or Errors & Troubleshooting.