Skip to main content

API Introduction

Explore the Optimly API through our guides and endpoint reference. Use it to integrate external systems, send messages, and track interactions in real time.

Accessing the API​

The Optimly API is available for accounts with an Advanced tier subscription or higher.

For full details on plan limits and pricing, please visit our pricing page.

Getting Your API Key​

Unlike other platforms, in Optimly each agent is provisioned with its own API key.

How to Get It​

  1. Go to the Agents section of your dashboard.
  2. Click on the agent you want to integrate.
  3. Open the Configuration tab.
  4. Copy the API Key displayed in the integration panel.

This key is unique to the selected agent. You can rotate it at any time from the same view. Api Token

Authentication​

Once you have the key, you can authenticate your API requests by including it in the Authorization header:

Authorization: Bearer YOUR_AGENT_API_KEY

Security Note​

  • Treat your API key like a password. Anyone with this key can send messages on behalf of your agent.
  • Never share it publicly or embed it in frontend code.
  • You can regenerate the key if it’s ever compromised.