RELEX Solutions Python API Docs | dltHub

Build a RELEX Solutions-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

RELEX Solutions provides a REST API for data integration and monitoring, secured by OAuth 2.0 and OpenID Connect. The REST API base URL is https://eu.rest.relexsolutions.com and all requests require a Bearer token obtained via OAuth 2.0 client credentials flow.

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


What data can I load from RELEX Solutions?

Here are some of the endpoints you can load from RELEX Solutions:

ResourceEndpointMethodData selectorDescription
file_eventsapi/v{N}/{customer_id}/events/fileGETdataMonitoring API file events; documented page/per_page pagination and filtering.
job_eventsapi/v{N}/{customer_id}/events/jobGETdataMonitoring API job events; documented page/per_page pagination and filtering.
environmentsapi/v{N}/{customer_id}/environmentsGETReturns available customer environments; response selector not documented in the retrieved source.
api_versionmeta/versionGETReturns API version metadata; response selector not documented in the retrieved source.
api_errorsmeta/errorsGETReturns API error metadata; response selector not documented in the retrieved source.
api_healthmeta/healthGETReturns API health metadata; response selector not documented in the retrieved source.
metricsapi/v{N}/{customer_id}/metricsGETPrometheus-compatible metrics endpoint; not a records-list response.
sales_forecastsdata/transactions/sales_forecastsGETSales forecasts list endpoint identified in the published API catalog; response selector not documented in the retrieved source.
order_proposalsdata/transactions/order_proposalsGETOrder proposals list endpoint identified in the published API catalog; response selector not documented in the retrieved source.
workload_driver_forecasts_daydata/transactions/workload_driver_forecasts_dayGETDaily workload-driver forecasts list endpoint identified in the published API catalog; response selector not documented in the retrieved source.
workload_driver_forecasts_quarterdata/transactions/workload_driver_forecasts_quarterGETQuarterly workload-driver forecasts list endpoint identified in the published API catalog; response selector not documented in the retrieved source.

How do I authenticate with the RELEX Solutions API?

Authentication is performed via the OAuth 2.0 client_credentials flow using a Client ID and Client Secret to obtain a JWT, which must be passed in an 'Authorization: Bearer ' header for all API requests.

1. Get your credentials

RELEX Solutions does not provide a self-service developer dashboard for generating API credentials. Credentials (Client ID, Client Secret, and Token Endpoint URL) are provisioned directly by RELEX personnel during the implementation project. Contact your RELEX representative to request these credentials.

2. Add them to .dlt/secrets.toml

[sources.relex_solutions_source] client_id = "your_client_id_here" client_secret = "your_client_secret_here" token_url = "https://identity.prod-eu.prod.cc.relexsolutions.com/login/restapi_prod/connect/token"

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:

uv init uv add "dlt[hub]"

1. Install the dlt AI harness:

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:

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 RELEX Solutions 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:

uv run python relex_solutions_pipeline.py

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

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

Inspect your pipeline and data:

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 /connect/token and api/v1/ from the RELEX Solutions API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def relex_solutions_source(client_secret=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://eu.rest.relexsolutions.com", "auth": {"type": "bearer", "token": client_secret}, }, "resources": [ {"name": "file_events", "endpoint": {"path": "api/v{N}/{customer_id}/events/file", "data_selector": "data"}}, {"name": "job_events", "endpoint": {"path": "api/v{N}/{customer_id}/events/job", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="relex_solutions_pipeline", destination="duckdb", dataset_name="relex_solutions_data", ) load_info = pipeline.run(relex_solutions_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):

import dlt data = dlt.pipeline("relex_solutions_pipeline").dataset() sessions_df = data.file_events.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM relex_solutions_data.file_events LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("relex_solutions_pipeline").dataset() data.file_events.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 RELEX Solutions data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for RELEX Solutions?

Request dlt skills, commands, AGENT.md files, and AI-native context.