Skip to content

API リファレンス

N.E.K.O. は FastAPI を通じて包括的な API を公開しています。すべてのエンドポイントはメインサーバー(デフォルト http://localhost:48911)から提供されます。

ベース URL

http://localhost:48911

認証

ローカルアクセスでは認証は不要です。LLM プロバイダーの API キーは設定システムで別途管理されます。

REST エンドポイント

ルータープレフィックス説明
Config/api/configAPI キー、ユーザー設定、プロバイダー設定
Characters/api/charactersキャラクターの CRUD、音声設定、マイク
Live2D/api/live2dLive2D モデル管理、感情マッピング
VRM/api/model/vrmVRM モデル管理、アニメーション
Memory/api/memoryメモリファイル、レビュー設定
Agent/api/agentエージェントフラグ、タスク、ヘルスチェック
Workshop/api/steam/workshopSteam 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/* — 音声プレビューレスポンス

MIT ライセンスの下で公開。