API リファレンス
N.E.K.O. は FastAPI を通じて包括的な API を公開しています。すべてのエンドポイントはメインサーバー(デフォルト http://localhost:48911)から提供されます。
ベース URL
http://localhost:48911認証
ローカルアクセスでは認証は不要です。LLM プロバイダーの API キーは設定システムで別途管理されます。
REST エンドポイント
| ルーター | プレフィックス | 説明 |
|---|---|---|
| Config | /api/config | API キー、ユーザー設定、プロバイダー設定 |
| Characters | /api/characters | キャラクターの CRUD、音声設定、マイク |
| Live2D | /api/live2d | Live2D モデル管理、感情マッピング |
| VRM | /api/model/vrm | VRM モデル管理、アニメーション |
| Memory | /api/memory | メモリファイル、レビュー設定 |
| Agent | /api/agent | エージェントフラグ、タスク、ヘルスチェック |
| Workshop | /api/steam/workshop | Steam Workshop アイテム、パブリッシュ |
| System | /api | 感情分析、スクリーンショット、ユーティリティ |
WebSocket
| エンドポイント | 説明 |
|---|---|
| プロトコル | 接続ライフサイクルとセッション管理 |
| メッセージタイプ | すべてのクライアント→サーバーおよびサーバー→クライアントのメッセージフォーマット |
| オーディオストリーミング | バイナリオーディオフォーマット、割り込み、リサンプリング |
内部 API
これらはサービス間 API であり、外部からの使用を意図していません:
| サーバー | 説明 |
|---|---|
| Memory Server | メモリの保存と取得(ポート 48912) |
| Agent Server | エージェントタスクの実行(ポート 48915) |
レスポンスフォーマット
すべての REST エンドポイントは JSON を返します。成功レスポンスは通常、データを直接含みます。エラーレスポンスは FastAPI のデフォルトフォーマットに従います:
json
{
"detail": "Error message describing what went wrong"
}コンテンツタイプ
application/json— ほとんどのエンドポイントmultipart/form-data— ファイルアップロード(モデル、音声サンプル)audio/*— 音声プレビューレスポンス
