This API is currently provided as a preview. Be aware of the following:
- There might be unannounced breaking changes.
- Any breaking changes to preview APIs won't produce a new API version.
- Public apps that use preview APIs will not pass the review process, and can't be made available to all Canva users.
Gets the result of an image generation job that was created using the Create image generation job API. Only the app and user that created the job can get it.
If the job is successful, the job's result contains a download URL for the generated image. The download URL is only valid for 24 hours. If the job was created with asset_upload set to type: upload, the result also contains the image asset that the image was saved as. These jobs stay in_progress until the asset has finished importing, so the returned asset is ready to use.
You might need to make multiple requests to this endpoint until you get a success or failed status. For more information on the workflow for using asynchronous jobs, see API requests and responses.
Path parameters
The image generation job ID.
Response
OK
Example response
{
"job": {
"result": {
"image": {
"asset": {
"type": "image",
"id": "Msd59349ff",
"name": "My Awesome Upload",
"tags": [
"image",
"holiday",
"best day ever"
],
"created_at": 1377396000,
"updated_at": 1692928800,
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
}
},
"width": 1024,
"height": 1024
}
}
}
}Changes
Changed in 1 of the 16 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○