仕様・API

AI文案提案 v0.1

writing-suggestions API・target 一覧。

AI 文案提案 v0.1

対象: POST …/ai/writing-jobs(推奨)・GET …/writing-jobs/{id}。同期 writing-suggestions は互換用。

関連: ai-features.mdai-lp-image-jobs-v0.1.mdmanage-api-v0.1.md


認証

管理API共通。ログインユーザーの JWT + ワークスペース ACL(editor 以上)。詳細は manage-api-v0.1.md


リクエスト LpAiWritingSuggestIn

フィールド必須説明
targetstring下表のいずれか
step_indexint条件付きcta_label / media_alt / step_supplement では 0 始まりで必須
current_textstring改善対象の既存文案(空可)
instructionstringトーン・長さなどの追加指示(最大2000文字)
definitionobject編集画面の LP 定義 JSON。未保存のナレッジを含めたいときに送る

target 一覧

用途step_index
cta_labelステップCTAラベル必須
media_altステップ画像の alt必須
meta_titleLP meta.title不要
meta_descriptionLP meta.description不要
step_supplementステップ補足(AI画像・演出指示)必須
knowledge_productknowledge_notesLPナレッジ各項目不要
storyboard全ステップの補足を一括生成不要(ステップ1件以上必要)

ナレッジ系: knowledge_product, knowledge_target, knowledge_value, knowledge_proof, knowledge_cta, knowledge_tone, knowledge_notes


レスポンス LpAiWritingSuggestOut

フィールド説明
targetリクエストと同じ
suggestions最大3件の文案文字列(cta_label 等)
storyboardtarget: storyboard 時。[{ step_index, supplement }]

ステップ補足・ストーリーボードの出力形式

supplement / 提案文案は スライド演出指示(キャッチコピー1行だけにしない)。推奨セクション:

  • 【役割】 … ストーリー上の位置づけ
  • 【前後】 … 前後スライドとの接続
  • 【画面構成】 … 背景・レイアウト・視線誘導
  • 【載せる要素】 … 見出し・数字・アイコン等
  • 【トーン】 … 色調・雰囲気

JSON 内の \n リテラルはサーバ・Web 双方で実改行に正規化する。


非同期ジョブ writing-jobs

操作パス説明
作成POST …/ai/writing-jobsボディは LpAiWritingSuggestIn と同一。201status: queued
取得GET …/ai/writing-jobs/{job_id}queuedrunningsucceeded / failed。成功時 suggestions / storyboard

監査: prompt_sha256prompt_preview(画像ジョブと同様)。管理 UI はジョブ作成後ポーリングする。


プロンプトに含まれるコンテキスト

  • LP meta(タイトル・説明)
  • 全ステップのアウトライン(インデックス・メディア・CTA要約)
  • 対象ステップの前後step_supplement 時)
  • LPナレッジcreatorKnowledge — リクエスト definition または DB 保存値)
  • instruction / current_text

エラー

HTTP条件
400step_index 不足、storyboard でステップ0件、定義不正
401 / 403未ログイン・権限不足
502OpenAI 失敗、パース失敗、提案0件

OpenAI APIキー未設定時は 502 相当のエラー。


管理UIでの露出

場所target
ステップCTA・altcta_label, media_alt
サイト設定meta_title, meta_description
LPナレッジ各欄knowledge_*
AI画像パネル・ステップ補足step_supplement
ステップ一覧storyboard(一括)

v0.2 以降の候補

  • 非同期ジョブ化・監査ログ(画像ジョブと同等)(実装済: writing-jobs
  • 生成履歴の Workspace 内一覧
  • トーンRAG の embedding 連携(画像側と統合)

ソース: docs/spec/ai-writing-v0.1.md