Skip to main content
Back to Actions Integrations Connect OpenAI to generate answers from context and extract skills from documents. See OpenAI Documentation for more information.

​
Authorizations Supported

The XO Platform supports basic authentication for OpenAI. See App Authorization Overview for details.
Authorization TypeBasic Auth
Pre-authorize the IntegrationYes
Allow Users to Authorize the IntegrationYes

​
Step 1: Enable the OpenAI Action

Prerequisites:
  • If you don’t have OpenAI credentials, create a developer account at OpenAI.
  • 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. Auth Type and API Key
    The Platform uses the configured API Key to authorize and generate suggestions from OpenAI.
  5. Click Enable. The Integration Successful pop-up is displayed. Enable integration
The OpenAI action moves from Available to Configured after enabling.

​
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. Auth type - Basic Auth
  4. Click Select Authorization > Create New. Create new Auth
  5. Select API Key as the authorization mechanism. See App Authorization Overview. Auth mechanism - API Key
  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. Save auth profile
  8. Select the new Authorization Profile. Select auth profile to complete integration
  9. Click Enable.

​
Step 2: Install the OpenAI Action Templates

  1. On the Integration Successful dialog, click Explore Templates. Explore Templates
  2. Click Install to begin installation. Begin installation
  3. Once installed, click Go to Dialog. A dialog task for each template is auto-created. Dialog task for each template
  4. Select the desired dialog task and click Proceed. Select desired task from template
  5. The dialog task is auto-created and the canvas opens with all required entity nodes, service nodes, and message scripts. dialog task is auto-created