API Reference Permissions

Remote Commands

List AI agents GET Get chat history GET Run any command POST Get layout GET List shells GET List tiles GET List tunnel ports GET List users GET List workspaces GET

Delete one session KV value. DELETE Read one session KV value. GET List all session KV entries for one plugin. GET Write one session KV value. PUT

Delete one plugin storage file. DELETE List files in plugin storage. GET Read one plugin storage file. GET Upload one multipart file to plugin storage. POST Write one plugin storage file. PUT

List a directory through the CLI. GET Read a text file through the CLI. GET Stage a binary file for range-capable download. GET

Session Plugins

Install a session-managed plugin. POST List session-managed plugins. GET Save this session's plugins as the owner's defaults. POST Enable or disable a session plugin. PATCH Uninstall a session plugin. DELETE

Delete one persistent per-user KV value. DELETE Read one persistent per-user KV value. GET List persistent per-user KV entries for a plugin. GET Write one persistent per-user KV value. PUT

Plugin Registry

Fetch the plugin registry. GET

Bridge Protocol

Virtual postMessage event envelope. POST Virtual postMessage init envelope. POST Virtual postMessage request envelope. POST

User Guide Plugins API Reference

User KV

Persistent per-user JSON state for one plugin.

User KV is the persistent counterpart to Session KV.

These routes are available only on servers built with the postgres feature. On stateless or non-Postgres deployments, this surface is not present.

Use it when:

data should follow one user across sessions
a plugin needs preferences, tokens, or saved state
JSON values are enough and a database-backed store is available

List entries

Read all persistent key-value pairs for one plugin and user.

Read or mutate one key

Get, set, or delete one persistent JSON value.