RESTful API

Last updated: May 15, 2026

Connect Aissist to your own API endpoints.

Use this integration when you want Aissist to read live data or trigger actions in your internal systems.

RESTful API is the integration.

Actions use your API during conversations.

Common use cases include:

• order lookup

• booking retrieval

• inventory checks

• refunds or account updates

Create the integration

1. Prepare your API URL and authentication details.

2. Go to Workspace → Integrations.

3. Click Add Integration.

4. Choose RESTful API.

5. Enter:

   • the API URL

   • authentication details, if required

   • optional headers, if your API needs them

If your API sits behind AWS API Gateway, make sure the required authentication headers are included.

Create actions from the API

After the integration is connected, create actions that call specific endpoints.

1. Go to Workspace → Action.

2. Click Add Action.

3. Select the Restful API integration.

4. Configure:

   • the method

   • a clear action name

   • a clear action description

   • the endpoint URL

   • the request parameters

   • whether the action runs inbound, outbound, or both

   • any linked sub agents

Use clear names and parameter descriptions so Aissist knows when to trigger the action and how to fill values correctly.

Link actions to sub agents when the endpoint supports a specific workflow, such as order tracking, booking lookup, or refund status.

If the response is large, add instructions for how Aissist should summarize it for the user.

Example action patterns

Examples:

• Order Tracking — pull shipping status from a logistics API

• Booking Lookup — retrieve appointment details from a booking system

• Inventory Check — fetch real-time stock levels from a warehouse system

• Refund Status — query refund details from a payment platform

Next step

After setup, test the action flow in Action Debugger.

If you want a more controlled way to expose internal systems, see AWS Lambda.