API Keys
API Keys authenticate your application and authorize access to NovaAI services. Every request to the NovaAI API requires a valid API key associated with a project. This guide explains how to create, manage, and securely use API keys.
Overview
API keys identify your application when communicating with NovaAI. Each key is scoped to a project and inherits that project's permissions and usage limits.
You can create multiple API keys for different environments, making it easier to manage access across development, staging, and production.
Key Types
Key Type | Purpose |
|---|---|
Development | Local development and testing. |
Staging | Pre-production testing. |
Production | Live applications and services. |
Read-only | Limited access for monitoring or reporting. |
Create an API Key
Follow these steps to generate a new API key.
Open the Developer Dashboard.
Navigate to Projects → API Keys.
Select your project.
Click Generate API Key.
Copy and securely store the generated key.
Store Keys Securely
Instead of hardcoding credentials, store them as environment variables.
Your application can then read the value securely at runtime.
API Key Lifecycle
API Key Properties
Property | Description |
Key ID | Unique identifier for the API key. |
Project | Project associated with the key. |
Environment | Development, staging, or production. |
Created At | Date the key was generated. |
Last Used | Most recent successful API request. |
Status | Active or Revoked. |
Best Practices
Create separate keys for each environment.
Rotate keys regularly.
Remove unused keys.
Restrict access to trusted servers.
Monitor key usage for unusual activity.
Common Issues
Invalid API Key
The supplied key is incorrect or has been revoked.
Solution
Verify the key value or generate a new one from the Developer Dashboard.
Key Not Found
The requested API key no longer exists.
Solution
Create a new key and update your application configuration.
Unauthorized Requests
The API key does not have permission to access the requested resource.
Solution
Ensure the key belongs to the correct project and has the required permissions.
Next Step
Continue to Usage & Limits to monitor API consumption, understand quotas, and optimize resource usage across your NovaAI projects.