> For the complete documentation index, see [llms.txt](https://docs.ixhello.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ixhello.com/ixhc/open-ai.md).

# Open AI

Follow the steps below to setup the Open AI Integration to your Open AI instance.

## Prerequisites

1. **An ix Hello Account**

For steps to create an ix Hello account, use the following steps: 

<https://docs.ixhello.com/ixhc/general/ixhello-create-account>

2. **An app in the ix Hello account**

One app in ix Hello should be created and at least one Utterance as well.

\
3\. **An Open AI Key to be generated**

Please refer to <https://platform.openai.com/settings/organization/api-keys> for OpenAI key

Step-by-Step to Create OpenAI API Key

1. **Go to OpenAI Platform**\
   Open this link in your browser:\
   <https://platform.openai.com/account/api-keys>
2. **Sign in**\
   Use your OpenAI account to log in. If you don’t have one, sign up.
3. **Navigate to API Keys Page**\
   After signing in, go directly to:\
   <https://platform.openai.com/account/api-keys>
4. **Click "Create new secret key"**
   * A pop up window appears showing your **new secret key**.
   * **Copy it immediately** — it will **not be shown again**.
5. **Store it safely**\
   Save the key in a secure location.

## Creating a Custom App in ix Hello

1. On the left navigation menu, expand **Apps** and select **Custom Apps**. Click **New Custom App**

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FWjcQLWU1AszmB8or88Wi%2Fimage.png?alt=media&amp;token=23f88eb0-4629-46cb-943b-372c1c5bc274" alt=""><figcaption></figcaption></figure>

2. The user will see the popup screen as shown below:
   1. Populate the fields:
      * **Name:** Open AI Demo Bot
      * **Custom Skill Type**: Search
      * **Category**: Default
      * Click on the checkbox: This is a Generative AI APP
   2. Click **Save**.
   3. The user should see the new App listed in the Custom Apps:

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FHuDfwGVV6CVpV4ytKpAh%2Fimage.png?alt=media&amp;token=2641bc9e-56fd-4c0e-b72c-21d5b4bbf880" alt="" width="563"><figcaption></figcaption></figure>

## Creating a Data Source

1. A Data Source connects the App with the integration. To add a Data Source, click on the App name in the listing. A page of App contents will appear.
2. To add a Data Source to the new App, first check that the desired App appears in the Current App field. Open the **Data Sources** tab in the top tabs and press **Create New Data Source**.

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FkgeDq3tsvmF82PBbicr2%2Fimage.png?alt=media&amp;token=f237efff-aa32-46ce-90f5-cb92c5b4fa94" alt=""><figcaption></figcaption></figure>

**Name:** Open AI DS

**Integration Configuration:** Generative AI: Voiceworx Generative AI (19)

**Click**: Save.

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2FI58AHFYA0Aeo7itd1ndg%2Fimage.png?alt=media&amp;token=2bacae89-3d60-4a76-9c1e-4b2eeec28a70" alt="" width="563"><figcaption></figcaption></figure>

## Creating a Method

Now let's create some methods that interact with the APIs.

The request type of method depends on the data source.&#x20;

On the Methods tab, click on Add New Method. Also note that, on the Data Source drop down, the data source created in the preceding step is selected.&#x20;

A custom app can have multiple data sources, integrating with multiple third-party systems.

<figure><img src="https://1107164708-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8XHvUsfyTUFLvToHqD%2Fuploads%2F1ursdP5KSwb0DbseTha8%2Fimage.png?alt=media&amp;token=8f374926-5d0f-49ed-9a28-0055f767c8c4" alt=""><figcaption></figcaption></figure>

You are setting up on which endpoint you want to send request to and how you want the result output to be presented to the user.

Please fill in the details as suggested:

**METHOD INPUT:**

Name: Open AI Method

Request Type: GET

Method Path: /users

Query Path: ?name={{Person}}

METHOD OUTPUT:

Result Type: ListOfRecords

Record JsonPath: $.\[\*]

Record Template: {{Records}}

Record Limit: 10

METHOD RESULT:

Valid Result Template: You can contact {{name}} at {{phone}} How else I can help you?

Empty Result Template: Sorry, I could not find {{Person}} How else I can help you?

Click Save


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ixhello.com/ixhc/open-ai.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.