Skip to main content
Blitz
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
Edit page

API reference

The service’s API, one page per proto file in proto/blitz/v1: each message, enum and service as a table and a Mermaid class diagram. The pages are generated from the protos by proto-gen-md-diagrams when the site is built (//docs:api), so they can’t drift from the API. The service API explains the design.

Proto Service
session.proto SessionService Sessions, running turns, steering, approvals and answers
turn.proto A turn and the events it streams
workspace.proto WorkspaceService Agents, models, settings, context, changes, extensions, images, search
file.proto FileService The workspace’s files, for the desktop app
language.proto LanguageService Language servers for the editor: completion, hover, definitions, problems
config.proto ConfigService The settings files and API keys
worker.proto WorkerService Workers and their runs