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

模式

normal

页面预设

浏览器导出格式

svg · pdf · png · dxf · zip · stl

导出格式取决于题目配置和账户套餐。创建响应中的 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.lineColor文本否
appearance.lineWidth数字; 最小 0; 最大 20否
appearance.strokeOutline是/否否
appearance.outlineColor文本否
appearance.outlineWidth数字; 最小 0; 最大 10否
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.thicknessMm数字; 最小 1; 最大 10否
export.gapMm数字; 最小 0.1; 最大 1否
input.imageAssetId文本否
options.seed数字; 整数; 最小 0; 最大 2147483647否
options.tilesX数字; 整数; 最小 1; 最大 100否
options.tilesY数字; 整数; 最小 1; 最大 100否
options.sizeX数字; 最小 1; 最大 10000否
options.sizeY数字; 最小 1; 最大 10000否
options.tabSize数字; 最小 10; 最大 35否
options.jitter数字; 最小 0; 最大 10否
options.cornerRadius数字; 最小 0; 最大 100否
options.shape文本; 最小 1; 最大 50否
options.hexRings数字; 整数; 最小 1; 最大 20否

模板与主题

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

图片与文件

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

失败情形

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

拼图 API 参考