Skip navigation

Skip to main content

The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
Canva Developers SDK
The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
Tools
Discovery
search-designsget-designget-design-contentget-design-pagesresolve-shortlink
Generation
generate-designcreate-design-from-candidatecreate-designget-create-design-async-jobseparate-image-layersget-separate-image-layers-job
Design operations
copy-designresize-designmerge-designsimport-design-from-url
Editing
start-editing-transactionperform-editing-operationscommit-editing-transactioncancel-editing-transaction
Images
generate-imageget-generate-image-jobremove-background
Brand templates and autofill
search-brand-templatescreate-brand-template-draftpublish-brand-templatelist-brand-kitscreate-design-from-brand-templateget-brand-template-datasetget-design-datasetautofill-design
Folders
create-folderlist-folder-itemssearch-foldersmove-item-to-folder
Comments
comment-on-designreply-to-commentlist-commentslist-replies
Assets and export
upload-asset-from-urlcreate-upload-urlget-assetsget-export-formatsexport-design
Help
help

get-generate-image-job

Check the status of an image generation job and get the generated image.

Use get-generate-image-job to poll a job started by generate-image. Pass the jobId that generate-image returned.

Example responses

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

{
  "status": "SUCCESS",
  "result": {
    "results": [ { "type": "MEDIA", "id": "MEDIA_EXAMPLE", "version": "1" } ]
  }
}
JSON

A status of SUCCESS returns the generated image as a MEDIA reference in result.results. Use its id to refer to the image in other tools, such as in imageReferences when editing the image with generate-image.

While the job runs, the response is { "status": "PENDING" }. Continue polling with the same jobId until the status is SUCCESS or FAILURE. Don't start a new generation job just because the existing one is still pending.

If the job fails, the response contains a failureType and failureMessage:

{
  "status": "FAILURE",
  "failureType": "SERVER_GENERIC",
  "failureMessage": "Something went wrong while generating the image. Please try again."
}
JSON

Learn more