Skip to main content
APIs (Application Programming Interfaces) connect agents to external systems via HTTP. APIs define what actions agents can perform—such as viewing, creating, or updating data—depending on endpoint permissions. For instance, a helpdesk API may let agents read tickets but not create them. When setting up your custom API, review the documentation to ensure it supports the functions your agent needs.

​
Configuring your API

To configure a custom API, go to the Integrations tab and select APIs. From the Add New screen, you can import your OpenAPI definition (JSON or YAML) to automatically declare available endpoints (e.g., GET /tickets, POST /users). Specify your authentication type as OAuth, API key, or None. Once your schema is imported and endpoints are visible under the Available Actions section, click Confirm to save.

​
Testing your API

After saving, open your API and click the Test button next to an endpoint to open the Test Panel. Here, you can view and modify parameters, headers, and body fields. Enter your desired values and click Send to see live API responses.
Some APIs do not support testing through the frontend. If you are using the test panel and experience issues, trying adding your API to an agent and testing it through the chat feature.

​
Best Practices

  • Make sure to test all APIs before deployment.
  • Verify your API keys, header format, and authentication settings if tests fail.
  • Use OpenAPI 3.x or later for best compatibility.