How to create an API key and access the documentation
Create an API key with the right permissions to integrate your system with Cognizy and open the API documentation.
1 min readBasicUpdated on November 12, 2026
Changed on 11/12/2026: New developers area with the complete API reference
Where to find it in Cognizy
Video lesson coming soon. For now, follow the steps below.
The API key authenticates integrations with Cognizy. Each key has an environment (production or sandbox) and only the permissions you select. The documentation includes the full reference and a quick start guide.
Where to find it in Cognizy
Before you start
- A plan with API access.
- Only the owner and admins can create keys.
- Keep the key somewhere safe: whoever has the key can access your organization.
Step by step
- Step 1:
Open . In API Keys, check the month's usage and click New Key.
- Step 2:
Give it a Name, choose the Environment (SANDBOX (TEST) for testing, PRODUCTION (LIVE) for real use) and select only the Permissions the integration needs, module by module.
- Step 3:
Click New Key at the bottom of the window. The key appears only once: copy it and save it in your system.
- Step 4:
On the Documentation tab, click Open Interactive Documentation to see all the routes, or download the OpenAPI JSON. The Quick Start shows the first call.
How to know it worked
The key appears in the list (without the secret) with its environment and permissions. The integration can now authenticate with it.
If something goes wrong
The API responds that it doesn't have permission.
The key doesn't have permission for that module. Create another key with the right permission.
I lost the key.
It won't show up again. Delete the old key and create a new one.
Next step
Set up a webhook to receive events.
For developers
Sign in with your Cognizy account to save your progress.
Sign in