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

Wave style

Available options:
sine,
layered,
zigzag,
hills,
asymmetric,
blob
amplitude
number

Amplitude

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

Frequency

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

Width

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

Height

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

Flip vertical

flipHorizontal
boolean

Flip horizontal

layers
number

Number of layers

Required range: 1 <= x <= 4
color1
string

Layer 1 colour

opacity1
number

Layer 1 opacity

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

Layer 2 colour

opacity2
number

Layer 2 opacity

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

Layer 3 colour

opacity3
number

Layer 3 opacity

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

Layer 4 colour

opacity4
number

Layer 4 opacity

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

Background colour

animate
boolean

Animate waves

animSpeed
enum<string>

Speed

Available options:
slow,
medium,
fast

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.