# Agent socket API

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](https://github.com/lattices-dev/lattices/blob/main/products/blink/docs/agent-api.md) 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](/canvas/docs/cli). The CLI works when the
app is closed. The socket works only while the app is running.

Continue with free email access at /canvas/docs/api.