RunRL Python API Docs | dltHub

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

Last updated:

RunRL is a platform exposing RL training, file management, deployments, and tools via a REST API. The REST API base URL is https://runrl.com/api/v1 and all requests require a Bearer API key in Authorization header.

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


What data can I load from RunRL?

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

ResourceEndpointMethodData selectorDescription
files/filesGETdata.filesList files (filters: type, search, page, per_page, sort)
runs/runsGETdata.runsList runs (filters: status, per_page)
run/runs/{id}GETdata.runInspect run details
run_history/runs/{id}/historyGETdata.historyRun status timeline
run_logs/runs/{id}/logsGETdata.logsPaginated logs
deployments/deploymentsGETdata.deploymentsList deployments
tools/toolsGETdata.toolsList tools
files_preview/files/{fileId}/previewGETdata.previewFile preview
files_content/files/{fileId}/contentGETdata.contentRaw file content
keys/keysGETdata.keysList API keys (requires read)
search/searchGETdata.resultsGlobal search
health/healthGETdataHealth check (quick auth test)

How do I authenticate with the RunRL API?

Provide an API key from Settings → API Keys in header: Authorization: Bearer YOUR_API_KEY. Keys can be scoped (read, write, admin).

1. Get your credentials

  1. Log in to RunRL web app → Settings → API Keys. 2) Click Create API Key, set name, scopes (read/write/admin) and request limit. 3) Copy the generated token (format rl_xxxxx) and store securely. 4) Use the token in Authorization header for API calls.

2. Add them to .dlt/secrets.toml

[sources.run_rl_source] api_key = "rl_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 RunRL 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 run_rl_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline run_rl_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 runs and files from the RunRL 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 run_rl_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://runrl.com/api/v1", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "runs", "endpoint": {"path": "runs", "data_selector": "data.runs"}}, {"name": "files", "endpoint": {"path": "files", "data_selector": "data.files"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="run_rl_pipeline", destination="duckdb", dataset_name="run_rl_data", ) load_info = pipeline.run(run_rl_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("run_rl_pipeline").dataset() sessions_df = data.runs.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM run_rl_data.runs LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("run_rl_pipeline").dataset() data.runs.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 RunRL 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.


Troubleshooting

Authentication failures

Ensure Authorization header present: Authorization: Bearer YOUR_API_KEY. 401 indicates missing/invalid key; 403 indicates scope mismatch.

Rate limits

API keys enforce hourly quotas (default 10,000/hour). Check response headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. 429 returned when exceeded.

Pagination

List endpoints support page and per_page parameters. Results are returned under data. and include pagination metadata in data (page, per_page, total).

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

Was this page helpful?

Community Hub

Need more dlt context for RunRL?

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