Skip to content
EN
Open app

Custom API

1 min read
Copy as Markdown
View as MarkdownOpen the raw .md file.md

Integrations - Catalogue - Custom API - Connect links any REST API with a base URL and one auth header for the agent to call mid-conversation.

Connect Custom API base URL and auth header
custom-api-connectExpand
API base URLREQUIRED
Root URL, e.g. https://api.example.com. No trailing slash.
Auth header nameREQUIRED
e.g. Authorization or X-Api-Key.
Auth header valueREQUIRED
The secret sent on every request.
Label
Friendly name, e.g. My API.
  1. Catalogue - search Custom API - Connect.
  2. Fill base URL + auth header name/value + label - Connect (cancel if you are only exploring).
  3. Enable the Custom API tool on the agent and map the operations your contract exposes.
  4. Save and prove on a test call.
Calls fail immediately after connect

Remove a trailing slash from the base URL. Confirm the auth header name matches what your API expects.