Authentication
The Nedzo API uses Bearer token authentication. All API requests must include your API key in theAuthorization header.
API Keys
API keys are created in the Nedzo dashboard and can be scoped to:- Account-level: Access all workspaces in your account
- Workspace-level: Access only a specific workspace
Making Authenticated Requests
Include your API key in theAuthorization header:
API Key Format
Nedzo API keys follow this format:| Environment | Format | Example |
|---|---|---|
| Production | sk_live_* | sk_live_abc123... |
| Test | sk_test_* | sk_test_xyz789... |
Error Responses
If authentication fails, you’ll receive a401 Unauthorized response:
Security Best Practices
Never expose keys in client-side code
Never expose keys in client-side code
API keys should only be used in server-side code. Never include them in JavaScript that runs in browsers or mobile apps.
Use environment variables
Use environment variables
Store API keys in environment variables, not in your codebase.
Rotate keys regularly
Rotate keys regularly
Periodically rotate your API keys, especially if you suspect they may have been compromised.
Use workspace-scoped keys
Use workspace-scoped keys
When possible, use workspace-scoped keys to limit the blast radius if a key is compromised.
Rate Limits
API requests are rate-limited to ensure fair usage:| Plan | Requests per minute |
|---|---|
| Free | 60 |
| Pro | 300 |
| Enterprise | Custom |
429 Too Many Requests response with a Retry-After header.