API Reference

The HTTP API is built on REST resource endpoints + SSE event streams. The openapi.yaml file is the authoritative interface definition.

Conventions

• Public API: /api/v1
• Internal model gateway: /internal/v1/models/* (loopback only, no Authorization)
• Host can inject a caller context resolver; without one, standalone server uses minimal caller context
• Async entry points (send message, trigger action) return 202
• Streaming uses SSE
• Final execution status determined by the run resource

Key boundaries: session = context boundary, run = execution boundary, runs within a session are serial.

Start Here

• Overall API shape: endpoint tables below
• Concrete schema: openapi.yaml
• Message sending + execution: read sessions.md, runs.md, streaming.md together
• File management: files.md

Module Documentation

Document	Content
openapi.yaml	OpenAPI 3.1 specification
workspaces.md	Workspace, catalog, model visibility
sessions.md	Sessions and messages
runs.md	Run lookup and cancellation
actions.md	Manual action triggering
files.md	Workspace file management
models.md	Model gateway
streaming.md	SSE event streaming
components.md	Shared schemas and error models

The OpenAPI file is the interface source of truth. The Markdown pages explain intent, boundaries, and behavior.