API Reference

N.E.K.O. exposes a comprehensive API surface through FastAPI. All endpoints are served from the main server (default http://localhost:48911).

Base URL

http://localhost:48911

Authentication

The API does not require authentication for local access. API keys for LLM providers are managed separately through the Configuration system.

REST endpoints

Router	Prefix	Description
Config	/api/config	API keys, preferences, provider settings
Characters	/api/characters	Character CRUD, voice settings, microphone
Live2D	/api/live2d	Live2D model management, emotion mapping
VRM	/api/model/vrm	VRM model management, animations
Memory	/api/memory	Memory files, review configuration
Agent	/api/agent	Agent flags, tasks, health checks
Workshop	/api/steam/workshop	Steam Workshop items, publishing
MMD	/api/model/mmd	MMD model management
PNGTuber	/api/model/pngtuber	PNGTuber model management
Music	/api/music	Music search and playback proxy
Jukebox	/api/jukebox	Song and action library
Game	/api/game	Minigame backend
Galgame	/api/galgame	Galgame reply options
Icebreaker	/api/icebreaker	New-user onboarding
Proactive	/api/proactive	Proactive-chat mode and settings
System	/api	Emotion analysis, screenshots, utilities

Other / internal routers

The following routers are live but not individually documented here: capture (/api/capture), cloudsave (/api/cloudsave), storage-location (/api/storage/location), avatar-drop (/api/avatar-drop), card-assist (/api/card-assist), auth/cookies (/api/auth), tool (/api/tools), and debug (/api/debug).

WebSocket

Endpoint	Description
Protocol	Connection lifecycle and session management
Message Types	All client→server and server→client message formats
Audio Streaming	Binary audio format, interruption, resampling

Internal APIs

These are inter-service APIs not intended for external use:

Server	Description
Memory Server	Memory storage and retrieval (port 48912)
Agent Server	Agent task execution (port 48915)

Response format

All REST endpoints return JSON. Successful responses typically include the data directly. Error responses follow FastAPI's default format:

{
  "detail": "Error message describing what went wrong"
}

Content types

• application/json — Most endpoints
• multipart/form-data — File uploads (models, voice samples)
• audio/* — Voice preview responses