Connect to Tavily Web SearchBeta
Learn how to connect Tavily Search API to Retool.
You can use the Tavily Web Search integration to create a resource and make it available in Retool. Once complete, your users can write queries that interact with Tavily Web Search data.
- Cloud-hosted organizations
- Self-hosted organizations
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.
- us-west-2
- eu-central-1
- ap-southeast-1
35.90.103.132/30
44.208.168.68/30
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
3.77.79.248/30
3.77.79.248
3.77.79.249
3.77.79.250
3.77.79.251
47.128.165.252
54.169.175.71
54.255.139.141
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.
Tavily Web Search settings and authentication
You must have sufficient access and familiarity with your Tavily Web Search 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 Tavily Web Search configuration, such as generating authentication credentials or allowing access through a firewall. Refer to the configuration and authentication sections to learn more.
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 your deployment to access the data source
Your self-hosted deployment must have access to the data source. Ensure that any potential firewall rules for either the data source or your deployment instance are updated to allow them to communicate.
Tavily Web Search settings and authentication
You must have sufficient access and familiarity with your Tavily Web Search 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 Tavily Web Search configuration, such as generating authentication credentials or allowing access through a firewall. Refer to the configuration and authentication sections to learn more.
Custom OAuth 2.0 client credentials
Authentication is performed using a custom OAuth 2.0 client app. You must create this client and then provide its credentials. Once configured, your users are redirected to Tavily Web Search to sign in and authorize Retool to access data.
OAuth apps typically require the following values during creation:
- OAuth callback URL: The URL to which users are redirected once they have successfully signed in.
- Scopes : The permissions granted to Retool. Each scope defines a specific set of permissions (e.g.,
messages:readto read messagesusers:writeto create new users). You must ensure that any scopes defined in your OAuth app matches the scopes you specify when configuring the resource.
Once you've created an OAuth app you can obtain its credentials, such as the Client ID and Client secret. You then provide these to configure Retool for OAuth authentication.
Refer to the Tavily Web Search documentation for detailed instructions on creating an OAuth app.
Configure the resource
Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Tavily Web Search.
Configuration
Specify the name, location, and description to use for your Tavily Web Search 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.
- Cloud-hosted organizations
- Self-hosted organizations
Name
The name to use for the resource.
Description
A description of the resource.
Override default outbound Retool region
Retool connects to your data source from the us-west-2 region. Choosing a different outbound region can improve performance through geographic proximity.
| Region | Location |
|---|---|
| us-west-2 | US West (Oregon) |
| eu-central-1 | Europe (Frankfurt, Germany) |
| ap-southeast-1 | Asia-Pacific (Singapore) |
Name
The name to use for the resource.
Description
A description of the resource.
Authentication
The Tavily Web Search integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your Tavily Web Search configuration.
- Cloud-hosted organizations
- Self-hosted organizations
No authentication is required to use the Tavily Web Search integration. You can choose to provide your own Tavily API key if you do not want to be subject to Retool's rate limits (100 calls per 24 hours) on Tavily.
To use your own key, enable the Provide my own API key setting, and enter your key in the Custom API Key setting.
You must provide your own Tavily API key.
To use your own key, enable the Provide my own API key setting, and enter your key in the Custom API Key setting.
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.
Next steps
Your Tavily Web Search resource is now ready to use. Check out related queries and code documentation to learn how to interact with Tavily Web Search data.