API Keys

API keys authenticate external widgets and PrimePilot API clients, enabling secure access to your squads. When an API key is assigned to a squad, it provides authentication credentials that allow external applications and chat widgets to communicate with that squad.

Creating API Keys

To deploy a squad, you must first create an API key in the API Keys section of your dashboard. API keys identify and authorize requests from external sources, ensuring only authenticated clients can access your squads. Without an API key assigned to a squad, the integration code cannot be generated, and the squad cannot be deployed to external websites or accessed via API clients.

Assigning API Keys to Squads

API keys are assigned to squads through the squad's API Key tab. When you assign an API key to a squad, the system validates that the key belongs to your tenant and is active. Once assigned, the API key is immediately available for use in the integration code. You can unassign an API key at any time, which will hide the integration code until a new key is assigned. This allows you to temporarily disable deployments or rotate keys without deleting the squad configuration.

The same API key can be assigned to multiple squads, allowing you to reuse credentials across different deployments while maintaining centralized key management.

Integration Code

Once an API key is assigned to a squad, the integration code in the Deployment tab automatically includes the actual API key value. This code is ready to use and can be copied directly into your website. The API key is included in the widget initialization, allowing the chat widget to authenticate with PrimePilot when deployed on your website. The integration code remains hidden until an API key is assigned, ensuring you complete the authentication setup before deployment.