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

Spinner type

Available options:
circle-stroke,
dual-ring,
dotted-ring,
pulse-dots,
bouncing-dots,
bar-loader,
ripple
size
number

Size (px)

Required range: 16 <= x <= 256
strokeWidth
number

Stroke width (px)

Required range: 1 <= x <= 30
primaryColor
string

Primary colour

secondaryColor
string

Track / secondary colour

speed
number

Speed (sec)

Required range: 0.2 <= x <= 5
ariaLabel
string

ARIA label

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.