Skip to content

Crossword puzzles API reference

Crossword puzzles: 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": "crossword", "title": "Nature crossword", "input": { "entries": [ { "word": "RIVER", "clue": "A flowing body of water" }, { "word": "TREE", "clue": "A woody plant" } ] } }'

Modes

normal Β· solution-word

Page presets

Browser export formats

pdf Β· answer-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

FieldAccepted valueRequired
presettextNo
modetextNo
localeone of; en | zh | es | de | fr | pt | it | id | ja | koNo
contentLanguageone of; en | zh | es | de | fr | pt | it | id | ja | koNo
titletextYes
retentionDaysnumber; integerNo
appearance.fontFamilyone of; sans | serif | handwriting | playful | monoNo
appearance.themeColortextNo
appearance.footerTexttext; maximum 200No
appearance.borderStyleone of; solid | dashed | dottedNo
appearance.layoutModeone of; default | worksheetNo
appearance.pillTitletrue/falseNo
appearance.showWorksheetHeadertrue/falseNo
appearance.outerBordertrue/falseNo
export.paperSizeone of; A3 | A4 | A4-landscape | A5 | B5 | Letter | Letter-landscape | Legal | Half-Letter | Tabloid | customNo
export.widthMmnumber; minimum 50; maximum 2000No
export.heightMmnumber; minimum 50; maximum 2000No
export.unitone of; mm | cm | in | pxNo
export.qualityone of; standard | high | printNo
input.entrieslist; minimum 1; maximum 200No
input.entries[].wordtext; minimum 1; maximum 50No
input.entries[].cluetext; minimum 1; maximum 300No
input.templateIdtext; minimum 1; maximum 100No
input.solutionWordtext; minimum 1; maximum 50No
options.seednumber; integer; minimum 0; maximum 2147483647No
options.difficultyone of; easy | medium | hardNo
options.gridSizenumber; integer; minimum 5; maximum 50No

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.

Crossword puzzles API reference