Canva Python API Docs | dltHub

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

Last updated:

The notification.addToast method shows a toast notification in Canva apps. It uses the Notification API to display brief messages. This method is part of the Canva Apps SDK. The REST API base URL is `` and Canva Apps SDK runs without HTTP auth; Connect API requires OAuth 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 pip install "dlt[workspace]" and start loading Canva data in under 10 minutes.


What data can I load from Canva?

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

ResourceEndpointMethodData selectorDescription
notification_add_toast(SDK) notification.addToastJS methodShows a toast notification in the Canva editor.
platform_get_platform_info(SDK) getPlatformInfoJS methodRetrieves platform information for the running app.
examples_notification/apps/examples/notification/GETDocumentation page showing example code for toast notifications.
connect_user_profile/v1/users/meGETReturns the authenticated user's profile (Connect API).
connect_designs_list/v1/designsGETLists designs accessible to the user (Connect API).

How do I authenticate with the Canva API?

Canva Apps SDK methods require no HTTP headers. Connect API requests must include Authorization: Bearer <access_token>.

1. Get your credentials

  1. Open the Canva Developer Portal and navigate to Your Apps. 2. Create a new app or select an existing one. 3. In the app settings, locate the OAuth Client ID and Client Secret. 4. Configure the Redirect URI(s) for your application. 5. Use the standard OAuth 2.0 authorization code flow: direct the user to the Canva authorization endpoint, receive an authorization code, and exchange it for an access token by calling the token endpoint with the client ID, client secret, and code. 6. Store the returned access token and use it as a Bearer token in API calls.

2. Add them to .dlt/secrets.toml

[sources.canva_source] client_id = "your_client_id_here" client_secret = "your_client_secret_here" access_token = "your_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 Canva 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 canva_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline canva_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 notification.addToast and getPlatformInfo from the Canva 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 canva_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "", "auth": { "type": "bearer", "access_token": access_token, }, }, "resources": [ {"name": "notification_add_toast", "endpoint": {"path": "(SDK) notification.addToast"}}, {"name": "platform_get_platform_info", "endpoint": {"path": "(SDK) getPlatformInfo"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="canva_pipeline", destination="duckdb", dataset_name="canva_data", ) load_info = pipeline.run(canva_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("canva_pipeline").dataset() sessions_df = data.notification_add_toast.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM canva_data.notification_add_toast LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("canva_pipeline").dataset() data.notification_add_toast.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 Canva 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 Canva?

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