---
title: "Mockup generation task result"
method: GET
path: "/mockup-generator/task"
tags: ["Mockup Generator API"]
---

# Mockup generation task result

`GET /mockup-generator/task`

Returns asynchronous mockup generation task result. If generation task is completed, it will contain a list of generated mockups.

## Query parameters

- `task_key` string, required

## Headers

- `X-PF-Store-Id` string

## Response `200`

OK

- object
  - `code` integer — Response status code `200`
  - `result` GenerationTask — GenerationTask
    - `task_key` string — Task identifier you will use to retrieve generated mockups.
    - `status` 'pending' | 'completed' | 'failed' — Status of the generation task.
    - `error` string — If task has failed, reason will be provided here.
    - `mockups` GenerationTaskMockup[] — If task is completed, list of mockups will be provided here.
      - `placement` string — Placement identifier.
      - `display_name` string — This is a name that can be displayed to end customers.
      - `variant_ids` integer[] — List of variant ids this mockup is used for. One mockup can be used for multiple variants.
      - `extra` GenerationTaskExtraMockup[] — Optional extra mockups.
        - `title` string — Display name of the extra mockup.
        - `url` string — Temporary URL of the mockup.
        - `option` string — Style option name
        - `option_group` string — Style option group name
    - `printfiles` GenerationTaskTemplateFile[] — If task is completed, list of printfiles will be provided here.
      - `variant_ids` integer[] — List of variant IDs associated with printfiles.
      - `placement` string — Placement identifier (front, back, etc.).
      - `url` string — Public URL where your file is stored.

## Other responses

- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.net/printful/apis/api-documentation-printful.md) · [All operations](https://skmtc.net/printful/apis/api-documentation-printful/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/printful/api-documentation-printful/revisions/18e2f2e178dd/schema)