Autofill

Overview Create design autofill job Get design autofill job

Create design autofill job

Create an asynchronous job to autofill a design from a brand template with your input information.

Starts a new job to autofill a Canva design using a brand template and input data.

To get a list of input data fields, use the Get brand template dataset API.

Brand templates contain references to image media. You can reference image media by providing the value of type with image within the data object. The number of references to image media within a brand template cannot currently exceed 300 references.

HTTP method and URL path

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

Authentication

This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):

design:content:write

For more information, see Scopes.

Header parameters

#Authorizationstring

Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#Content-Typestring

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

Body parameters

#brand_template_idstring

Required

ID of the input brand template.

#dataobject

Required

Data object containing the data fields and values to autofill.

Properties of data

#<KEY>object of DatasetValues

Required

The data field to autofill.

{
  "cute_pet_image_of_the_day": {
    "type": "image",
    "asset_id": "Msd59349ff"
  },
  "cute_pet_witty_pet_says": {
    "type": "text",
    "text": "It was like this when I got here!"
  }
}

json

#typestring

Required

This can be one of the following:

image: If the data field is an image field.
text: If the data field is a text field.

#asset_idstring

Sometimes required

asset_id of the image to insert into the template element.

#textstring

Sometimes required

Text to insert into the template element.

#titlestring

Optional

Title to use for the autofilled design. Must be less than 256 characters.

If no design title is provided, the autofilled design will have the same title as the brand template.

Example request

Examples for using the /v1/autofills endpoint:

curl --request POST 'https://api.canva.com/rest/v1/autofills' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
  "brand_template_id": "DAFVztcvd9z",
  "title": "string",
  "data": {
    "cute_pet_image_of_the_day": {
      "type": "image",
      "asset_id": "Msd59349ff"
    },
    "cute_pet_witty_pet_says": {
      "type": "text",
      "text": "It was like this when I got here!"
    }
  }
}'

const fetch = require("node-fetch");

fetch("https://api.canva.com/rest/v1/autofills", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "brand_template_id": "DAFVztcvd9z",
    "title": "string",
    "data": {
      "cute_pet_image_of_the_day": {
        "type": "image",
        "asset_id": "Msd59349ff"
      },
      "cute_pet_witty_pet_says": {
        "type": "text",
        "text": "It was like this when I got here!"
      }
    }
  }),
})
  .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"))
            .header("Authorization", "Bearer {token}")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("{\"brand_template_id\": \"DAFVztcvd9z\", \"title\": \"string\", \"data\": {\"cute_pet_image_of_the_day\": {\"type\": \"image\", \"asset_id\": \"Msd59349ff\"}, \"cute_pet_witty_pet_says\": {\"type\": \"text\", \"text\": \"It was like this when I got here!\"}}}"))
            .build();

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

java

import requests

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

data = {
    "brand_template_id": "DAFVztcvd9z",
    "title": "string",
    "data": {
        "cute_pet_image_of_the_day": {
            "type": "image",
            "asset_id": "Msd59349ff"
        },
        "cute_pet_witty_pet_says": {
            "type": "text",
            "text": "It was like this when I got here!"
        }
    }
}

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

using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://api.canva.com/rest/v1/autofills"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
  Content = new StringContent(
    "{\"brand_template_id\": \"DAFVztcvd9z\", \"title\": \"string\", \"data\": {\"cute_pet_image_of_the_day\": {\"type\": \"image\", \"asset_id\": \"Msd59349ff\"}, \"cute_pet_witty_pet_says\": {\"type\": \"text\", \"text\": \"It was like this when I got here!\"}}}",
    Encoding.UTF8,
    "application/json"
  ),
};

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

csharp

package main

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

func main() {
	payload := strings.NewReader(`{
	  "brand_template_id": "DAFVztcvd9z",
	  "title": "string",
	  "data": {
	    "cute_pet_image_of_the_day": {
	      "type": "image",
	      "asset_id": "Msd59349ff"
	    },
	    "cute_pet_witty_pet_says": {
	      "type": "text",
	      "text": "It was like this when I got here!"
	    }
	  }
	}`)

	url := "https://api.canva.com/rest/v1/autofills"
	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))
}

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.canva.com/rest/v1/autofills",
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer {token}',
    'Content-Type: application/json',
  ),
  CURLOPT_POSTFIELDS => json_encode([
    "brand_template_id" => "DAFVztcvd9z",
    "title" => "string",
    "data" => [
      "cute_pet_image_of_the_day" => [
        "type" => "image",
        "asset_id" => "Msd59349ff"
      ],
      "cute_pet_witty_pet_says" => [
        "type" => "text",
        "text" => "It was like this when I got here!"
      ]
    ]
  ])
));

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

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

php

require 'net/http'
require 'uri'

url = URI('https://api.canva.com/rest/v1/autofills')
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
{
  "brand_template_id": "DAFVztcvd9z",
  "title": "string",
  "data": {
    "cute_pet_image_of_the_day": {
      "type": "image",
      "asset_id": "Msd59349ff"
    },
    "cute_pet_witty_pet_says": {
      "type": "text",
      "text": "It was like this when I got here!"
    }
  }
}
REQUEST_BODY

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

ruby

Success response

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

#jobDesignAutofillJob

Details about the autofill job.

Properties of job

#idstring

ID of the asynchronous job that is creating the design using the provided data.

#statusstring

Status of the design autofill job. This can be one of the following:

in_progress
success
failed

#resultDesignAutofillJobResult

Optional

Result of the design autofill job. Only present if job status is success.

Properties of result

#typestring

This can be one of the following:

create_design: Design has been created and saved to user's root folder.

#designDesignSummary

Basic details about the design, such as the design's ID, title, and URL.

Properties of design

#idstring

Optional

The design ID.

#titlestring

Optional

The design title.

#urlstring

Optional

URL of the design.

#thumbnailThumbnail

Optional

A thumbnail image representing the object.

Properties of thumbnail

#widthinteger

The width of the thumbnail image in pixels.

#heightinteger

The height of the thumbnail image in pixels.

#urlstring

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.

#errorAutofillError

Optional

If the autofill job fails, this object provides details about the error.

Properties of error

#codestring

This can be one of the following:

autofill_error
thumbnail_generation_error
create_design_error

#messagestring

A human-readable description of what went wrong.

Example response

{
  "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>"
        }
      }
    },
    "error": {
      "code": "autofill_error",
      "message": "string"
    }
  }
}

json

Create design autofill job

HTTP method and URL path

Authentication

Header parameters

Body parameters

Example request

Success response

Example response

Try it out

Step 1: Enter your access token