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
bgColor
string

Box background

edgeColor
string

Edge color

topEnabled
boolean

Enable top edge

topStyle
enum<string>

Style

Available options:
zigzag,
wavy,
scallop
topSize
number

Size (period)

Required range: 8 <= x <= 120
topAmplitude
number

Amplitude (depth)

Required range: 2 <= x <= 60
rightEnabled
boolean

Enable right edge

rightStyle
enum<string>

Style

Available options:
zigzag,
wavy,
scallop
rightSize
number

Size (period)

Required range: 8 <= x <= 120
rightAmplitude
number

Amplitude (depth)

Required range: 2 <= x <= 60
bottomEnabled
boolean

Enable bottom edge

bottomStyle
enum<string>

Style

Available options:
zigzag,
wavy,
scallop
bottomSize
number

Size (period)

Required range: 8 <= x <= 120
bottomAmplitude
number

Amplitude (depth)

Required range: 2 <= x <= 60
leftEnabled
boolean

Enable left edge

leftStyle
enum<string>

Style

Available options:
zigzag,
wavy,
scallop
leftSize
number

Size (period)

Required range: 8 <= x <= 120
leftAmplitude
number

Amplitude (depth)

Required range: 2 <= x <= 60
className
string

Class name

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.