History

Get Image Processing History

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

post/get-upscayl-history

Request body

timestampOffsetinteger

Unix timestamp (ms) to start fetching records from

batchboolean

Filter by batch processing status

failedboolean

Filter by failed status

limitinteger

Number of records to return per page

processed'pending' | 'processing' | 'completed' | 'failed'

Filter by processing status

Example request

{
  "timestampOffset": 1633024800000,
  "batch": true,
  "limit": 10,
  "processed": "processing"
}

Response

Successfully retrieved history

status'success' required

Changes

Changed in 5 of the 9 revisions of this API.82416

    • removed the optional property data/items/compression from the response with the 200 status

      response-optional-property-removed

    • added the new clear-boost-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new crystal-plus-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new digital-art-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new digital-art-plus-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new natural-max-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new natural-plus-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new nature-boost-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new pure-boost-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new quick-clear-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new texture-boost-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new upscayl-lite-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

    • added the new upscayl-standard-4x enum value to the data/items/model response property for the response status 200

      response-property-enum-value-added

  • 5c6242cc07637715See the full diff
    • request body became required

      request-body-became-required

    • request property processed was restricted to a list of enum values

      request-property-became-enum

    • the limit request property type/format changed from number/ to integer/

      request-property-type-changed

    • the timestampOffset request property type/format changed from number/ to integer/int64

      request-property-type-changed

    • removed the media type text/plain for the response with the status 400

      response-media-type-removed

    • removed the media type text/plain for the response with the status 500

      response-media-type-removed

    • removed the success response with the status 204

      response-success-status-removed

    • the limit request property's max was set to 100.00

      request-property-max-set

    • the limit request property's min was set to 1.00

      request-property-min-set

    • added the new completed enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new failed enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new pending enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new processing enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new success enum value to the status response property for the response status 200

      response-property-enum-value-added

    • the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • api tag History added

      api-tag-added

    • the limit request property default value 20 was added

      request-property-default-value-added

    • added the new completed enum value to the request property processed

      request-property-enum-value-added

    • added the new failed enum value to the request property processed

      request-property-enum-value-added

    • added the new pending enum value to the request property processed

      request-property-enum-value-added

    • added the new processing enum value to the request property processed

      request-property-enum-value-added

    • added the media type application/json for the response with the status 400

      response-media-type-added

    • added the media type application/json for the response with the status 500

      response-media-type-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 429

      response-non-success-status-added

    • the response property data became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • added the required property pagination to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property data/items/createdAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/endedAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/userId from the response with the 200 status

      response-optional-property-removed

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog