---
title: "Get Image Processing History"
method: POST
path: "/get-upscayl-history"
tags: ["History"]
---

# Get Image Processing History

`POST /get-upscayl-history`

Retrieves paginated history of image processing tasks.
Results can be filtered by status and time range.

## Request body

- object
  - `timestampOffset` integer — Unix timestamp (ms) to start fetching records from
  - `batch` boolean — Filter by batch processing status
  - `failed` boolean — Filter by failed status
  - `limit` integer — Number of records to return per page
  - `processed` 'pending' | 'processing' | 'completed' | 'failed' — Filter by processing status

## Response `200`

Successfully retrieved history

- object
  - `status` 'success', required
  - `pagination` object, required
    - `total` integer — Total number of records
    - `hasMore` boolean — Whether more records exist
    - `nextOffset` integer — Timestamp offset for next page
  - `data` ProcessingTask[], required
    - `batchMode` boolean — Whether task was processed in batch mode
    - `enhanceFace` boolean — Whether face enhancement was applied
    - `error` string — Error message if processing failed
    - `files` ProcessedFile[]
      - `fileName` string
      - `fileType` string
      - `path` string
      - `createdAt` integer
      - `expiresAt` integer
      - `originalFileName` string
      - `fileSize` integer
      - `downloadLink` string, uri
      - `thumbnailLink` string, uri
      - `finalFileSize` integer
      - `processedFileName` string
      - `dimensions` object
        - `width` integer
        - `height` integer
    - `model` 'upscayl-standard-4x' | 'upscayl-lite-4x' | 'clear-boost-4x' | 'crystal-plus-4x' | 'digital-art-4x' | 'digital-art-plus-4x' | 'natural-max-4x' | 'natural-plus-4x' | 'nature-boost-4x' | 'pure-boost-4x' | 'quick-clear-4x' | 'texture-boost-4x' — AI model used for processing
    - `progress` string — Processing progress percentage
    - `scale` string — Upscale factor applied
    - `status` 'pending' | 'processing' | 'completed' | 'failed'
    - `saveImageAs` 'png' | 'jpg' | 'webp'
    - `creditsDeducted` boolean

## Other responses

- `400` — Invalid request parameters
- `401` — Authentication failed or API key missing
- `404` — Requested resource not found
- `429` — Rate limit exceeded
- `500` — Internal server error occurred

## Changes

- **2025-02-01** `3a2f19f6a906` — 13 warning
  - removed the optional property `data/items/compression` from the response with the `200` status
  - added the new `clear-boost-4x` enum value to the `data/items/model` response property for the response status `200`
  - added the new `crystal-plus-4x` enum value to the `data/items/model` response property for the response status `200`
  - added the new `digital-art-4x` enum value to the `data/items/model` response property for the response status `200`
  - …9 more
- **2025-01-14** `5c6242cc0763` — 7 breaking, 7 warning, 15 info
  - request body became required
  - request property `processed` was restricted to a list of enum values
  - the `limit` request property type changed from `number` to `integer`
  - the `timestampOffset` request property type changed from `number` to `integer`, and format from no format to `int64`
  - …25 more
- **2024-11-10** `ce3636863d93` — 4 warning
  - removed the optional property `data/items/createdAt` from the response with the `200` status
  - removed the optional property `data/items/endedAt` from the response with the `200` status
  - removed the optional property `data/items/id` from the response with the `200` status
  - removed the optional property `data/items/userId` from the response with the `200` status
- **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-upscayl-history/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/2320ccb2ffed/schema)