Skip navigation

Skip to main content

Tools
Tools

start-editing-transaction

Open an editing session on a design.

Use start-editing-transaction to start the editing flow. Edits stay in draft until you commit with commit-editing-transaction.

The editing flow is three tools: open a transaction, apply operations, then commit.

Example prompt

"Open my Q3 campaign poster for editing."

Example response

IDs, URLs, and tokens below are placeholders; field names and structure are exactly as returned.

{
  "transaction": { "status": "open", "transaction_id": "TXN_EXAMPLE" },
  "edit_design_url": "https://www.canva.com/d/EXAMPLE",
  "richtexts": [
    { "page_index": 1, "regions": [ { "type": "character", "text": "Unlock Creativity with AI Editing" } ], "containerElement": { "type": "TEXT", "position": { "top": 399.67, "left": 160.92 }, "dimension": { "width": 758.16, "height": 175.35 } }, "element_id": "ELEMENT_EXAMPLE_1" }
  ],
  "fills": [
    { "type": "image", "asset_id": "ASSET_EXAMPLE", "page_index": 1, "editable": true, "element_id": "ELEMENT_EXAMPLE_2" }
  ],
  "thumbnails": [ { "width": -1, "height": -1, "url": "https://design-manipulation-download.canva.com/EXAMPLE" } ],
  "pages": [ { "page_id": "PAGE_EXAMPLE", "page_number": 1, "dimension": { "width": 1080, "height": 1350 }, "is_responsive": false, "is_empty": false, "is_editable": true } ]
}
JSON

Returns a transaction_id and the design's editable elements — richtexts and fills, each with an element_id. Element IDs are the source for editing operations (they don't come from get-design-content). Carry the transaction_id and element IDs into perform-editing-operations.

Learn more