Appearance

Topaz Upscale

POST/v1/run

Upscale Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to topaz/upscale/image.

Default: topaz/upscale/image

stringpromptrequired

Text prompt to guide generative upscaling (max 1024 chars). Applies to Redefine model only.

stringimagerequired

Url of the image to be upscaled

Optional<number>strength

Enhancement strength (0.01-1.0). Applies to Text Refine model only.

Range: 0.01 to 1

Optional<string>output_format

Output format of the upscaled image.

Allowed values: jpeg, png

Default: jpeg

Optional<number>face_enhancement_creativity

Creativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled.

Range: 0 to 1

Default: 0

Optional<string>enhancement_model

Model to use for image enhancement.

Allowed values: Low Resolution V2, Standard V2, CGI, High Fidelity V2, Text Refine, Recovery, Redefine, Recovery V2, Standard MAX, Wonder

Default: Standard V2

Optional<string>subject_detection

Subject detection mode for the image enhancement. Applies to standard enhance and Recovery V2 models.

Allowed values: All, Foreground, Background

Default: All

Optional<boolean>crop_to_fill

Request parameter supported by this model.

Default: false

Optional<number>fix_compression

Compression artifact removal level (0.0-1.0). Applies to Standard V2, Low Resolution V2, High Fidelity V2, and Text Refine models.

Range: 0 to 1

Optional<number>face_enhancement_strength

Strength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled.

Range: 0 to 1

Default: 0.8

Optional<number>detail

Detail recovery level (0.0-1.0). Applies to Recovery V2 model only.

Range: 0 to 1

Optional<integer>creativity

Creativity level for generative upscaling (1-6). Higher values produce more creative/hallucinated details. Applies to Redefine model only.

Range: 1 to 6

Optional<boolean>autoprompt

Enable automatic prompt generation for generative upscaling. Applies to Redefine model only.

Optional<number>sharpen

Sharpening level (0.0-1.0). Applies to Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, and Redefine models.

Range: 0 to 1

Optional<number>upscale_factor

Factor to upscale the image by (e.g. 2.0 doubles width and height)

Range: 1 to 4

Default: 2

Optional<integer>texture

Texture detail level for generative upscaling (1-5). Applies to Redefine model only.

Range: 1 to 5

Optional<number>denoise

Denoising level (0.0-1.0). Applies to Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, and Redefine models.

Range: 0 to 1

Optional<boolean>face_enhancement

Whether to apply face enhancement to the image. Applies to standard enhance and Recovery V2 models.

Default: true

Response Schema

The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.

Optional<string>error

Error message if the task failed. Empty on success.

stringidrequired

Unique identifier for the generation task.

Optional<string>model

Model ID used for the prediction.

Optional<array>outputs

Array of generated content. Empty when status is not completed.

stringstatusrequired

Status of the task: pending, running, completed, failed, or timeout.

Allowed values: pending, running, completed, failed, timeout

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async