Upload asset Upload a new asset to the user's Projects.
You can upload media assets to a user’s content library using the assets/upload
endpoint.
When specifying an asset that already exists, it renames the asset.
The request format for this endpoint is an application/octet-stream
body of bytes. Attach
information about the upload using an Upload-Metadata
header.
HTTP method and URL path
POST https://api.canva.com /rest /v1 /assets /upload
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 .
Authorization: Bearer {token}
Content-Type: application/octet-stream
Upload-Metadata: {Upload-Metadata}
The name of the asset. The maximum length of this property is 50 characters.
The ID of the parent folder where the asset will be uploaded.
Body parameters
Binary of the asset to upload.
Example request
Examples for using the /v1/assets/upload
endpoint:
cURL Node.js Java Python C# Go PHP Ruby
curl --request POST 'https://api.canva.com/rest/v1/assets/upload' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/octet-stream' \
--header 'Upload-Metadata: { "name": "My Awesome Upload", "parent_folder_id": "FG5IFBpY3M", "tags": ["go to market","holiday","adventure"] }' \
--data-binary '@/path/to/file'
const fetch = require ( "node-fetch" ) ;
const fs = require ( "fs" ) ;
fetch ( "https://api.canva.com/rest/v1/assets/upload" , {
method : "POST" ,
headers : {
"Authorization" : "Bearer {token}" ,
"Content-Length" : fs . statSync ( "/path/to/file" ) . size ,
"Content-Type" : "application/octet-stream" ,
"Upload-Metadata" : JSON . stringify ( { "name" : "My Awesome Upload" , "parent_folder_id" : "FG5IFBpY3M" , "tags" : [ "go to market" , "holiday" , "adventure" ] } ) ,
} ,
body : fs . createReadStream ( "/path/to/file" ) ,
} )
. 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 . * ;
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/assets/upload" ) )
. header ( "Authorization" , "Bearer {token}" )
. header ( "Content-Type" , "application/octet-stream" )
. header ( "Upload-Metadata" , "{ \"name\": \"My Awesome Upload\", \"parent_folder_id\": \"FG5IFBpY3M\", \"tags\": [\"go to market\",\"holiday\",\"adventure\"] }" )
. 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 ( ) ) ;
}
}
import requests
import json
headers = {
"Authorization" : "Bearer {token}" ,
"Content-Type" : "application/octet-stream" ,
"Upload-Metadata" : json . dumps ( { "name" : "My Awesome Upload" , "parent_folder_id" : "FG5IFBpY3M" , "tags" : [ "go to market" , "holiday" , "adventure" ] } )
}
with open ( "/path/to/file" , "rb" ) as file :
response = requests . post ( "https://api.canva.com/rest/v1/assets/upload" ,
headers = headers ,
data = file
)
print ( response . json ( ) )
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/assets/upload" ) ,
Headers =
{
{ "Authorization" , "Bearer {token}" } ,
{ "Upload-Metadata" , "{ \"name\": \"My Awesome Upload\", \"parent_folder_id\": \"FG5IFBpY3M\", \"tags\": [\"go to market\",\"holiday\",\"adventure\"] }" } ,
} ,
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 ) ;
} ;
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/assets/upload"
req , _ := http . NewRequest ( "POST" , url , payload )
req . Header . Add ( "Authorization" , "Bearer {token}" )
req . Header . Add ( "Content-Type" , "application/octet-stream" )
req . Header . Add ( "Upload-Metadata" , "{ \"name\": \"My Awesome Upload\", \"parent_folder_id\": \"FG5IFBpY3M\", \"tags\": [\"go to market\",\"holiday\",\"adventure\"] }" )
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/assets/upload" ,
CURLOPT_CUSTOMREQUEST => "POST" ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_HTTPHEADER => array (
'Authorization: Bearer {token}' ,
'Content-Type: application/octet-stream' ,
'Upload-Metadata: { "name": "My Awesome Upload", "parent_folder_id": "FG5IFBpY3M", "tags": ["go to market","holiday","adventure"] }' ,
) ,
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 ;
}
require 'net/http'
require 'uri'
url = URI ( 'https://api.canva.com/rest/v1/assets/upload' )
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 [ 'Upload-Metadata' ] = '{ "name": "My Awesome Upload", "parent_folder_id": "FG5IFBpY3M", "tags": ["go to market","holiday","adventure"] }'
request . body = File . read ( '/path/to/file' )
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:
The asset object, which contains metadata about the asset.
Properties of asset
The import status of the asset.
Properties of import_status
State of the import job for an uploaded asset. This can be one of the following:
FAILED
IN_PROGRESS
SUCCESS
If the import fails, this object provides details about the error.
Properties of error
A short string indicating why the upload failed. This field can be used to handle errors programmatically. This can be one of the following:
FILE_TOO_BIG
IMPORT_FAILED
A human-readable description of what went wrong.
When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix
Epoch).
When the asset 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.
Example response
{
"asset" : {
"id" : "Msd59349ff" ,
"name" : "My Awesome Upload" ,
"tags" : [
"image" ,
"holiday" ,
"best day ever"
] ,
"import_status" : {
"state" : "SUCCESS"
} ,
"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>"
}
}
}