Load Oxygen XML Forum data to DuckDB

Oxygen XML Web Author REST API is an interface used to integrate external content management systems or file servers for browsing, loading, and saving documents within the Web Author environment. Everything needed to build a working Oxygen XML Forum → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your Oxygen XML Forum to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Oxygen XML Forum to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Oxygen XML Forum API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

Oxygen XML Forum API at a glance

These values come from the Oxygen XML Forum API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the Oxygen XML Forum API?

The API supports cookie-based authentication or bearer token authentication. Requests requiring authorization should include an 'Authorization' header with the format 'Bearer '.

1. Get your credentials

Oxygen XML Web Author REST API does not use a traditional API key/secret generated in a dashboard. Instead, it relies on authentication mechanisms implemented by the CMS it connects to. There are two primary methods: 1) Session Cookies: The client performs a login via the $BASE_URL/rest-login endpoint, which returns session cookies that are then included in subsequent API requests. 2) Bearer Tokens: If supported by your custom CMS implementation, you can include an 'Authorization: Bearer ' header in your requests. You should consult your specific CMS administration documentation for how to generate or retrieve these credentials.

2. Add them to .dlt/secrets.toml

Copy
[sources.oxygen_xml_forum_source]
session_cookie = "your_session_cookie_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What Oxygen XML Forum data can I load into DuckDB?

These are the Oxygen XML Forum endpoints dlt can load into DuckDB:

---

How do I load only new Oxygen XML Forum records?

The Oxygen XML Forum API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

Copy
{"name": "files", "endpoint": {
    "path": "files?url={path}",
    # Replace with a field that increases on every write.
    "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated Oxygen XML Forum pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading files and doc/load from the Oxygen XML Forum API into DuckDB:

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

@dlt.source
def oxygen_xml_forum_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "Configurable base URL provided by the CMS integration (e.g., 'https://example.com/oxygen-cms/v1/')",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "files", "endpoint": {"path": "files?url={path}"}},
            {"name": "file", "endpoint": {"path": "file?url={path}"}}
        ],
    }
    yield from rest_api_resources(config)


def load_oxygen_xml_forum_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="oxygen_xml_forum_pipeline",
        destination="duckdb",
        dataset_name="oxygen_xml_forum_data",
    )
    load_info = pipeline.run(oxygen_xml_forum_source())
    print(load_info)


if __name__ == "__main__":
    load_oxygen_xml_forum_to_duckdb()

Run it with python oxygen_xml_forum_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query Oxygen XML Forum data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("oxygen_xml_forum_pipeline").dataset()
df = data.files.df()
print(df.head())

SQL:

Copy
SELECT * FROM oxygen_xml_forum_data.files LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the Oxygen XML Forum to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw Oxygen XML Forum loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Oxygen XML Forum data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack