Skip to content

HTTP API

refact-planner edited this page Jun 7, 2026 · 1 revision

HTTP API

The v1 HTTP surface for chat, code, tools, AST, retrieval, git, checkpoints, integrations, knowledge, and voice.

See also Chat System.

The base URL is http://127.0.0.1:{port}/v1/.

Transport

  • Permissive CORS
  • 15MB body limit
  • JSON-centric request/response APIs

Core endpoints

Common endpoints include:

  • /ping
  • /caps
  • /graceful-shutdown
  • /chats/{id}/commands
  • /chats/subscribe
  • /chat (legacy)
  • /code-completion
  • /code-lens
  • /tools
  • /tools-check-if-confirmation-needed
  • /ast-file-symbols
  • /ast-status
  • /rag-status
  • /vecdb-search
  • /git-commit
  • /checkpoints-preview
  • /checkpoints-restore
  • /integrations
  • /integration-get
  • /integration-save
  • /knowledge/update-memory
  • /knowledge/delete-memory
  • /knowledge-graph
  • /voice/transcribe
  • /voice/stream/{id}
  • /voice/stream/{id}/chunk

Chat and events

  • GET /v1/chats/subscribe?chat_id={id} streams SSE events.
  • Events use monotonic seq: u64.
  • POST /v1/chats/{chat_id}/commands queues chat commands.

Notes on code-grounded scope

The HTTP router modules under src/http/routers/v1/ implement the API surface above. The router set also includes many feature-specific handlers beyond the list here; this page intentionally documents only the endpoints called out in the engine AGENTS guidance and router names.

Clone this wiki locally