> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retool

> You can connect Retool to Connect AI via the OpenAPI specification or via the Virtual SQL Server API. Follow the prerequisites and steps for the method you want to use.

## Prerequisites for Connecting via OpenAPI

Before you connect via OpenAPI, you must first do the following:

* In Connect AI:
  * Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
  * [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
  * [Add assets](/en/Workspaces#workspace-assets) to your workspace.
  * Generate a Personal Access Token (PAT) on the [Settings](/en/Settings#personal-access-tokens) page. Copy this down, as it acts as your password during authentication.
* In Retool:
  * Go to **Settings** > **API** and click **Create new** to generate an access token. See the [Retool documentation](https://docs.retool.com/org-users/guides/retool-api/authentication) for more information.

## Connect to Connect AI via OpenAPI

To establish a connection from Retool to Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In **Workspaces** in Connect AI, select a workspace and copy the OpenAPI URL for the workspace. Keep the default options. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_endpoints_URL.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=5c7f022c87ac7484a9bb2a96423b019d" alt="" width="752" height="531" data-path="en/images/retool_client_endpoints_URL.png" />
    </Frame>
  </Step>

  <Step>
    Log in to Retool.
  </Step>

  <Step>
    In the **Resources** tab, click **Create new** > **Resource**.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_create_new.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=70c62064c537b9eb76a78be86d2586b9" alt="" width="1894" height="863" data-path="en/images/retool_client_create_new.png" />
    </Frame>
  </Step>

  <Step>
    In the **Select a resource type** search bar, enter *OpenAPI*.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_openapi.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=b1a7ccc4009e53ac8b4e261374f05ccf" alt="" width="710" height="738" data-path="en/images/retool_client_openapi.png" />
    </Frame>
  </Step>

  <Step>
    Click **OpenAPI**. The **Configure OpenAPI** screen appears.
  </Step>

  <Step>
    Enter the following information to configure the OpenAPI connector:

    * **Name**—the name to use to identify the connector.
    * **Specification URL**—the OpenAPI URL you copied in Connect AI. Paste the URL here.
    * **Forward headers when fetching OpenAPI spec**—must be selected.
    * **Headers**—Authorization is *Basic*. Then, Retool requires that you Base64 encode your Connect AI username and PAT using the input format *username:PAT*. The PAT is the token you created in the prerequisites. You can use a tool such as the one [here](https://www.base64encode.org/). Click **Encode** and copy the Base64 encoded result into this field. For example, for *[test@cdata.com](mailto:test@cdata.com):12345*, the Base64 encoded value is *dGVzdEBjZGF0YS5jb206MTIzNDU=*.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings#personal-access-tokens) page.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_openapi_config.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=17a01c437d1867788af25e3f0be57dad" alt="" width="840" height="812" data-path="en/images/retool_client_openapi_config.png" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection** to test your connection configuration.
  </Step>

  <Step>
    Once you have a successful connection, click **Create resource**.
  </Step>

  <Step>
    Create the app in Retool in which to integrate your data.
  </Step>

  <Step>
    Click **Create resource query**.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_create_resource.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=ca93fcd02809f21a94ef6f0366b8e675" alt="" width="1920" height="926" data-path="en/images/retool_client_create_resource.png" />
    </Frame>
  </Step>

  <Step>
    Select the new resource you created, and view the endpoints that are available.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_endpoints.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=a8ea46c34cd22d62f3576469e2451cef" alt="" width="1915" height="864" data-path="en/images/retool_client_endpoints.png" />
    </Frame>
  </Step>

  <Step>
    You can now build your app with the data.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_create_app.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=78f73c7674a47314ddfde5af3a75590a" alt="" width="1919" height="917" data-path="en/images/retool_client_create_app.png" />
    </Frame>
  </Step>
</Steps>

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings#personal-access-tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via Virtual SQL Server API

To establish a connection from Retool to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Retool.
  </Step>

  <Step>
    Under **Resources**, click **Connect a resource**.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_01.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=019c842a5164a7ebc3068cd3d1db4702" alt="" width="1408" height="329" data-path="en/images/retool_client_01.png" />
    </Frame>
  </Step>

  <Step>
    Enter "Microsoft SQL" in the search bar and click the resulting option.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_02.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=9ac018a4747cfb747575c1720035092a" alt="" width="632" height="258" data-path="en/images/retool_client_02.png" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * **Name**—a name for the connection to Connect AI
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Database username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Database password**—enter the PAT you generated on the [Settings](/en/Settings#personal-access-tokens) page.

    <Frame>
      <img src="https://mintcdn.com/cdata/U1GIlo3WoTfP-zjY/en/images/retool_client_03.png?fit=max&auto=format&n=U1GIlo3WoTfP-zjY&q=85&s=d63821f42bdb9223511830058260b0c0" alt="" width="1085" height="791" data-path="en/images/retool_client_03.png" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection**. If it succeeds, you can click **Create resource**. Your connection to Connect AI is ready to use.
  </Step>
</Steps>