Skip to main content

​
API Authentication

Authenticate requests to Visent APIs using API keys, ensuring secure access to Telemetry, Atlas, and Forge services. All API endpoints require authentication with proper key management and rate limiting. Supports both personal and organization-level API keys with granular permission controls.

​
Getting API Keys

Coming soon - how to generate and manage API keys in the Visent dashboard.

​
Authentication Methods

​
Bearer Token Authentication

# Using curl with Bearer token
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.visent.ai/telemetry/metrics"

# Using environment variable
export VISENT_API_KEY="your_api_key_here"
curl -H "Authorization: Bearer $VISENT_API_KEY" \
  "https://api.visent.ai/atlas/pricing"

​
Header-based Authentication

Coming soon - alternative authentication header formats.

​
API Key Management

​
Creating API Keys

Coming soon - step-by-step guide for creating new API keys.

​
Key Permissions

Coming soon - configuring permissions and scopes for API keys.

​
Key Rotation

Coming soon - best practices for rotating and updating API keys.

​
Revoking Keys

Coming soon - how to revoke compromised or unused API keys.

​
Rate Limiting

Coming soon - API rate limits and throttling policies.

​
Error Handling

​
Authentication Errors

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key",
    "details": "The provided API key is not valid or has been revoked"
  }
}

​
Common Error Codes

Coming soon - complete list of authentication error codes and solutions.

​
Security Best Practices

​
Key Storage

Coming soon - secure storage and handling of API keys.

​
Network Security

Coming soon - HTTPS requirements and network security considerations.

​
Access Control

Coming soon - implementing proper access controls and monitoring.

​
SDK Authentication

Coming soon - authentication setup in official Visent SDKs.

​
Next Steps