Azure AI Foundry Python API Docs | dltHub

Azure AI Foundry is a unified platform for enterprise AI operations, model builders, and application development that enables the creation and management of AI resources and generative AI applications. The REST API base URL is https://{resource-name}.services.ai.azure.com and all requests require either a Bearer token or an API key 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 add "dlt[hub]" and start loading Azure AI Foundry data in under 10 minutes.

---

What data can I load from Azure AI Foundry?

Here are some of the endpoints you can load from Azure AI Foundry:

---

How do I authenticate with the Azure AI Foundry API?

Azure AI Foundry supports Microsoft Entra ID (Bearer token) or API key authentication. For Entra ID, the Authorization header must be formatted as 'Bearer {token}', while for API keys, use the 'api-key' header.

1. Get your credentials

1. Navigate to the Azure AI Foundry portal and select your specific project. 2. Go to the Overview, Settings, or Keys and endpoints section. 3. Locate the Keys and endpoints area (or Connected resources). 4. Copy your API key (Key1 or Key2). Note: If not visible, ensure you have sufficient permissions (e.g., Owner, Contributor, or Cognitive Services Contributor) and that the key is stored in the associated Azure Key Vault.

2. Add them to .dlt/secrets.toml

Copy
[sources.azure_ai_foundry_source]
api_key = "your_api_key_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 Azure AI Foundry 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 azure_ai_foundry_pipeline.py

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

Copy
Pipeline azure_ai_foundry_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset azure_ai_foundry_data
The duckdb destination used duckdb:/azure_ai_foundry.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 inference/chat and deployments from the Azure AI Foundry 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 azure_ai_foundry_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{resource-name}.services.ai.azure.com",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "agents", "endpoint": {"path": "assistants?api-version=v1", "data_selector": "data"}},
            {"name": "evaluations", "endpoint": {"path": "evals?api-version=v1", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM azure_ai_foundry_data.agents LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("azure_ai_foundry_pipeline").dataset()
data.agents.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 Azure AI Foundry 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