API reference · Topaz Labs

topaz/upscale/image/generative

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

IMAGEAsyncOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDtopaz/upscale/image/generative
01

Input Schema

17 parameters · 2 required · 15 optional

ParameterTypeRequiredDescription
imagestringRequiredUrl of the image to be upscaled · Min length: 1
promptstringRequiredText prompt to guide generative upscaling (max 1024 chars). Applies to Redefine model only. · Max length: 1024
modelstringOptionalGenerative upscaling model. Wonder 3.5 is the latest Wonder with finer detail and fewer repetitive patterns; Wonder 3 is Topaz's most advanced generative realism model (Wonder 2/Wonder are earlier generations); Recover 3 rebuilds natural detail; Standard MAX is high-quality precision-leaning upscaling; Redefine adds prompt-guided creative detail; Recovery and Recovery V2 rebuild extreme low-resolution images. · Options: Wonder 3.5, Wonder 3, Wonder 2, Wonder, Recover 3, Standard MAX, Redefine, Recovery V2, Recovery · Default: "Wonder 3"
Wonder 3.5Wonder 3Wonder 2WonderRecover 3Standard MAXRedefineRecovery V2Recovery
detailnumberOptionalDetail recovery level (0.0-1.0). Applies to Recovery V2 model only. · Min: 0 · Max: 1
denoisenumberOptionalDenoising level (0.0-1.0). Applies to Redefine model only. · Min: 0 · Max: 1
sharpennumberOptionalSharpening level (0.0-1.0). Applies to Redefine model only. · Min: 0 · Max: 1
textureintegerOptionalTexture detail level for generative upscaling (1-5). Applies to Redefine model only. · Min: 1 · Max: 5
autopromptbooleanOptionalEnable automatic prompt generation for generative upscaling. Applies to Redefine model only.
creativityintegerOptionalCreativity level for generative upscaling (1-6). Higher values produce more creative/hallucinated details. Applies to Redefine model only. · Min: 1 · Max: 6
crop_to_fillbooleanOptionalDefault: false
output_formatstringOptionalOutput format of the upscaled image. · Options: jpeg, png · Default: "jpeg"
jpegpng
upscale_factornumberOptionalFactor to upscale the image by (e.g. 2.0 doubles width and height) · Min: 1 · Max: 4 · Default: 2
face_enhancementbooleanOptionalWhether to apply face enhancement to the image. · Default: true
subject_detectionstringOptionalSubject detection mode for the image enhancement. Applies to Wonder 3, Recovery and Recovery V2 models. · Options: All, Foreground, Background · Default: "All"
AllForegroundBackground
enhancement_strengthstringOptionalEnhancement strength for generative upscaling. Applies to Wonder 3 and Wonder 3.5 models. When omitted, Topaz auto-configures it. · Options: low, medium, high
lowmediumhigh
face_enhancement_strengthnumberOptionalStrength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled. · Min: 0 · Max: 1 · Default: 0.8
face_enhancement_creativitynumberOptionalCreativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled. · Min: 0 · Max: 1 · Default: 0
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

  1. Submit — POST to /v1/run, receive an id
  2. Poll — GET /v1/run/{id} until status is completed, failed, or timeout
  3. Retrieve — Read outputs from the completed response
03

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "Wonder 3",
  "image": "https://static.sandbase.ai/examples/topaz/upscale/image/generative/input_image_0.jpeg",
  "crop_to_fill": false,
  "output_format": "jpeg",
  "upscale_factor": 2,
  "face_enhancement": true,
  "subject_detection": "All",
  "face_enhancement_strength": 0.8,
  "face_enhancement_creativity": 0,
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"