创建设计自动填充作业

创建一个异步作业，使用您的输入信息自动填充品牌模板中的设计。

此 API 目前以预览版形式提供。请注意以下事项：

可能会有未公布的重大变化。

对预览 API 的任何重大更改都不会产生新的API 版本。

使用预览 API 的公共集成将不会通过审核流程，并且无法向所有 Canva 用户提供。

要使用此 API，您的集成必须代表Canva Enterprise组织成员用户行事。

开始一项新工作，使用品牌模板和输入数据自动填充 Canva 设计。

要获取输入数据字段的列表，请使用获取品牌模板数据集 API。

品牌模板包含对图像媒体的引用。您可以通过在对象中提供的值type来引用图像媒体。品牌模板中对图像媒体的引用数量目前不能超过 300 个。image``data

curl --location --request POST 'http://dev-cn.your-api-server.com/rest/v1/autofills' \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data-raw '{ "brand_template_id": "DAFVztcvd9z", "title": "string", "data": { "cute_pet_image_of_the_day": { "type": "image", "asset_id": "Msd59349ff" }, "cute_pet_witty_pet_says": { "type": "text", "text": "It was like this when I got here!" } } }'

{ "job": { "id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72", "status": "success", "result": { "type": "create_design", "design": { "id": "DAFVztcvd9z", "title": "My summer holiday", "url": "https://www.canva.com/design/DAFVztcvd9z/edit", "thumbnail": { "width": 595, "height": 335, "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>" } } }, "error": { "code": "autofill_error", "message": "string" } } }

请求参数

Header 参数

Authorization

string

必需

示例值:

Bearer {token}

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

brand_template_id

string

必需

输入品牌模板的ID。

title

string

可选

如果没有提供设计标题，自动填充的设计将具有与品牌模板相同的标题。

data

object

必需

包含要自动填充的数据字段和值的数据对象。

cute_pet_image_of_the_day

object

必需

cute_pet_witty_pet_says

object

必需

示例

返回响应

🟢200成功

application/json

Body

job

object

必需

string

必需

使用提供的数据创建设计的异步作业的 ID。

status

string

必需

设计自动填充作业的状态。可以是以下之一： in_progress success failed

result

object

可选

设计自动填充作业的结果。仅当作业状态为时才显示success。

error

object

可选

如果自动填充作业失败，此对象会提供有关错误的详细信息。