Wren AI Python API Docs | dltHub

Build a Wren AI-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Wren AI's API enables embedding data analysis in applications. It offers SQL generation and chart creation from natural language queries. To use it, obtain an API key and refer to the API Reference for detailed documentation. The REST API base URL is https://cloud.getwren.ai/api/v1 and All requests use an Authorization Bearer API key..

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 Wren AI data in under 10 minutes.


What data can I load from Wren AI?

Here are some of the endpoints you can load from Wren AI:

ResourceEndpointMethodData selectorDescription
sql_generation/api/v1/generate_sqlPOSTGenerate SQL from natural language question.
chart_generation/api/v1/generate_chartPOSTGenerate Vega‑Lite chart specification.
api_history/api/v1/historyGETView chronological record of API calls (does not include auth failures).
projects/api/v1/projectsGETList projects accessible to the API key.
keys/api/v1/keysGETRetrieve API key metadata (if supported).

How do I authenticate with the Wren AI API?

Wren expects an HTTP header Authorization: Bearer YOUR_API_KEY.

1. Get your credentials

  1. Log into Wren Cloud (cloud.getwren.ai).
  2. In the dashboard navigate to API > API Keys (or Project → API Keys).
  3. Create a Project or Organization API key.
  4. Copy the key and store it securely; use it in the Authorization header as Bearer YOUR_API_KEY.

2. Add them to .dlt/secrets.toml

[sources.wren_ai_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:

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

1. Install the dlt AI Workbench:

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:

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 Wren AI 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:

python wren_ai_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline wren_ai_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 sql_generation and chart_generation from the Wren AI API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def wren_ai_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://cloud.getwren.ai/api/v1", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "sql_generation", "endpoint": {"path": "api/v1/generate_sql"}}, {"name": "chart_generation", "endpoint": {"path": "api/v1/generate_chart"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="wren_ai_pipeline", destination="duckdb", dataset_name="wren_ai_data", ) load_info = pipeline.run(wren_ai_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):

import dlt data = dlt.pipeline("wren_ai_pipeline").dataset() sessions_df = data.sql_generation.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM wren_ai_data.sql_generation LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("wren_ai_pipeline").dataset() data.sql_generation.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 Wren AI data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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


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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Wren AI?

Request dlt skills, commands, AGENT.md files, and AI-native context.