v3
latestOpenAPI 3.0.0©2023 All Rights Reserved2026-08-0659315450.0 KBdesign
<Warning>
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 integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.
Gets the dataset definition of a design. If the design contains autofill data fields, this API returns an object with the data field names and the type of data they accept.
<Note>To get the dataset definition of a brand template, use the Get brand template dataset API.
</Note>Available data field types include:
- Images (which you can autofill with an image or a video asset)
- Text
- Charts
Use the returned field names and types to build the data payload for the Create a design autofill job API with type: create_from_design.
WARNING: Chart data fields and autofilling a video are preview features. There might be unannounced breaking changes to these features which won't produce a new API version.
get/v1/designs/{designId}/dataset
Path parameters
designIdstring required
The design ID.
Response
OK
Example response
{
"dataset": {
"cute_pet_image_of_the_day": {
"type": "image"
},
"cute_pet_witty_pet_says": {
"type": "text"
},
"cute_pet_sales_chart": {
"type": "chart"
}
}
}