design_import

Changed on

Starts a new asynchronous job to import an external file as a new design in Canva.

The request format for this endpoint has an application/octet-stream body of bytes, and the information about the import is provided using an Import-Metadata header.

Supported file types for imports are listed in Design imports overview.

<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 design import jobs created with this API using the Get design import job API.

</Note>
post/v1/imports

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/imports
  • Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: design:content:write)

Headers

Request body application/octet-stream

string binary required

Response

OK

Example response

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "success",
    "result": {
      "designs": [
        {
          "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": "design_creation_throttled",
      "message": "We're sorry, but the file upload quota has exceeded. Please try again later."
    }
  }
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

  • 5ea5a3f48e72Revision changes
    • warning

      added the new asset_not_ready enum value to the response property for the response status