---
title: "Get Batch Download Status"
method: GET
path: "/boards/tasks/batch-download"
tags: ["Board Tasks"]
---

# Get Batch Download Status

`GET /boards/tasks/batch-download`

Query the status of a batch download task. Use this to poll for download progress and retrieve the download URL when ready.

## Query parameters

- `boardId` string, required
- `downloadTaskId` string, required

## Headers

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

## Response `200`

Download status retrieved successfully

- object
  - `code` string
  - `message` string
  - `result` object
    - `downloadTaskId` string — Download task ID
    - `status` 'init' | 'running' | 'success' | 'fail' — Task status. init=queued, running=processing, success=ready for download, fail=failed
    - `progress` integer — Progress percentage (0-100)
    - `processedCount` integer — Number of files already processed
    - `totalCount` integer — Total number of files to process
    - `downloadUrl` string, nullable — CloudFront signed download URL (only when status=success). This is a temporary URL with expiration.
    - `fileCount` integer, nullable — Number of files successfully included in the ZIP (only when status=success)
    - `totalSize` integer, nullable — Total ZIP file size in bytes (only when status=success)
    - `expiresAt` string, date-time, nullable — Download URL expiration time (only when status=success). Download link will not be available after this time.
    - `gmtCreate` string, date-time, nullable — Task creation time
    - `completedAt` string, date-time, nullable — Task completion time (only when status=success or fail)
    - `errorCode` string, nullable — Error code (only when status=fail). Examples: FILE_NOT_FOUND, PERMISSION_DENIED, STORAGE_ERROR, etc.
    - `errorMessage` string, nullable — Error message (only when status=fail). Human-readable error description.

---

[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/revisions/83cd46ca7859/schema)