asset

Changed on

Starts a new asynchronous job to upload an asset from a URL to the user's content library. Supported file types for assets are listed in the Assets API overview.

<Note> Uploading a video asset from a URL is limited to a maximum 100MB file size. For importing larger video files, use the [Create asset upload job API](https://www.canva.dev/docs/apps/rest-apis/reference/assets/create-asset-upload-job/). </Note> <Note> For more information on the workflow for using asynchronous jobs, see [API requests and responses](https://www.canva.dev/docs/apps/rest-apis/requests-responses/#asynchronous-job-endpoints). You can check the status and get the results of asset upload jobs created with this API using the [Get asset upload job via URL API](https://www.canva.dev/docs/apps/rest-apis/reference/assets/get-url-asset-upload-job/). </Note>
post/v1/url-asset-uploads

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/url-asset-uploads
  • 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: asset:write)

Request body

namestring required

A name for the asset.

urlstring required

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

Example request

{
  "name": "My Awesome Asset",
  "url": "https://example.com/my_asset_to_upload.jpg"
}

Response

OK

Example response

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "success",
    "asset": {
      "id": "Msd59349ff",
      "type": "image",
      "name": "My Awesome Upload",
      "tags": [
        "image",
        "holiday",
        "best day ever"
      ],
      "owner": {
        "user_id": "oU123456AbCdE",
        "team_id": "oB123456AbCdE"
      },
      "created_at": 1377396000,
      "updated_at": 1692928800,
      "thumbnail": {
        "width": 595,
        "height": 335,
        "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
      }
    }
  }
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

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

    • warning

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

    • 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

    • warning

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

    • warning

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