Authorization header of all your requests.
Obtaining API Keys
API keys can be generated from your workspace. To create a new API key:- Navigate to your workspace in the Plati AI dashboard
- Go to “API Keys” section
- Click “Create API Key”
- Choose a descriptive name for your key
- Select the appropriate role:
read-only- Can only read dataread-write- Can read and modify data
- Store your API key securely - it will only be displayed once
Using Your API Key
Include your API key in theAuthorization header of all requests:
API Key Security
Follow these best practices to keep your API keys secure:- Never expose API keys in client-side code
- Don’t commit API keys to version control
- Use environment variables to store keys
- Implement key rotation periodically
- Create separate keys for different environments (development, staging, production)
- Apply the principle of least privilege (use read-only keys when write access is not required)
Key Permissions
API keys have different roles that determine their permissions:| Role | Description |
|---|---|
read-only | Can only retrieve data, cannot make changes |
read-write | Can both retrieve data and make changes |
Revoking API Keys
If an API key is compromised, you should immediately revoke it:- Go to your workspace settings
- Navigate to the API Keys section
- Find the key you want to revoke
- Click “Delete” to invalidate the key
