Get design autofill job Get the status and results of an autofill job, including the autofilled design.
Get the result of a design autofill job that was created using the Create a design autofill job
API .
You might need to make multiple requests to this endpoint until you get a success
or
failed
status.
HTTP method and URL path
GET 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):
For more information, see Scopes .
Provides credentials to authenticate the request, in the form of a Bearer
token.
For example: Authorization: Bearer {token}
Path parameters
The design autofill job ID.
Example request
Examples for using the /v1/autofills/{jobId}
endpoint:
cURL Node.js Java Python C# Go PHP Ruby
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 requests
headers = {
"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 main
import (
"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 = true
request = 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:
Details about the autofill job.
Properties of job
ID of the asynchronous job that is creating the design using the provided data.
Status of the design autofill job. This can be one of the following:
in_progress
success
failed
Result of the design autofill job. Only present if job status is success
.
Properties of result
This can be one of the following:
create_design
: Design has been created and saved to user's root folder.
Basic details about the design, such as the design's ID, title, and URL.
Properties of design
A temporary set of URLs for viewing or editing the design.
Properties of urls
A temporary editing URL for the design.
A temporary viewing URL for the design.
When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
Epoch).
When the design was last updated in Canva, as a Unix timestamp (in seconds since the
Unix Epoch).
A thumbnail image representing the object.
Properties of thumbnail
The width of the thumbnail image in pixels.
The height of the thumbnail image in pixels.
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.
The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
If the autofill job fails, this object provides details about the error.
Properties of error
This can be one of the following:
autofill_error
thumbnail_generation_error
create_design_error
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"
}
}
}
Try it out