Skip to main content
POST
Topaz Wonder 3.5
These aliases are accepted for compatibility only and are not shown in the request schema.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Webhook-URL
string<uri>

URL to receive a POST request when the job completes. The webhook will receive the job data including results.

Body

application/json
width
number
required
Required range: 1 <= x <= 16000
height
number
required
Required range: 1 <= x <= 16000
image_url
string<uri>
required

Can be an external URL, base64 data URI, or uploaded asset URL.

Maximum string length: 1024
seed
number
default:1337
output_format
enum<string>
default:jpg
Available options:
png,
jpg,
webp
crop_to_fill
boolean
default:false
enhancement_strength
enum<string>
default:high
Available options:
low,
medium,
high
grain
boolean
default:false
grain_model
enum<string>
default:silver
Available options:
silver,
gaussian,
grey
grain_density
number
default:0.5
Required range: 0 <= x <= 1
grain_strength
number
default:0.5
Required range: 0 <= x <= 1
grain_size
number
default:1
Required range: 1 <= x <= 5
upscaling_activated
boolean
default:false
image_scaling_factor
number
default:1
Required range: 1 <= x <= 32

Response

The resulting job data. This will be returned in a pending state until the job is completed. See /jobs/{id} for retrieving the results.

job_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
backlogged,
queued,
scheduled,
processing,
sampling,
intermediate-complete,
completed,
failed,
cancelled
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completed_at
null
required
result
null
required
error
object