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": "wordsearch", "preset": "word-search-for-kids", "title": "Animal word search", "input": { "words": [ "CAT", "DOG", "LION", "TIGER" ] }, "options": { "gridSize": 10, "allowDiagonal": false } }'

モード

normal

ページ別の設定

ブラウザーでの出力形式

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真偽値いいえ
appearance.wordListPositionいずれか; bottom | rightいいえ
appearance.showGridLines真偽値いいえ
appearance.showDirectionIcons真偽値いいえ
appearance.answerStyleいずれか; highlight | circle | strikethroughいいえ
appearance.titleScale数値; 最小 0.5; 最大 3いいえ
appearance.letterCaseいずれか; uppercase | lowercaseいいえ
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.words配列; 最小 1; 最大 200いいえ
input.words[]文字列; 最小 2; 最大 30いいえ
input.templateId文字列; 最小 1; 最大 100いいえ
options.seed数値; 整数; 最小 0; 最大 2147483647いいえ
options.gridSize数値; 整数; 最小 5; 最大 30いいえ
options.allowDiagonal真偽値いいえ
options.allowBackward真偽値いいえ
options.fillLettersOnly真偽値いいえ

テンプレートとテーマ

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

画像とファイル

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

失敗する場合

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

ワードサーチ API 資料