Get the result of an asset upload job that was created using the Create asset upload 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 /asset-uploads/{jobId}
This operation is rate limited to 180 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):
asset:read
For more information, see Scopes.
Header parameters
Path parameters
jobId
string
The asset upload job ID.
Example request
Examples for using the /v1/asset-uploads/{jobId}
endpoint:
curl --request GET 'https://api.canva.com/rest/v1/asset-uploads/{jobId}' \--header 'Authorization: Bearer {token}'
const fetch = require("node-fetch");fetch("https://api.canva.com/rest/v1/asset-uploads/{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/asset-uploads/{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/asset-uploads/{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/asset-uploads/{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/asset-uploads/{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/asset-uploads/{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/asset-uploads/{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
AssetUploadJob
The status of the asset upload job.
Properties of job
id
string
The ID of the asset upload job.
status
string
Status of the asset upload job. This can be one of the following:
failed
in_progress
success
error
AssetUploadError
If the upload fails, this object provides details about the error.
Properties of error
code
string
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
message
string
A human-readable description of what went wrong.
asset
Asset
The asset object, which contains metadata about the asset.
Properties of asset
type
string
Type of an asset. Support for video
assets is currently provided as a preview.
id
string
The ID of the asset.
name
string
The name of the asset.
created_at
integer
When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix Epoch).
updated_at
integer
When the asset was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).
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.
import_status
ImportStatus
The import status of the asset.
Properties of import_status
state
string
State of the import job for an uploaded asset. This can be one of the following:
failed
in_progress
success
error
ImportError
If the import fails, this object provides details about the error.
Properties of error
message
string
A human-readable description of what went wrong.
code
string
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
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","asset": {"id": "Msd59349ff","name": "My Awesome Upload","tags": ["image","holiday","best day ever"],"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>"}}}}
Failed job
{"job": {"id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8","status": "failed","error": {"code": "file_too_big","message": "Failed to import because the file is too big"}}}