Visual Paradigm Python API Docs | dltHub

Visual Paradigm Online is a platform for managing modeling projects and data that provides a REST API for programmatic access. The REST API base URL is https://online.visual-paradigm.com/api/v1/ and all requests require 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 add "dlt[hub]" and start loading Visual Paradigm data in under 10 minutes.

---

What data can I load from Visual Paradigm?

Here are some of the endpoints you can load from Visual Paradigm:

---

How do I authenticate with the Visual Paradigm API?

Authentication is performed using a Bearer token provided in the Authorization header.

1. Get your credentials

To obtain credentials for the Visual Paradigm Online REST API, log in to your Visual Paradigm Online account dashboard. Navigate to your user profile settings or account security section, where you can find options to generate or manage your personal API access token. This token acts as your primary credential for authenticated API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.visual_paradigm_source]
access_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:

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 Visual Paradigm 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 visual_paradigm_pipeline.py

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

Copy
Pipeline visual_paradigm_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset visual_paradigm_data
The duckdb destination used duckdb:/visual_paradigm.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 shop and report from the Visual Paradigm 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 visual_paradigm_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://online.visual-paradigm.com/api/v1/",
            "auth": {"type": "bearer", "token": access_token},
        },
        "resources": [
            {"name": "shop", "endpoint": {"path": "shop"}},
            {"name": "report", "endpoint": {"path": "report"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM visual_paradigm_data.shop LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("visual_paradigm_pipeline").dataset()
data.shop.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 Visual Paradigm 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