Load Retool data to DuckDB
Build a Retool to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Retool API base URL, auth, endpoints, and incremental loading.
The Retool API allows for programmatic management and interaction with Retool resources, apps, and organization settings. Everything needed to build a working Retool → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.
Build your Retool to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Retool to DuckDB and run it on dltHub
That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Retool API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →
Prefer to write it yourself? Every fact the agent uses is below.
Retool API at a glance
| Base URL | https://{your-retool-instance}/api/v2 |
| Example endpoint | GET resources |
| Records found at | data |
| Authentication | all requests require a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer |
| Pagination | Cursor-based next cursor at next_token |
| Incremental field | next_token |
| Record id | id |
| API reference | https://docs.retool.com/api |
These values come from the Retool API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Retool API?
The Retool API uses HTTP Bearer authentication. Requests must include the 'Authorization' header with the value 'Bearer {token}'.
1. Get your credentials
To obtain API credentials for the Retool REST API, follow these steps in your Retool dashboard: 1. Sign in to your Retool instance as an organization administrator. 2. Navigate to Settings, then click on the Retool API tab. 3. Click Create new to generate a new access token. 4. Provide a descriptive name and select the required permission scopes based on your needs. 5. Click Save or Create. Ensure you copy the token immediately, as it is displayed only once.
2. Add them to .dlt/secrets.toml
[sources.retool_source] api_key = "your_api_key_here"
dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.
What Retool data can I load into DuckDB?
These are the Retool endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| resources | /resources | GET | data | Lists all data source resources configured in the Retool organization. |
| get_resource | /resources/{id} | GET | Retrieves metadata for a specific resource by ID. | |
| list_folders | /resourceFolders | GET | Lists all resource folders. | |
| list_spaces | /spaces | GET | Lists all spaces in the organization. | |
| list_users | /users | GET | Lists all users in the organization. |
How do I load only new Retool records?
Retool exposes next_token on resources, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.
{"name": "resources", "endpoint": { "path": "resources", "data_selector": "data", "incremental": {"cursor_path": "next_token", "initial_value": "2024-01-01T00:00:00Z"}, }}
On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.
What does the generated Retool pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading apps and users from the Retool API into DuckDB:
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://{your-retool-instance}/api/v2", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "resources", "endpoint": {"path": "resources", "data_selector": "data"}}, {"name": "spaces", "endpoint": {"path": "spaces", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_retool_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="retool_pipeline", destination="duckdb", dataset_name="retool_data", ) load_info = pipeline.run(retool_source()) print(load_info) if __name__ == "__main__": load_retool_to_duckdb()
Run it with python retool_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.
How do I query Retool data in DuckDB?
dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("retool_pipeline").dataset() df = data.resources.df() print(df.head())
SQL:
SELECT * FROM retool_data.resources LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Retool to DuckDB pipeline in production?
The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.
- Deploy & schedule — run the pipeline as a managed job with automatic retries.
- Monitor — observable job queues, alerting, and load metrics for every run.
- Transform — promote raw Retool loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load Retool data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example value |
|---|---|
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.
Next steps
Was this page helpful?
Community Hub
Need more dlt context for Retool to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.