Dataiku Python API Docs | dltHub
Build a Dataiku-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Dataiku's REST API allows programmatic access via HTTP endpoints. The latest reference is available at https://developer.dataiku.com/latest/api-reference/index.html. The base URL is http://dss_host:dss_port/public/api/. The REST API base URL is http://{dss_host}:{dss_port}/public/api and All requests require a Dataiku API key (can be provided as Bearer token or Basic auth password)..
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 Dataiku data in under 10 minutes.
What data can I load from Dataiku?
Here are some of the endpoints you can load from Dataiku:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| projects | /projects | GET | (top-level array) | List all projects (returns array of Project objects) |
| project | /projects/{projectKey} | GET | Get project details (object) | |
| datasets | /projects/{projectKey}/datasets/ | GET | (top-level array) | List datasets in a project (returns array of Dataset objects) |
| dataset | /projects/{projectKey}/datasets/{datasetName} | GET | Get dataset metadata (object) | |
| dataset_schema | /projects/{projectKey}/datasets/{datasetName}/schema | GET | columns | Dataset schema; columns is an array of column objects |
| dataset_data | /projects/{projectKey}/datasets/{datasetName}/data?format=json | GET | (top-level array of arrays) | Retrieve dataset rows in JSON format (returns an array of arrays) |
| recipes | /projects/{projectKey}/recipes/ | GET | (top-level array) | List recipes in a project |
| jobs | /projects/{projectKey}/jobs/ | GET | (top-level array) | List job records for a project |
| scenarios | /projects/{projectKey}/scenarios | GET | (top-level array) | List scenarios in a project |
| savedmodels | /projects/{projectKey}/savedmodels | GET | (top-level array) | List saved models in a project |
How do I authenticate with the Dataiku API?
Dataiku uses API keys managed in the DSS Administration UI. The API key can be sent as an HTTP Bearer token (Authorization: Bearer <api_key>) or via HTTP Basic auth with empty username and the API key as password.
1. Get your credentials
- Log in to your Dataiku DSS instance as an admin or a user with permission to create API keys.2. Go to Administration > API keys (or User profile > API keys) depending on your DSS version.3. Create a new API key, give it a name and appropriate permissions (project access as needed), and copy the generated key.4. Store the key in your dlt secrets.toml under sources.{source}_source as api_key = "...".
2. Add them to .dlt/secrets.toml
[sources.dataiku_source] api_key = "your_dataiku_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 Dataiku 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 dataiku_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline dataiku_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset dataiku_data The duckdb destination used duckdb:/dataiku.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline dataiku_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 projects and datasets from the Dataiku 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 dataiku_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "http://{dss_host}:{dss_port}/public/api", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "projects", "endpoint": {"path": "projects"}}, {"name": "datasets", "endpoint": {"path": "projects/{projectKey}/datasets/"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="dataiku_pipeline", destination="duckdb", dataset_name="dataiku_data", ) load_info = pipeline.run(dataiku_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("dataiku_pipeline").dataset() sessions_df = data.datasets.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM dataiku_data.datasets LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("dataiku_pipeline").dataset() data.datasets.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 Dataiku data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 Dataiku?
Request dlt skills, commands, AGENT.md files, and AI-native context.