API reference
DOCS / REFERENCE

API reference

The local Hono API for sessions, streaming, and discovery.

Base URL

text
http://localhost:3000/api

The launcher normally manages a local API on an available port. When developing the API independently, the default port is 3000.

Endpoints

MethodPathPurpose
GET / POST/sessionsList or create sessions.
GET / PATCH / DELETE/sessions/:idInspect, update, or delete a session.
GET/sessions/:id/messagesRead persisted conversation history.
POST/vibe/streamStart a streaming agent response.
GET/vibe/:sessionId/reconnectReconnect to an active stream.
GET/agentsInspect the worker roster.
GET/workspaces/:id/gitRead branch and working-tree status.
GET/healthCheck API health.

A streaming request

shell
curl -N http://localhost:3000/api/vibe/stream \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{ "role": "user", "content": "Explain this repository" }],
    "mode": "plan"
  }'

Include session_id to continue a session. The response is a stream, not a single JSON document. Clients should consume the stream protocol rather than expecting one final response object.

Read the source contract

Request validation and streaming endpoints live in apps/api/src/routers/vibe.ts. The API entry point, model factory, and stream coordinator define the remaining server behavior.

Use the repository’s web or terminal client as a reference when implementing reconnection, tool approvals, or custom data-part rendering.

Improve this page Grounded in the Vibes source.

Find a guide, command, or concept.