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

Ribbon Text

corner
enum<string>

Corner

Available options:
top-left,
top-right,
bottom-left,
bottom-right
ribbonColor
string

Ribbon Color

textColor
string

Text Color

ribbonSize
number

Ribbon Size (px)

Required range: 80 <= x <= 220
foldShadow
boolean

Folded-edge shadow

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.