API Keys
There are two types of API keys:sk_live_* — Live keys for production use. All requests affect real data.
sk_test_* — Test keys for development. Isolated from production data.
Using API Keys
Include your API key using either theAuthorization header as a Bearer token, or the X-API-Key header:
OAuth 2.0
For third-party applications that need to access user data, use OAuth 2.0 with PKCE. OAuth access tokens use theorb_at_* prefix.
To build an OAuth app, visit the Developer Portal to register your application and obtain client credentials.
Security Best Practices
Use environment variables — Store API keys in environment variables on your server. Never include them in frontend bundles.
Authentication Errors
| Status | Meaning |
|---|---|
401 | Invalid or missing API key |
403 | API key lacks required permissions |