Configure your organization for Agents
Configure Agents for cloud and self-hosted instances.
An organization admin must complete the steps in the following sections to make sure your organization is ready to use Agents.
To learn how to create and use agents, visit the Agents quickstart or the Agents tutorials.
Configure organization settings
Ensure that Agents is enabled and that it has access to the proper AI models.
- To ensure your users can access Agents, navigate to Settings > AI. Verify that the Retool AI and AI Agents settings are toggled on.
- Navigate to Resources > Retool AI. Ensure that at least one AI provider is enabled. You can choose to use Retool-managed keys or self-managed keys.
Only AI models that support tool creation can be used with Agents. Refer to AI providers and models for supported models.
When users in your organization create a new agent, Retool automatically selects the first available enabled AI provider resource as the default model. Make sure the providers you want to expose are enabled in the order you prefer.
Self-hosted configuration
Complete the steps in the following sections if you self-host Retool. Skip these steps if you use cloud.
Requirements
To use Agents on self-hosted instances, your organization must:
- Use Retool version 3.234.0 or later (3.253.0 or later for stable releases).
- Have its own AI model key(s) configured.
- Meet all of the requirements outlined in the tutorial for your chosen deployment infrastructure.
Installation
Agents is supported for the following self-hosted deployment options.
- Docker
- Kubernetes with Helm
Follow the instructions outlined in the Docker deployment tutorial.
Docker deployments are not suitable for production use. For production deployments, use Kubernetes with Helm.
To deploy a self-hosted instance that contains agents, use the Retool Helm chart 6.6.0 or later.
Configure the values.yaml file as follows:
-
In the
image.tagfor thetryretool/backendandtryretool/code-executor-service, specify the Docker tag for the version of Retool to install, such astryretool/backend:4.0.10-stable.importantAgents is available on Retool version
3.253.0-stableor later. -
Set agents to
enabled: true.
For further configuration, you can reference the full agents: block as defined in retool-helm.
Additional configuration
Agents on self-hosted instances rely on Temporal. To deploy agents, you must create two additional containers with configuration and networking egress identical to the workflows-worker container:
| Container | SERVICE_TYPE Environment Variable 1 | Networks | Dependencies | Restart Policy |
|---|---|---|---|---|
agent-worker | AGENT_TEMPORAL_WORKER | backend, code-executor | postgres | always |
agent-eval-worker | AGENT_EVAL_TEMPORAL_WORKER | backend, code-executor | postgres | always |
The infrastructure of the Agents edge deployment is very similar to a Retool deployment with workflows. The following example code block shows the agent-worker and agent-eval-worker container configuration for a Docker Compose deployment.
services:
# Temporal workers for Agents
agent-worker:
build:
context: .
env_file: docker.env
environment:
- SERVICE_TYPE=AGENT_TEMPORAL_WORKER
networks:
- backend
- code-executor
depends_on:
- postgres
restart: always
agent-eval-worker:
build:
context: .
env_file: docker.env
environment:
- SERVICE_TYPE=AGENT_EVAL_TEMPORAL_WORKER
networks:
- backend
- code-executor
depends_on:
- postgres
restart: always
Using a Retool-managed agents observability API is required in the edge release. This API strictly does not receive, persist, or have access to sensitive customer data, agent inputs, or agent outputs. It is required to power the Monitor dashboard.