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
mode
enum<string>

Mode

Available options:
pixels-to-print,
print-to-pixels
widthPx
number

Image Width (px)

Required range: x >= 1
heightPx
number

Image Height (px)

Required range: x >= 1
printWidth
number

Print Width

Required range: x >= 0.01
printHeight
number

Print Height

Required range: x >= 0.01
printUnit
enum<string>

Print Unit

Available options:
in,
cm,
mm
dpi
number

DPI / PPI

Required range: 1 <= x <= 9999

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.