Developer Guide · 11

API Reference

11.1 Admin API

MethodPathDescription
POST/api/auth/registerRegister (requires code)
POST/api/auth/loginLogin
GET/api/auth/meCurrent user
GET/POST/DELETE/api/conversations[/{id}]Conversation management
POST/api/chat / /chat/resume / /chat/stopSSE chat
GET/api/chat/streaming-statusBackground stream status
CRUD/api/files/*File operations + media + upload/download
POST/api/scripts/runExecute script
POST/api/audio/transcribeVoice transcription
GET/api/modelsModel list
CRUD/api/system-prompt[/versions]Prompt management
CRUD/api/user-profile[/versions]User profile
CRUD/api/subagentsSubagent management
CRUD/api/capability-prompts[/{key}]Capability prompts
GET/PUT/api/soul/configSoul configuration
POST/GET/api/batch/*Batch execution
CRUD/api/services[/{id}[/keys]]Service management
CRUD/api/scheduler[/{id}]Admin scheduled tasks
POST/api/scheduler/{id}/run-nowExecute immediately
GET/api/scheduler/{id}/runsRun history
GET/api/scheduler/services/allAll service tasks
CRUD/api/scheduler/services/{svc_id}[/{task_id}]Service tasks
CRUD/api/inbox[/{id}]Inbox
GET/api/inbox/unread-countUnread count
GET/POST/api/packages[/init/install/uninstall]Per-user venv
GET/PUT/POST/api/settings/api-keys[/test/status]Per-admin API Keys
GET/api/wc/{service_id}/qrcodeService WeChat QR
GET/api/wc/{service_id}/sessions[/{session_id}/messages]Session view
POST/api/admin/wechat/qrcodeAdmin WeChat QR
GET/DELETE/api/admin/wechat/sessionAdmin session management
WS/api/voice/wsS2S WebSocket

11.2 Consumer API

MethodPathDescription
POST/api/v1/conversationsCreate conversation
GET/api/v1/conversations/{id}Conversation history
GET/api/v1/conversations/{id}/files[/{path}]Generated file list / download
GET/api/v1/conversations/{id}/attachments/{path}User attachment
POST/api/v1/chatCustom SSE
POST/api/v1/chat/completionsOpenAI-compatible

11.3 Static Pages

PathDescription
GET /s/{service_id}Consumer standalone chat page (React)
GET /s/{service_id}?key=sk-svc-...Same, auto-writes to localStorage
GET /wc/{service_id}WeChat scan landing page