Ultradox Python API Docs | dltHub

Ultravox is a REST API for creating and inspecting AI-powered voice/video calls (calls, messages, events, voices, accounts, webhooks). The REST API base URL is https://api.ultravox.ai/api/ and All requests require an API key passed in the X-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 pip install "dlt[workspace]" and start loading Ultradox data in under 10 minutes.

---

What data can I load from Ultradox?

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

---

How do I authenticate with the Ultradox API?

Ultravox uses API keys (format: 8 characters + '.' + 32 characters). Include the key in every request using the 'X-API-Key' header. Optionally 'X-Unsafe-API-Key' can be used for local/demo CORS scenarios.

1. Get your credentials

1. Sign up or log in at https://app.ultravox.ai.
2. Open your account/settings or API Keys page.
3. Create or copy an API key (format: xxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx).
4. Store this key securely and use it in the X-API-Key header for API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.ultradox_calls_source]
api_key = "your_ultravox_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 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 Ultradox 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 ultradox_calls_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline ultradox_calls_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 calls and call_messages from the Ultradox 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 ultradox_calls_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.ultravox.ai/api/",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "calls", "endpoint": {"path": "api/calls", "data_selector": "results"}},
            {"name": "call_messages", "endpoint": {"path": "api/calls/{callId}/messages", "data_selector": "results"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM ultradox_calls_data.calls LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("ultradox_calls_pipeline").dataset()
data.calls.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 Ultradox 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.

---

Troubleshooting

Authentication failures

If you receive 401 Unauthorized: verify your X-API-Key header is present and the key is valid (keys are 8+'.'+32 char format). Ensure no accidental whitespace and that you copied the full key.

Missing resource / 404

If a GET to /api/calls/{callId} returns 404, confirm the callId is correct and belongs to your account.

Rate limiting and 429

If you receive 429 Too Many Requests, back off and retry with exponential backoff. Check account usage/quota in the dashboard.

Pagination

List endpoints return an object with 'results' (array), 'next' (URL|null), 'previous' (URL|null), and 'total' (integer). Use the 'next' value to iterate pages; 'results' is the data selector for dlt.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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