DatoCMS Python API Docs | dltHub
Build a DatoCMS-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
DatoCMS's Real-time Updates API allows streaming of real-time content changes. Use @datocms/rest-api-events for real-time updates instead of polling. DatoCMS is a headless CMS trusted by many businesses for scalable content management. The REST API base URL is https://site-api.datocms.com and All requests require a Bearer token (Authorization: Bearer ).
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 DatoCMS data in under 10 minutes.
What data can I load from DatoCMS?
Here are some of the endpoints you can load from DatoCMS:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| site | /site | GET | data | Project-level metadata (single resource) |
| items | /items | GET | data | List records (Items) for the project |
| item_types | /item-types | GET | data | List item types (models) |
| uploads | /uploads | GET | data | List uploaded assets |
| users | /users | GET | data | List project users / collaborators |
| locales | /locales | GET | data | List locales for the project |
| environments | /environments | GET | data | List environments (if enabled) |
| graphql_cda | https://graphql.datocms.com | POST | (GraphQL response) data | GraphQL Content Delivery API endpoint (use POST with queries) |
| graphql_listen | https://graphql-listen.datocms.com | POST | { "url": "..." } | Real-time Content API returns a channel URL for SSE connections (use same Authorization header) |
How do I authenticate with the DatoCMS API?
DatoCMS uses project API tokens for its REST/Content Management API and the same Bearer token is used with the GraphQL Content Delivery and Real-time Content APIs. Include Authorization: Bearer YOUR_TOKEN and X-Api-Version: 3 and Accept: application/json (Content-Type: application/vnd.api+json for write requests) where applicable.
1. Get your credentials
- Log in to your DatoCMS dashboard. 2) Open the project you want to access. 3) Go to Settings > API tokens (or Project settings > API tokens). 4) Create or copy an existing token (choose the appropriate scope: read-only for delivery, management for CMA). 5) Use the token as a Bearer token in the Authorization header.
2. Add them to .dlt/secrets.toml
[sources.datocms_source] token = "your_datocms_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 DatoCMS 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 datocms_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline datocms_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset datocms_data The duckdb destination used duckdb:/datocms.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline datocms_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 items and item_types from the DatoCMS 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 datocms_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://site-api.datocms.com", "auth": { "type": "bearer", "token": api_token, }, }, "resources": [ {"name": "items", "endpoint": {"path": "items", "data_selector": "data"}}, {"name": "item_types", "endpoint": {"path": "item-types", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="datocms_pipeline", destination="duckdb", dataset_name="datocms_data", ) load_info = pipeline.run(datocms_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("datocms_pipeline").dataset() sessions_df = data.items.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM datocms_data.items LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("datocms_pipeline").dataset() data.items.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 DatoCMS data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 DatoCMS?
Request dlt skills, commands, AGENT.md files, and AI-native context.