Agent socket API
The implemented JSON-RPC methods and events on Canvas's local Unix socket.
The running Canvas app serves a small JSON-RPC 2.0 API on a local Unix domain socket. Use it to read live panel state, present a note, save and restore desks, and receive change events.
This page documents only the methods that Canvas implements today. The broader design in Agent API proposal is proposed and is not built. Do not call a method from that proposal unless it is listed here.
For most work, prefer the canvas CLI. The CLI works when the
app is closed. The socket works only while the app is running.
Keep exploring.
Get free access to the full guides and studies. We’ll email you a welcome note with your access code.
Free. No account or password.