> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuring the OpenAI Action

<Badge icon="arrow-left" color="gray">[Back to Actions Integrations](/ai-for-service/integrations/overview#actions)</Badge>

Connect OpenAI to generate answers from context and extract skills from documents. See [OpenAI Documentation](https://platform.openai.com/docs/api-reference/introduction) for more information.

***

## Authorizations Supported

The XO Platform supports basic authentication for OpenAI. See [App Authorization Overview](/ai-for-service/app-settings#authorization-profiles) for details.

| Authorization Type                       | Basic Auth |
| ---------------------------------------- | ---------- |
| Pre-authorize the Integration            | Yes        |
| Allow Users to Authorize the Integration | Yes        |

***

## Step 1: Enable the OpenAI Action

**Prerequisites:**

* If you don't have OpenAI credentials, create a developer account at [OpenAI](https://platform.openai.com/docs/api-reference/authentication).
* Copy your API Key.

**Steps:**

1. Go to **App Settings** > **Integrations** > **Actions**.
2. Select **OpenAI**.

### Pre-authorize the Integration

**Basic Auth**

1. Go to **App Settings** > **Integrations** > **Actions** and select **OpenAI**.

2. In **Configurations**, select the **Authorization** tab.

3. Set **Authorization Type** to **Pre-authorize the Integration** > **Basic Auth**.

4. Enter your **API Key**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img2.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=b858e8867ae344f37a493b11e2b668c9" alt="Auth Type and API Key" width="894" height="840" data-path="ai-for-service/integrations/actions/images/open-ai-action-img2.png" />

   <Note>The Platform uses the configured API Key to authorize and generate suggestions from OpenAI.</Note>

5. Click **Enable**. The **Integration Successful** pop-up is displayed.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img3.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=c9dfe582992691225e94ef34f29f5bf0" alt="Enable integration" width="666" height="272" data-path="ai-for-service/integrations/actions/images/open-ai-action-img3.png" />

<Note>The OpenAI action moves from *Available* to *Configured* after enabling.</Note>

### Allow End User to Authorize

1. Go to **App Settings** > **Integrations** > **Actions** and select **OpenAI**.

2. In **Configurations**, select the **Authorization** tab.

3. Set **Authorization Type** to **Allow Users to Authorize the Integration** > **Basic Auth**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img4.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=049cc95b0312f2cef27a34d48e2f1b13" alt="Auth type - Basic Auth" width="899" height="836" data-path="ai-for-service/integrations/actions/images/open-ai-action-img4.png" />

4. Click **Select Authorization** > **Create New**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img5.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=2139bd4bfc1bdf688cf32e0eee966cad" alt="Create new Auth" width="797" height="844" data-path="ai-for-service/integrations/actions/images/open-ai-action-img5.png" />

5. Select **API Key** as the authorization mechanism. See [App Authorization Overview](/ai-for-service/app-settings#authorization-profiles).

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img6.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=9b171b6e77b558aafbd950665d0510a8" alt="Auth mechanism - API Key" width="785" height="910" data-path="ai-for-service/integrations/actions/images/open-ai-action-img6.png" />

6. Enter the Basic Auth credentials:
   * **Name** - Name for the auth profile.
   * **Base URL** - Base tenant URL for OpenAI instance.
   * **Authorization Check URL** - Authorization check URL for your OpenAI instance.
   * **Description** - Description of the profile.

7. Click **Save Auth**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img7.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=108d1eae8d79f185f197074dffac6a82" alt="Save auth profile" width="797" height="902" data-path="ai-for-service/integrations/actions/images/open-ai-action-img7.png" />

8. Select the new **Authorization Profile**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img8.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=d0be59f038ccb574ebeb62604222ed5c" alt="Select auth profile to complete integration" width="1072" height="822" data-path="ai-for-service/integrations/actions/images/open-ai-action-img8.png" />

9. Click **Enable**.

***

## Step 2: Install the OpenAI Action Templates

1. On the **Integration Successful** dialog, click **Explore Templates**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img9.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=e77b182af5fe3f7700dabd6c0d251d9d" alt="Explore Templates" width="666" height="270" data-path="ai-for-service/integrations/actions/images/open-ai-action-img9.png" />

2. Click **Install** to begin installation.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img10.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=edf07fe5db6388ff6a126603b512e1e2" alt="Begin installation" width="668" height="428" data-path="ai-for-service/integrations/actions/images/open-ai-action-img10.png" />

3. Once installed, click **Go to Dialog**. A dialog task for each template is auto-created.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img11.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=298334cf0977c39e1e98529935d61e6c" alt="Dialog task for each template" width="1336" height="508" data-path="ai-for-service/integrations/actions/images/open-ai-action-img11.png" />

4. Select the desired dialog task and click **Proceed**.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img12.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=7dfb0bf9d4359e529a13ada5b183a151" alt="Select desired task from template" width="1076" height="910" data-path="ai-for-service/integrations/actions/images/open-ai-action-img12.png" />

5. The dialog task is auto-created and the canvas opens with all required entity nodes, service nodes, and message scripts.

   <img src="https://mintcdn.com/koreai/NuCnGNJCXSVC7wUP/ai-for-service/integrations/actions/images/open-ai-action-img13.png?fit=max&auto=format&n=NuCnGNJCXSVC7wUP&q=85&s=dd70941339e9c42263f09234b98ed1ab" alt="dialog task is auto-created" width="1600" height="812" data-path="ai-for-service/integrations/actions/images/open-ai-action-img13.png" />


Built with [Mintlify](https://mintlify.com).