Skip to main content
POST
SVG Wave Generator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioWaveStyle
enum<string>

Wave style

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

Amplitude

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

Frequency

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

Width

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

Height

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

Flip vertical

ioFlipHorizontal
boolean

Flip horizontal

ioLayers
number

Number of layers

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

Layer 1 colour

ioOpacity1
number

Layer 1 opacity

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

Layer 2 colour

ioOpacity2
number

Layer 2 opacity

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

Layer 3 colour

ioOpacity3
number

Layer 3 opacity

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

Layer 4 colour

ioOpacity4
number

Layer 4 opacity

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

Background colour

ioAnimate
boolean

Animate waves

ioAnimSpeed
enum<string>

Speed

Available options:
slow,
medium,
fast

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.