veaselcode
View source

FIELD GUIDE / API

A small local
conversation API.

The versioned HTTP API connects the terminal client to the V server. It listens on loopback and currently covers health, capabilities, sessions, synchronous chat, and replayable events.

Endpoints

MethodPathPurpose
GET/v1/healthCheck the local server.
GET/v1/capabilitiesDiscover implemented features.
GET · POST/v1/sessionsList sessions or create one for an existing directory.
GET/v1/sessions/{id}Read session metadata.
GET · POST/v1/sessions/{id}/messagesRestore history or complete and persist one exchange.
POST/v1/chat/completionsRequest a provider response without a session.
GET/v1/eventsReplay events and continue with server-sent events.

Resume the event stream

Events use increasing numeric IDs. Send the last event ID you handled to replay newer events after a reconnect:

curl -N -H 'Last-Event-ID: 12' \
  http://127.0.0.1:4097/v1/events

Each event includes its session ID and type. Keep the cursor supplied by the server; IDs are created by the local event database.

Open the OpenAPI 3.1 document See the request architecture