Create word cloud job
create_word_cloud_jobStart a word cloud rendering job and get status and artifact URLs immediately, without waiting for completion. Enables asynchronous generation of styled word clouds from text or weighted words.
Instructions
Start a ShapeWords render job and return status/artifact URLs without waiting for completion.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | Unsigned 32-bit layout seed for reproducible browserless ShapeWords renders. Canvas-profile default: 0. Use engine auto or browserless; browser fallback does not support non-zero seed. | |
| text | No | Words, phrases, notes, or source text for the word cloud. Optional when words[] is provided. | |
| width | No | Canvas width in pixels. Canvas-profile default: 800. | |
| words | No | Explicit weighted words. Use this when another system already tokenized, lemmatized, or scored the input. | |
| engine | No | Hosted renderer engine. auto uses the hosted renderer default path. | |
| format | No | Output artifact format. Canvas-profile default: svg. | |
| height | No | Canvas height in pixels. Canvas-profile default: 600. | |
| locale | No | ShapeWords UI/render locale. Canvas-profile default: en. | |
| padding | No | Word collision padding in pixels. Canvas-profile default: 3. | |
| palette | No | ||
| quality | No | sq is faster, hq renders at higher device scale. Canvas-profile default: hq. | |
| fillMode | No | Shape filling strategy. Canvas-profile default: fill. | |
| maxWords | No | Maximum number of words to lay out. Canvas-profile default: 700. | |
| colorMode | No | ||
| rotations | No | Explicit rotation angles in degrees. When provided, these override rotationPreset. | |
| shapeType | No | ShapeWords shape id, for example circle, rectangle, heart, star, cloud, diamond, custom. Canvas-profile default: cloud. | |
| background | No | Output background style. Canvas-profile default: white. | |
| fontFamily | No | ShapeWords font family name. Canvas-profile default: Montserrat. | |
| spiralType | No | Placement spiral algorithm. Canvas-profile default: archimedean. | |
| maxFontSize | No | ||
| minFontSize | No | ||
| returnLayout | No | Include layout JSON when supported. Canvas-profile default: false. | |
| renderProfile | No | Default option profile. canvas matches the main ShapeWords canvas; api keeps the older compact Render API defaults. | canvas |
| rotationPreset | No | Rotation preset matching the ShapeWords canvas. Canvas-profile default: orthogonal. | |
| customShapeDefinition | No | Custom SVG shape definition used when shapeType is custom. |