Using the API

What is the Cognigy API?

For communication with the COGNIGY.AI installation, the frontend uses a HTTP-based API.
This API can also be used by developers to build custom integrations with the COGNIGY.AI systems.

What are the API's capabilities?

Any kind of information that is visible and any kind of action that can be performed in the frontend is queried or triggered through this API, which is 100% exposed for developers, too.

What do I need to access the API?

To use the API, you will need to have two things:

The API baseurl


This is the url which the API is available at.

Environment API Base URL
Demo (demo.cognigy.ai) https://api-demo.cognigy.ai
Community (app.cognigy.cloud) Not Supported
On-Premise Installations This is the url that has been defined as BACKEND_BASE_URL_WITH_PROTOCOL in your production.env file

Valid API key


An API key is used to authenticate to the COGNIGY.AI API as a user in the system without exposing the user's credentials.

You can get an API-key by logging into the frontend, going to your own user-profile by clicking your avatar in the top right, then click "My Profile" in the menu.

From here, provided that you have sufficient rights assigned, you can see an API key section where you can create a new API key.
By clicking an API key, you can copy the API key to your clipboard.

How do I use the API?

To do a call to the API, do a HTTP request and add either

  • a query parameter api_key with your API key as value
  • a header X-API-Keywith your API key set as value

Let's assume I have a COGNIGY.AI installation running at https://api-dummy.cognigy.ai and i created myself an API key which reads myDummyApiKey123.

I can now open a new browser tab and go to https://api-dummy.cognigy.ai/projects?api_key=myDummyApiKey123 to get a list of all the projects that are assigned to me, including meta-information about the resources within that project.
This call, for example, is used by the frontend when you load the "Projects" page.


What’s Next

With your API baseurl and your API key set up, find more information about what you can do in the API Reference

Did this page help you?