Sonzai Docs

APIリファレンス

エージェントの作成とREST API経由でのインタラクションのためのパブリックリファレンス。内部コンテキスト組み立て、記憶管理、状態オーケストレーションはプラットフォームが管理しており、意図的に省略されています。

認証

すべてのAPI呼び出しには、プロジェクトAPIキーによるBearer認証が必要です。

Authorization: Bearer YOUR_PROJECT_API_KEY

REST API

エージェントライフサイクル、リアルタイムエージェントインタラクション、プロアクティブ配信のためのパブリックHTTPエンドポイント。記憶、ムード、関係性、コンテキスト管理の内部処理はプラットフォームが行います。

サーバーサイド限定。APIはブラウザリクエストを受け付けません。Webアプリの場合はバックエンドを経由してプロキシしてください。 統合ガイドを参照してください。

エージェントライフサイクル

POST/api/v1/agents

新しいエージェントを作成します。プラットフォーム生成のUUID付きエージェントを返します。

パラメーター

namestringエージェント名（必須）
personality_promptstringカスタムシステムプロンプト（任意）
big5objectビッグファイブスコア: openness, conscientiousness, extraversion, agreeableness, neuroticism (0.0-1.0)
speech_patternsstring[]発話パターン（任意）
true_interestsstring[]エージェントの興味（任意）
project_idstringエージェントを割り当てるプロジェクトUUID（任意）
languagestringISO言語コード、例: "en"（任意）

レスポンス

{ "agent_id": "uuid", "name": "...", ... }

GET/api/v1/agents

エージェント一覧を取得。project_idクエリパラメーターでフィルタリング。

パラメーター

project_idstringプロジェクトでフィルタリング（クエリパラメーター、任意）

レスポンス

エージェントオブジェクトの配列

GET/api/v1/agents/{agentId}

IDでエージェントを取得。

レスポンス

パーソナリティ、ムード、プロフィールを含むエージェントオブジェクト

チャット

POST/api/v1/agents/{agentId}/chat

SSEストリーミングでエージェントとチャット。Server-Sent Eventsを返します。

パラメーター

messagesCEChatMessage[]会話メッセージ
user_idstringユーザー識別子

レスポンス

チャット完了チャンクのSSEストリーム

プロアクティブ通知

GET/api/v1/agents/{agentId}/notifications

保留中のプロアクティブメッセージ一覧。

パラメーター

statusstringステータスでフィルタリング: pending | consumed（デフォルト: pending、クエリパラメーター）
user_idstringユーザーでフィルタリング（任意、クエリパラメーター）
limitint最大結果数（デフォルト: 50、最大: 500、クエリパラメーター）

レスポンス

message_id, agent_id, user_id, check_type, intent, generated_message, status, created_atを含むプロアクティブメッセージのリスト

POST/api/v1/agents/{agentId}/notifications/{messageId}/consume

配信後に通知を消費済みとしてマーク。

レスポンス

確認

GET/api/v1/agents/{agentId}/notifications/history

すべてのステータスの通知一覧。

レスポンス

完全な通知履歴

エージェントライフサイクル（詳細）

CreateAgent

パーソナリティ設定で新しいエージェントを作成します。パーソナリティプロンプト、発話パターン、感情的傾向を生成します。

リクエスト

user_idstringオーナーユーザー識別子
agent_namestringエージェント表示名
genderstring"male", "female", または "non_binary"
biostringエージェントの経歴（任意）
avatar_urlstringアバター画像URL（任意）
big5CEBig5Scoresビッグファイブパーソナリティスコア (0.0-1.0)
languagestringプライマリ言語
equipped_outfitstring初期衣装ID（任意）
skillsCESkillLevel[]初期スキルレベル（任意）
model_tierint32LLMモデルティア（任意）
project_idstringエージェントを割り当てるプロジェクト（任意）
agent_idstring決定的エージェント用の呼び出し元指定ID（任意）
personality_promptstringカスタムシステムプロンプト（任意）
generate_goalsbool作成後に目標を自動生成（任意）
provided_goalsstring[]これらの目標を直接保存（任意）
speech_patternsstring[]発話パターン（任意）
true_interestsstring[]エージェントの興味（任意）
true_dislikesstring[]エージェントの嫌いなもの（任意）
user_display_namestringオーナー表示名（任意）
generate_avatarbool作成時にAIアバターを自動生成（デフォルト: true、1クレジット消費）。スキップするにはfalseに設定。

レスポンス

agent_id (UUID), status ('completed' または 'in_progress')

GetAgent

パーソナリティ、ムード、プロフィールを含むエージェントの現在の状態を取得します。

リクエスト

agent_idstringエージェントUUID

レスポンス

Agent ID, name, bio, gender, avatar_url, Big5 scores, owner, created_at

UpdateAgent

エージェントのフィールドを更新します（名前、経歴、アバター、パーソナリティ、興味、発話パターン）。

リクエスト

agent_idstringエージェントUUID
namestring新しい名前（任意）
biostring新しい経歴（任意）
avatar_urlstring新しいアバターURL（任意）
big5CEBig5Scores更新されたBig5スコア（任意）
true_interestsstring[]更新された興味（任意）
true_dislikesstring[]更新された嫌いなもの（任意）
speech_patternsstring[]更新された発話パターン（任意）
personality_promptstring更新されたシステムプロンプト（任意）

レスポンス

success (bool)

DeleteAgent

エージェントと関連するすべてのデータ（記憶、ムード、関係性）を完全に削除します。

リクエスト

agent_idstringエージェントUUID

レスポンス

success (bool)

RegenerateAvatar

エージェントのAI生成アバターを生成または再生成します。LLMを使用してパーソナリティデータから画像プロンプトを作成し、画像を生成・アップロードします。1クレジット消費。アバターは無効にしない限り、エージェント作成時に自動生成されます。

リクエスト

agent_idstringエージェントUUID（URLパラメーター）
stylestring任意のスタイルヒント（例: 'watercolor anime', 'realistic portrait'）

レスポンス

success (bool), avatar_url (string), prompt (string), generation_time_ms (int64)

UpdateAgentPersonality

プロダクトが意図的にエージェント設計を変更する場合に、エージェントの著者設定のBig5パーソナリティ設定を更新します。

リクエスト

agent_idstringエージェントUUID
big5CEBig5Scores信頼度付きの更新されたビッグファイブスコア

レスポンス

success (bool)

プロアクティブ動作

ScheduleWakeup

遅延後にエージェントがユーザーにプロアクティブに連絡するようスケジュールします。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
check_typestringチェックタイプ: check_in, follow_up, mood_driven
intentstringエージェントが連絡を取りたい理由
delay_hoursint32ウェイクアップまでの遅延時間

レスポンス

wakeup_id (string), scheduled_at (Timestamp)

GetPendingWakeups

エージェントの保留中のウェイクアップイベントを取得します。

リクエスト

agent_idstringエージェントUUID

レスポンス

PendingWakeupのリスト (wakeup_id, user_id, check_type, intent, scheduled_at)

ストリーミングチャット

主要なパブリック会話RPC。エージェント、ユーザー、アプリケーションコンテキスト、メッセージ履歴を送信します。プラットフォームがコンテキスト組み立てと状態更新を自動的に処理します。

StreamChat

エージェントインタラクションのAIレスポンスをストリーミングし、プラットフォームが内部の記憶と状態更新をバックグラウンドで処理します。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
session_idstring一意のセッションID
game_contextGameContextアプリケーション状態コンテキスト
messagesCEChatMessage[]会話メッセージ
continuation_tokenstring前のレスポンスから再開（任意）
request_typestring"chat", "guide", または "outing"
capabilitiesstring[]アンロックされた機能（任意）
languagestringISO言語コード（任意）
interaction_rolestring"owner" または "non_owner"
skill_levelsmap<string, int32>スキルレベル（任意）

レスポンス

StreamChatEventのストリーム (delta | message_boundary | complete | side_effects | error)

StreamChatEventは以下のイベントタイプを持つoneofです：

StreamChatDelta (delta)
contentstringAIからのテキストチャンク
message_indexint32マルチメッセージレスポンスでのインデックス
is_follow_upboolこれがフォローアップメッセージかどうか
replacementbooltrueの場合、前のすべてのコンテンツを置換
StreamChatComplete (complete)
full_contentstring完全なレスポンステキスト
finish_reasonstring"stop", "length", または "content_filter"
continuation_tokenstring会話を続けるためのトークン
message_countint32レスポンス内のメッセージ数
StreamChatError (error)
messagestringエラーメッセージ
codestringエラーコード

AI生成

経歴、目標、パーソナリティ、日記エントリ、画像のプラットフォーム管理AI コンテンツ生成。

GenerateBio

パーソナリティとコンテキストに基づいてAIを使用してエージェントの経歴を生成または書き換えます。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
current_biostring書き換え用の現在の経歴（任意）
stylestringスタイル: casual, formal, poetic など（任意）

レスポンス

bio (string), tone (string), confidence (double)

GenerateGoals

特性、興味、記憶に基づいてエージェントのパーソナリティ駆動の目標を生成します。

リクエスト

agent_idstringエージェントUUID
agent_namestringエージェント表示名
big5CEBig5ScoresBig5スコア
true_interestsstring[]エージェントの興味
true_dislikesstring[]エージェントの嫌いなもの
speech_patternsstring[]発話パターン
recent_memoriesCERecentMemory[]コンテキスト用の最近の記憶
current_goalsCEGoalSummary[]重複を避けるための既存の目標
max_goalsint32生成する最大目標数
model_configCEModelConfigLLMモデル設定（任意）
custom_contextmap<string, string>アプリケーション固有のコンテキスト（任意）

レスポンス

CEGeneratedGoalのリスト (type, title, description, priority, related_traits), reasoning

GeneratePersonality

テンプレートとBig5スコアから発話パターンと興味を生成します。

リクエスト

template_idstringテンプレート識別子
base_promptstringベースパーソナリティプロンプト
big5CEBig5ScoresBig5スコア
agent_namestringエージェント名
genderstringエージェントの性別

レスポンス

speech_patterns (string[]), true_interests (string[]), used_fallback (bool)

GenerateDiary

会話メッセージやアプリケーションイベントから日記エントリを生成します。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
datestringYYYY-MM-DD形式の日付
agent_namestringエージェント表示名
languagestring生成コンテンツの言語
messagesCEDiaryMessage[]会話メッセージ (role, content, time)
trigger_typestringdaily_summary, achievement, milestone, breakthrough
trigger_contextCEDiaryTriggerContextイベントトリガーコンテキスト（任意）
modelstringLLMモデルのオーバーライド（任意）
temperaturedoubleTemperatureのオーバーライド（任意）
timezonestring日付処理のタイムゾーン（任意）

レスポンス

user_id, date, diary (title, body_lines, tags), generation_time_ms

GenerateImage

テキストプロンプトから画像を生成し、クラウドストレージに保存します。

リクエスト

promptstring画像生成プロンプト
negative_promptstringネガティブプロンプト（任意）
modelstring使用するモデル（任意）
providerstring使用するプロバイダー（任意）
output_bucketstring出力用GCSバケット（任意）
output_pathstringバケット内の出力パス（任意）
cdn_domainstringパブリックURL用CDNドメイン（任意）

レスポンス

success, image_id, gcs_uri, public_url, mime_type, generation_time_ms, error

ボイス＆メディア

ボイスマッチング、テキスト読み上げ、ボイスチャット、リフレクション機能。

VoiceMatch

パーソナリティ特性に基づいて適切なTTSボイスにエージェントをマッチングします。

リクエスト

big5CEBig5Scoresマッチング用Big5スコア
preferred_genderstring希望のボイス性別（任意）
agent_idstringエージェントUUID（big5なしで提供された場合、自動ルックアップ）

レスポンス

voice_id, voice_name, match_score, reasoning

TextToSpeech

感情コンテキスト認識を備えたGoogle Geminiボイスによるテキスト読み上げ。

リクエスト

textstring変換するテキスト
voice_namestringGeminiボイス名
languagestring言語コード（任意）
emotional_contextCEEmotionalContext感情テーマとトーン（任意）

レスポンス

audio (bytes), content_type, voice_name

VoiceChat

シングルターンボイスチャット: 音声を書き起こし、AIレスポンスを生成し、TTS音声を返します。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
audiobytes生の音声データ
audio_formatstring音声フォーマット (opus, pcm, wav)
voice_namestringTTSボイス名
continuation_tokenstring前のターンから再開（任意）
languagestring言語コード（任意）
game_idstringアプリケーション識別子（任意）

レスポンス

transcript, response (text), audio (bytes), content_type, continuation_token, side_effects_json

ListVoices

利用可能なGemini TTSボイスの一覧。オプションで性別フィルタリング。

リクエスト

genderstring性別でフィルタリング（任意）

レスポンス

CEGeminiVoiceのリスト (name, gender)

Reflect

機能アンロック、マイルストーン、その他のイベントに関するAIリフレクションを生成します。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
reflection_typestring"capability_unlock", "milestone" など
capabilitystring機能名
capability_sourcestring機能のソース
contextstring追加コンテキスト文字列（任意）
new_capabilities_jsonbytes新しい機能JSON（任意）
session_idstring自動コンテキストビルド用セッションID（任意）
interaction_rolestring"owner" または "non_owner"（デフォルト: "owner"）

レスポンス

success (bool), reflection (string), side_effects_json (bytes)

ストリーミングボイスチャット

サーバーサイドVAD（音声活動検出）を備えた双方向ストリーミングボイスチャット。クライアントは音声チャンクを連続的にストリーミングし、サーバーが音声検出、書き起こし、AIレスポンス、TTSを処理します。

StreamVoiceChat

双方向ストリーミング: クライアントがinit＋音声チャンクを送信し、サーバーがトランスクリプトとTTS音声を返します。手動停止ボタンは不要です。

リクエスト

initVoiceChatInit最初のメッセージ: セッション初期化
audio_chunkVoiceAudioChunk後続メッセージ: 生の音声データ

レスポンス

イベントストリーム: ready | vad | transcript | response_delta | audio | turn_complete | error

VoiceChatInit
agent_idstringエージェントUUID
user_idstringユーザー識別子
audio_formatstring"opus", "pcm", "wav"（デフォルト: "opus"）
sample_rateint32サンプルレート（Hz）（デフォルト: opus用48000）
voice_namestringTTSボイス名
languagestring言語コード（デフォルト: "en"）
game_idstringアプリケーション識別子
continuation_tokenstring前のセッションから再開（任意）
VoiceAudioChunk
audiobytes生の音声データ（例：Opusフレーム）
end_of_speechbool任意のクライアントサイドVADヒント

サーバーレスポンスイベント：

VoiceStreamReady
session_idstring割り当てられたセッションID
VoiceStreamVAD
speakingbooltrue = 発話開始, false = 発話終了
VoiceStreamTranscript
textstringトランスクリプトテキスト
is_finalbooltrue = この発話の最終トランスクリプト
VoiceStreamAudio
audiobytes音声データチャンク
content_typestring例: "audio/opus", "audio/wav"
VoiceStreamTurnComplete
continuation_tokenstringセッションを継続するためのトークン
side_effects_jsonbytesJSONシリアライズされたAgentSideEffects（任意）
VoiceStreamError
messagestringエラーメッセージ
codestring"vad_error", "stt_error", "llm_error", "tts_error"
fatalbooltrueの場合、セッションを閉じる必要あり

分析＆検索

AIを活用した会話分析、要約、グラウンデッド検索。

AnalyzeConversation

会話を分析して副作用（パーソナリティ変化、習慣、記憶など）を抽出します。

リクエスト

agent_idstringエージェントUUID
agent_namestringエージェント表示名
user_idstringユーザー識別子
messagesCEAnalyzeConversationMessage[]分析するメッセージ (role, content)
is_finalboolこれがメッセージの最終バッチかどうか

レスポンス

success, side_effects_json (bytes), summary, latency_ms

SummarizeConversation

トピック抽出を含む会話の簡潔な要約を生成します。

リクエスト

messagesCESummarizeConversationMessage[]メッセージ (role, content, time)
agent_namestringエージェント名
user_namestringユーザー表示名
max_summary_lengthint32要約の最大文字数

レスポンス

summary (string), topics (string[]), message_count (int)

GenerateSearchQuery

トピックとカテゴリからWeb検索用の最適化された検索クエリを生成します。

リクエスト

topicstring検索するトピック
categorystringコンテキスト用カテゴリ

レスポンス

query (string), context (string)

GroundedSearch

複数のクエリでグラウンデッドWeb検索を実行し、ソース付きの要約結果を返します。

リクエスト

queriesstring[]検索クエリ
contextstring検索関連性のコンテキスト
agent_namestringレスポンスフレーミング用エージェント名

レスポンス

CEGroundedSearchResultのリスト (query, summary, sources with title/url/snippet)

マルチエージェント対話

アウティング、対話、マルチエージェントシーンのためのエージェント間会話。

AgentDialogue

マルチエージェント対話コンテキスト（例：エージェント間のアウティング）でエージェントのレスポンスを生成します。

リクエスト

agent_idstringエージェントUUID（応答するエージェント）
user_idstringユーザー識別子
messagesCEChatMessage[]対話メッセージ
request_typestring"outing", "dialogue" など
scene_guidancestringシーン固有のプロンプトガイダンス
tool_config_jsonbytesツール設定JSON（任意）
session_idstring自動コンテキストビルド用セッションID（任意）
interaction_rolestring"owner" または "non_owner"（デフォルト: "owner"）

レスポンス

response (string), side_effects_json (bytes)

アプリケーションイベント

重要なアプリケーションイベントについてプラットフォームに通知します。プラットフォームは日記エントリの生成、目標の更新、その他のAIアクションを実行する場合があります。日記が作成されるとOnDiaryGenerated webhookが発火します。

TriggerGameEvent

アプリケーションイベント（達成、マイルストーン、ブレイクスルー、完了）を受け入れ、AIコンテンツ生成をトリガーします。

リクエスト

agent_idstringエージェントUUID
user_idstringユーザー識別子
event_typestring"achievement", "milestone", "breakthrough", "level_up"
event_descriptionstringAI用の人間可読なコンテキスト
metadatamap<string, string>追加コンテキスト (achievement_id, level など)
languagestring生成コンテンツの言語（デフォルト: "en"）

レスポンス

accepted (bool), event_id (string)

ナレッジベース

プロジェクトスコープのナレッジグラフ。ドキュメントをアップロードするか、API経由で構造化データをプッシュします -- プラットフォームがエンティティを抽出し、グラフを構築し、エージェントに会話中にクエリするためのknowledge_searchツールを提供します。

ドキュメント

POST/projects/{projectId}/knowledge/documents

ドキュメントをアップロード（'file'フィールドのmultipart/form-data、最大50 MB）。202を返し、document_idとともに非同期抽出をトリガーします。

パラメーター

filemultipartドキュメントファイル

レスポンス

document_id, file_name, file_size, checksum, status, gcs_path

GET/projects/{projectId}/knowledge/documents

ドキュメント一覧。クエリ: limit（デフォルト50、最大200）。

レスポンス

documents[], total

GET/projects/{projectId}/knowledge/documents/{docId}

単一のドキュメントを取得。

レスポンス

KBDocumentオブジェクト

DELETE/projects/{projectId}/knowledge/documents/{docId}

ドキュメントを削除。

レスポンス

204 No Content

ファクト＆グラフ

POST/projects/{projectId}/knowledge/facts

ナレッジグラフにエンティティとリレーションシップを挿入。既存ノードに対して解決し、バージョン履歴付きで作成/更新します。

パラメーター

sourcestringソース識別子（デフォルト: 'api'）
facts[]arrayエンティティ: entity_type, label, properties
relationships[]arrayエッジ: from_label, to_label, edge_type

レスポンス

processed, created, updated, details[]

GET/projects/{projectId}/knowledge/nodes

ナレッジグラフノード一覧。クエリ: type（フィルター）、limit（デフォルト100、最大500）。

レスポンス

nodes[], total

GET/projects/{projectId}/knowledge/nodes/{nodeId}

接続されたエッジ付きのノードを取得。クエリ: history=trueでバージョン履歴。

レスポンス

node, outgoing[], incoming[], history[]

DELETE/projects/{projectId}/knowledge/nodes/{nodeId}

ノードを論理削除（is_active=falseに設定）。

レスポンス

204 No Content

GET/projects/{projectId}/knowledge/nodes/{nodeId}/history

ノードのバージョン履歴を取得。クエリ: limit（デフォルト50、最大200）。

レスポンス

history[], total

検索

GET/projects/{projectId}/knowledge/search

グラフトラバーサル付き全文検索。クエリ: q（必須）、limit、history、type、filters（JSON）。

パラメーター

qstring検索クエリ（必須）
limitint最大結果数（デフォルト20、最大100）
typestringフィルターするエンティティタイプ（カンマ区切り）
filtersJSON stringプロパティフィルターオブジェクト
historyboolバージョン履歴を含める

レスポンス

query, results[]（関連ノード付き）, total

スキーマ

POST/projects/{projectId}/knowledge/schemas

フィールドと任意の類似性設定を持つエンティティタイプスキーマを作成。

パラメーター

entity_typestringエンティティタイプ名（必須）
fields[]arrayフィールド定義: name, type, required
descriptionstringスキーマの説明
similarity_configobjectmatch_fields[], threshold

レスポンス

KBEntitySchemaオブジェクト

GET/projects/{projectId}/knowledge/schemas

プロジェクトのエンティティスキーマ一覧。

レスポンス

schemas[], total

PUT/projects/{projectId}/knowledge/schemas/{schemaId}

エンティティスキーマを更新。

パラメーター

entity_typestring更新されたエンティティタイプ名
fields[]array更新されたフィールド定義

レスポンス

KBEntitySchemaオブジェクト

DELETE/projects/{projectId}/knowledge/schemas/{schemaId}

エンティティスキーマを削除。

レスポンス

204 No Content

統計

GET/projects/{projectId}/knowledge/stats

ナレッジベース統計を取得（ドキュメント数、ノード数、エッジ数、抽出トークン数）。

レスポンス

documents {total, indexed, pending, failed}, nodes {total, active}, edges, extraction_tokens

アナリティクス

POST/projects/{projectId}/knowledge/analytics/rules

アナリティクスルール（レコメンデーションまたはトレンド）を作成。

パラメーター

rule_typestring'recommendation' または 'trend'
namestringルール名
configobjectルール設定
enabledboolルールが有効かどうか

レスポンス

KBAnalyticsRuleオブジェクト

GET/projects/{projectId}/knowledge/analytics/recommendations

レコメンデーションを取得。クエリ: rule_id, source_id（両方必須）, limit。

レスポンス

recommendations[], total

GET/projects/{projectId}/knowledge/analytics/trends

トレンド集計を取得。クエリ: node_id（必須）。

レスポンス

trends[], total

POST/projects/{projectId}/knowledge/analytics/feedback

レコメンデーションフィードバック（表示/コンバージョン）を記録。

パラメーター

source_node_idstringソースノードID
target_node_idstringターゲットノードID
rule_idstringアナリティクスルールID
convertedboolユーザーがコンバージョンしたかどうか
score_at_timefloatレコメンデーション表示時のスコア

レスポンス

status: 'recorded'

ユーザープライミング

ユーザーメタデータとコンテンツを事前ロードして、AIエージェントが最初の会話からユーザーを「知っている」状態にします。メタデータ（名前、会社、役職）は即座にファクトになります。コンテンツブロック（テキスト、チャットトランスクリプト）はLLM抽出を介して非同期で処理されます。

ユーザーのプライミング

POST/agents/{agentId}/users/{userId}/prime

メタデータとコンテンツでユーザーをプライミング。202をジョブIDとともに返します。コンテンツのLLM抽出は非同期で実行されます。

パラメーター

display_namestringユーザーの表示名
metadataobjectcompany, title, email, phone, custom (map)
content[]arrayコンテンツブロック: type ('text', 'chat_transcript'), body
sourcestringソース識別子（例: 'crm', 'linkedin'）

レスポンス

job_id, status ('queued'), facts_created

GET/agents/{agentId}/users/{userId}/prime/{jobId}

プライミングジョブのステータスを取得。

レスポンス

ImportJobオブジェクト (job_id, status, facts_created, error_message など)

コンテンツ

POST/agents/{agentId}/users/{userId}/content

非同期LLM抽出用のコンテンツブロックを追加（例：プライミング後にチャットトランスクリプトを追加）。

パラメーター

content[]arrayコンテンツブロック: type, body
sourcestringソース識別子

レスポンス

job_id, status ('queued')

メタデータ

GET/agents/{agentId}/users/{userId}/metadata

ユーザーのプライミングメタデータを取得。

レスポンス

UserPrimingMetadataオブジェクト

PATCH/agents/{agentId}/users/{userId}/metadata

プライミングメタデータを部分更新。更新されたフィールドから新しいファクトが自動生成されます。

パラメーター

display_namestring更新された名前
companystring更新された会社
titlestring更新された役職
emailstring更新されたメール
phonestring更新された電話番号
custommapカスタムキーバリューペア（マージ）

レスポンス

metadata（更新済み）, facts_created

バッチインポート

POST/agents/{agentId}/users/import

単一のリクエストでメタデータとコンテンツを含む複数のユーザーをインポート。メタデータファクトは同期的に作成。コンテンツ抽出は非同期で実行。

パラメーター

users[]array{user_id, display_name, metadata, content[]}の配列
sourcestringソース識別子

レスポンス

job_id, status ('queued'), total_users, facts_created

GET/agents/{agentId}/users/import/{jobId}

バッチインポートジョブのステータスを取得。

レスポンス

ImportJobオブジェクト

GET/agents/{agentId}/users/imports

エージェントの最近のインポートジョブ一覧。クエリ: limit（デフォルト20）。

レスポンス

jobs[], count

共通型

GameContext
custom_fieldsmap<string, string>プロンプトにパススルーされるアプリケーション固有の任意キーバリューペア
game_state_jsonbytes任意の構造化状態（JSON）（プロンプトにパススルー）
CEBig5Scores
opennessdouble経験への開放性 (0.0-1.0)
conscientiousnessdouble組織性と規律 (0.0-1.0)
extraversiondouble社交的エネルギーと熱意 (0.0-1.0)
agreeablenessdouble温かさと協調性 (0.0-1.0)
neuroticismdouble感情的敏感さ (0.0-1.0)
confidencedouble評価の信頼度 (0.0-1.0)
MoodState
valencedouble快-不快スペクトラム (0-100)
arousaldouble活性化/エネルギーレベル (0-100)
tensiondoubleストレス/穏やかさ状態 (0-100)
affiliationdouble社会的温かさ/親密さ (0-100)
CEChatMessage
rolestring"user" または "assistant"
contentstringメッセージテキスト
timestampTimestampメッセージ送信時刻
MemoryCandidate
contentstring記憶コンテンツテキスト
fact_typestringpreference, commitment, fact, experience, correction
importancedouble重要度スコア (0.0-1.0)
entitiesstring[]関連エンティティ
Habit
namestring習慣名
categorystring習慣カテゴリ
strengthdouble現在の強度 (0.0-1.0)
last_observedTimestamp最終観測時刻
is_formedbool習慣が完全に形成されているかどうか
CEGoal
idstring目標識別子
descriptionstring目標の説明
statusstring"active", "completed", "abandoned"
prioritystring優先度レベル
related_traitsstring[]関連パーソナリティ特性
created_atTimestamp目標作成時刻
Interest
topicstring興味のトピック
categorystring興味のカテゴリ
confidencedouble検出信頼度 (0.0-1.0)
discovered_atTimestamp興味が発見された時刻
research_statusstring"pending" または "researched"
CEModelConfig
providerstringLLMプロバイダー名
modelstringモデル識別子
temperaturedoubleサンプリングTemperature
max_tokensint32生成する最大トークン数
ProactiveMessage
message_idstring一意のメッセージ識別子
agent_idstringメッセージを生成したエージェント
user_idstringターゲットユーザー
wakeup_idstring関連するウェイクアップイベント
check_typestringチェックタイプ (check_in, follow_up, mood_driven)
intentstringエージェントが連絡を取りたい理由
generated_messagestring実際のメッセージテキスト
statusstringpending, consumed, expired, failed_generation
created_atTimestamp生成時刻
← 統合ガイドMCP統合→