Openverse Python API Docs | dltHub

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

Last updated:

Openverse API provides access to openly-licensed media. Use the JavaScript client @openverse/api-client for easy integration. Authenticate with a clientId and clientSecret. API documentation includes response schemas and examples. The REST API base URL is https://api.openverse.org/v1 and Anonymous requests allowed; registered apps may use OAuth2 client_credentials to obtain a Bearer token for higher rate limits..

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


What data can I load from Openverse?

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

ResourceEndpointMethodData selectorDescription
images/v1/images/GETresultsSearch images (paginated).
images_detail/v1/images/{identifier}/GETGet details for a single image (object response).
images_related/v1/images/{identifier}/related/GETresultsGet related images for a specified image.
images_stats/v1/images/stats/GETGet list of content sources and their image counts (top‑level array).
audio/v1/audio/GETresultsSearch audio (paginated).
audio_detail/v1/audio/{identifier}/GETGet details for a single audio item (object response).
rate_limit/v1/rate_limit/GETGet current rate‑limit usage (object).
key_info/v1/key_info/GETGet information about your API key / token usage (object).
images_oembed/v1/images/oembed/GEToEmbed data for a specified image URL (object).

How do I authenticate with the Openverse API?

Register an application via the register endpoint to receive client_id and client_secret, then POST them with grant_type=client_credentials to the token endpoint. Include the returned access_token as a Bearer token in the Authorization header (Authorization: Bearer ).

1. Get your credentials

  1. POST to https://api.openverse.org/v1/register with {name, description, email} to receive client_id and client_secret.
  2. POST to https://api.openverse.org/v1/token with application/x-www-form-urlencoded body containing client_id, client_secret, and grant_type=client_credentials to receive access_token.
  3. Use Authorization: Bearer <access_token> on subsequent API requests.

2. Add them to .dlt/secrets.toml

[sources.openverse_source] token = "your_openverse_access_token_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 Openverse 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 openverse_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline openverse_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 images and audio from the Openverse 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 openverse_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.openverse.org/v1", "auth": { "type": "bearer", "token": token, }, }, "resources": [ {"name": "images", "endpoint": {"path": "images/", "data_selector": "results"}}, {"name": "audio", "endpoint": {"path": "audio/", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="openverse_pipeline", destination="duckdb", dataset_name="openverse_data", ) load_info = pipeline.run(openverse_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("openverse_pipeline").dataset() sessions_df = data.images.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM openverse_data.images LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("openverse_pipeline").dataset() data.images.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 Openverse 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 Openverse?

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