Word scrambles API reference
Word scrambles: This reference reads modes, presets, formats and accepted fields from the same registry and input contract as the API.
Example request
curl -X POST https://puzzlegenio.com/api/v1/puzzles \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Idempotency-Key: task-000000000001' \
-H 'Content-Type: application/json' \
-d '{ "type": "scramble", "title": "Animal scramble", "input": { "words": [ "TIGER", "HORSE", "RABBIT" ] } }'Modes
scramble · double
Page presets
Browser export formats
png · pdf
Formats reflect the puzzle configuration and account plan. The creation response gives viewUrl and exportPageUrl for browser downloads; it does not contain PDF, PNG or STL bytes. The saved export policy is fixed when published and is checked again on republish.
Common request fields
| Field | Accepted value | Required |
|---|---|---|
| preset | text | No |
| mode | text | No |
| locale | one of; en | zh | es | de | fr | pt | it | id | ja | ko | No |
| contentLanguage | one of; en | zh | es | de | fr | pt | it | id | ja | ko | No |
| title | text | Yes |
| retentionDays | number; integer | No |
| appearance.fontFamily | one of; sans | serif | handwriting | playful | mono | No |
| appearance.themeColor | text | No |
| appearance.footerText | text; maximum 200 | No |
| appearance.borderStyle | one of; solid | dashed | dotted | No |
| appearance.layoutMode | one of; default | worksheet | No |
| appearance.pillTitle | true/false | No |
| appearance.showWorksheetHeader | true/false | No |
| appearance.outerBorder | true/false | No |
| appearance.titleScale | number; minimum 0.5; maximum 3 | No |
| appearance.letterCase | one of; uppercase | lowercase | No |
| appearance.answerStyle | one of; boxed | line | No |
| appearance.secretShade | true/false | No |
| appearance.rowSpacing | one of; compact | normal | relaxed | No |
| appearance.hideInstructions | true/false | No |
| export.paperSize | one of; A3 | A4 | A4-landscape | A5 | B5 | Letter | Letter-landscape | Legal | Half-Letter | Tabloid | custom | No |
| export.widthMm | number; minimum 50; maximum 2000 | No |
| export.heightMm | number; minimum 50; maximum 2000 | No |
| export.unit | one of; mm | cm | in | px | No |
| export.quality | one of; standard | high | print | No |
| input.words | list; minimum 1; maximum 20 | Yes |
| input.words[] | text; minimum 2; maximum 15 | Yes |
| input.secretMessage | text; maximum 200 | No |
| options.seed | number; integer; minimum 0; maximum 2147483647 | No |
| options.hintMode | one of; none | first-letter | No |
| options.revealLetters | list; maximum 26 | No |
| options.revealLetters[] | text | No |
| options.showWordBank | true/false | No |
Templates and themes
Query /api/v1/capabilities for currently available template IDs, themes and account-specific limits. A template selection still creates one saved puzzle.
Images and files
Image input uses a previously uploaded or imported assetId owned by the API key account. Downloads are performed on the result page in a browser; a result URL is not a direct file URL.
Failure cases
Unknown fields or incompatible type, mode and preset combinations return 422. Inputs that cannot produce a complete puzzle also return 422. Available formats depend on configuration and account rights.