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

Width

Required range: 1 <= x <= 4000
height
number

Height

Required range: 1 <= x <= 4000
bgType
enum<string>

Type

Available options:
solid,
gradient
bgColor
string

Color

gradientStart
string

Start

gradientEnd
string

End

gradientAngle
number

Angle (deg)

Required range: 0 <= x <= 360
customText
boolean

Use custom text

text
string

Text

textColor
string

Text color

fontSize
number

Font size

Required range: 8 <= x <= 200
showBorder
boolean

Show border

borderColor
string

Border color

borderWidth
number

Border width

Required range: 1 <= x <= 40

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.