BentoBox Python API Docs | dltHub

Build a BentoBox-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

Bento (often referred to as BentoBox in some contexts) is a marketing automation and subscriber management platform that provides a REST API for managing users, events, and emails. The REST API base URL is https://app.bentonow.com/api/v1/ and all requests require Basic authentication with keys and a site_uuid query parameter.

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 BentoBox data in under 10 minutes.


What data can I load from BentoBox?

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

ResourceEndpointMethodData selectorDescription
fetch_tagsfetch/tagsGETRetrieve tag definitions for the site
fetch_segmentsfetch/segmentsGETRetrieve segment definitions for the site
fetch_subscribersfetch/subscribersGETRetrieve subscriber information
fetch_broadcastsfetch/broadcastsGETRetrieve broadcast list
fetch_workflowsfetch/workflowsGETRetrieve list of workflows

How do I authenticate with the BentoBox API?

Authentication uses HTTP Basic Auth where the username is the Publishable Key and the password is the Secret Key, encoded as a Base64 string in the 'Authorization' header. Every request must also include the 'site_uuid' as a query parameter and a 'User-Agent' header to avoid being blocked.

1. Get your credentials

  1. Log in to your Bento dashboard. 2. Navigate to Settings → API Keys. 3. Copy the Publishable Key (starting with 'pk_'), the Secret Key (starting with 'sk_'), and the Site UUID. 4. Use these credentials to authenticate via HTTP Basic Auth, where the Publishable Key is the username and the Secret Key is the password. The Site UUID must be provided as a query parameter in every request (e.g., ?site_uuid=YOUR_SITE_UUID).

2. Add them to .dlt/secrets.toml

[sources.bentobox_source] publishable_key = "your_publishable_key" secret_key = "your_secret_key" site_uuid = "your_site_uuid"

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 init uv add "dlt[hub]"

1. Install the dlt AI harness:

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:

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 BentoBox 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:

uv run python bentobox_pipeline.py

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

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

Inspect your pipeline and data:

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 /batch/events and /batch/subscribers from the BentoBox 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 bentobox_source(publishable_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://app.bentonow.com/api/v1/", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": publishable_key}, }, "resources": [ {"name": "batch_events", "endpoint": {"path": "batch/events", "data_selector": "results"}}, {"name": "batch_subscribers", "endpoint": {"path": "batch/subscribers", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="bentobox_pipeline", destination="duckdb", dataset_name="bentobox_data", ) load_info = pipeline.run(bentobox_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("bentobox_pipeline").dataset() sessions_df = data.fetch_tags.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM bentobox_data.fetch_tags LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("bentobox_pipeline").dataset() data.fetch_tags.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 BentoBox 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 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.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for BentoBox?

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