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

Pattern type

Available options:
dots,
lines-h,
lines-v,
diagonal,
grid,
chevron,
hexagons,
triangles,
diamonds,
crosses,
waves,
checkerboard
fgColor
string

Foreground

bgColor
string

Background

strokeWidth
number

Stroke / element size

Required range: 1 <= x <= 20
spacing
number

Spacing (px)

Required range: 5 <= x <= 100
opacity
number

Opacity

Required range: 1 <= x <= 10
rotation
number

Rotation (deg)

Required range: 0 <= x <= 360

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.