Canva
API actions for the Canva integration.
Canva
Create, edit, and publish designs in Canva.
Create a Canva design
Create a new design in Canva with a specified type, dimensions, and optional title.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
design_type | string | Yes | The type of design to create: 'doc', 'whiteboard', 'presentation', or 'custom'. Custom designs need a width and height. |
title | string | No | Optional title for the design (1-255 characters). |
width | number | No | Width in pixels (40-8000) for custom design type. |
height | number | No | Height in pixels (40-8000) for custom design type. |
asset_id | string | No | Optional ID of an image already uploaded to Canva to add to the design. |
Response
{
"id": "DAFVcK_N123",
"title": "My New Design",
"urls": {
"edit_url": "https://www.canva.com/design/DAFVcK_N123/edit",
"view_url": "https://www.canva.com/design/DAFVcK_N123/view"
}
}Export a Canva design
Export a Canva design to a file format like PDF, PNG, JPG, or MP4.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
design_id | string | Yes | The ID of the design to export. |
format_type | string | No | The file format to export to: 'pdf', 'jpg', 'png', 'gif', 'pptx', or 'mp4'. |
quality | string | No | Quality of the exported file: 'regular' or 'pro'. Applies to JPG and PDF exports. |
width | number | No | Optional export width (respects aspect ratio). |
height | number | No | Optional export height (respects aspect ratio). |
pages | array | No | Optional list of page numbers to export. The first page is 1. |
Response
{
"design_id": "DAFVcK_N123",
"job_id": "export_job_123abc",
"status": "in_progress"
}Get design details
Retrieve details about a specific Canva design.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
design_id | string | Yes | The ID of the design to retrieve. |
Response
{
"created_at": "2024-01-15T10:30:00Z",
"id": "DAFVcK_N123",
"owner": {
"team_id": "team_456",
"user_id": "user_123"
},
"title": "My Design",
"updated_at": "2024-01-16T14:45:00Z",
"urls": {
"edit_url": "https://www.canva.com/design/DAFVcK_N123/edit",
"view_url": "https://www.canva.com/design/DAFVcK_N123/view"
}
}Get export job status
Check the status and results of a Canva export job.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | string | Yes | The export job ID returned by the 'Export a Canva design' action. |
Response
{
"job_id": "export_job_123abc",
"status": "success",
"urls": [
"https://export.canva.com/export_job_123abc/design.png"
]
}List Canva designs
List the designs in your connected Canva account.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | Optional text to search for to narrow down the list of designs. |
continuation | string | No | To get the next page of results, pass the 'continuation' value returned by the previous run. |
Response
{
"continuation": "next_page_token_xyz",
"designs": [
{
"id": "DAFVcK_N123",
"thumbnail": {
"url": "https://thumbnail.canva.com/123.png"
},
"title": "My First Design"
},
{
"id": "DAFVcK_N456",
"thumbnail": {
"url": "https://thumbnail.canva.com/456.png"
},
"title": "My Second Design"
}
]
}