Oxygen XML Forum Python API Docs | dltHub

Oxygen XML Web Author REST API is a REST interface used by oXygen Web Author (and its Web Author REST plugin) to integrate a CMS or file server for file browsing, loading and saving documents. The REST API base URL is https://your-cms.example.com/oxygen-cms/v1/ and Requests typically use a session-based (cookie) login flow or an explicit login endpoint; some deployments also support token or basic auth depending on server implementation..

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 Oxygen XML Forum data in under 10 minutes.

---

What data can I load from Oxygen XML Forum?

Here are some of the endpoints you can load from Oxygen XML Forum:

---

How do I authenticate with the Oxygen XML Forum API?

The Web Author REST integration expects the CMS to provide an authentication mechanism that the plugin can use (either a login page at $BASE_URL/rest-login that sets a session cookie, or HTTP auth implemented by the server). The plugin documentation notes the server may authenticate via cookies; the plugin can load rest-login in an (invisible) iframe to establish a session.

1. Get your credentials

1. Implement or obtain credentials for your CMS/server. 2) Ensure the server exposes a login page at $BASE_URL/rest-login (or provide a session cookie on requests). 3) Test login by visiting the login URL or by POSTing credentials to your server’s login endpoint to receive a session cookie. 4) Configure the oXygen Web Author plugin REST Server URL to point at your server base URL.

2. Add them to .dlt/secrets.toml

Copy
[sources.oxygen_xml_forum_source]
rest_auth = "your_session_token_or_credentials_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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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

Copy
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 Oxygen XML Forum 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
python oxygen_xml_forum_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline oxygen_xml_forum_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 files and doc/load from the Oxygen XML Forum 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 oxygen_xml_forum_source(rest_auth=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://your-cms.example.com/oxygen-cms/v1/",
            "auth": {
                "type": "http",
                "session_cookie": rest_auth,
            },
        },
        "resources": [
            {"name": "files", "endpoint": {"path": "files?url={path}"}},
            {"name": "doc_load", "endpoint": {"path": "rest/v{version}/doc/load"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> 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)

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("oxygen_xml_forum_pipeline").dataset()
sessions_df = data.files.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM oxygen_xml_forum_data.files LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("oxygen_xml_forum_pipeline").dataset()
data.files.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 Oxygen XML Forum 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.

---

Troubleshooting

Authentication failures

If Web Author reports that it cannot access the repository or you see 401/403 responses, ensure your REST server supports the login flow expected by the plugin. Provide a rest-login page that establishes a session cookie or configure HTTP auth. Check server logs for rejected credentials.

Incorrect REST Server URL / Routing

The plugin config uses a REST Server URL (documented as $BASE_URL). If file operations fail, verify the REST Server URL is correct and that endpoints like $BASE_URL/file and $BASE_URL/files are reachable from the Web Author server. The demo implementation uses WEB_AUTHOR_URL/plugins-dispatcher/demo-rest-server as the demo repository URL.

Unexpected response formats

The Web Author plugin expects specific endpoints and response shapes; if you return HTML instead of JSON (or vice versa) the file browser or load operations may fail. Inspect browser devtools/XHR to see the exact request paths (forum examples show Web Author requesting doc/load and file endpoints).

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• 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