Topaz Upscale Image Generative API Reference

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/generative.

Default: topaz/upscale/image/generative

stringpromptrequired

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

stringimagerequired

Url of the image to be upscaled

Optional<string>output_format

Output format of the upscaled image.

Allowed values: jpeg, png

Default: jpeg

Optional<number>detail

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

Range: 0 to 1

Optional<string>subject_detection

Subject detection mode for the image enhancement. Applies to Wonder 3, Recovery and Recovery V2 models.

Allowed values: All, Foreground, Background

Default: All

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<boolean>autoprompt

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

Optional<boolean>face_enhancement

Whether to apply face enhancement to the image.

Default: true

Optional<number>sharpen

Sharpening level (0.0-1.0). Applies to Redefine model only.

Range: 0 to 1

Optional<boolean>crop_to_fill

Request parameter supported by this model.

Default: false

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<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<string>enhancement_strength

Enhancement strength for generative upscaling. Applies to Wonder 3 and Wonder 3.5 models. When omitted, Topaz auto-configures it.

Allowed values: low, medium, high

Optional<number>denoise

Denoising level (0.0-1.0). Applies to Redefine model only.

Range: 0 to 1

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<integer>texture

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

Range: 1 to 5

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

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

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

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

# 1. Submit a generation request curl -X POST https://api.sandbase.ai/v1/run \ -H "Authorization: Bearer $SANDBASE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "topaz/upscale/image/generative", "prompt": "A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting", "image": "https://static.sandbase.ai/examples/topaz/upscale/image/generative/input_image_0.jpeg", "output_format": "jpeg" }' # 2. If the response is still running, poll the returned id curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \ -H "Authorization: Bearer $SANDBASE_API_KEY"