> ## 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 design generation 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 integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.
</Warning>

Gets the status and result of a design generation job created using the [Create design generation job API](https://www.canva.dev/docs/apps/rest-apis/reference/generations/create-design-generation-job/).

You might need to make multiple requests until the job has 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).

Only the user and integration that created the job can retrieve it, and the user must be in the same team. Jobs expire 24 hours after creation.

Polling doesn't consume the user's [AI credit allowance](https://www.canva.com/help/ai-access/). Reaching the AI allowance limit after job creation doesn't prevent retrieving the result.

Requires the `design_generation` capability.

## HTTP method and URL path

GET https\://api.canva.com/rest/v1/generations/\{jobId}

### Rate limit

This operation's rate limit depends on your app type:

<table layout="fixed">
  <thead>
    <tr>
      <th width="55%">App type</th>
      <th width="45%">Rate limit</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>**Public or private apps** (acts on behalf of a user using the OAuth authorization code flow)</td>
      <td>120 requests per minute for each user of your app</td>
    </tr>

    <tr>
      <td>**Service apps** (acts on behalf of your app itself using the OAuth client credentials flow)</td>
      <td>100 requests per minute for your app</td>
    </tr>
  </tbody>
</table>

## Authentication and authorization

This endpoint requires a valid OAuth access token. For more information, see [Generate an access token](/docs/apps/rest-apis/reference/authentication/generate-access-token).

### Scopes

The access token must have the following [scopes](/docs/apps/rest-apis/scopes) (permissions), depending on your app type:

<table layout="fixed">
  <thead>
    <tr>
      <th width="55%">App type</th>
      <th width="45%">Required scopes</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>**Public or private apps** (acts on behalf of a user using the OAuth authorization code flow)</td>

      <td>
        * `design:content:write`
      </td>
    </tr>

    <tr>
      <td>**Service apps** (acts on behalf of your app itself using the OAuth client credentials flow)</td>

      <td>
        * `service:design:content:write`
      </td>
    </tr>
  </tbody>
</table>

### Capabilities

Capabilities only apply to public or private apps, which act on behalf of a user. The user must have at least one of the following [capabilities](/docs/apps/rest-apis/capabilities/):

* `design_generation`

## 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 public design generation job ID.
  </Prop>
</Prop.List>

## Example request

Examples for using the `/v1/generations/{jobId}` endpoint:

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

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

    fetch("https://api.canva.com/rest/v1/generations/{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/generations/{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/generations/{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/generations/{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/generations/{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/generations/{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/generations/{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="DesignGenerationJobV2" required mode="output">
    The status and result of a public design generation job.

    <PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
      <Prop.List>
        <Prop name="id" type="string" required mode="output">
          The public design generation job ID.
        </Prop>

        <Prop name="status" type="string" required mode="output">
          The public status of the job. `result` is present only for `success`, and
          `error` is present only for `failed`.

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

            * `failed`: The design couldn't be generated.
            * `in_progress`: The design is still being generated.
            * `success`: The design was generated and saved to the user's Canva account.
          </Prop.Extras>
        </Prop>

        <Prop name="result" type="DesignGenerationJobResultV2" mode="output">
          Present only when the job status is `success`.

          <PillAccordion title={<>Properties of <strong>result</strong></>}>
            <Prop.List>
              <Prop name="design" type="DesignSummary" required mode="output">
                Basic details about the design, such as the design's ID, title, and URL.

                <PillAccordion title={<>Properties of <strong>design</strong></>}>
                  <Prop.List>
                    <Prop name="id" type="string" required mode="output">
                      The design ID.
                    </Prop>

                    <Prop name="urls" type="DesignLinks" required mode="output">
                      A temporary set of URLs for viewing or editing the design.

                      <PillAccordion title={<>Properties of <strong>urls</strong></>}>
                        <Prop.List>
                          <Prop name="edit_url" type="string" required mode="output">
                            A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.

                            NOTE: This is not a permanent URL, it is only valid for 30 days.
                          </Prop>

                          <Prop name="view_url" type="string" required mode="output">
                            A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.

                            NOTE: This is not a permanent URL, it is only valid for 30 days.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>

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

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

                    <Prop name="title" type="string" mode="output">
                      The design title.
                    </Prop>

                    <Prop name="url" type="string" mode="output">
                      URL of the design.
                    </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="page_count" type="integer" mode="output">
                      The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>

        <Prop name="error" type="DesignGenerationJobErrorV2" mode="output">
          Details about a failed design generation job.

          <PillAccordion title={<>Properties of <strong>error</strong></>}>
            <Prop.List>
              <Prop name="code" type="string" required mode="output">
                The reason the design generation job failed.

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

                  * `content_not_allowed`: The brief or generated content didn't pass Canva's content-safety checks.
                  * `generation_failed`: Canva couldn't complete the design generation job.
                </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 design generation job

```json
{
  "job": {
    "id": "f81b26fd-a33d-4c2d-9e8c-4a7aca798b17",
    "status": "in_progress"
  }
}
```

### Successfully completed design generation job

```json
{
  "job": {
    "id": "f81b26fd-a33d-4c2d-9e8c-4a7aca798b17",
    "status": "success",
    "result": {
      "design": {
        "id": "DAFVztcvd9z",
        "title": "SolarNow Seed Pitch",
        "urls": {
          "edit_url": "https://www.canva.com/api/design/example/edit",
          "view_url": "https://www.canva.com/api/design/example/view"
        },
        "thumbnail": {
          "width": 800,
          "height": 450,
          "url": "https://document-export.canva.com/example/thumbnail/0001.png?signature=example"
        },
        "created_at": 1788768000,
        "updated_at": 1788768000,
        "page_count": 3
      }
    }
  }
}
```

### Design generation rejected by content-safety checks

```json
{
  "job": {
    "id": "f81b26fd-a33d-4c2d-9e8c-4a7aca798b17",
    "status": "failed",
    "error": {
      "code": "content_not_allowed",
      "message": "The design couldn't be generated because the request didn't meet Canva's content guidelines."
    }
  }
}
```

### Design generation failed

```json
{
  "job": {
    "id": "f81b26fd-a33d-4c2d-9e8c-4a7aca798b17",
    "status": "failed",
    "error": {
      "code": "generation_failed",
      "message": "The design couldn't be generated. Please try again."
    }
  }
}
```

## Error responses

### 400 Bad Request

<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 job ID is invalid

```json
{
  "code": "invalid_field",
  "message": "The design generation job ID is invalid."
}
```

### 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"
}
```

### 403 Forbidden

<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

##### Design generation isn't available to the user

```json
{
  "code": "permission_denied",
  "message": "Design generation isn't available for this user."
}
```

##### The caller didn't create this job

```json
{
  "code": "permission_denied",
  "message": "The user doesn't have access to this design generation job."
}
```

### 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 job wasn't found

```json
{
  "code": "not_found",
  "message": "The design generation job wasn't found."
}
```

### 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"
}
```