Skip to content

宾果卡 API 参考

宾果卡: 本参考直接读取 API 共用注册表与输入契约中的模式、预设、格式和字段。

请求示例

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 } }'

模式

classic · signature · number · blank

页面预设

浏览器导出格式

pdf · caller-pdf

导出格式取决于题目配置和账户套餐。创建响应中的 viewUrl 与 exportPageUrl 用于浏览器下载,不包含 PDF、PNG 或 STL 文件内容。发布时确定导出权限,再次发布时重新检查。

通用请求字段

字段允许的值必填
preset文本否
mode文本否
locale任选其一; en | zh | es | de | fr | pt | it | id | ja | ko否
contentLanguage任选其一; en | zh | es | de | fr | pt | it | id | ja | ko否
title文本是
retentionDays数字; 整数否
appearance.themeColor文本否
appearance.title.fontFamily任选其一; sans | serif | handwriting | playful | mono否
appearance.title.fontWeight任选其一; normal | medium | semibold | bold | extrabold否
appearance.title.color文本否
appearance.title.align任选其一; left | center | right否
appearance.title.maxFontSize数字; 最小 6; 最大 120否
appearance.grid.shape任选其一; square | circle否
appearance.grid.corners任选其一; sharp | sm | md | lg否
appearance.grid.gap任选其一; none | sm | md | lg否
appearance.grid.colorMode任选其一; mono | checker否
appearance.grid.bg任选其一; 文本 | transparent | object否
appearance.grid.textFontFamily任选其一; sans | serif | handwriting | playful | mono否
appearance.grid.textFontWeight任选其一; normal | medium | semibold | bold | extrabold否
appearance.grid.textColor文本否
appearance.grid.borderWidth数字; 整数; 最小 0; 最大 3否
appearance.grid.borderColor文本否
appearance.grid.borderStyle任选其一; solid | dashed | dotted否
appearance.card.bgColor任选其一; 文本 | transparent | object否
appearance.card.borderRadius任选其一; sharp | rounded否
appearance.card.borderWidth数字; 整数; 最小 0; 最大 3否
appearance.card.borderColor文本否
appearance.header.bgColor任选其一; 文本 | transparent | object否
appearance.header.fontFamily任选其一; sans | serif | handwriting | playful | mono否
appearance.header.fontWeight任选其一; normal | medium | semibold | bold | extrabold否
appearance.header.color文本否
appearance.header.maxFontSize数字; 最小 6; 最大 120否
appearance.footer.enabled是/否否
appearance.footer.text文本; 最大 200否
appearance.footer.fontFamily任选其一; sans | serif | handwriting | playful | mono否
appearance.footer.fontWeight任选其一; normal | medium | semibold | bold | extrabold否
appearance.footer.color文本否
appearance.footer.align任选其一; left | center | right否
appearance.footer.maxFontSize数字; 最小 6; 最大 120否
appearance.columnHeaders列表; 最大 5否
appearance.columnHeaders[]文本; 最小 1; 最大 8否
appearance.showColumnHeaders是/否否
appearance.randomization任选其一; full | column否
appearance.freeSpaceLabel文本; 最大 40否
appearance.signatureLines是/否否
appearance.fontFamily任选其一; sans | serif | handwriting | playful | mono否
appearance.fontSize任选其一; small | medium | large否
appearance.headerBgColor文本否
appearance.showGridLines是/否否
appearance.outerBorder是/否否
appearance.borderStyle任选其一; solid | dashed | dotted否
export.paperSize任选其一; A3 | A4 | A4-landscape | A5 | B5 | Letter | Letter-landscape | Legal | Half-Letter | Tabloid | custom否
export.widthMm数字; 最小 50; 最大 2000否
export.heightMm数字; 最小 50; 最大 2000否
export.unit任选其一; mm | cm | in | px否
export.quality任选其一; standard | high | print否
export.layout任选其一; 1x1 | 1x2 | 2x2 | 2x4否
input.words列表; 最小 1; 最大 200否
input.words[]文本; 最小 1; 最大 50否
input.numbers列表否
input.numbers[]数字; 整数; 最小 0; 最大 9999否
options.seed数字; 整数; 最小 0; 最大 2147483647否
options.gridSize任选其一; 3 | 4 | 5否
options.cardCount数字; 整数; 最小 1; 最大 100否
options.freeSpace是/否否
options.minNumber数字; 整数; 最小 0; 最大 9999否
options.maxNumber数字; 整数; 最小 0; 最大 9999否
options.ballCount任选其一; 30 | 75 | 80否
options.signatureLine是/否否

模板与主题

查询 /api/v1/capabilities 获取当前可用的模板编号、主题与账户限额。选择模板后创建的结果同样占一个保存名额。

图片与文件

图片输入使用本账户预先上传或导入的 assetId。下载在浏览器结果页进行;结果页链接并不是文件直链。

失败情形

未知字段、冲突的 type、mode 与 preset 返回 422。无法生成完整谜题的输入也返回 422。实际可用格式取决于配置和账户权益。

宾果卡 API 参考