---
title: "Get Task Status"
method: POST
path: "/get-task-status"
---

# Get Task Status

`POST /get-task-status`

## Request body

- object
  - `data` object
    - `taskId` string — The task ID

## Response `200`

Successful operation

- object
  - `status` string
  - `data` object
    - `batchMode` boolean — Indicates if batch mode is enabled
    - `enhanceFace` boolean — Indicates if face enhancement is enabled
    - `error` string — Error message if any
    - `files` object[]
      - `fileName` string
      - `fileType` string
      - `path` string
      - `createdAt` number
      - `expiresAt` number
      - `originalFileName` string
      - `fileSize` number
      - `downloadLink` string
      - `thumbnailLink` string
      - `finalFileSize` number
      - `processedFileName` string
      - `dimensions` object
        - `width` number
        - `height` number
    - `model` string — The model used for the task
    - `progress` string — The progress of the task
    - `scale` string — The scale of the task
    - `status` string — The status of the task
    - `saveImageAs` 'png' | 'jpg' | 'webp' — The format to save the image as
    - `compression` number — The compression level
    - `creditsDeducted` boolean — Indicates if credits were deducted
    - `deductedCredits` number — The number of credits deducted

## Other responses

- `400` — Bad request
- `404` — Not found
- `500` — Internal server error

## Changes

- **2024-11-10** `ce3636863d93` — 4 warning, 1 info
  - removed the optional property `data/createdAt` from the response with the `200` status
  - removed the optional property `data/endedAt` from the response with the `200` status
  - removed the optional property `data/id` from the response with the `200` status
  - removed the optional property `data/userId` from the response with the `200` status
  - …1 more
- **2024-10-22** `77e0fca87b92` — 1 info
  - endpoint added
- **2024-10-22** `fa796ac65c29` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/upscayl/apis/upscayl-cloud-api/changes/get-task-status/post.md)

---

[API](https://skmtc.dev/upscayl/apis/upscayl-cloud-api.md) · [All operations](https://skmtc.dev/upscayl/apis/upscayl-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/upscayl/upscayl-cloud-api/revisions/ce3636863d93/schema)