Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
presetA
enum<string>

Preset

Available options:
custom,
iphone-15-pro,
iphone-se,
ipad-pro-129,
mbp-14,
mbp-16,
imac-24,
monitor-27-4k,
monitor-24-1080,
monitor-27-1440,
ultrawide-34,
tv-55-4k,
tv-65-4k
widthA
number

Width

Required range: x >= 1
heightA
number

Height

Required range: x >= 1
diagonalA
number

Diagonal

Required range: x >= 0.1
diagonalUnitA
enum<string>

Diagonal Unit

Available options:
in,
cm
presetB
enum<string>

Preset

Available options:
custom,
iphone-15-pro,
iphone-se,
ipad-pro-129,
mbp-14,
mbp-16,
imac-24,
monitor-27-4k,
monitor-24-1080,
monitor-27-1440,
ultrawide-34,
tv-55-4k,
tv-65-4k
widthB
number

Width

Required range: x >= 1
heightB
number

Height

Required range: x >= 1
diagonalB
number

Diagonal

Required range: x >= 0.1
diagonalUnitB
enum<string>

Diagonal Unit

Available options:
in,
cm

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.