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

Shape

Available options:
slant,
curve,
triangle,
arrow,
book-page,
clouds
slantDepth
number

Slant depth

Required range: 10 <= x <= 90
curveDepth
number

Curve depth

Required range: 20 <= x <= 160
peakPosition
enum<string>

Peak position

Available options:
left,
center,
right
peakHeight
number

Peak height

Required range: 20 <= x <= 200
notchDepth
number

Notch depth

Required range: 20 <= x <= 200
curlSize
number

Curl size

Required range: 20 <= x <= 200
bumpCount
number

Number of bumps

Required range: 3 <= x <= 12
bumpHeight
number

Bump height

Required range: 10 <= x <= 100
width
number

Width

Required range: 200 <= x <= 3000
height
number

Height

Required range: 50 <= x <= 600
flipVertical
boolean

Flip vertical

flipHorizontal
boolean

Flip horizontal

fillColor
string

Fill colour

fillOpacity
number

Fill opacity

Required range: 10 <= x <= 100
bgColor
string

Background colour

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.