Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Billing Information
- GETGet Organizations
- POSTCreate an Organization
- GETGet an Organization
- DELDelete an Organization
- PATCHUpdate an Organization
- POSTCreate an API Key
- POSTEnforce Password Policy
- POSTCreate a System Message
- GETGet Users
- POSTCreate a User
- GETGet a User
- DELDelete a User
- PATCHUpdate a User
- POSTImpersonate a User
- GETGet Vendor Information
- GETGet Billing Information
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Create an API Key
Creates an API Key with admin permissions. The API Key is valid for 15 minutes. To activate this feature, set the FEATURE_USE_SUPERAPIKEY_API to ātrueā.
curl --request POST \
--url https://api-trial.cognigy.ai/new/management/v2.0/organisations/{organisationId}/apikeys \
--header 'Authorization: Basic <encoded-value>'{
"name": "<string>",
"_id": "<string>",
"createdAt": 1527621049,
"apiKey": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Basic Authentication used by routes designed for the Management-UI.
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Organisation
24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/management/v2.0/organisations/{organisationId}/apikeys \
--header 'Authorization: Basic <encoded-value>'{
"name": "<string>",
"_id": "<string>",
"createdAt": 1527621049,
"apiKey": "<string>"
}