Skip to main content
POST
Upscale an image with Clarity Upscaler

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Body

application/json
image
string
required

Image to upscale. A public image URL, a data URI, raw base64, or an uploaded-file URL from POST /v1/uploads.

creativity
number
default:0.35

How much new detail the model may invent (0.3-0.9 recommended).

dynamic
number
default:6

HDR effect strength (3-9 for best results).

prompt
string

Optional guiding prompt describing the image content — helps the model invent plausible detail.

resemblance
number
default:0.6

How closely the result must match the input (0-3).

scale_factor
number
default:2

Upscale factor (2 or 4).

seed
integer

Seed for reproducible results. Omit for random.

Response

Job accepted.

credits
integer

Total price of this job (flat per image

id
string

Opaque job id — use it to poll status.

message
string
model
string
status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

Available options:
pending,
starting,
processing,
completing,
succeeded,
failed,
timeout