宾果卡 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。实际可用格式取决于配置和账户权益。
