Skip to main content
The Plati AI API uses API keys for authentication. You’ll need to include your API key in the Authorization header of all your requests.

Obtaining API Keys

API keys can be generated from your workspace. To create a new API key:
  1. Navigate to your workspace in the Plati AI dashboard
  2. Go to “API Keys” section
  3. Click “Create API Key”
  4. Choose a descriptive name for your key
  5. Select the appropriate role:
    • read-only - Can only read data
    • read-write - Can read and modify data
  6. Store your API key securely - it will only be displayed once

Using Your API Key

Include your API key in the Authorization header of all requests:
curl -X GET https://api.plati.ai/workers \
  -H "Authorization: Bearer YOUR_API_KEY"

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:
RoleDescription
read-onlyCan only retrieve data, cannot make changes
read-writeCan both retrieve data and make changes
Choose the appropriate permission level based on your integration needs.

Revoking API Keys

If an API key is compromised, you should immediately revoke it:
  1. Go to your workspace settings
  2. Navigate to the API Keys section
  3. Find the key you want to revoke
  4. Click “Delete” to invalidate the key
Once revoked, all requests using that key will be rejected.