Reference · Panelith 0.1.0 · plain HTML edition; the interactive edition has search and live examples
HTTP API
The HTTP API the shell talks to. Every reply that carries actions is an ActionList; every request that can carry a client context does.
| Method | Path | Purpose |
|---|---|---|
GET |
/api/manifest |
the manifest; sets the session cookie on a new visitor |
GET |
/api/time |
the server's epoch time, for countdowns |
POST |
/api/panes |
register a new or restored pane (RegisterPane); returns {state, actions} |
GET |
/api/panes/{cid} |
the server's copy of a pane's state |
DELETE |
/api/panes/{cid} |
the pane was closed |
POST |
/api/panes/{cid}/event |
an event from a widget (PaneEvent); returns actions |
POST |
/api/commands/{id} |
run a command (CommandCall); returns actions |
GET |
/api/lists/{id}?q= |
a list source's rows (ListRows); with q, a live list's search_rows |
POST |
/api/route |
the URL hash (RouteCall) for App.on_route; returns actions |
GET |
/api/events |
the server-sent-events stream (event: actions, keepalive every 20 s) |
GET |
/plugins/{name} |
an app's custom widget module |
GET |
/{path} |
the shell: a static file if one matches, otherwise index.html |
Event and command bodies are capped at 64 KB; a list query at 500 characters. panelith serve mounts several apps under prefixes, each with this API beneath it.