AI Actions | Operations Automation | Bring your own API

Introduction

Bring Your Own API allows you to connect your own backend systems directly with Exei and let the AI agent trigger real actions during conversations.

Using this capability, the AI agent can call your APIs in real time to fetch data, perform operations, or update systems—turning conversations into fully automated workflows instead of just responses.

This feature is designed for teams that want deep customization and tighter integration with their existing systems.

What Bring Your Own API Does

When Bring Your Own API is enabled:

• The AI agent can securely call your APIs

• Real-time data can be fetched during conversations

• Backend actions can be triggered automatically

• Responses are generated using live system data

This allows the AI to move beyond static answers and perform real operations.

Common Use Cases

Bring Your Own API is commonly used for:

• Fetching order or shipment status

• Checking account or subscription details

• Updating user information

• Creating or updating records in internal systems

• Triggering workflows in CRMs, ERPs, or internal tools

Any use case that requires real-time data or action is a good fit.

Where to Configure Bring Your Own API

To configure a custom API action:

1. Open your AI agent from My Agents

2. Go to AI Actions

3. Select Bring Your Own API

4. Add a new API configuration

All API-based automations are managed from this section.

Defining an API Action

When adding a new API action, admins define:

• API endpoint (URL)

• HTTP method (GET, POST, PUT, etc.)

• Request headers (authentication, content type, etc.)

• Request body or parameters

• Expected response format

This tells the AI how to interact with your system.

How the AI Uses Your API

Once configured:

• The AI identifies when an API call is required

• It gathers required parameters from the conversation

• The API is triggered in real time

• The response is parsed

• The AI replies to the user using the API response

All of this happens seamlessly during the conversation.

Controlling When the API Is Triggered

Admins control when an API should be called by:

• Defining sample queries or intents

• Specifying required parameters

• Setting rules for when the action should run

This ensures APIs are triggered only in the correct scenarios.

Security and Access Control

Bring Your Own API is designed with security in mind.

• API credentials are stored securely

• Only configured actions can be triggered

• Access is controlled at the agent and admin level

This prevents unauthorized or accidental API usage.

API Responses and Error Handling

If an API responds successfully:

• The AI uses the response to answer the user

If an API fails or returns an error:

• The AI can provide a fallback response

• The issue can be reviewed from Conversations

• Admins can refine the API configuration

This ensures graceful handling of failures.

Visibility in Conversations

All API-triggered interactions:

• Appear in the Conversations section

• Include context of the API call

• Can be reviewed for debugging and optimization

This provides transparency and traceability.

Best Practices for Bring Your Own API

• Keep APIs fast and reliable

• Return clean, structured responses

• Avoid exposing sensitive data unnecessarily

• Test API actions thoroughly in the Playground

• Start with read-only APIs before write operations

Well-designed APIs lead to better AI behavior.

Common Mistakes to Avoid

• Triggering APIs on vague or generic queries

• Not validating required parameters

• Returning unstructured or unclear responses

• Skipping error handling scenarios

Careful setup prevents unexpected behavior.

How to Test Bring Your Own API

To test a custom API action:

1. Open Test AI Agent

2. Ask a query that should trigger the API

3. Verify the API response is used correctly

4. Check the conversation logs for accuracy

Testing ensures the API behaves as expected before going live.

When to Use Bring Your Own API

Use Bring Your Own API when:

• Data must be fetched in real time

• Actions must update external systems

• Standard AI Actions are not sufficient

• You need full control over logic and workflows

This feature is ideal for advanced automation scenarios.

What’s Next?

Once custom APIs are connected, you can build more advanced workflows.

Recommended next guide:

• Test your AI Agent | Playground