最終更新: 2026-03-06 ベースURL:
http://localhost:18500関連: spec.ja.md, cli-reference.ja.md
| 方式 | 説明 |
|---|---|
| セッションクッキー | POST /api/auth/login で取得した session_token クッキー |
| localhost 信頼 | trust_localhost: true（デフォルト）時、localhost からの接続は認証不要 |
| local_trust モード | auth.json の mode: "local_trust" 時、全リクエスト認証不要 |
認証不要エンドポイント: /api/auth/login, /api/setup/*, /api/system/health, /api/webhooks/*
- 認証 (Auth)
- Anima 管理
- チャット
- 共有チャネル・DM
- 記憶 (Memory)
- セッション・履歴
- システム
- アセット
- 設定 (Config)
- ログ
- ユーザー管理
- ツールプロンプト
- セットアップ
- Webhook
- WebSocket
- 内部 API
ログインしセッションクッキーを取得する。
リクエスト:
{ "username": "string", "password": "string" }レスポンス: 200 OK
{ "username": "admin", "display_name": "管理者", "role": "owner" }Set-Cookie: session_token=...
セッションを破棄する。
レスポンス: 200 OK — { "status": "ok" }
現在のログインユーザー情報を取得する。
レスポンス:
{
"username": "admin",
"display_name": "管理者",
"bio": "",
"role": "owner",
"auth_mode": "password",
"has_password": true
}全 Anima の一覧を取得する。
レスポンス:
[
{
"name": "alice",
"status": "running",
"bootstrapping": false,
"pid": 12345,
"uptime_sec": 3600,
"appearance": "anime",
"supervisor": null,
"speciality": "engineer",
"role": "engineer",
"model": "claude-opus-4-6"
}
]Anima の詳細情報を取得する。
| パスパラメータ | 型 | 説明 |
|---|---|---|
name |
string | Anima 名 |
レスポンス:
{
"status": { "enabled": true, "model": "claude-opus-4-6", "...": "..." },
"identity": "# Alice\n...",
"injection": "## 役割\n...",
"state": "現在のタスク内容",
"pending": "バックログ内容",
"knowledge_files": ["topic1.md"],
"episode_files": ["2026-03-05.md"],
"procedure_files": ["deploy.md"]
}解決済みのモデル設定を取得する。
レスポンス:
{
"anima": "alice",
"model": "claude-opus-4-6",
"execution_mode": "S",
"config": { "max_turns": 200, "max_chains": 10, "..." : "..." }
}Anima を有効化する。
レスポンス: 200 OK — { "name": "alice", "enabled": true }
Anima を無効化する（約30秒でプロセス停止）。
レスポンス: 200 OK — { "name": "alice", "enabled": false }
Anima プロセスを起動する。
レスポンス: 200 OK — { "status": "started", "name": "alice" }
既に起動中の場合: { "status": "already_running", "current_status": "..." }
Anima プロセスを停止する。
レスポンス: 200 OK — { "status": "stopped", "name": "alice" }
Anima プロセスを再起動する。
レスポンス: 200 OK — { "status": "restarted", "name": "alice", "pid": 12346 }
実行中の LLM セッションを中断する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
thread_id |
string | null | 中断対象スレッド ID |
レスポンス: 200 OK — IPC 結果 or { "status": "timeout" }
status.json のホットリロードを実行する（プロセス再起動不要）。
レスポンス: 200 OK — IPC 結果
全 Anima の設定をホットリロードする。
レスポンス: 200 OK — { "status": "ok", "results": { "alice": "...", "..." : "..." } }
ハートビートを手動でトリガーする。
レスポンス: 200 OK — IPC 結果 | 504 タイムアウト
バックグラウンドタスク（submit 経由の非同期ツール実行）の一覧を取得する。
レスポンス: 200 OK — { "tasks": [{ "task_id": "...", "status": "...", "..." : "..." }] }
特定のバックグラウンドタスクの詳細を取得する。
組織チャート（階層構造）を取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
include_disabled |
bool | false | 無効化された Anima も含める |
format |
string | "json" | json or text（テキストツリー） |
レスポンス (JSON):
{
"generated_at": "2026-03-06T10:00:00+09:00",
"total": 5,
"tree": { "alice": { "children": { "bob": { "children": {} } } } },
"flat": [{ "name": "alice", "supervisor": null, "role": "manager" }]
}非ストリーミングでチャットメッセージを送信する。
リクエスト:
{
"message": "こんにちは",
"from_person": "human",
"intent": "",
"images": [{ "data": "base64...", "media_type": "image/png" }],
"resume": null,
"last_event_id": null,
"thread_id": "default"
}| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
message |
string | 必須 | メッセージ本文 |
from_person |
string | 任意 | 送信者名（デフォルト: "human"） |
intent |
string | 任意 | インテント（delegation, report, question） |
images |
array | 任意 | 画像添付（base64 + media_type） |
resume |
string | 任意 | セッション再開用 ID |
last_event_id |
string | 任意 | SSE 再接続用イベント ID |
thread_id |
string | 任意 | スレッド ID（デフォルト: "default"） |
レスポンス:
{ "response": "こんにちは！何かお手伝いできますか？", "anima": "alice", "images": [] }SSE（Server-Sent Events）でストリーミングチャットを行う。
リクエスト: POST /api/animas/{name}/chat と同一
レスポンス: text/event-stream
event: text
data: {"text": "こん", "emotion": "happy"}
event: tool_start
data: {"tool": "search_memory", "input": {"query": "..."}}
event: tool_end
data: {"tool": "search_memory", "result": "..."}
event: tool_detail
data: {"tool": "search_memory", "status": "running", "summary": "..."}
event: thinking
data: {"text": "考え中..."}
event: done
data: {"response_id": "abc123", "emotion": "neutral"}
event: error
data: {"error": "メッセージ"}
挨拶を生成する（会話を開始せずに応答のみ取得）。
レスポンス:
{ "response": "おはようございます！", "emotion": "happy", "cached": false, "anima": "alice" }現在アクティブなストリームの状態を取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
thread_id |
string | null | スレッド ID |
レスポンス:
{
"active": true,
"response_id": "abc123",
"status": "streaming",
"full_text": "途中までのテキスト...",
"active_tool": "search_memory",
"tool_history": [{ "tool": "...", "result": "..." }],
"last_event_id": "evt_42",
"event_count": 15,
"emotion": "neutral"
}特定のストリームの進捗を取得する。
共有チャネルの一覧を取得する。
レスポンス:
[
{ "name": "general", "message_count": 42, "last_post_ts": "2026-03-06T09:00:00Z" }
]チャネルのメッセージを取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit |
int | 50 | 最大取得件数 |
offset |
int | 0 | オフセット |
レスポンス:
{
"channel": "general",
"messages": [{ "from": "alice", "text": "報告です", "ts": "..." }],
"total": 100,
"offset": 0,
"limit": 50,
"has_more": true
}チャネルにメッセージを投稿する。
リクエスト:
{ "text": "お知らせです", "from_name": "alice" }レスポンス: 200 OK — { "status": "ok", "channel": "general" }
特定 Anima へのメンションを取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit |
int | 10 | 最大件数 |
DM 会話ペアの一覧を取得する。
レスポンス:
[
{ "pair": "alice-bob", "participants": ["alice", "bob"], "message_count": 15, "last_message_ts": "..." }
]DM 履歴を取得する（pair は alice-bob 形式）。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit |
int | 50 | 最大件数 |
エピソード記憶の一覧を取得する。
レスポンス: { "files": ["2026-03-05.md", "2026-03-04.md"] }
特定日のエピソード記憶を取得する。
レスポンス: { "date": "2026-03-05", "content": "# 2026-03-05\n..." }
知識記憶の一覧を取得する。
レスポンス: { "files": ["deploy-procedure.md", "api-design.md"] }
特定の知識記憶を取得する。
手続き記憶の一覧を取得する。
特定の手続き記憶を取得する。
現在の会話状態を取得する。
レスポンス:
{
"anima": "alice",
"total_turn_count": 24,
"raw_turns": 24,
"compressed_turn_count": 5,
"has_summary": true,
"summary_preview": "これまでの会話の要約...",
"total_token_estimate": 15000,
"turns": [{ "role": "user", "content": "..." }]
}会話履歴をクリアする。
レスポンス: { "status": "cleared", "anima": "alice" }
会話履歴を圧縮する。
レスポンス:
{ "compressed": true, "anima": "alice", "total_turn_count": 5, "total_token_estimate": 3000 }記憶の統計情報を取得する。
レスポンス:
{
"anima": "alice",
"episodes": { "count": 20, "total_bytes": 45000 },
"knowledge": { "count": 15, "total_bytes": 32000 },
"procedures": { "count": 5, "total_bytes": 8000 }
}セッション一覧を取得する。
レスポンス:
{
"anima": "alice",
"active_conversation": { "turn_count": 10, "..." : "..." },
"threads": ["default", "thread-abc"],
"archived_sessions": ["session_20260305_1234.json"],
"episodes": ["2026-03-05.md"],
"transcripts": ["2026-03-05.md"]
}アクティビティログベースの会話履歴を取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit |
int | 50 | 最大件数 |
before |
string | null | このタイムスタンプ以前を取得 |
thread_id |
string | "default" | スレッド ID |
strict_thread |
bool | false | スレッド厳密一致 |
アーカイブされたセッションの詳細を取得する。
トランスクリプト（会話記録）を取得する。
ヘルスチェック（認証不要）。
レスポンス: 200 OK — { "status": "ok" }
システム全体の状態を取得する。
レスポンス:
{
"animas": [{ "name": "alice", "status": "running", "..." : "..." }],
"processes": { "alice": { "pid": 12345, "uptime": 3600 } },
"scheduler_running": true
}WebSocket・プロセス接続情報を取得する。
スケジューラ（heartbeat / cron）の状態を取得する。
レスポンス:
{
"running": true,
"system_jobs": [{ "id": "...", "next_run": "..." }],
"anima_jobs": { "alice": [{ "type": "heartbeat", "next_run": "..." }] }
}Anima プロセスの再読み込み（新規追加・変更検出）を実行する。
レスポンス: { "added": 1, "refreshed": 2, "skipped_busy": 0, "removed": 0, "total": 5 }
全 Anima の最近のアクティビティを取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
hours |
int | 48 | 取得期間（時間） |
anima |
string | null | Anima 名でフィルタ |
offset |
int | 0 | オフセット |
limit |
int | 200 | 最大件数 |
event_type |
string | null | イベントタイプでフィルタ |
grouped |
bool | false | トリガーベースでグルーピング |
group_limit |
int | 50 | グループ最大数 |
group_offset |
int | 0 | グループオフセット |
トークン使用量とコスト推定を取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
anima |
string | null | 特定 Anima のみ |
days |
int | 30 | 集計期間（日） |
全設定（config, credentials, Slack, Anima プロセス）を一括ホットリロードする。
Slack 接続のみリロードする。
認証情報のみリロードする。
Anima プロセスのみリロードする。
サーバーのログレベルを取得・設定する。
POST リクエスト:
{ "level": "DEBUG", "logger_name": "core.memory" }表示モード（anime / realistic）を変更する。
リクエスト: { "mode": "anime" } or { "mode": "realistic" }
フロントエンドログの送信・閲覧。
アセットファイルの一覧を取得する。
レスポンス: { "assets": [{ "name": "fullbody.png", "size": 245000 }] }
アセットメタデータ（表情・アニメーション・カラー情報含む）を取得する。
アセットファイルを取得する（ETag / 304 対応）。
チャット添付ファイルを取得する。
外部画像をプロキシ経由で取得する（SSRF 対策済み）。
| クエリパラメータ | 型 | 説明 |
|---|---|---|
url |
string | プロキシ対象の画像 URL |
キャラクターアセットを生成する。
リクエスト:
{
"prompt": "カスタムプロンプト",
"negative_prompt": "除外ワード",
"steps": 28,
"skip_existing": true,
"image_style": "anime"
}表情アセットをオンデマンド生成する。
リクエスト: { "expression": "angry", "image_style": "anime" }
リメイクプレビューを生成する（Vibe Transfer）。
リクエスト:
{
"style_from": "bob",
"vibe_strength": 0.6,
"vibe_info_extracted": 0.8,
"prompt": null,
"seed": null,
"image_style": "anime",
"backup_id": null
}リメイクを確定し既存アセットを置換する。
リクエスト: { "backup_id": "bk_abc123", "image_style": "anime" }
リメイクプレビューをキャンセルしバックアップを復元する。
config.json の内容を取得する（API キーはマスク済み）。
初期化状態を確認する。
レスポンス:
{
"checks": { "config_exists": true, "..." : "..." },
"config_exists": true,
"animas_count": 3,
"api_keys": { "anthropic": true, "openai": false },
"shared_dir_exists": true,
"initialized": true
}ログファイルの一覧を取得する。
レスポンス:
{ "files": [{ "name": "animaworks.log", "path": "...", "size_bytes": 150000, "modified": "..." }] }SSE でログをリアルタイムストリーミングする。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
file |
string | "animaworks.log" | ログファイル名 |
ログファイルの内容を取得する。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
offset |
int | 0 | 開始行 |
limit |
int | 200 | 最大行数 |
パス指定でログファイルを読み取る。
| クエリパラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
file |
string | 必須 | ファイルパス |
offset |
int | 0 | 開始行 |
limit |
int | 200 | 最大行数 |
ユーザー一覧を取得する。
レスポンス:
[{ "username": "admin", "display_name": "管理者", "bio": "", "role": "owner", "created_at": "..." }]ユーザーを追加する（owner 権限が必要）。
リクエスト:
{ "username": "user1", "display_name": "ユーザー1", "password": "pass", "bio": "" }ユーザーを削除する（owner 権限が必要）。
自分のパスワードを変更する。
リクエスト: { "current_password": "old", "new_password": "new" }
Anima のツール説明・ガイド・システムプロンプトセクションを管理する API。
全ツール説明の一覧を取得する。
個別ツール説明の取得・更新。
全ガイドの一覧を取得する。
個別ガイドの取得・更新。
全システムプロンプトセクションの一覧を取得する。
個別セクションの取得・更新。
ツールスキーマのプレビューを生成する。
リクエスト: { "mode": "anthropic" } — anthropic, litellm, text から選択
特定 Anima のシステムプロンプトをプレビューする。
リクエスト: { "anima_name": "alice" }
レスポンス:
{
"anima_name": "alice",
"execution_mode": "S",
"system_prompt": "...",
"token_estimate": 8500,
"char_count": 34000
}初回セットアップ用 API（全て認証不要）。
セットアップ環境情報を取得する。
レスポンス:
{
"claude_code_available": true,
"locale": "ja",
"providers": ["anthropic", "openai"],
"available_locales": ["ja", "en"]
}Accept-Language ヘッダーからロケールを検出する。
API キーの有効性を検証する。
リクエスト: { "provider": "anthropic", "api_key": "sk-..." }
セットアップを完了する。
リクエスト:
{
"locale": "ja",
"credentials": { "anthropic": { "api_key": "sk-..." } },
"anima": { "name": "alice", "template": "default" },
"user": { "username": "admin", "password": "pass" },
"image_style": "anime"
}外部プラットフォームからのイベント受信（認証不要、署名検証あり）。
Slack Event API からのイベントを受信する（URL 検証 challenge 対応）。
Chatwork Webhook からのイベントを受信する。
メイン WebSocket。ダッシュボード・チャット UI のリアルタイム更新用。
サーバー→クライアント イベント:
| イベント | 説明 |
|---|---|
anima_status |
Anima のステータス変更 |
chat_response |
チャット応答テキスト |
tool_activity |
ツール使用状況 |
heartbeat |
定期的な生存確認（ping） |
クライアント→サーバー:
| メッセージ | 説明 |
|---|---|
{ "type": "pong" } |
heartbeat 応答 |
音声チャット WebSocket。
認証: 接続後に { "type": "auth", "token": "SESSION_TOKEN" } を送信（localhost 信頼時は不要）。
クライアント→サーバー:
| 形式 | 説明 |
|---|---|
| binary | 16kHz mono 16-bit PCM 音声データ |
{ "type": "speech_end" } |
発話終了（STT 実行トリガー） |
{ "type": "interrupt" } |
TTS 再生中断（barge-in） |
{ "type": "config", ... } |
設定変更 |
サーバー→クライアント:
| タイプ | 形式 | 説明 |
|---|---|---|
status |
JSON | セッション状態変更 |
transcript |
JSON | STT 結果テキスト |
response_text |
JSON | Anima 応答テキスト（チャンク） |
tts_audio |
binary | TTS 音声データ |
tts_start / tts_done |
JSON | TTS 開始/完了通知 |
error |
JSON | エラー通知 |
CLI から送信されたメッセージの通知（UI 更新用）。
リクエスト:
{ "from_person": "alice", "to_person": "bob", "content": "報告です", "message_id": "msg_123" }保存されたメッセージを取得する。
チャット UI のペイン・タブ状態を取得する。
チャット UI の状態を保存する。
リクエスト: { "state": { "version": 1, "active_anima": "alice", "..." : "..." } }