Skip to main content
POST
Word Cloud Generator

Authorizations

Authorization
string
header
required

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

Body

application/json
ioInputText
string

Text

ioShape
enum<string>

Shape

Available options:
rectangle,
circle,
ellipse
ioCanvasSize
enum<string>

Canvas size

Available options:
600x400,
900x600,
1200x800,
800x800,
1600x600
ioMaxWords
number

Max words

Required range: 10 <= x <= 300
ioMinFontSize
number

Min font size (px)

Required range: 8 <= x <= 60
ioMaxFontSize
number

Max font size (px)

Required range: 30 <= x <= 200
ioRotation
enum<string>

Rotation

Available options:
none,
mixed,
random
ioSeed
number

Layout seed

ioPalette
enum<string>

Color palette

Available options:
vibrant,
pastel,
ocean,
sunset,
forest,
monochrome,
grayscale
ioFontFamily
enum<string>

Font family

Available options:
Inter, Arial, sans-serif,
Georgia, 'Times New Roman', serif,
'Courier New', Courier, monospace,
Impact, 'Arial Black', sans-serif,
'Comic Sans MS', 'Marker Felt', cursive
ioBgColor
string

Background

ioIgnoreStopWords
boolean

Exclude common stop words

ioCaseSensitive
boolean

Case sensitive

ioMinWordLength
number

Min word length

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

Custom exclusions

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.