Authentication
Learn how to authenticate with the DeepV-ADK API.Overview
DeepV-ADK uses API keys for authentication. All API requests must include your API key in the request headers.Getting Your API Key
Authentication Methods
API Key Header
Include your API key in theAuthorization header:
``bash
curl https://api.deepv36.com/v1/analyze \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
`
SDK Authentication
When using the SDK, pass your API key during initialization:
`typescript
import { DeepVClient } from '@deepv/adk-sdk';
const client = new DeepVClient({
apiKey: process.env.DEEPV_API_KEY
});
`
Environment-Based Keys
Use different API keys for different environments:
`typescript
const config = {
development: {
apiKey: process.env.DEEPV_DEV_KEY
},
production: {
apiKey: process.env.DEEPV_PROD_KEY
}
};
const client = new DeepVClient(
config[process.env.NODE_ENV]
);
`
Security Best Practices
DO
- Store API keys in environment variables
- Rotate keys regularly (every 90 days)
- Use different keys for different environments
- Revoke compromised keys immediately
DON'T
- Commit API keys to version control
- Share API keys via email or chat
- Use production keys in development
- Hard-code API keys in your application
Key Permissions
API keys can have different permission levels:
| Permission | Description |
|------------|-------------|
| Read | View data only |
| Write | Create and update data |
| Delete | Remove data |
| Admin | Full access to all operations |
Rate Limiting
API keys are subject to rate limits:
- Free tier: 100 requests/minute
- Pro tier: 1,000 requests/minute
- Enterprise: Custom limits
Troubleshooting
Invalid API Key
Error:
401 Unauthorized - Invalid API key
Solution: Verify your API key is correct and active in the dashboard.
Rate Limit Exceeded
Error: 429 Too Many Requests`
Solution: Implement exponential backoff or upgrade your plan.
Next Steps
Found an issue? Help us improve this page.