Canva ACTION
Export Design
Starts a new job to export a file from Canva. See the documentation
- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Canva account once, then configure and run Export Design from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "canva-export-design",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
canva: { authProvisionId: "apn_xxxxxxx" },
designId: "Design ID",
type: "Format Type",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "canva-export-design",
"configured_props": {
"canva": { "authProvisionId": "apn_xxxxxxx" },
"designId": "Design ID",
"type": "Format Type"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "canva",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "canva-export-design",
arguments: {
designId: "Design ID",
type: "Format Type",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
designId Design ID | string | The ID of the design Required Dynamic |
type Format Type | string | The desired export format Required |
pages Pages | integer[] | To specify which pages to export in a multi-page design, provide the page numbers as an array. The first page in a design is page 1. If pages isn't specified, all the pages are exported. Optional |
waitForCompletion Wait for Completion | boolean | Set to true to poll the API in 3-second intervals until the job is completed Optional |
quality Quality | integer | Applicable for JPG exports only. 1 (smallest) to 100 (best quality). Defaults to 80 if not specified. Optional |
mp4Quality Video Quality | string | Applicable for MP4 exports only. The orientation and resolution of the exported video. Optional |
size Paper Size | string | Applicable for PDF exports only. The paper size of the exported file. Optional |
lossless Lossless | boolean | Applicable for PNG exports only. When true, uses lossless compression. Optional |
asSingleImage As Single Image | boolean | Applicable for PNG exports only. When true, merges multi-page designs into a single image. Optional |
exportQuality Export Quality | string | Applicable for PDF, JPG, PNG, GIF, MP4 exports. Pro export may fail if design contains premium elements. Optional |
height Height | integer | Applicable for JPG, PNG, GIF exports only. Height in pixels of the exported image. Optional |
width Width | integer | Applicable for JPG, PNG, GIF exports only. Width in pixels of the exported image. Optional |
newFileName File Name | string | The file name to save the exported file as under /tmp. Include the extension e.g. design.pdf Optional |
syncDir SyncDir | dir | Required |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- canva-export-design
- Version
- 0.1.2
- App
- Canva
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗