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 for more information.
  • Add a workspace to Workspaces.
  • Add assets to your workspace.
  • Generate a Personal Access Token (PAT) on the Settings 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 for more information.

Connect to Connect AI via OpenAPI

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

1. In Workspaces in Connect AI, select a workspace and copy the OpenAPI URL for the workspace. Keep the default options. See OpenAPI for more information.

   
2. Log in to Retool.

3. In the Resources tab, click Create new > Resource.

   
4. In the Select a resource type search bar, enter OpenAPI.

   
5. Click OpenAPI. The Configure OpenAPI screen appears.

6. 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. Click Encode and copy the Base64 encoded result into this field. For example, for [e-mail]: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, [e-mail].
   • Password—enter the PAT you generated on the Settings page.

   
7. Click Test connection to test your connection configuration.

8. Once you have a successful connection, click Create resource.

9. Create the app in Retool in which to integrate your data.

10. Click Create resource query.

    
11. Select the new resource you created, and view the endpoints that are available.

    
12. You can now build your app with the data.

    

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 for more information.
• Generate a Personal Access Token (PAT) on the Settings 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.

1. Log in to Retool.

2. Under Resources, click Connect a resource.

   
3. Enter “Microsoft SQL” in the search bar and click the resulting option.

   
4. 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, [e-mail].
   • Database password—enter the PAT you generated on the Settings page.

   
5. Click Test connection. If it succeeds, you can click Create resource. Your connection to Connect AI is ready to use.