O-RAN SC RIC A1 Mediator Python API Docs | dltHub

Build a O-RAN SC RIC A1 Mediator-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

The A1 Mediator is part of the RAN Intelligent Controller Platform, providing APIs for communication. The official documentation is available at https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-a1/en/latest/user-guide-api.html. It includes user guides and API details. The REST API base URL is http://<host>/A1-P/v2 and No built‑in authentication; requests are plain HTTP without auth headers..

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 O-RAN SC RIC A1 Mediator data in under 10 minutes.


What data can I load from O-RAN SC RIC A1 Mediator?

Here are some of the endpoints you can load from O-RAN SC RIC A1 Mediator:

ResourceEndpointMethodData selectorDescription
policytypes/A1-P/v2/policytypes/GETList all policy type IDs (top‑level JSON array)
policytype/A1-P/v2/policytypes/{policy_type_id}GETGet policy type schema and metadata (JSON object)
policytype_policies/A1-P/v2/policytypes/{policy_type_id}/policies/GETList policy instance IDs for a policy type (top‑level array)
policy_instance/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}GETGet a policy instance body (JSON object)
policy_instance_status/A1-P/v2/policytypes/{policy_type_id}/policies/{policy_instance_id}/statusGETGet status for a policy instance (JSON object)
healthcheck/A1-P/v2/healthcheckGETService health‑check endpoint (plain 200 OK)

How do I authenticate with the O-RAN SC RIC A1 Mediator API?

The A1 Mediator northbound API uses plain HTTP requests without built‑in auth; security must be provided by the deployment (TLS, ingress, mTLS, API gateway).

1. Get your credentials

  1. Deploy the A1 Mediator in your Kubernetes cluster.
  2. Configure TLS termination or an ingress controller that enforces authentication (e.g., OAuth2 proxy, mTLS, API gateway).
  3. Create a user/service account in the authentication system you chose (OAuth client, API key, or client certificate).
  4. Grant that account network access to the A1 Mediator service.
  5. Use the obtained credential (token, API key, or client cert) when calling the A1 endpoints via the ingress gateway.

2. Add them to .dlt/secrets.toml

[sources.o_ran_sc_ric_a1_mediator_source]

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 venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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:

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 O-RAN SC RIC A1 Mediator 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:

python o_ran_sc_ric_a1_mediator_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline o_ran_sc_ric_a1_mediator_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 policytypes and policies from the O-RAN SC RIC A1 Mediator 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 o_ran_sc_ric_a1_mediator_source(=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "http://<host>/A1-P/v2", "auth": { "type": "none", "": , }, }, "resources": [ {"name": "policytypes", "endpoint": {"path": "policytypes/"}}, {"name": "policies", "endpoint": {"path": "policytypes/{policy_type_id}/policies/"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="o_ran_sc_ric_a1_mediator_pipeline", destination="duckdb", dataset_name="o_ran_sc_ric_a1_mediator_data", ) load_info = pipeline.run(o_ran_sc_ric_a1_mediator_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("o_ran_sc_ric_a1_mediator_pipeline").dataset() sessions_df = data.policytypes.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM o_ran_sc_ric_a1_mediator_data.policytypes LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("o_ran_sc_ric_a1_mediator_pipeline").dataset() data.policytypes.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 O-RAN SC RIC A1 Mediator 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 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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for O-RAN SC RIC A1 Mediator?

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