> For the complete documentation index, see [llms.txt](https://doc.aissist.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.aissist.io/integrations/restful-api.md).

# 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

<details>

<summary>Create the integration</summary>

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.

<figure><img src="/files/lQUcfggY7Qof2EgkAiyb" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary>Create actions from the API</summary>

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.

</details>

<details>

<summary>Example action patterns</summary>

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

<figure><img src="/files/pwYXmpq5xNNHmB7Q0rMk" alt=""><figcaption></figcaption></figure>

</details>

### Next step

After setup, test the action flow in [Action Debugger](/integrations/action-debugger.md).

If you want a more controlled way to expose internal systems, see [AWS Lambda](/integrations/aws-lambda.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.aissist.io/integrations/restful-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.