# Restful API

## Introduction to Integrations with Aissist

Aissist makes it simple to connect with **RESTful APIs**, giving you access to your internal systems like inventory, billing, calendars, and more. It can even perform actions such as canceling orders, issuing refunds, sending invoices, resetting passwords—you name it!\
These integrations enable Aissist to retrieve the right information and take the right actions at the right time, making your customer support faster, smarter, and more efficient.

<details>

<summary>🔌 Setting Up Integrations</summary>

Here’s how to set up a RESTful API integration:

1. Obtain your **API URL** and any required **authentication** (such as API keys or bearer tokens).
2. In the Aissist console, go to the **Workspace->Integration,** click "Add Integration", and select **Restful API**.
3. Enter:
   * The **API URL**
   * Authentication details (if needed)
   * (Optional) Customize the request **headers** if your API requires specific fields.

<figure><img src="https://301624521-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKHM836KGDAfAWvw6XL6%2Fuploads%2FqpWCatbJ8PGXqOZf3IMD%2FScreenshot%202025-04-26%20at%208.52.55%20PM.png?alt=media&#x26;token=71c00637-1f2e-448b-a33d-94a909bf28c4" alt=""><figcaption></figcaption></figure>

🔵 **Tip:** If you’re using an API behind AWS API Gateway, be sure you configure authentication properly (e.g., API key headers, OAuth).

</details>

<details>

<summary>🛠️ Setting Up Smart Actions with Restful APIs</summary>

Once your RESTful API is connected, you can create **Smart Actions** to automate tasks.

Here’s how:

1. Go to **Workspace->Action**, click **“Add Action”** .
2. Select the **Restful API** integration to open the **Smart Action Builder**.
3. Fill in the following:
   * Choose a **method** from the list
   * Input **Action Name** and **Description**
   * **Associate with Sub-Agents:**\
     You can link the action to a Sub-Agent for specific scenarios.
   * **Decide When to Run:**\
     Choose to run the action **at the beginning of a session** or **during the interaction** — or even enable both.
   * Select **Action Trigger** to be inbound, outbound or both
     * Inbound means a user's input message triggers this action
     * Outbound means Aissistant's reply triggers this action
     * Both means both direction can trigger this action
   * Input the **Endpoint URL**
   * Add all the **Request Parameters**
   * #### Returning and Summarizing Information

     You can also add instructions to explain the type of information the action returns.\
     If the response contains a lot of data, you can guide Aissistant to **summarize it** and extract only the important details needed for user responses

✅ **Important**:\
Give each smart action a clear, descriptive name that reflects its purpose, and provide a detailed explanation in the “D**escription**” field. This helps Aissistant understand exactly when and how to use the action during a conversation—the more specific you are, the better the results. Likewise, make sure each parameter has a meaningful name and description to ensure it's used correctly.

</details>

<details>

<summary>✨ Example Applications of Smart Actions</summary>

* **Order Tracking:** Pull shipping status from a logistics API.
* **Booking Lookup:** Retrieve a customer’s appointment details from your booking system.
* **Inventory Check:** Fetch real-time stock levels from your warehouse management API.
* **Refund Status:** Query refund information from your payment processor.

<figure><img src="https://301624521-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKHM836KGDAfAWvw6XL6%2Fuploads%2FJOngDyQafPqtdjIvWeco%2Fscreencapture-console-aissist-io-workspace-actions-fd4bc512-d6a9-4af2-89e9-08a62077c5d3-2025-04-26-22_58_32.png?alt=media&#x26;token=25fd99ed-e802-4d70-a2b1-793389777231" alt=""><figcaption></figcaption></figure>

***

By integrating Aissist with your own APIs, you can automate key workflows, provide quicker responses to users, and free up your team for more high-value tasks!

</details>

After setting up the Restful API integration and actions, you can use the [**Action Debugger**](https://doc.aissist.io/integrations/action-debugger) to test and verify that everything is working correctly.


---

# Agent Instructions: 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.