WorkAdventure Python API Docs | dltHub

The WorkAdventure Map Storage API is a REST API for creating and managing WAM and TMJ files on the server. It requires an authentication token and supports file upload via GET requests. The API is part of WorkAdventure's suite of developer tools. The REST API base URL is https://admin.workadventu.re/api/v1/worlds/[your world slug] and All requests require an authentication token set in the HTTP Authorization 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 WorkAdventure data in under 10 minutes.

---

What data can I load from WorkAdventure?

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

---

How do I authenticate with the WorkAdventure API?

Obtain a token in the WorkAdventure admin dashboard (Settings → Developers → Tokens) and include it in the HTTP Authorization header of every request.

1. Get your credentials

1. Sign in to the WorkAdventure admin dashboard. 2) Navigate to Settings → Developers. 3) In the Tokens section click "Create new token", give it a name and save. 4) Copy the generated token and use it in the Authorization header of every request. Premium world access is required.

2. Add them to .dlt/secrets.toml

Copy
[sources.workadventure_map_storage_source]
token = "your_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:

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 WorkAdventure 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 workadventure_map_storage_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline workadventure_map_storage_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 members and rooms from the WorkAdventure 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 workadventure_map_storage_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://admin.workadventu.re/api/v1/worlds/[your world slug]",
            "auth": {
                "type": "api_key",
                "token": token,
            },
        },
        "resources": [
            {"name": "members", "endpoint": {"path": "worlds/{slug}/members", "data_selector": "members"}},
            {"name": "rooms", "endpoint": {"path": "worlds/{slug}/rooms", "data_selector": "rooms"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="workadventure_map_storage_pipeline",
        destination="duckdb",
        dataset_name="workadventure_map_storage_data",
    )
    load_info = pipeline.run(workadventure_map_storage_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("workadventure_map_storage_pipeline").dataset()
sessions_df = data.members.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM workadventure_map_storage_data.members LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("workadventure_map_storage_pipeline").dataset()
data.members.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 WorkAdventure 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 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