design_import

<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.
</Warning>

Starts a new asynchronous job to convert an image into an editable design in Canva, using Magic Layers. Elements in the image become separate editable layers in the resulting design.

Provide the image as an asset that is already in the user's Canva account.

The image must be a standard photo or graphic file, such as a PNG or JPEG. Vector-based formats such as SVG, EPS, or AI files, are not supported. Video assets are not supported.

This conversion is designed for flat, non-photographic images such as posters, flyers, banners, and social graphics.

Starting a job consumes the user's AI credit allowance. If the user has reached their AI allowance limit, the request returns a 429 error with the credit_quota_exceeded code. Polling for the result of a job using the Get image-to-design import job API doesn't consume any of the allowance.

Use this API when the user wants to edit the contents of the image, such as changing its text, colors, or individual elements. If you only need to place the image into a design as a single flat image, use the Create design API with an asset_id instead. The Create design API doesn't consume AI credits.

<Note>

For more information on the workflow for using asynchronous jobs, see API requests and responses. You can check the status and get the results of image-to-design import jobs created with this API using the Get image-to-design import job API.

</Note>
post/v1/image-to-design-imports

Request body

titlestring

A title for the created design. If not provided, Canva generates a title.

Example request

{
  "image": {
    "asset_id": "Msd59349ff"
  },
  "title": "My Image Design"
}

Response

OK

Example response

{
  "job": {
    "id": "f81b26fd-a33d-4c2d-9e8c-4a7aca798b17",
    "status": "success",
    "result": {
      "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>"
        },
        "urls": {
          "edit_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/edit",
          "view_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/view"
        },
        "created_at": 1377396000,
        "updated_at": 1692928800,
        "page_count": 3
      }
    },
    "error": {
      "code": "bad_input",
      "message": "The image could not be converted into a design."
    }
  }
}

Changes

Changed in 1 of the 15 revisions of this API.1