仕様・API
AI文案提案 v0.1
writing-suggestions API・target 一覧。
AI 文案提案 v0.1
対象: POST …/ai/writing-jobs(推奨)・GET …/writing-jobs/{id}。同期 writing-suggestions は互換用。
関連: ai-features.md、ai-lp-image-jobs-v0.1.md、manage-api-v0.1.md
認証
管理API共通。ログインユーザーの JWT + ワークスペース ACL(editor 以上)。詳細は manage-api-v0.1.md。
リクエスト LpAiWritingSuggestIn
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
target | string | ✓ | 下表のいずれか |
step_index | int | 条件付き | cta_label / media_alt / step_supplement では 0 始まりで必須 |
current_text | string | 改善対象の既存文案(空可) | |
instruction | string | トーン・長さなどの追加指示(最大2000文字) | |
definition | object | 編集画面の LP 定義 JSON。未保存のナレッジを含めたいときに送る |
target 一覧
| 値 | 用途 | step_index |
|---|---|---|
cta_label | ステップCTAラベル | 必須 |
media_alt | ステップ画像の alt | 必須 |
meta_title | LP meta.title | 不要 |
meta_description | LP meta.description | 不要 |
step_supplement | ステップ補足(AI画像・演出指示) | 必須 |
knowledge_product 〜 knowledge_notes | LPナレッジ各項目 | 不要 |
storyboard | 全ステップの補足を一括生成 | 不要(ステップ1件以上必要) |
ナレッジ系: knowledge_product, knowledge_target, knowledge_value, knowledge_proof, knowledge_cta, knowledge_tone, knowledge_notes
レスポンス LpAiWritingSuggestOut
| フィールド | 説明 |
|---|---|
target | リクエストと同じ |
suggestions | 最大3件の文案文字列(cta_label 等) |
storyboard | target: storyboard 時。[{ step_index, supplement }] |
ステップ補足・ストーリーボードの出力形式
各 supplement / 提案文案は スライド演出指示(キャッチコピー1行だけにしない)。推奨セクション:
【役割】… ストーリー上の位置づけ【前後】… 前後スライドとの接続【画面構成】… 背景・レイアウト・視線誘導【載せる要素】… 見出し・数字・アイコン等【トーン】… 色調・雰囲気
JSON 内の \n リテラルはサーバ・Web 双方で実改行に正規化する。
非同期ジョブ writing-jobs
| 操作 | パス | 説明 |
|---|---|---|
| 作成 | POST …/ai/writing-jobs | ボディは LpAiWritingSuggestIn と同一。201 で status: queued |
| 取得 | GET …/ai/writing-jobs/{job_id} | queued → running → succeeded / failed。成功時 suggestions / storyboard |
監査: prompt_sha256・prompt_preview(画像ジョブと同様)。管理 UI はジョブ作成後ポーリングする。
プロンプトに含まれるコンテキスト
- LP
meta(タイトル・説明) - 全ステップのアウトライン(インデックス・メディア・CTA要約)
- 対象ステップの前後(
step_supplement時) - LPナレッジ(
creatorKnowledge— リクエストdefinitionまたは DB 保存値) instruction/current_text
エラー
| HTTP | 条件 |
|---|---|
| 400 | step_index 不足、storyboard でステップ0件、定義不正 |
| 401 / 403 | 未ログイン・権限不足 |
| 502 | OpenAI 失敗、パース失敗、提案0件 |
OpenAI APIキー未設定時は 502 相当のエラー。
管理UIでの露出
| 場所 | target |
|---|---|
| ステップCTA・alt | cta_label, media_alt |
| サイト設定 | meta_title, meta_description |
| LPナレッジ各欄 | knowledge_* |
| AI画像パネル・ステップ補足 | step_supplement |
| ステップ一覧 | storyboard(一括) |
v0.2 以降の候補
非同期ジョブ化・監査ログ(画像ジョブと同等)(実装済:writing-jobs)- 生成履歴の Workspace 内一覧
- トーンRAG の embedding 連携(画像側と統合)