Skip to main content

Connect to the OpenAI Platform API

Learn how to connect OpenAI's platform API to Retool.

This resource integration is for interacting directly with Open AI's platform API. This can be useful for OpenAI organization administrators to programmatically manage users and projects.

Refer to the OpenAI for Retool AI documentation if you want to use OpenAI's models to power AI apps, workflows, and agents.

You can use the OpenAI platform integration to create a resource and make it available in Retool. Once complete, your users can write queries that interact with OpenAI platform data.

Requirements​

The OpenAI platform integration requirements depend on whether you have a cloud-hosted or self-hosted Retool organization. You may also need to make OpenAI platform configuration changes before creating the resource.

Sufficient user permissions to create resources

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

Allow Retool to access the data source

If the data source is behind a firewall or restricts access based on IP address, then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

To allow Retool access from one of its outbound regions, you must include the necessary IP addresses in your allowlist if you use inbound firewall rules. You can also use the Get IP Allowlist by Region endpoint to retrieve this list programmatically.

CIDR IP addresses
35.90.103.132/30
44.208.168.68/30
Individual IP addresses
35.90.103.132
35.90.103.133
35.90.103.134
35.90.103.135
44.208.168.68
44.208.168.69
44.208.168.70
44.208.168.71

Retool is building support for querying firewalled resources without allowlisting Retool’s IP address. To learn more or be considered for early access, contact cloud-connect@retool.com.

OpenAI platform settings and authentication

You must have sufficient access and familiarity with your OpenAI platform data source so you can provide:

  • Required connection settings (e.g., URL and server variables).
  • Authentication credentials (e.g., API keys).

In some cases, you may need to make changes to your OpenAI platform configuration, such as generating authentication credentials or allowing access through a firewall. Refer to the configuration and authentication sections to learn more.

Configure the resource​

Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select OpenAI platform.

Configuration​

Specify the name, location, and description to use for your OpenAI platform resource. Retool displays the resource name and type in query editors to help users identify them.

Provide the following configuration settings to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

API version

The API version with which to perform requests.

Authentication​

The OpenAI platform integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your OpenAI platform configuration.

API key

Authentication is performed using the API key. You must be able to obtain and provide these credentials to create the resource.

Save the resource​

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Query the resource​

The OpenAI Platform resource is now available for use in resource queries. When writing an OpenAI Platform resource query, you can select any supported API method in the Operations dropdown. Refer to OpenAI's platform API reference for more information about supported actions.

Next steps​

Your OpenAI platform resource is now ready to use. Check out related queries and code documentation to learn how to interact with OpenAI platform data.