RunwayML Python API Docs | dltHub
Build a RunwayML-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
RunwayML's API allows for video generation from images, text, and other media. It includes models like Gen-4.5 and SDKs for integration. Enterprise users can request higher usage limits. The REST API base URL is https://api.runway.team/v1 and All requests require an API key via the X-API-Key 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 RunwayML data in under 10 minutes.
What data can I load from RunwayML?
Here are some of the endpoints you can load from RunwayML:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| projects | /projects | GET | projects | List all projects |
| models | /models | GET | models | Retrieve available models |
| tasks | /tasks | GET | tasks | Get a list of tasks |
| credits | /credits/usage | GET | results | Retrieve credit usage statistics |
| users | /users/me | GET | Get information about the authenticated user | |
| tasks | /tasks | POST | Create a new task (included for completeness) | |
| models | /models/{model_id} | GET | Get details of a specific model | |
| projects | /projects/{project_id} | GET | Get details of a specific project | |
| runs | /runs | GET | runs | List runs |
| runs | /runs/{run_id} | GET | Get details of a specific run |
How do I authenticate with the RunwayML API?
Authentication is performed by including your API key in the X-API-Key request header.
1. Get your credentials
- Log in to your Runway account at https://runwayml.com.
- Navigate to the Account Settings or API section.
- Locate the "API Keys" area.
- Click "Create New Key" (or similar), give it a name, and confirm.
- Copy the generated API key and store it securely; you will use it as the value for
RUNWAYML_API_SECRETor theapi_keyparameter. - Optionally, set the environment variable
RUNWAYML_API_SECRETwith the key for local development.
2. Add them to .dlt/secrets.toml
[sources.runwayml_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 RunwayML 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 runwayml_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline runwayml_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset runwayml_data The duckdb destination used duckdb:/runwayml.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline runwayml_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 tasks from the RunwayML 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 runwayml_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.runway.team/v1", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "projects", "endpoint": {"path": "projects", "data_selector": "projects"}}, {"name": "tasks", "endpoint": {"path": "tasks", "data_selector": "tasks"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="runwayml_pipeline", destination="duckdb", dataset_name="runwayml_data", ) load_info = pipeline.run(runwayml_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("runwayml_pipeline").dataset() sessions_df = data.tasks.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM runwayml_data.tasks LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("runwayml_pipeline").dataset() data.tasks.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 RunwayML 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 RunwayML?
Request dlt skills, commands, AGENT.md files, and AI-native context.