---
title: "Query Task"
method: GET
path: "/v1/common_task/storyboard/task/query"
---

# Query Task

`GET /v1/common_task/storyboard/task/query`

Query the status and output of a Storyboard image generation task by taskId. `images` is empty or in progress while the task is unfinished; on success, returns the generated storyboard grid image fileId and access URL.

**Status**: Unfinished tasks return `running`; finished tasks return `success` or `fail`.

**Credits**: `costCredit` is the actual credit consumed; updated after task success.

## Query parameters

- `taskId` string, required
- `needCloudFrontUrl` boolean

## Headers

- `Topview-Uid` string, required
- `Authorization` string, required

## Response `200`

Query successful

- object
  - `code` string — Business status code; 200 on success
  - `message` string — Status message
  - `result` object — Task query result (AiImageTaskResponse)
    - `taskId` string — Task ID
    - `status` 'init' | 'running' | 'success' | 'fail' — Task status: init (submitted, not started); running (in progress); success; fail
    - `errorMsg` string — Failure reason (returned when status=fail; omitted otherwise)
    - `costCredit` number, float — Actual credits consumed by this task; default 0.00; updated after task success
    - `boardId` string — Associated Board ID (returned when the task originates from a Board)
    - `images` object[] — Generated storyboard grid images (returned on task success; Storyboard tasks typically return 1 grid preview image)
      - `status` 'init' | 'running' | 'success' | 'fail' — Sub-task status: init / running / success / fail
      - `fileId` string — Output image fileId; reusable in subsequent APIs
      - `filePath` string — Output image access URL. When needCloudFrontUrl=true, CloudFront URL is preferred
      - `width` integer — Image width in pixels
      - `height` integer — Image height in pixels
      - `errorMsg` string — Sub-task error message (returned when status=fail)
      - `boardTaskId` string — Associated Board Task ID (returned when the task originates from a Board)

---

[API](https://skmtc.net/topview/apis/image-character-swap-apis-editable-in-readme.md) · [All operations](https://skmtc.net/topview/apis/image-character-swap-apis-editable-in-readme/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/topview/image-character-swap-apis-editable-in-readme/versions/83cd46ca7859/schema)