Guide for Kimix opencode-style HTTP server (FastAPI + SSE), including route definitions, builtin endpoints, and app.post usage.
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
설치 방법 보기설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.
FastAPI HTTP server in kimix.server.app exposing an opencode-compatible REST API with SSE event streaming. Create via create_app(); run with kimix serve --host 127.0.0.1 --port 4096.
Handler style: async handlers; path params {name} as function args; query params Optional[int] = Query(...); Pydantic request bodies; errors via HTTPException.
Builtin endpoints:
| Method | Path | Summary |
|---|---|---|
| GET | /global/health | Health check |
| GET | /event | SSE event stream (global) |
| POST | /session | Create session |
| GET | /session | List sessions |
| GET | /session/status | Get all session statuses |
| GET | /session/{sessionID} | Get session info |
| DELETE | /session/{sessionID} | Delete session |
| GET | /session/{sessionID}/message | Get messages |
| POST | /session/{sessionID}/prompt_async | Send message (fire-and-forget, 204) |
| POST | /session/{sessionID}/abort | Abort session |
| POST | /session/{sessionID}/permissions/{permissionID} | Grant permission |
SSE /event: OpenCode protocol — no event: field, plain data: {json}\n\n lines; heartbeat is : heartbeat\n\n.
app.post patterns: create resource (200 + body), fire-and-forget (204, no body), action (200 + empty body), nested path params.
Full code examples and models: read references/guide.md.
아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.
로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.
아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.
Guide for the Kimix web frontend (src/app/) — vanilla TypeScript + Vite, SSE-based chat UI mirroring sse_cli.py. Use when modifying the frontend, adding new UI features, changing the API client, or understanding the message rendering pipeline.
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
Guide for navigating and maintaining Kimix project documentation. Use when: (1) user asks about the docs structure, (2) user wants to add, update, or append content to project documents.
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
Guide for using KimiX API utilities covering kimix, kimix.utils, kimix.base, kimix.dag, kimix.network, kimix.server, kimix.parser, kimix.cot, kimix.retrieval, kimix.summarize, and kimi_agent_sdk.
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
Guide for the Kimix HTTP serve system — FastAPI backend + TypeScript/Vite frontend. Use when adding new backend endpoints, modifying the session manager, changing the frontend API client, or understanding how data flows from backend to UI. Covers dummy_app.py, dummy_session_manager.py, sse_cli.py, and src/app/.
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
Guide for creating effective skills. Use when users want to create or update a skill that extends agent's capabilities.
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
Guide for creating tools using CallableTool2 and Params pattern, plus YAML agent registration
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.