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
minFontSize
number

Min font size (px)

Required range: 8 <= x <= 40
maxFontSize
number

Max font size (px)

Required range: 8 <= x <= 72
minViewport
number

Min viewport width (px)

Required range: 280 <= x <= 768
maxViewport
number

Max viewport width (px)

Required range: 768 <= x <= 2560
minRatio
enum<string>

Scale ratio at min viewport

Available options:
1.067,
1.125,
1.2,
1.25,
1.333,
1.414,
1.5,
1.618
maxRatio
enum<string>

Scale ratio at max viewport

Available options:
1.067,
1.125,
1.2,
1.25,
1.333,
1.414,
1.5,
1.618
outputUnit
enum<string>

Output unit

Available options:
rem,
px
asCustomProperties
boolean

Output as CSS custom properties

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.