Zencoder Python API Docs | dltHub

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

Last updated:

Zencoder API enables fast and reliable video and audio transcoding. It supports web and various device outputs. Quick start guides are available for basic job submissions. The REST API base URL is https://app.zencoder.com/api/v2 and all requests require an API key sent in the Zencoder-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 Zencoder data in under 10 minutes.


What data can I load from Zencoder?

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

ResourceEndpointMethodData selectorDescription
jobs/jobsGET(top-level array)List jobs (paginated, default 50 per page).
job_details/jobs/{job_id}GET(object)Get job details for a single job.
job_progress/jobs/{job_id}/progressGET(object)Get job progress; returns keys like state, input, outputs, progress.
inputs/inputs/{input_id}GET(object)Get input details.
outputs/outputs/{output_id}GET(object)Get output details.
output_progress/outputs/{output_id}/progressGET(object)Get output processing progress.
account/accountGET(object)Get account details.
reports_vod/reports/vodGET(object)Get usage / VOD reports (analytics/usage).

How do I authenticate with the Zencoder API?

Zencoder uses an API key for authentication. Include your API key in the request header named "Zencoder-Api-Key" (Content-Type: application/json expected).

1. Get your credentials

  1. Create a Zencoder account (via the Zencoder/Brightcove signup flow or the Create Account API). 2) After account creation, obtain your API key from the account response or account settings (the Create Account API returns an api-key). 3) Store that API key securely and provide it in the Zencoder-Api-Key header for API calls.

2. Add them to .dlt/secrets.toml

[sources.zencoder_source] api_key = "your_zencoder_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:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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:

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

python zencoder_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline zencoder_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 jobs and outputs from the Zencoder 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 zencoder_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://app.zencoder.com/api/v2", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "jobs", "endpoint": {"path": "jobs"}}, {"name": "outputs", "endpoint": {"path": "outputs/{output_id}"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="zencoder_pipeline", destination="duckdb", dataset_name="zencoder_data", ) load_info = pipeline.run(zencoder_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("zencoder_pipeline").dataset() sessions_df = data.jobs.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM zencoder_data.jobs LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("zencoder_pipeline").dataset() data.jobs.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 Zencoder 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 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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Zencoder?

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