Voiceflow Python API Docs | dltHub

Voiceflow is a platform for building conversational voice and chat agents and exposes REST/streaming APIs to interact with agents and manage test executions. The REST API base URL is https://general-runtime.voiceflow.com and All requests require an Agent API key provided in the Authorization 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 Voiceflow data in under 10 minutes.

---

What data can I load from Voiceflow?

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

---

How do I authenticate with the Voiceflow API?

Use an Agent API key (prefixed VF.DM.) from your project settings. Include the key in the Authorization header of requests (Authorization: {Your Voiceflow API Key}). For version selection include the versionID header (e.g. 'development' or 'production').

1. Get your credentials

1. Open the Voiceflow project (agent) you want to use. 2. Click Settings (shortcut: 7). 3. Go to the API keys / Integrations section. 4. Copy the Agent API key (VF.DM.*) or create/generate a new one. Rotate and promote secondary keys as needed.

2. Add them to .dlt/secrets.toml

Copy
[sources.voiceflow_streaming_api_source]
api_key = "VF.DM.your_agent_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 Voiceflow 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 voiceflow_streaming_api_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline voiceflow_streaming_api_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 system_info and test_status from the Voiceflow 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 voiceflow_streaming_api_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://general-runtime.voiceflow.com",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "system_info", "endpoint": {"path": "api/v1/system/info"}},
            {"name": "test_status", "endpoint": {"path": "api/v1/tests/status/{execution_id}"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM voiceflow_streaming_api_data.system_info LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("voiceflow_streaming_api_pipeline").dataset()
data.system_info.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 Voiceflow 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 requests return 401/403, confirm you are sending the Agent API key from Project > Settings > API keys in the Authorization header. Ensure you haven’t revoked or rotated the key.

404 Not Found

Ensure you are using the correct base path (/api/v1/ or runtime base) and correct projectID/versionID. The docs note using the correct base path and verifying server accessibility.

Streaming quirks and SSE handling

The streaming interact endpoint returns Server-Sent Events (text/event-stream). Clients must handle SSE framing (event: ..., data: ...) and may receive multiple trace events per interaction; use completion_events=true to stream LLM tokens. Handle 'event: end' to detect stream completion.

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