> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# Get image transformation job

<Warning>
  This API is currently provided as a preview. Be aware of the following:

  * There might be unannounced breaking changes.
  * Any breaking changes to preview APIs won't produce a new [API version](https://www.canva.dev/docs/apps/rest-apis/versions/).
  * Public apps that use preview APIs will not pass the review process, and can't be made available to all Canva users.
</Warning>

Gets the result of an image transformation job that was created using the [Create image transformation job API](https://www.canva.dev/docs/apps/rest-apis/reference/image-transformations/create-image-transformation-job/).

If the job is successful, the job's `result` contains the new image asset produced by the transformations.

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](https://www.canva.dev/docs/apps/rest-apis/requests-responses/#asynchronous-job-endpoints).

## HTTP method and URL path

GET https\://api.canva.com/rest/v1/image-transformations/\{jobId}

### Rate limit

This operation is rate limited to 120 requests per minute for each user of your app.

## Authentication and authorization

This endpoint supports public or private apps, and requires a valid OAuth access token that acts on behalf of a user (OAuth authorization code flow). For more information, see [Generate an access token](/docs/apps/rest-apis/reference/authentication/generate-access-token).

### Scopes

The access token must have all the following [scopes](/docs/apps/rest-apis/scopes) (permissions):

* `asset:read`

## Header parameters

<Prop.List>
  <Prop name="Authorization" type="string" required>
    Provides credentials to authenticate the request, in the form of a `Bearer` token.

    For example: `Authorization: Bearer {token}`
  </Prop>
</Prop.List>

## Path parameters

<Prop.List>
  <Prop name="jobId" type="string" required>
    The image transformation job ID.
  </Prop>
</Prop.List>

## Example request

Examples for using the `/v1/image-transformations/{jobId}` endpoint:

<Tabs storageKey="example.language" disableContentTransition>
  <Tab name="cURL">
    ```sh
    curl --request GET 'https://api.canva.com/rest/v1/image-transformations/{jobId}' \
    --header 'Authorization: Bearer {token}'
    ```
  </Tab>

  <Tab name="Node.js">
    ```js
    const fetch = require("node-fetch");

    fetch("https://api.canva.com/rest/v1/image-transformations/{jobId}", {
      method: "GET",
      headers: {
        "Authorization": "Bearer {token}",
      },
    })
      .then(async (response) => {
        const data = await response.json();
        console.log(data);
      })
      .catch(err => console.error(err));
    ```
  </Tab>

  <Tab name="Java">
    ```java
    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/image-transformations/{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());
        }
    }
    ```
  </Tab>

  <Tab name="Python">
    ```py
    import requests

    headers = {
        "Authorization": "Bearer {token}"
    }

    response = requests.get("https://api.canva.com/rest/v1/image-transformations/{jobId}",
        headers=headers
    )
    print(response.json())
    ```
  </Tab>

  <Tab name="C#">
    ```csharp
    using System.Net.Http;

    var client = new HttpClient();
    var request = new HttpRequestMessage
    {
      Method = HttpMethod.Get,
      RequestUri = new Uri("https://api.canva.com/rest/v1/image-transformations/{jobId}"),
      Headers =
      {
        { "Authorization", "Bearer {token}" },
      },
    };

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

  <Tab name="Go">
    ```go
    package main

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

    func main() {
    	url := "https://api.canva.com/rest/v1/image-transformations/{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))
    }
    ```
  </Tab>

  <Tab name="PHP">
    ```php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.canva.com/rest/v1/image-transformations/{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;
    }
    ```
  </Tab>

  <Tab name="Ruby">
    ```ruby
    require 'net/http'
    require 'uri'

    url = URI('https://api.canva.com/rest/v1/image-transformations/{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
    ```
  </Tab>
</Tabs>

## Success response

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

<Prop.List>
  <Prop name="job" type="ImageTransformationJob" required mode="output">
    Details about the image transformation job. If the job status is `success`, the job's
    `result` is present.

    <PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
      <Prop.List>
        <Prop name="status" type="string" required mode="output">
          The status of the image transformation job. A newly created job will be `in_progress`
          and will eventually become `success` or `failed`. A job may also complete
          immediately, returning `success` or `failed` from job creation. If the status is
          `success`, the job's `result` is present.

          <Prop.Extras>
            **Available values:**

            * `failed`
            * `in_progress`
            * `success`
          </Prop.Extras>
        </Prop>

        <Prop name="id" type="string" mode="output">
          The image transformation job ID. Only present if the job status is `in_progress`.
          A job that completes immediately returns its `result` or `error` directly and has
          no ID to poll.
        </Prop>

        <Prop name="result" type="ImageTransformationJobResult" mode="output">
          Result of the image transformation job. Only present if the job status is `success`.

          <PillAccordion title={<>Properties of <strong>result</strong></>}>
            <Prop.List>
              <Prop name="asset" type="object" required mode="output">
                The new image asset produced by applying all of the requested transformations.

                <PillAccordion title={<>Properties of <strong>asset</strong></>}>
                  <Prop.List>
                    <Prop name="type" type="string" required mode="output">
                      Type of an asset.

                      <Prop.Extras>
                        **Available values:**

                        * `image`
                        * `video`
                      </Prop.Extras>
                    </Prop>

                    <Prop name="id" type="string" required mode="output">
                      The ID of the asset.
                    </Prop>

                    <Prop name="name" type="string" required mode="output">
                      The name of the asset.
                    </Prop>

                    <Prop name="tags" type="string[]" required mode="output">
                      The user-facing tags attached to the asset.
                      Users can add these tags to their uploaded assets, and they can search their uploaded
                      assets in the Canva UI by searching for these tags. For information on how users use
                      tags, see the
                      [Canva Help Center page on asset tags](https://www.canva.com/help/add-edit-tags/).
                    </Prop>

                    <Prop name="created_at" type="integer" required mode="output">
                      When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix
                      Epoch).
                    </Prop>

                    <Prop name="updated_at" type="integer" required mode="output">
                      When the asset was last updated in Canva, as a Unix timestamp (in seconds since the
                      Unix Epoch).
                    </Prop>

                    <Prop name="owner" type="TeamUserSummary" required mode="output">
                      Metadata for the user, consisting of the User ID and Team ID.

                      <PillAccordion title={<>Properties of <strong>owner</strong></>}>
                        <Prop.List>
                          <Prop name="user_id" type="string" required mode="output">
                            The ID of the user.
                          </Prop>

                          <Prop name="team_id" type="string" required mode="output">
                            The ID of the user's Canva Team.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>

                    <Prop name="thumbnail" type="Thumbnail" mode="output">
                      A thumbnail image representing the object.

                      <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
                        <Prop.List>
                          <Prop name="width" type="integer" required mode="output">
                            The width of the thumbnail image in pixels.
                          </Prop>

                          <Prop name="height" type="integer" required mode="output">
                            The height of the thumbnail image in pixels.
                          </Prop>

                          <Prop name="url" type="string" required mode="output">
                            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.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>

                    <Prop name="metadata" type="AssetMetadata" mode="output">
                      Type-specific metadata for the asset.

                      <Tabs>
                        <Tab name="image">
                          <Prop.List>
                            <Prop name="type" type="string" required mode="output">
                              <Prop.Extras>
                                **Available values:** The only valid value is `image`.
                              </Prop.Extras>
                            </Prop>

                            <Prop name="width" type="integer" mode="output">
                              The width of the image in pixels.
                            </Prop>

                            <Prop name="height" type="integer" mode="output">
                              The height of the image in pixels.
                            </Prop>

                            <Prop name="smart_tags" type="string[]" mode="output">
                              AI-generated tags for the image.
                            </Prop>
                          </Prop.List>
                        </Tab>

                        <Tab name="video">
                          <Prop.List>
                            <Prop name="type" type="string" required mode="output">
                              <Prop.Extras>
                                **Available values:** The only valid value is `video`.
                              </Prop.Extras>
                            </Prop>

                            <Prop name="width" type="integer" required mode="output">
                              The width of the video in pixels.
                            </Prop>

                            <Prop name="height" type="integer" required mode="output">
                              The height of the video in pixels.
                            </Prop>

                            <Prop name="duration" type="integer" mode="output">
                              The duration of the video in seconds.
                            </Prop>
                          </Prop.List>
                        </Tab>
                      </Tabs>
                    </Prop>

                    <Prop name="import_status" type="ImportStatus" deprecated mode="output">
                      The import status of the asset.

                      <PillAccordion title={<>Properties of <strong>import_status</strong></>}>
                        <Prop.List>
                          <Prop name="state" type="string" required deprecated mode="output">
                            State of the import job for an uploaded asset.

                            <Prop.Extras>
                              **Available values:**

                              * `failed`
                              * `in_progress`
                              * `success`
                            </Prop.Extras>
                          </Prop>

                          <Prop name="error" type="ImportError" deprecated mode="output">
                            If the import fails, this object provides details about the error.

                            <PillAccordion title={<>Properties of <strong>error</strong></>}>
                              <Prop.List>
                                <Prop name="message" type="string" required deprecated mode="output">
                                  A human-readable description of what went wrong.
                                </Prop>

                                <Prop name="code" type="string" required deprecated mode="output">
                                  A short string indicating why the upload failed. This field can be used to handle errors programmatically.

                                  <Prop.Extras>
                                    **Available values:**

                                    * `file_too_big`
                                    * `import_failed`
                                  </Prop.Extras>
                                </Prop>
                              </Prop.List>
                            </PillAccordion>
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>

        <Prop name="error" type="ImageTransformationError" mode="output">
          If the image transformation job fails, this object provides details about the error.
          Only present if the job status is `failed`.

          <PillAccordion title={<>Properties of <strong>error</strong></>}>
            <Prop.List>
              <Prop name="code" type="string" required mode="output">
                Error code indicating what went wrong with the image transformation.

                <Prop.Extras>
                  **Available values:**

                  * `no_foreground_found`: No foreground subject was found in the image, so there is no background to remove.
                  * `quota_exceeded`: The user has run out of quota, such as their AI credit quota. The quota isn't necessarily specific to the requested transformations.
                  * `internal_error`: An unexpected error occurred during the transformation.
                </Prop.Extras>
              </Prop>

              <Prop name="message" type="string" required mode="output">
                A human-readable description of what went wrong.
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>
</Prop.List>

## Example responses

### In progress job

```json
{
  "job": {
    "id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
    "status": "in_progress"
  }
}
```

### Successfully completed job

```json
{
  "job": {
    "status": "success",
    "result": {
      "asset": {
        "id": "Msd59349ff",
        "type": "image",
        "name": "My Awesome Upload with the background removed",
        "tags": [
          "image",
          "holiday",
          "best day ever"
        ],
        "owner": {
          "user_id": "oU123456AbCdE",
          "team_id": "oB123456AbCdE"
        },
        "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

```json
{
  "job": {
    "status": "failed",
    "error": {
      "code": "no_foreground_found",
      "message": "No foreground subject was found in the image, so there is no background to remove."
    }
  }
}
```

## Error responses

### 401 Unauthorized

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error responses

##### The OAuth client credentials are invalid

```json
{
  "code": "invalid_client",
  "message": "Client {clientId} not available"
}
```

##### Access token could not be decoded or signature could not be verified.

```json
{
  "code": "invalid_access_token",
  "message": "Access token is invalid"
}
```

##### Client credentials or body auth are missing from the request

```json
{
  "code": "invalid_client",
  "message": "Client credentials or body auth are missing from the request."
}
```

##### Authorization header has wrong number of components

```json
{
  "code": "invalid_access_token",
  "message": "Malformed Authorization header: wrong number of components"
}
```

##### Authorization header has invalid mode

```json
{
  "code": "invalid_access_token",
  "message": "Malformed Authorization header: invalid mode"
}
```

##### Token couldn't be introspected

```json
{
  "code": "invalid_access_token",
  "message": "Token couldn't be introspected"
}
```

##### Access token is revoked

```json
{
  "code": "revoked_access_token",
  "message": "Access token is revoked"
}
```

##### Missing Authorization header

```json
{
  "code": "invalid_access_token",
  "message": "Missing Authorization header"
}
```

##### Malformed Authorization header

```json
{
  "code": "invalid_access_token",
  "message": "Malformed Authorization header"
}
```

### 404 Not Found

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

##### The image transformation job was not found

```json
{
  "code": "not_found",
  "message": "Image transformation job not found: {jobId}"
}
```

### 429 Too Many Requests

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error responses

##### Rate limit exceeded

```json
{
  "code": "too_many_requests",
  "message": "Too many requests to {operation}"
}
```

##### Throttled because too many requests

```json
{
  "code": "too_many_requests",
  "message": "Throttled because too many requests"
}
```