Edge Delta Python API Docs | dltHub

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

Last updated:

Edge Delta is a platform for managing pipelines, alerts, and configurations via a REST API. The REST API base URL is https://api.edgedelta.com/v1 and All requests require an X-ED-API-Token header with a bearer token..

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


What data can I load from Edge Delta?

Here are some of the endpoints you can load from Edge Delta:

ResourceEndpointMethodData selectorDescription
pipeline_config/orgs/<ORG_ID>/confs/<PIPELINE_ID>GETcontentRetrieves a specific pipeline configuration (YAML)
pipeline_history/orgs/<ORG_ID>/pipelines/<PIPELINE_ID>/historyGETReturns an array of version history entries
list_pipelines/orgs/<ORG_ID>/pipelinesGETpipelinesLists all pipelines in an organization
organization_id/orgs/<ORG_ID>GETidRetrieves organization details
alerts/orgs/<ORG_ID>/alertsGETalertsLists alerts configured for the organization

How do I authenticate with the Edge Delta API?

Provide the token in the X-ED-API-Token request header for every API call.

1. Get your credentials

  1. Log in to the Edge Delta web console.
  2. Navigate to Account SettingsAPI Tokens.
  3. Click Create New Token, give it a name, and set desired scopes.
  4. Save the generated token; copy it for use in API calls.

2. Add them to .dlt/secrets.toml

[sources.edge_delta_source] api_token = "your_api_token_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 Edge Delta 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 edge_delta_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline edge_delta_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 pipeline_config and pipeline_history from the Edge Delta 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 edge_delta_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.edgedelta.com/v1", "auth": { "type": "api_key", "api_key": api_token, }, }, "resources": [ {"name": "pipeline_config", "endpoint": {"path": "orgs/<ORG_ID>/confs/<PIPELINE_ID>", "data_selector": "content"}}, {"name": "pipeline_history", "endpoint": {"path": "orgs/<ORG_ID>/pipelines/<PIPELINE_ID>/history"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="edge_delta_pipeline", destination="duckdb", dataset_name="edge_delta_data", ) load_info = pipeline.run(edge_delta_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("edge_delta_pipeline").dataset() sessions_df = data.pipeline_config.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM edge_delta_data.pipeline_config LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("edge_delta_pipeline").dataset() data.pipeline_config.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 Edge Delta 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

If the X-ED-API-Token header is missing or invalid, the API returns a 401 Unauthorized response.

Rate Limiting

When too many requests are made in a short period, the API may respond with 429 Too Many Requests. Implement back‑off and retry logic.

Pagination

List endpoints may paginate results using page and pageSize query parameters. Check the response for nextPageToken to retrieve subsequent pages.

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 Edge Delta?

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