Skip to content

Bingo cards API reference

Bingo cards: 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": "bingo", "title": "Party bingo", "input": { "words": [ "APPLE", "BANANA", "CHERRY", "DATE", "FIG", "GRAPE", "KIWI", "LEMON", "MANGO" ] }, "options": { "gridSize": 3, "cardCount": 1 } }'

Modes

classic Β· signature Β· number Β· blank

Page presets

Browser export formats

pdf Β· caller-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.themeColortextNo
appearance.title.fontFamilyone of; sans | serif | handwriting | playful | monoNo
appearance.title.fontWeightone of; normal | medium | semibold | bold | extraboldNo
appearance.title.colortextNo
appearance.title.alignone of; left | center | rightNo
appearance.title.maxFontSizenumber; minimum 6; maximum 120No
appearance.grid.shapeone of; square | circleNo
appearance.grid.cornersone of; sharp | sm | md | lgNo
appearance.grid.gapone of; none | sm | md | lgNo
appearance.grid.colorModeone of; mono | checkerNo
appearance.grid.bgone of; text | transparent | objectNo
appearance.grid.textFontFamilyone of; sans | serif | handwriting | playful | monoNo
appearance.grid.textFontWeightone of; normal | medium | semibold | bold | extraboldNo
appearance.grid.textColortextNo
appearance.grid.borderWidthnumber; integer; minimum 0; maximum 3No
appearance.grid.borderColortextNo
appearance.grid.borderStyleone of; solid | dashed | dottedNo
appearance.card.bgColorone of; text | transparent | objectNo
appearance.card.borderRadiusone of; sharp | roundedNo
appearance.card.borderWidthnumber; integer; minimum 0; maximum 3No
appearance.card.borderColortextNo
appearance.header.bgColorone of; text | transparent | objectNo
appearance.header.fontFamilyone of; sans | serif | handwriting | playful | monoNo
appearance.header.fontWeightone of; normal | medium | semibold | bold | extraboldNo
appearance.header.colortextNo
appearance.header.maxFontSizenumber; minimum 6; maximum 120No
appearance.footer.enabledtrue/falseNo
appearance.footer.texttext; maximum 200No
appearance.footer.fontFamilyone of; sans | serif | handwriting | playful | monoNo
appearance.footer.fontWeightone of; normal | medium | semibold | bold | extraboldNo
appearance.footer.colortextNo
appearance.footer.alignone of; left | center | rightNo
appearance.footer.maxFontSizenumber; minimum 6; maximum 120No
appearance.columnHeaderslist; maximum 5No
appearance.columnHeaders[]text; minimum 1; maximum 8No
appearance.showColumnHeaderstrue/falseNo
appearance.randomizationone of; full | columnNo
appearance.freeSpaceLabeltext; maximum 40No
appearance.signatureLinestrue/falseNo
appearance.fontFamilyone of; sans | serif | handwriting | playful | monoNo
appearance.fontSizeone of; small | medium | largeNo
appearance.headerBgColortextNo
appearance.showGridLinestrue/falseNo
appearance.outerBordertrue/falseNo
appearance.borderStyleone of; solid | dashed | dottedNo
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.layoutone of; 1x1 | 1x2 | 2x2 | 2x4No
input.wordslist; minimum 1; maximum 200No
input.words[]text; minimum 1; maximum 50No
input.numberslistNo
input.numbers[]number; integer; minimum 0; maximum 9999No
options.seednumber; integer; minimum 0; maximum 2147483647No
options.gridSizeone of; 3 | 4 | 5No
options.cardCountnumber; integer; minimum 1; maximum 100No
options.freeSpacetrue/falseNo
options.minNumbernumber; integer; minimum 0; maximum 9999No
options.maxNumbernumber; integer; minimum 0; maximum 9999No
options.ballCountone of; 30 | 75 | 80No
options.signatureLinetrue/falseNo

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.

Bingo cards API reference