クロスワード 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": "crossword", "title": "Nature crossword", "input": { "entries": [ { "word": "RIVER", "clue": "A flowing body of water" }, { "word": "TREE", "clue": "A woody plant" } ] } }'

モード

normal · solution-word

ページ別の設定

ブラウザーでの出力形式

pdf · answer-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.fontFamily	いずれか; sans \| serif \| handwriting \| playful \| mono	いいえ
appearance.themeColor	文字列	いいえ
appearance.footerText	文字列; 最大 200	いいえ
appearance.borderStyle	いずれか; solid \| dashed \| dotted	いいえ
appearance.layoutMode	いずれか; default \| worksheet	いいえ
appearance.pillTitle	真偽値	いいえ
appearance.showWorksheetHeader	真偽値	いいえ
appearance.outerBorder	真偽値	いいえ
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	いいえ
input.entries	配列; 最小 1; 最大 200	いいえ
input.entries[].word	文字列; 最小 1; 最大 50	いいえ
input.entries[].clue	文字列; 最小 1; 最大 300	いいえ
input.templateId	文字列; 最小 1; 最大 100	いいえ
input.solutionWord	文字列; 最小 1; 最大 50	いいえ
options.seed	数値; 整数; 最小 0; 最大 2147483647	いいえ
options.difficulty	いずれか; easy \| medium \| hard	いいえ
options.gridSize	数値; 整数; 最小 5; 最大 50	いいえ

テンプレートとテーマ

利用可能なテンプレート番号、テーマ、アカウントの制限は /api/v1/capabilities で確認してください。テンプレートを使った結果も保存枠を一つ使います。

画像とファイル

画像には、同じアカウントで事前に送信または取り込んだ assetId を指定します。ダウンロードはブラウザーの結果ページから行います。結果ページの URL はファイルへの直接リンクではありません。

失敗する場合

未知の項目や type、mode、preset の矛盾は 422 です。完成できない入力も 422 です。出力形式は設定とアカウントの権限で変わります。