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

Text

shape
enum<string>

Shape

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

Canvas size

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

Max words

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

Min font size (px)

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

Max font size (px)

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

Rotation

Available options:
none,
mixed,
random
seed
number

Layout seed

palette
enum<string>

Color palette

Available options:
vibrant,
pastel,
ocean,
sunset,
forest,
monochrome,
grayscale
fontFamily
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
bgColor
string

Background

ignoreStopWords
boolean

Exclude common stop words

caseSensitive
boolean

Case sensitive

minWordLength
number

Min word length

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

Custom exclusions

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.