Custom API connections

If a system you use has an API but isn't in the integrations list, you can connect it yourself. Your agent reads the docs, works out the calls and uses the data in answers, dashboards and pages.

Add a connection

1. Go to Integrations and open Custom API.
2. Enter a name and the base address, for example https://api.yoursystem.com.
3. Choose how it signs in: bearer token, API key in a header, API key in the address, username and password, or no sign-in.
4. Paste the key or token. It is encrypted and never shown again, including in the agent's replies.
5. Optionally add a link to the docs or OpenAPI file, and notes for your agent.
6. Tick Let everyone in my organisation's agents use it to share it with your team.
7. Press Connect, then Test.

Each connection shows whether it is working and its last error.

Switching it on

Admins can switch custom API connections on or off for each person in Settings › Team.