Skip to content

Jigsaw puzzles API reference

Jigsaw 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": "jigsaw", "title": "Mountain puzzle", "options": { "tilesX": 5, "tilesY": 5, "shape": "rectangle" } }'

Modes

normal

Page presets

Browser export formats

svg Β· pdf Β· png Β· dxf Β· zip Β· stl

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.lineColortextNo
appearance.lineWidthnumber; minimum 0; maximum 20No
appearance.strokeOutlinetrue/falseNo
appearance.outlineColortextNo
appearance.outlineWidthnumber; minimum 0; maximum 10No
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
export.thicknessMmnumber; minimum 1; maximum 10No
export.gapMmnumber; minimum 0.1; maximum 1No
input.imageAssetIdtextNo
options.seednumber; integer; minimum 0; maximum 2147483647No
options.tilesXnumber; integer; minimum 1; maximum 100No
options.tilesYnumber; integer; minimum 1; maximum 100No
options.sizeXnumber; minimum 1; maximum 10000No
options.sizeYnumber; minimum 1; maximum 10000No
options.tabSizenumber; minimum 10; maximum 35No
options.jitternumber; minimum 0; maximum 10No
options.cornerRadiusnumber; minimum 0; maximum 100No
options.shapetext; minimum 1; maximum 50No
options.hexRingsnumber; integer; minimum 1; maximum 20No

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.

Jigsaw puzzles API reference