Get design autofill job
To use this API, your integration must act on behalf of a user that's a member of a Canva Enterprise(opens in a new tab or window) organization.
Get the result of a design autofill job that was created using the Create design autofill 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
https://api.canva.com /rest /v1 /autofills/{jobId}
This operation is rate limited to 60 requests per minute for each user of your integration.
Authentication
This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):
design:meta:read
For more information, see Scopes.
Header parameters
Path parameters
jobId
string
The design autofill job ID.
Example request
Examples for using the /v1/autofills/{jobId}
endpoint:
curl --request GET 'https://api.canva.com/rest/v1/autofills/{jobId}' \--header 'Authorization: Bearer {token}'
const fetch = require("node-fetch");fetch("https://api.canva.com/rest/v1/autofills/{jobId}", {method: "GET",headers: {"Authorization": "Bearer {token}",},}).then(async (response) => {const data = await response.json();console.log(data);}).catch(err => console.error(err));
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/autofills/{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());}}
import requestsheaders = {"Authorization": "Bearer {token}"}response = requests.get("https://api.canva.com/rest/v1/autofills/{jobId}",headers=headers)print(response.json())
using System.Net.Http;var client = new HttpClient();var request = new HttpRequestMessage{Method = HttpMethod.Get,RequestUri = new Uri("https://api.canva.com/rest/v1/autofills/{jobId}"),Headers ={{ "Authorization", "Bearer {token}" },},};using (var response = await client.SendAsync(request)){response.EnsureSuccessStatusCode();var body = await response.Content.ReadAsStringAsync();Console.WriteLine(body);};
package mainimport ("fmt""io""net/http")func main() {url := "https://api.canva.com/rest/v1/autofills/{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))}
$curl = curl_init();curl_setopt_array($curl, array(CURLOPT_URL => "https://api.canva.com/rest/v1/autofills/{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;}
require 'net/http'require 'uri'url = URI('https://api.canva.com/rest/v1/autofills/{jobId}')http = Net::HTTP.new(url.host, url.port)http.use_ssl = truerequest = Net::HTTP::Get.new(url)request['Authorization'] = 'Bearer {token}'response = http.request(request)puts response.read_body
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
job
DesignAutofillJob
Details about the autofill job.
Properties of job
id
string
ID of the asynchronous job that is creating the design using the provided data.
status
string
Status of the design autofill job.
Available values:
in_progress
success
failed
result
DesignAutofillJobResult
Result of the design autofill job. Only present if job status is success
.
Properties of result
type
string
This can be one of the following:
create_design
: Design has been created and saved to user's root folder.
design
DesignSummary
Basic details about the design, such as the design's ID, title, and URL.
Properties of design
id
string
The design ID.
urls
DesignLinks
A temporary set of URLs for viewing or editing the design.
Properties of urls
edit_url
string
A temporary editing URL for the design.
This is not a permanent URL, it is only valid for 30 days.
view_url
string
A temporary viewing URL for the design.
This is not a permanent URL, it is only valid for 30 days.
created_at
integer
When the design was created in Canva, as a Unix timestamp (in seconds since the Unix Epoch).
updated_at
integer
When the design was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).
title
string
The design title.
url
string
URL of the design.
thumbnail
Thumbnail
A thumbnail image representing the object.
Properties of thumbnail
width
integer
The width of the thumbnail image in pixels.
height
integer
The height of the thumbnail image in pixels.
url
string
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.
page_count
integer
The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
error
AutofillError
If the autofill job fails, this object provides details about the error.
Properties of error
code
string
Available values:
autofill_error
thumbnail_generation_error
create_design_error
message
string
A human-readable description of what went wrong.
Example responses
In progress job
{"job": {"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72","status": "in_progress"}}
Successfully completed job
{"job": {"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72","status": "success","result": {"type": "create_design","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>"}}}}}
Failed job
{"job": {"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72","status": "failed","error": {"code": "autofill_error","message": "Error autofilling design from brand template"}}}