Retool Python API Docs | dltHub

Retool API enables you to perform actions across your organization or its spaces, allowing for RESTful requests to manage various objects like adding users or updating resource configurations. The REST API base URL is https://api.retool.com/api/v2/ and All requests can be authenticated using various methods, including a Bearer token..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Retool data in under 10 minutes.

---

What data can I load from Retool?

Here are some of the endpoints you can load from Retool:

---

How do I authenticate with the Retool API?

Retool supports several authentication methods, including Bearer token, Basic authentication, OAuth 2.0, AWS Signature V4, Custom, Digest, Google Service Account, and None. When using a Bearer token, Retool sends the token as Authorization: Bearer {token}.

1. Get your credentials

To obtain API credentials, navigate to the resource's configuration page within Retool, select an authentication method from the dropdown, and provide the necessary credentials.

2. Add them to .dlt/secrets.toml

Copy
[sources.retool_source]
api_key = "your_api_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Retool API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python retool_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline retool_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset retool_data
The duckdb destination used duckdb:/retool.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline retool_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads placeholder_resource_1 and placeholder_resource_2 from the Retool API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def retool_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.retool.com/api/v2/",
            "auth": {
                "type": "bearer",
                "token": api_key,
            },
        },
        "resources": [
            {"name": "placeholder_resource_1", "endpoint": {"path": "placeholder/path/1"}},
            {"name": "placeholder_resource_2", "endpoint": {"path": "placeholder/path/2"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="retool_pipeline",
        destination="duckdb",
        dataset_name="retool_data",
    )
    load_info = pipeline.run(retool_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("retool_pipeline").dataset()
sessions_df = data.placeholder_resource.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM retool_data.placeholder_resource LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("retool_pipeline").dataset()
data.placeholder_resource.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Retool data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

API Errors

The provided documentation does not detail specific API error codes or common error scenarios beyond general authentication failures. Users should refer to the Retool platform for real-time error messages and debugging tools.

Rate Limits

Information regarding API rate limits is not available in the provided documentation. Users should consult the Retool platform or contact support for details on rate limiting policies.

Pagination

The provided documentation does not specify pagination mechanisms for API responses. Users should examine individual endpoint responses for pagination fields or consult the Retool platform's query builder for pagination options.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack