Etherpad Python API Docs | dltHub

Etherpad is a real-time collaborative text editor platform that exposes an HTTP API to manage pads, authors, groups, sessions and pad content. The REST API base URL is https://{your-etherpad-host}/api/1 and all requests require an 'apikey' parameter passed in the query string or as a POST parameter.

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 add "dlt[hub]" and start loading Etherpad data in under 10 minutes.

---

What data can I load from Etherpad?

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

---

How do I authenticate with the Etherpad API?

Authentication is performed using an API key which is passed as a query or POST parameter named 'apikey' on every request. The key is generated at server start and stored in the APIKEY.txt file in the Etherpad installation root.

1. Get your credentials

Etherpad does not provide a web-based dashboard for managing API credentials. Authentication is handled via a single, deployment-wide API key generated automatically upon the first server startup. To obtain this key: 1. Access the server hosting the Etherpad instance via SSH or directly via the filesystem. 2. Navigate to the Etherpad installation root directory. 3. Locate and open the file named APIKEY.txt. 4. The content of this file is your API key.

2. Add them to .dlt/secrets.toml

Copy
[sources.etherpad_source]
api_key = "your_etherpad_apikey_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:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub 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:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

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 Etherpad 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:

Copy
uv run python etherpad_pipeline.py

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

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

Inspect your pipeline and data:

Copy
uv run dlthub 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 listAllPads and getText from the Etherpad API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def etherpad_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{your-etherpad-host}/api/1",
            "auth": {"type": "api_key", "api_key": api_key, "name": "apikey"},
        },
        "resources": [
            {"name": "list_all_pads", "endpoint": {"path": "listAllPads", "data_selector": "padIDs"}},
            {"name": "list_all_groups", "endpoint": {"path": "listAllGroups", "data_selector": "groupIDs"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="etherpad_pipeline",
        destination="duckdb",
        dataset_name="etherpad_data",
    )
    load_info = pipeline.run(etherpad_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):

Copy
import dlt

data = dlt.pipeline("etherpad_pipeline").dataset()
sessions_df = data.list_all_pads.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM etherpad_data.list_all_pads LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("etherpad_pipeline").dataset()
data.list_all_pads.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 Etherpad data to?

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

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 harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack