Connect API — Design Imports

Design Imports Overview

The Canva Connect APIs for importing designs from other applications into Canva.

The design import API lets you import files into Canva from a range of applications, helping you bring your content to Canva without having to recreate your work.

For more information about Canva designs, see Canva concepts.

Supported file types

The design import API accepts the following file types:

Name	MIME type	File extension
Adobe Illustrator	application/illustrator	.ai
Adobe Photoshop	image/vnd.adobe.photoshop	.psd
Affinity	application/affinity	.af, .afdesign, .afphoto, .afpub
Apple Keynote	application/vnd.apple.keynote	.key
Apple Numbers	application/vnd.apple.numbers	.numbers
Apple Pages	application/vnd.apple.pages	.pages
Microsoft Excel (pre 2007)	application/vnd.ms-excel	.xls
Microsoft Excel	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet	.xlsx
Microsoft PowerPoint (pre 2007)	application/vnd.ms-powerpoint	.ppt
Microsoft PowerPoint	application/vnd.openxmlformats-officedocument.presentationml.presentation	.pptx
Microsoft Word (pre 2007)	application/msword	.doc
Microsoft Word	application/vnd.openxmlformats-officedocument.wordprocessingml.document	.docx
OpenOffice Draw	application/vnd.oasis.opendocument.graphics	.odg
OpenOffice Presentation	application/vnd.oasis.opendocument.presentation	.odp
OpenOffice Sheets	application/vnd.oasis.opendocument.spreadsheet	.ods
OpenOffice Text	application/vnd.oasis.opendocument.text	.odt
PDF	application/pdf	.pdf

For upload formats and requirements, see Canva Help — Upload formats and requirements.

Design import API

• Create design import job: Create an asynchronous job to import a design created in another application.
• Create URL import job: Create an asynchronous job to import a design created in another application, using a URL.
• Get design import job: Get the status and results of a design import job, including the imported design.
• Get URL import job: Get the status and results of a URL import job, including the imported design.

Create Import Job

Create an asynchronous job to import a design created in another application.

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>

HTTP method and URL path

POST https://api.canva.com/rest/v1/imports

This operation is rate limited to 20 requests per minute for each user of your integration.

Authentication and authorization

This endpoint requires a valid access token that acts on behalf of a user.

Scopes

The access token must have all the following scopes (permissions):

• design:content:write

Header parameters

<Prop.List> <Prop name="Authorization" type="string" required> Provides credentials to authenticate the request, in the form of a Bearer token.

For example: `Authorization: Bearer {token}`

</Prop>

<Prop name="Content-Type" type="string" required> Indicates the media type of the information sent in the request. This must be set to application/octet-stream.

For example: `Content-Type: application/octet-stream`

</Prop>

<Prop name="Import-Metadata" type="DesignImportMetadata" required> Metadata about the design that you include as a header parameter when importing a design.

<PillAccordion title={<>Properties of <strong>Import-Metadata</strong></>}>
  <Prop.List>
    <Prop name="title_base64" type="string" required>
      The design's title, encoded in Base64.

      The maximum length of a design title in Canva (unencoded) is 50 characters.

      Base64 encoding allows titles containing emojis and other special
      characters to be sent using HTTP headers.
      For example, "My Awesome Design 😍" Base64 encoded
      is `TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==`.

      <Prop.Extras>
        **Minimum length:** `1`
      </Prop.Extras>
    </Prop>

    <Prop name="mime_type" type="string">
      The MIME type of the file being imported. If not provided, Canva attempts to automatically detect the type of the file.
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Body parameters

Binary of the file to import.

Example request

Examples for using the /v1/imports endpoint:

<Tabs storageKey="example.language" disableContentTransition> <Tab name="cURL"> sh curl --request POST 'https://api.canva.com/rest/v1/imports' \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/octet-stream' \ --header 'Import-Metadata: { "title_base64": "TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==", "mime_type": "application/pdf" }' \ --data-binary '@/path/to/file' </Tab>

<Tab name="Node.js"> ```js const fetch = require("node-fetch"); const fs = require("fs");

fetch("https://api.canva.com/rest/v1/imports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {token}",
    "Content-Length": fs.statSync("/path/to/file").size,
    "Content-Type": "application/octet-stream",
    "Import-Metadata": JSON.stringify({ "title_base64": "TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==", "mime_type": "application/pdf" }),
  },
  body: fs.createReadStream("/path/to/file"),
})
  .then(async (response) => {
    const data = await response.json();
    console.log(data);
  })
  .catch(err => console.error(err));
```

</Tab>

<Tab name="Java"> ```java import java.io.IOException; import java.net.URI; import java.net.http.*; import java.nio.file.Paths;

public class ApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.canva.com/rest/v1/imports"))
            .header("Authorization", "Bearer {token}")
            .header("Content-Type", "application/octet-stream")
            .header("Import-Metadata", "{ \"title_base64\": \"TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==\", \"mime_type\": \"application/pdf\" }")
            .method("POST", HttpRequest.BodyPublishers.ofFile(Paths.get("/path/to/file")))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}
```

</Tab>

<Tab name="Python"> ```py import requests import json

headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/octet-stream",
    "Import-Metadata": json.dumps({ "title_base64": "TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==", "mime_type": "application/pdf" })
}

with open("/path/to/file", "rb") as file:
    response = requests.post("https://api.canva.com/rest/v1/imports",
        headers=headers,
        data=file
    )
    print(response.json())
```

</Tab>

<Tab name="C#"> ```csharp using System.Net.Http; using System.Net.Http.Headers;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://api.canva.com/rest/v1/imports"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
    { "Import-Metadata", "{ \"title_base64\": \"TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==\", \"mime_type\": \"application/pdf\" }" },
  },
  Content = new StreamContent(File.OpenRead("/path/to/file"))
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/octet-stream"),
    }
  },
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};
```

</Tab>

<Tab name="Go"> ```go package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	payload, _ := os.Open("/path/to/file")
	defer payload.Close()

	url := "https://api.canva.com/rest/v1/imports"
	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer {token}")
	req.Header.Add("Content-Type", "application/octet-stream")
	req.Header.Add("Import-Metadata", "{ \"title_base64\": \"TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==\", \"mime_type\": \"application/pdf\" }")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
```

</Tab>

<Tab name="PHP"> ```php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.canva.com/rest/v1/imports", CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => array( 'Authorization: Bearer {token}', 'Content-Type: application/octet-stream', 'Import-Metadata: { "title_base64": "TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==", "mime_type": "application/pdf" }', ), CURLOPT_POSTFIELDS => file_get_contents("/path/to/file") ));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if (empty($err)) {
  echo $response;
} else {
  echo "Error: " . $err;
}
```

</Tab>

<Tab name="Ruby"> ```ruby require 'net/http' require 'uri'

url = URI('https://api.canva.com/rest/v1/imports')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer {token}'
request['Content-Type'] = 'application/octet-stream'
request['Import-Metadata'] = '{ "title_base64": "TXkgQXdlc29tZSBEZXNpZ24g8J+YjQ==", "mime_type": "application/pdf" }'
request.body = File.read('/path/to/file')

response = http.request(request)
puts response.read_body
```

</Tab> </Tabs>

Success response

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

<Prop.List> <Prop name="job" type="DesignImportJob" required mode="output"> The status of the design import job.

<PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
  <Prop.List>
    <Prop name="id" type="string" required mode="output">
      The ID of the design import job.
    </Prop>

    <Prop name="status" type="string" required mode="output">
      The status of the design import job.

      <Prop.Extras>
        **Available values:**

        * `failed`
        * `in_progress`
        * `success`
      </Prop.Extras>
    </Prop>

    <Prop name="result" type="DesignImportJobResult" mode="output">
      <PillAccordion title={<>Properties of <strong>result</strong></>}>
        <Prop.List>
          <Prop name="designs" type="DesignSummary[]" required mode="output">
            A list of designs imported from the external file. It usually contains one item.
            Imports with a large number of pages or assets are split into multiple designs.

            <PillAccordion title={<>Properties of <strong>designs</strong></>}>
              <Prop.List>
                <Prop name="id" type="string" required mode="output">
                  The design ID.
                </Prop>

                <Prop name="urls" type="DesignLinks" required mode="output">
                  A temporary set of URLs for viewing or editing the design.

                  <PillAccordion title={<>Properties of <strong>urls</strong></>}>
                    <Prop.List>
                      <Prop name="edit_url" type="string" required mode="output">
                        A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>

                      <Prop name="view_url" type="string" required mode="output">
                        A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="created_at" type="integer" required mode="output">
                  When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
                  Epoch).
                </Prop>

                <Prop name="updated_at" type="integer" required mode="output">
                  When the design was last updated in Canva, as a Unix timestamp (in seconds since the
                  Unix Epoch).
                </Prop>

                <Prop name="title" type="string" mode="output">
                  The design title.
                </Prop>

                <Prop name="url" type="string" mode="output">
                  URL of the design.
                </Prop>

                <Prop name="thumbnail" type="Thumbnail" mode="output">
                  A thumbnail image representing the object.

                  <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
                    <Prop.List>
                      <Prop name="width" type="integer" required mode="output">
                        The width of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="height" type="integer" required mode="output">
                        The height of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="url" type="string" required mode="output">
                        A URL for retrieving the thumbnail image.
                        This URL expires after 15 minutes. This URL includes a query string
                        that's required for retrieving the thumbnail.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="page_count" type="integer" mode="output">
                  The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="error" type="DesignImportError" mode="output">
      If the import job fails, this object provides details about the error.

      <PillAccordion title={<>Properties of <strong>error</strong></>}>
        <Prop.List>
          <Prop name="code" type="string" required mode="output">
            A short string about why the import failed. This field can be used to handle errors
            programmatically.

            <Prop.Extras>
              **Available values:**

              * `design_creation_throttled`
              * `design_import_throttled`
              * `duplicate_import`
              * `internal_error`
              * `invalid_file`
              * `fetch_failed`
            </Prop.Extras>
          </Prop>

          <Prop name="message" type="string" required mode="output">
            A human-readable description of what went wrong.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Example responses

In progress job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "in_progress"
  }
}

Successfully completed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "success",
    "result": {
      "designs": [
        {
          "id": "DAGQm2AkzOk",
          "title": "My Awesome Design",
          "thumbnail": {
            "width": 376,
            "height": 531,
            "url": "https://document-export.canva.com/..."
          },
          "urls": {
            "edit_url": "https://www.canva.com/api/design/...",
            "view_url": "https://www.canva.com/api/design/..."
          },
          "created_at": 1726198998,
          "updated_at": 1726199000
        }
      ]
    }
  }
}

Failed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "failed",
    "error": {
      "code": "invalid_file",
      "message": "Document could not be imported because the file is corrupt."
    }
  }
}

Create URL Import Job

Create an asynchronous job to import a design created in another application, using a URL.

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>

HTTP method and URL path

POST https://api.canva.com/rest/v1/url-imports

This operation is rate limited to 20 requests per minute for each user of your integration.

Authentication and authorization

This endpoint requires a valid access token that acts on behalf of a user.

Scopes

The access token must have all the following scopes (permissions):

• design:content:write

Header parameters

<Prop.List> <Prop name="Authorization" type="string" required> Provides credentials to authenticate the request, in the form of a Bearer token.

For example: `Authorization: Bearer {token}`

</Prop>

<Prop name="Content-Type" type="string" required> Indicates the media type of the information sent in the request. This must be set to application/json.

For example: `Content-Type: application/json`

</Prop> </Prop.List>

Body parameters

<Prop.List> <Prop name="title" type="string" required> A title for the design.

<Prop.Extras>
  **Minimum length:** `1`

  **Maximum length:** `255`
</Prop.Extras>

</Prop>

<Prop name="url" type="string" required> The URL of the file to import. This URL must be accessible from the internet and be publicly available.

<Prop.Extras>
  **Minimum length:** `1`

  **Maximum length:** `2048`
</Prop.Extras>

</Prop>

<Prop name="mime_type" type="string"> The MIME type of the file being imported. If not provided, Canva attempts to automatically detect the type of the file.

<Prop.Extras>
  **Minimum length:** `1`

  **Maximum length:** `100`
</Prop.Extras>

</Prop> </Prop.List>

Example request

Examples for using the /v1/url-imports endpoint:

<Tabs storageKey="example.language" disableContentTransition> <Tab name="cURL"> sh curl --request POST 'https://api.canva.com/rest/v1/url-imports' \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{ "title": "My Awesome Design", "url": "string", "mime_type": "application/vnd.apple.keynote" }' </Tab>

<Tab name="Node.js"> ```js const fetch = require("node-fetch");

fetch("https://api.canva.com/rest/v1/url-imports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "My Awesome Design",
    "url": "string",
    "mime_type": "application/vnd.apple.keynote"
  }),
})
  .then(async (response) => {
    const data = await response.json();
    console.log(data);
  })
  .catch(err => console.error(err));
```

</Tab>

<Tab name="Java"> ```java import java.io.IOException; import java.net.URI; import java.net.http.*;

public class ApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.canva.com/rest/v1/url-imports"))
            .header("Authorization", "Bearer {token}")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("{\"title\": \"My Awesome Design\", \"url\": \"string\", \"mime_type\": \"application/vnd.apple.keynote\"}"))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}
```

</Tab>

<Tab name="Python"> ```py import requests

headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json"
}

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

response = requests.post("https://api.canva.com/rest/v1/url-imports",
    headers=headers,
    json=data
)
print(response.json())
```

</Tab>

<Tab name="C#"> ```csharp using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://api.canva.com/rest/v1/url-imports"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
  Content = new StringContent(
    "{\"title\": \"My Awesome Design\", \"url\": \"string\", \"mime_type\": \"application/vnd.apple.keynote\"}",
    Encoding.UTF8,
    "application/json"
  ),
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};
```

</Tab>

<Tab name="Go"> ```go package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
	  "title": "My Awesome Design",
	  "url": "string",
	  "mime_type": "application/vnd.apple.keynote"
	}`)

	url := "https://api.canva.com/rest/v1/url-imports"
	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer {token}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
```

</Tab>

<Tab name="PHP"> ```php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.canva.com/rest/v1/url-imports", CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => array( 'Authorization: Bearer {token}', 'Content-Type: application/json', ), CURLOPT_POSTFIELDS => json_encode([ "title" => "My Awesome Design", "url" => "string", "mime_type" => "application/vnd.apple.keynote" ]) ));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if (empty($err)) {
  echo $response;
} else {
  echo "Error: " . $err;
}
```

</Tab>

<Tab name="Ruby"> ```ruby require 'net/http' require 'uri'

url = URI('https://api.canva.com/rest/v1/url-imports')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer {token}'
request['Content-Type'] = 'application/json'
request.body = <<REQUEST_BODY
{
  "title": "My Awesome Design",
  "url": "string",
  "mime_type": "application/vnd.apple.keynote"
}
REQUEST_BODY

response = http.request(request)
puts response.read_body
```

</Tab> </Tabs>

Success response

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

<Prop.List> <Prop name="job" type="DesignImportJob" required mode="output"> The status of the design import job.

<PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
  <Prop.List>
    <Prop name="id" type="string" required mode="output">
      The ID of the design import job.
    </Prop>

    <Prop name="status" type="string" required mode="output">
      The status of the design import job.

      <Prop.Extras>
        **Available values:**

        * `failed`
        * `in_progress`
        * `success`
      </Prop.Extras>
    </Prop>

    <Prop name="result" type="DesignImportJobResult" mode="output">
      <PillAccordion title={<>Properties of <strong>result</strong></>}>
        <Prop.List>
          <Prop name="designs" type="DesignSummary[]" required mode="output">
            A list of designs imported from the external file. It usually contains one item.
            Imports with a large number of pages or assets are split into multiple designs.

            <PillAccordion title={<>Properties of <strong>designs</strong></>}>
              <Prop.List>
                <Prop name="id" type="string" required mode="output">
                  The design ID.
                </Prop>

                <Prop name="urls" type="DesignLinks" required mode="output">
                  A temporary set of URLs for viewing or editing the design.

                  <PillAccordion title={<>Properties of <strong>urls</strong></>}>
                    <Prop.List>
                      <Prop name="edit_url" type="string" required mode="output">
                        A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>

                      <Prop name="view_url" type="string" required mode="output">
                        A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="created_at" type="integer" required mode="output">
                  When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
                  Epoch).
                </Prop>

                <Prop name="updated_at" type="integer" required mode="output">
                  When the design was last updated in Canva, as a Unix timestamp (in seconds since the
                  Unix Epoch).
                </Prop>

                <Prop name="title" type="string" mode="output">
                  The design title.
                </Prop>

                <Prop name="url" type="string" mode="output">
                  URL of the design.
                </Prop>

                <Prop name="thumbnail" type="Thumbnail" mode="output">
                  A thumbnail image representing the object.

                  <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
                    <Prop.List>
                      <Prop name="width" type="integer" required mode="output">
                        The width of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="height" type="integer" required mode="output">
                        The height of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="url" type="string" required mode="output">
                        A URL for retrieving the thumbnail image.
                        This URL expires after 15 minutes. This URL includes a query string
                        that's required for retrieving the thumbnail.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="page_count" type="integer" mode="output">
                  The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="error" type="DesignImportError" mode="output">
      If the import job fails, this object provides details about the error.

      <PillAccordion title={<>Properties of <strong>error</strong></>}>
        <Prop.List>
          <Prop name="code" type="string" required mode="output">
            A short string about why the import failed. This field can be used to handle errors
            programmatically.

            <Prop.Extras>
              **Available values:**

              * `design_creation_throttled`
              * `design_import_throttled`
              * `duplicate_import`
              * `internal_error`
              * `invalid_file`
              * `fetch_failed`
            </Prop.Extras>
          </Prop>

          <Prop name="message" type="string" required mode="output">
            A human-readable description of what went wrong.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Example responses

In progress job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "in_progress"
  }
}

Successfully completed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "success",
    "result": {
      "designs": [
        {
          "id": "DAGQm2AkzOk",
          "title": "My Awesome Design",
          "thumbnail": {
            "width": 376,
            "height": 531,
            "url": "https://document-export.canva.com/..."
          },
          "urls": {
            "edit_url": "https://www.canva.com/api/design/...",
            "view_url": "https://www.canva.com/api/design/..."
          },
          "created_at": 1726198998,
          "updated_at": 1726199000
        }
      ]
    }
  }
}

Failed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "failed",
    "error": {
      "code": "invalid_file",
      "message": "Document could not be imported because the file is corrupt."
    }
  }
}

Get Import Job

Get the status and results of a design import job, including the imported design.

Gets the result of a design import job created using the Create design import job API.

You might need to make multiple requests to this endpoint until you get a success or failed status. For more information on the workflow for using asynchronous jobs, see API requests and responses.

HTTP method and URL path

GET https://api.canva.com/rest/v1/imports/{jobId}

This operation is rate limited to 120 requests per minute for each user of your integration.

Authentication and authorization

This endpoint requires a valid access token that acts on behalf of a user.

Scopes

The access token must have all the following scopes (permissions):

• design:content:write

Header parameters

<Prop.List> <Prop name="Authorization" type="string" required> Provides credentials to authenticate the request, in the form of a Bearer token.

For example: `Authorization: Bearer {token}`

</Prop> </Prop.List>

Path parameters

<Prop.List> <Prop name="jobId" type="string" required> The design import job ID. </Prop> </Prop.List>

Example request

Examples for using the /v1/imports/{jobId} endpoint:

<Tabs storageKey="example.language" disableContentTransition> <Tab name="cURL"> sh curl --request GET 'https://api.canva.com/rest/v1/imports/{jobId}' \ --header 'Authorization: Bearer {token}' </Tab>

<Tab name="Node.js"> ```js const fetch = require("node-fetch");

fetch("https://api.canva.com/rest/v1/imports/{jobId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {token}",
  },
})
  .then(async (response) => {
    const data = await response.json();
    console.log(data);
  })
  .catch(err => console.error(err));
```

</Tab>

<Tab name="Java"> ```java import java.io.IOException; import java.net.URI; import java.net.http.*;

public class ApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.canva.com/rest/v1/imports/{jobId}"))
            .header("Authorization", "Bearer {token}")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}
```

</Tab>

<Tab name="Python"> ```py import requests

headers = {
    "Authorization": "Bearer {token}"
}

response = requests.get("https://api.canva.com/rest/v1/imports/{jobId}",
    headers=headers
)
print(response.json())
```

</Tab>

<Tab name="C#"> ```csharp using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://api.canva.com/rest/v1/imports/{jobId}"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};
```

</Tab>

<Tab name="Go"> ```go package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.canva.com/rest/v1/imports/{jobId}"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer {token}")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
```

</Tab>

<Tab name="PHP"> ```php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.canva.com/rest/v1/imports/{jobId}", CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => array( 'Authorization: Bearer {token}', ), ));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if (empty($err)) {
  echo $response;
} else {
  echo "Error: " . $err;
}
```

</Tab>

<Tab name="Ruby"> ```ruby require 'net/http' require 'uri'

url = URI('https://api.canva.com/rest/v1/imports/{jobId}')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer {token}'

response = http.request(request)
puts response.read_body
```

</Tab> </Tabs>

Success response

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

<Prop.List> <Prop name="job" type="DesignImportJob" required mode="output"> The status of the design import job.

<PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
  <Prop.List>
    <Prop name="id" type="string" required mode="output">
      The ID of the design import job.
    </Prop>

    <Prop name="status" type="string" required mode="output">
      The status of the design import job.

      <Prop.Extras>
        **Available values:**

        * `failed`
        * `in_progress`
        * `success`
      </Prop.Extras>
    </Prop>

    <Prop name="result" type="DesignImportJobResult" mode="output">
      <PillAccordion title={<>Properties of <strong>result</strong></>}>
        <Prop.List>
          <Prop name="designs" type="DesignSummary[]" required mode="output">
            A list of designs imported from the external file. It usually contains one item.
            Imports with a large number of pages or assets are split into multiple designs.

            <PillAccordion title={<>Properties of <strong>designs</strong></>}>
              <Prop.List>
                <Prop name="id" type="string" required mode="output">
                  The design ID.
                </Prop>

                <Prop name="urls" type="DesignLinks" required mode="output">
                  A temporary set of URLs for viewing or editing the design.

                  <PillAccordion title={<>Properties of <strong>urls</strong></>}>
                    <Prop.List>
                      <Prop name="edit_url" type="string" required mode="output">
                        A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>

                      <Prop name="view_url" type="string" required mode="output">
                        A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="created_at" type="integer" required mode="output">
                  When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
                  Epoch).
                </Prop>

                <Prop name="updated_at" type="integer" required mode="output">
                  When the design was last updated in Canva, as a Unix timestamp (in seconds since the
                  Unix Epoch).
                </Prop>

                <Prop name="title" type="string" mode="output">
                  The design title.
                </Prop>

                <Prop name="url" type="string" mode="output">
                  URL of the design.
                </Prop>

                <Prop name="thumbnail" type="Thumbnail" mode="output">
                  A thumbnail image representing the object.

                  <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
                    <Prop.List>
                      <Prop name="width" type="integer" required mode="output">
                        The width of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="height" type="integer" required mode="output">
                        The height of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="url" type="string" required mode="output">
                        A URL for retrieving the thumbnail image.
                        This URL expires after 15 minutes. This URL includes a query string
                        that's required for retrieving the thumbnail.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="page_count" type="integer" mode="output">
                  The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="error" type="DesignImportError" mode="output">
      If the import job fails, this object provides details about the error.

      <PillAccordion title={<>Properties of <strong>error</strong></>}>
        <Prop.List>
          <Prop name="code" type="string" required mode="output">
            A short string about why the import failed. This field can be used to handle errors
            programmatically.

            <Prop.Extras>
              **Available values:**

              * `design_creation_throttled`
              * `design_import_throttled`
              * `duplicate_import`
              * `internal_error`
              * `invalid_file`
              * `fetch_failed`
            </Prop.Extras>
          </Prop>

          <Prop name="message" type="string" required mode="output">
            A human-readable description of what went wrong.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Example responses

In progress job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "in_progress"
  }
}

Successfully completed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "success",
    "result": {
      "designs": [
        {
          "id": "DAGQm2AkzOk",
          "title": "My Awesome Design",
          "thumbnail": {
            "width": 376,
            "height": 531,
            "url": "https://document-export.canva.com/..."
          },
          "urls": {
            "edit_url": "https://www.canva.com/api/design/...",
            "view_url": "https://www.canva.com/api/design/..."
          },
          "created_at": 1726198998,
          "updated_at": 1726199000
        }
      ]
    }
  }
}

Failed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "failed",
    "error": {
      "code": "invalid_file",
      "message": "Document could not be imported because the file is corrupt."
    }
  }
}

Get URL Import Job

Get the status and results of a URL import job, including the imported design.

Gets the result of a URL import job created using the Create URL import job API.

You might need to make multiple requests to this endpoint until you get a success or failed status. For more information on the workflow for using asynchronous jobs, see API requests and responses.

HTTP method and URL path

GET https://api.canva.com/rest/v1/url-imports/{jobId}

This operation is rate limited to 120 requests per minute for each user of your integration.

Authentication and authorization

This endpoint requires a valid access token that acts on behalf of a user.

Scopes

The access token must have all the following scopes (permissions):

• design:content:write

Header parameters

<Prop.List> <Prop name="Authorization" type="string" required> Provides credentials to authenticate the request, in the form of a Bearer token.

For example: `Authorization: Bearer {token}`

</Prop> </Prop.List>

Path parameters

<Prop.List> <Prop name="jobId" type="string" required> The ID of the URL import job. </Prop> </Prop.List>

Example request

Examples for using the /v1/url-imports/{jobId} endpoint:

<Tabs storageKey="example.language" disableContentTransition> <Tab name="cURL"> sh curl --request GET 'https://api.canva.com/rest/v1/url-imports/{jobId}' \ --header 'Authorization: Bearer {token}' </Tab>

<Tab name="Node.js"> ```js const fetch = require("node-fetch");

fetch("https://api.canva.com/rest/v1/url-imports/{jobId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {token}",
  },
})
  .then(async (response) => {
    const data = await response.json();
    console.log(data);
  })
  .catch(err => console.error(err));
```

</Tab>

<Tab name="Java"> ```java import java.io.IOException; import java.net.URI; import java.net.http.*;

public class ApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.canva.com/rest/v1/url-imports/{jobId}"))
            .header("Authorization", "Bearer {token}")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}
```

</Tab>

<Tab name="Python"> ```py import requests

headers = {
    "Authorization": "Bearer {token}"
}

response = requests.get("https://api.canva.com/rest/v1/url-imports/{jobId}",
    headers=headers
)
print(response.json())
```

</Tab>

<Tab name="C#"> ```csharp using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://api.canva.com/rest/v1/url-imports/{jobId}"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};
```

</Tab>

<Tab name="Go"> ```go package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.canva.com/rest/v1/url-imports/{jobId}"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer {token}")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
```

</Tab>

<Tab name="PHP"> ```php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.canva.com/rest/v1/url-imports/{jobId}", CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => array( 'Authorization: Bearer {token}', ), ));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if (empty($err)) {
  echo $response;
} else {
  echo "Error: " . $err;
}
```

</Tab>

<Tab name="Ruby"> ```ruby require 'net/http' require 'uri'

url = URI('https://api.canva.com/rest/v1/url-imports/{jobId}')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer {token}'

response = http.request(request)
puts response.read_body
```

</Tab> </Tabs>

Success response

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

<Prop.List> <Prop name="job" type="DesignImportJob" required mode="output"> The status of the design import job.

<PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
  <Prop.List>
    <Prop name="id" type="string" required mode="output">
      The ID of the design import job.
    </Prop>

    <Prop name="status" type="string" required mode="output">
      The status of the design import job.

      <Prop.Extras>
        **Available values:**

        * `failed`
        * `in_progress`
        * `success`
      </Prop.Extras>
    </Prop>

    <Prop name="result" type="DesignImportJobResult" mode="output">
      <PillAccordion title={<>Properties of <strong>result</strong></>}>
        <Prop.List>
          <Prop name="designs" type="DesignSummary[]" required mode="output">
            A list of designs imported from the external file. It usually contains one item.
            Imports with a large number of pages or assets are split into multiple designs.

            <PillAccordion title={<>Properties of <strong>designs</strong></>}>
              <Prop.List>
                <Prop name="id" type="string" required mode="output">
                  The design ID.
                </Prop>

                <Prop name="urls" type="DesignLinks" required mode="output">
                  A temporary set of URLs for viewing or editing the design.

                  <PillAccordion title={<>Properties of <strong>urls</strong></>}>
                    <Prop.List>
                      <Prop name="edit_url" type="string" required mode="output">
                        A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>

                      <Prop name="view_url" type="string" required mode="output">
                        A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                        NOTE: This is not a permanent URL, it is only valid for 30 days.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="created_at" type="integer" required mode="output">
                  When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
                  Epoch).
                </Prop>

                <Prop name="updated_at" type="integer" required mode="output">
                  When the design was last updated in Canva, as a Unix timestamp (in seconds since the
                  Unix Epoch).
                </Prop>

                <Prop name="title" type="string" mode="output">
                  The design title.
                </Prop>

                <Prop name="url" type="string" mode="output">
                  URL of the design.
                </Prop>

                <Prop name="thumbnail" type="Thumbnail" mode="output">
                  A thumbnail image representing the object.

                  <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
                    <Prop.List>
                      <Prop name="width" type="integer" required mode="output">
                        The width of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="height" type="integer" required mode="output">
                        The height of the thumbnail image in pixels.
                      </Prop>

                      <Prop name="url" type="string" required mode="output">
                        A URL for retrieving the thumbnail image.
                        This URL expires after 15 minutes. This URL includes a query string
                        that's required for retrieving the thumbnail.
                      </Prop>
                    </Prop.List>
                  </PillAccordion>
                </Prop>

                <Prop name="page_count" type="integer" mode="output">
                  The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="error" type="DesignImportError" mode="output">
      If the import job fails, this object provides details about the error.

      <PillAccordion title={<>Properties of <strong>error</strong></>}>
        <Prop.List>
          <Prop name="code" type="string" required mode="output">
            A short string about why the import failed. This field can be used to handle errors
            programmatically.

            <Prop.Extras>
              **Available values:**

              * `design_creation_throttled`
              * `design_import_throttled`
              * `duplicate_import`
              * `internal_error`
              * `invalid_file`
              * `fetch_failed`
            </Prop.Extras>
          </Prop>

          <Prop name="message" type="string" required mode="output">
            A human-readable description of what went wrong.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Example responses

In progress job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "in_progress"
  }
}

Successfully completed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "success",
    "result": {
      "designs": [
        {
          "id": "DAGQm2AkzOk",
          "title": "My Awesome Design",
          "thumbnail": {
            "width": 376,
            "height": 531,
            "url": "https://document-export.canva.com/..."
          },
          "urls": {
            "edit_url": "https://www.canva.com/api/design/...",
            "view_url": "https://www.canva.com/api/design/..."
          },
          "created_at": 1726198998,
          "updated_at": 1726199000
        }
      ]
    }
  }
}

Failed job

{
  "job": {
    "id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
    "status": "failed",
    "error": {
      "code": "invalid_file",
      "message": "Document could not be imported because the file is corrupt."
    }
  }
}