SQLFlow Python API Docs | dltHub

SQLFlow REST API documentation is available at https://docs.gudusoft.com/3.-api-docs/sqlflow-rest-api-reference/. It uses JWT authorization for all RESTful requests. The REST API base URL is https://api.gudusoft.com and Requests require a temporary JWT token (userId + token) obtained from the generateToken API..

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 SQLFlow data in under 10 minutes.

---

What data can I load from SQLFlow?

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

---

How do I authenticate with the SQLFlow API?

Obtain a token by calling POST /gspLive_backend/user/generateToken with userId and secretKey; include userId and token as form fields (or query params) in subsequent API calls.

1. Get your credentials

1. Obtain userId and secretKey from your SQLFlow admin/dashboard (or from account provisioning).
2. Call POST https://api.gudusoft.com/gspLive_backend/user/generateToken with form fields userId and secretKey to receive a temporary token.
3. Use the returned token (and userId) in subsequent API requests (as form fields userId and token or query parameters as shown in examples).

2. Add them to .dlt/secrets.toml

Copy
[sources.sqlflow_widget_source]
userId = "your_user_id_here"
 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 SQLFlow 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 sqlflow_widget_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline sqlflow_widget_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 sqlflow_generation and job_display_all from the SQLFlow 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 sqlflow_widget_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.gudusoft.com",
            "auth": {
                "type": "api_key",
                "token": token,
            },
        },
        "resources": [
            {"name": "sqlflow_generation", "endpoint": {"path": "gspLive_backend/sqlflow/generation/sqlflow", "data_selector": "sqlflow.dbobjs"}},
            {"name": "job_display_all", "endpoint": {"path": "gspLive_backend/sqlflow/job/displayUserJobsSummary", "data_selector": "jobDetails"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM sqlflow_widget_data.sqlflow_generation LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("sqlflow_widget_pipeline").dataset()
data.sqlflow_generation.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 SQLFlow 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