{ "openapi": "3.0.1", "info": { "title": "Canva Connect API - Design Automation & Export", "description": "Automate Canva design workflows with Canva Connect API. Create designs, export to multiple formats, manage assets, autofill brand templates & organize your creative library.\n\nThe Canva Connect API lets you integrate Canva's powerful design capabilities into your automation workflows.", "version": "1.0", "x-build-id": "kF0zWElwNGOPevMp1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~canva-connect-api---design-automation-export/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-canva-connect-api---design-automation-export", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~canva-connect-api---design-automation-export/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-canva-connect-api---design-automation-export", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~canva-connect-api---design-automation-export/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-canva-connect-api---design-automation-export", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "list_designs", "get_design", "create_design", "export_design", "get_export_status", "list_assets", "get_asset", "upload_asset", "delete_asset", "list_folders", "get_folder", "create_folder", "list_folder_items", "move_to_folder", "list_brand_templates", "get_brand_template", "autofill_template", "get_user_profile", "batch_export" ], "type": "string", "description": "Operation to perform", "default": "list_designs" }, "accessToken": { "title": "Access Token", "type": "string", "description": "Canva OAuth access token. Get this by setting up a Canva Connect integration." }, "designId": { "title": "Design ID", "type": "string", "description": "Canva design ID for get/export/autofill operations" }, "assetId": { "title": "Asset ID", "type": "string", "description": "Canva asset ID for get/delete operations" }, "folderId": { "title": "Folder ID", "type": "string", "description": "Canva folder ID for folder operations" }, "brandTemplateId": { "title": "Brand Template ID", "type": "string", "description": "Brand template ID for autofill operations (Enterprise)" }, "designTitle": { "title": "Design Title", "type": "string", "description": "Title for new design" }, "designType": { "title": "Design Type", "enum": [ "doc", "whiteboard", "presentation", "instagram_post", "instagram_story", "facebook_post", "facebook_cover", "youtube_thumbnail", "twitter_post", "linkedin_post", "poster", "flyer", "business_card", "logo", "custom" ], "type": "string", "description": "Preset design type or 'custom' for custom dimensions", "default": "instagram_post" }, "customWidth": { "title": "Custom Width (px)", "minimum": 40, "maximum": 8000, "type": "integer", "description": "Width in pixels for custom design type" }, "customHeight": { "title": "Custom Height (px)", "minimum": 40, "maximum": 8000, "type": "integer", "description": "Height in pixels for custom design type" }, "exportFormat": { "title": "Export Format", "enum": [ "pdf", "png", "jpg", "gif", "pptx", "mp4" ], "type": "string", "description": "Format for design export", "default": "png" }, "exportQuality": { "title": "Export Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Export quality (1-100, for jpg/png)", "default": 90 }, "exportPages": { "title": "Export Pages", "type": "string", "description": "Specific page numbers to export (comma-separated, e.g., '1,2,3'). Leave empty for all pages." }, "assetUrl": { "title": "Asset URL", "type": "string", "description": "URL to upload as an asset" }, "assetName": { "title": "Asset Name", "type": "string", "description": "Name for the uploaded asset" }, "folderName": { "title": "Folder Name", "type": "string", "description": "Name for new folder" }, "parentFolderId": { "title": "Parent Folder ID", "type": "string", "description": "Parent folder ID for creating nested folders" }, "autofillData": { "title": "Autofill Data", "type": "object", "description": "JSON object with data to autofill into brand template", "default": {} }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Search term for filtering designs or templates" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of results to return", "default": 20 }, "batchDesignIds": { "title": "Batch Design IDs", "type": "array", "description": "Array of design IDs for batch export", "default": [], "items": { "type": "string" } }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to send results to (Zapier, Make, n8n, etc.)" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data (no access token required)", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }