Get a job

Retrieve status, progress, and result URL for a single job.

get/jobs/{id}

Path parameters

idstring uuid required

Job ID returned by POST /v1/jobs.

Response

Job details.

idstring uuid required
status'pending' | 'uploading' | 'processing' | 'downloading' | 'completed' | 'failed' | 'canceled' required
model'flare' | 'prism' | 'lumen' | 'mirage' | 'motion' | 'motion-x' required

What to upscale with.

  • flare: everyday photos, fastest and cheapest, up to 4x.
  • prism: text, logos and product shots. Adds no detail that was not in the original. Up to 4x.
  • lumen: maximum real detail recovery, for print. Up to 8x.
  • mirage: invents plausible new detail. Most dramatic, least faithful. Up to 8x.
  • motion: standard video upscale, up to 4x.
  • motion-x: cinema-grade video, slower and dearer, up to 4x.
scaleinteger required
original_filenamestring nullable required
result_urlstring uri nullable required

Presigned URL to the upscaled file. Valid for 1 hour.

errorstring nullable required

Why the job failed. Null unless status is 'failed'.

frames_totalinteger nullable required

Video only. Frames the job has to process.

frames_doneinteger nullable required

Video only. Frames processed so far.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "model": "flare",
  "scale": 4,
  "original_filename": "photo.jpg",
  "result_url": "https://cdn.upres.ai/results/abc123.png"
}

Changes

Changed in 1 of the 2 revisions of this API.197

  • a1a5f505549c197See the full diff
    • the response property original_filename became nullable for the status 200

      response-property-became-nullable

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the new motion-x enum value to the model response property for the response status 200

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the optional property issues to the response with the 401 status

      response-optional-property-added

    • added the optional property issues to the response with the 404 status

      response-optional-property-added

    • the response property error became required for the status 200

      response-property-became-required

    • the response property original_filename became required for the status 200

      response-property-became-required

    • the response property result_url became required for the status 200

      response-property-became-required

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

      response-required-property-added

    • added the required property frames_total 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