POST /v1/url-imports — canva-connect-api

v3

design_import

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

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 URL import job API.

</Note>

post/v1/url-imports

Request body

titlestring required

A title for the design.

urlstring required

The URL of the file to import. This URL must be accessible from the internet and be publicly available.

mime_typestring

The MIME type of the file being imported. If not provided, Canva attempts to automatically detect the type of the file.

Example request

{
  "title": "My Awesome Design",
  "mime_type": "application/vnd.apple.keynote"
}

Response

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."
    }
  }
}