API Keys
Learn how to create and manage API keys in Kognitos.
Overview
Kognitos provides a self-service console for creating and managing API keys. Keys can be scoped to an entire organization or a specific agent, depending on the level of access required.
Creating and Managing API Keys
API keys can be created and managed by:
Organization Admins: Can create and manage organization-level and agent-level keys.
Agent Admins: Can create and manage only agent-level keys.
API Key Creation
An organization can have up to 10 API keys in total, including organization-level and agent-level keys. Follow these steps to create a new one:
API Key Management
Click the three-dot menu (⋮) to the right of an API key to access management options. From there, you can edit or delete an existing key.
Editing
API keys can be renamed at any time. However, a key's scope (organization or agent) cannot be changed after creation.
Deleting
API keys do not expire automatically. If a key is no longer needed, you can delete it to revoke access immediately.
Troubleshooting
1. Error: "access not permitted" or statusCode: 401
statusCode: 401
This error typically means your API key is invalid or has been revoked. If a key was working previously but is now returning this error, it may have been deleted by an administrator.
2. Unable to create a new API key
If you're an admin and can't create new API keys, you may have reached your organization's limit. An organization can have up to 10 API keys in total, including organization-level and agent-level keys. You'll need to delete an existing, unused API key to free up a slot before you can create a new one.
Here to Help!
If you have questions or need assistance with API Keys, please contact our support team at [email protected] or via our platform's Support AI Assistance Chat (preferred).
Last updated
Was this helpful?