Control API

Use the control API to manage workspaces, run agents, and read events. The API version is vibeke/1.

Make a call

Use the CLI to call a method. Pass parameters as a JSON object.

vibeke api call server.status
vibeke api call workspace.list '{}'

Add --session NAME to select a session. Add --socket PATH to use a specific socket.

For applications, use the TypeScript client or Python client. Both clients connect to the server through a local Unix socket.

Access

• Full: requires a client with full access.
• Pane: also accepts a pane token.
• Own panes: a pane token can act only on its own panes or runs.

Read methods return data. Write methods can change state. Gateway clients must include an actor for write methods.

Parameters and results

Get the schema for a method:

vibeke api call api.schema '{"method":"agent.start"}'

A ? marks an optional field. [T] is a list. A | B permits either type or value. A name such as Target refers to a shared type in the JSON Schema.

Download the method catalog or complete schema for all parameters, results, and events.

Clients must accept new fields and event types. The API can change before version 1.0.