Guides

Generate an API key

Create and manage API tokens for secure access to Optra APIs.

Overview

API keys let you authenticate programmatic requests to the Optra API. Keys are scoped to an organization and can be restricted by permission level.

Create an API key

  1. Go to Settings → API keys in the Optra Platform.
  2. Click Generate new key.
  3. Choose a name and select the permission scopes required.
  4. Click Create and copy the key — it will only be shown once.

Use the key

Include the key in the Authorization header of every API request:

Authorization: Bearer <YOUR_API_KEY>

Rotate a key

To rotate a key, generate a new one, update your integration, then delete the old key from the settings page.