Voiceflow Python API Docs | dltHub

Voiceflow is an AI agent building and management platform providing APIs for session management, knowledge base interaction, and project build operations. The REST API base URL is https://realtime-api.voiceflow.com/v1/stable and all requests require an 'Authorization' header with a Bearer token.

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 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?

Voiceflow requires a personal access token (PAT) to be sent in the 'Authorization' header using the 'Bearer' scheme. The header should be formatted as 'Authorization: Bearer <your_token>'.

1. Get your credentials

To obtain API credentials for Voiceflow, log in to your Voiceflow account and navigate to Settings. Select the Access tokens section and click Create personal access token. Provide a name for the token and define its expiration. The token, which begins with the prefix vfp_, is displayed only once upon creation, so ensure you store it securely immediately.

2. Add them to .dlt/secrets.toml

Copy
[sources.voiceflow_source]
voiceflow_api_key = "vfp_your_personal_access_token_here"
voiceflow_project_id = "your_project_id_from_settings_metadata"

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 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
uv run python voiceflow_pipeline.py

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

Copy
Pipeline voiceflow_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset voiceflow_data
The duckdb destination used duckdb:/voiceflow.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 /v4/interact and /v1/stable/conversation 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_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://realtime-api.voiceflow.com/v1/stable",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "projects", "endpoint": {"path": "v1/stable/project"}},
            {"name": "workspaces", "endpoint": {"path": "v1/stable/workspace"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="voiceflow_pipeline",
        destination="duckdb",
        dataset_name="voiceflow_data",
    )
    load_info = pipeline.run(voiceflow_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_pipeline").dataset()
sessions_df = data.projects.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM voiceflow_data.projects LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("voiceflow_pipeline").dataset()
data.projects.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.

---

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