Chatbot Settings

REST API を使って AI Agent の設定全体を取得・更新します。

Chatbot Settings

パーソナリティ、会話スタイル、システムプロンプトを含む AI Agent の設定全体を取得・更新します。

動作の設定は、ダッシュボードの アイデンティティ > AIペルソナ にあります。訪問者向けのテキストは チャンネル > あなたのウェブサイト > テキストコンテンツ で設定します。各設定の正確な場所は、以下のフィールド表を参照してください。

Get Chatbot Settings

スコープ: read_all

GET https://app.quickchat.ai/v1/api/chatbot_settings

Shell
Python

curl https://app.quickchat.ai/v1/api/chatbot_settings \
  -H 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/chatbot_settings",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "personality": 0,
  "profession": "helpful_assistant",
  "creativity_level": 1,
  "greeting": "<p>Hello! How can I help you today?</p>",
  "greeting2": "",
  "header": "Support Assistant",
  "header2": "",
  "language_chosen": "en",
  "reply_length": 1,
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"]
}

Field	Description
`one_word_description` string	AI Agent 名。ダッシュボード：アイデンティティ > AIペルソナ > 名前。API は最大 200 文字を受け付けます。アプリ内のフィールドは 40 文字までです。
`short_description` string	メインプロンプト（システムプロンプト）。ダッシュボード：アイデンティティ > AIペルソナ > メインプロンプト。API はすべてのプランで最大 25,000 文字を受け付けます。アプリ内エディタは、15,000 文字から始まるプランごとの上限に制限します。
`ai_commands` array of strings	AI の行動ガイドライン。配列の 1 要素につき 1 件です。ダッシュボード：アイデンティティ > AIペルソナ > ガイドライン。最大 250 件、1 件あたり 5,000 文字、全件合計で 10,000 文字までです。
`personality` integer (0–13)	AI の個性のプリセット。ダッシュボード：アイデンティティ > AIペルソナ > 個性。下表を参照してください。
`profession` string	AI の職業 / 役割。ダッシュボード：アイデンティティ > AIペルソナ > 職業（最大 200 文字）。下表を参照してください。
`creativity_level` integer (0–2)	ダッシュボード：アイデンティティ > AIペルソナ > 創造性。`0` = 低い、`1` = 普通、`2` = 高い
`reply_length` integer (0–2)	ダッシュボード：アイデンティティ > AIペルソナ > 回答の長さ。`0` = 短い、`1` = 普通、`2` = 長い
`greeting` string	メインの挨拶メッセージ（HTML）。ダッシュボード：チャンネル > あなたのウェブサイト > テキストコンテンツ > ウェルカムメッセージ（最大 1000 文字）。Widget Configuration の `welcome_message` と同じフィールドです。
`greeting2` string	サブの挨拶メッセージ（HTML）。API で利用できます。ダッシュボードには編集用のフィールドはありません。
`header` string	チャットヘッダーのテキスト。ダッシュボード：チャンネル > あなたのウェブサイト > テキストコンテンツ > ヘッダーテキスト（最大 200 文字）
`header2` string	サブのヘッダーテキスト（最大 200 文字）。API の `header2`、または Widget Configuration の `subtitle` として利用できます。ダッシュボードには編集用のフィールドはありません。
`language_chosen` string	カンマ区切りの言語コード（例：`"en,es,de"`）。ダッシュボード：アイデンティティ > AIペルソナ > 言語（合計で最大 200 文字。30 言語の上限を超えたコードは除外されます）

Personality の値:

Value	Label	Description
0	Classic	バランスが取れており、プロフェッショナルさと親しみやすさが調和（デフォルト）
1	Humorous	ダジャレやジョークを交えた機知に富んだトーンで、楽しいやり取り
2	Formal	フォーマルで真面目、ビジネス向けに簡潔で事実に基づいた情報
3	Friendly	親しみやすく個人的な雰囲気のカジュアルな会話
4	Sassy	自信に満ち、ユーモアを交えた遊び心のある対応
5	Intelligent	包括的な理解のための詳細で正確な情報
6	Empathetic	気持ちに配慮した、思いやりと共感のあるやり取り
7	Bold	自信を持って伝える、強い意見や推奨
9	Excited	活気にあふれエネルギッシュな関わり
10	Mysterious	ユニークな体験のための、謎めいて興味をそそる応答
11	Inspiring	コーチのようにポジティブ思考と目標達成を後押し
12	Adventurous	快適な領域を抜け出し、新たな機会を探ることを促す
13	Elegant	ユニークで上質なブランドのための洗練された体験

Profession の値:

Value	Dashboard Label	Description
`helpful_assistant`	Helpful Assistant	多用途で汎用的。ほとんどのユースケースに推奨
`customer_support_representative`	Support Agent	共感的で、ステップバイステップの解決策とトラブルシューティングを提供
`shopping_assistant`	Shopping Assistant	リンク付きの商品レコメンドを積極的に提示
`field_expert`	Field Expert	専門コンサルタントとして、明確化のための質問を行い、専門的な指針を提供
`interviewer`	Interviewer	回答する代わりに質問する。アンケート、インタビュー、フィードバック向け

one_word_description、short_description、ai_commands の各フィールドは、Knowledge Base Settings エンドポイントからも利用できます。これらのフィールドは共有されており、どちらのエンドポイントから更新しても同じ基底データが変更されます。

Update Chatbot Settings

スコープ: write_all

PATCH https://app.quickchat.ai/v1/api/chatbot_settings

Request Body — すべてのフィールドは任意です。更新したいフィールドのみを含めてください。

Parameter	Description
`personality` integer (0–13)	AI パーソナリティのプリセット
`profession` string	AI の職種 / 役割（最大 200 文字）
`creativity_level` integer (0–2)	`0` = 低い、`1` = 普通、`2` = 高い
`greeting` string	メインのウェルカムメッセージ（HTML、最大 1000 文字）
`greeting2` string	サブのウェルカムメッセージ
`header` string	チャットヘッダーのテキスト（最大 200 文字）
`header2` string	サブのヘッダーテキスト（最大 200 文字）
`language_chosen` string	カンマ区切りの言語コード（合計で最大 200 文字。30 言語の上限を超えたコードは除外されます）
`reply_length` integer (0–2)	`0` = 短い、`1` = 普通、`2` = 長い
`one_word_description` string	AI Agent 名。API は最大 200 文字を受け付けます。アプリ内のフィールドは 40 文字までです。
`short_description` string	AI Agent のシステムプロンプト / メインプロンプト。API はすべてのプランで最大 25,000 文字を受け付けます。アプリ内エディタは、15,000 文字から始まるプランごとの上限に制限します。上限を超える値は `422` を返します。
`ai_commands` array of strings	AI Guidelines。配列の 1 要素につき 1 件です。最大 250 件、1 件あたり 5,000 文字、全件合計で 10,000 文字までです。上限を超える値は `422` を返します。

配列の各要素が 1 件のガイドラインで、送信したとおりに保存されます。セミコロンを含め、句読点はそのまま保持されます。以前このエンドポイントは、保存前にテキストから ; を削除していました。そのためにセミコロンを削除または置き換えていた場合、その必要はなくなりました。

ai_commands を省略するか null を送信すると、ガイドラインは変更されません。[] を送信すると削除されます。

Shell
Python

curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "greeting": "<p>Welcome! Ask me anything.</p>",
  "creativity_level": 2
}'

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/chatbot_settings",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "greeting": "<p>Welcome! Ask me anything.</p>",
        "creativity_level": 2,
    },
)
data = response.json()

Response 200 OK — 更新された chatbot settings を返します（Get Chatbot Settings のレスポンスと同じスキーマ）。

Chatbot Settings