User GuidePluginsAPI Reference
POST
/v1/sessions/{session_id}/remote/command

The universal remote-command endpoint. Send a method name and params, and an active browser client for the session will execute it. This is what taiku func calls under the hood. If no browser client is connected, the request returns 504 after the timeout.

Authorization

apiKeyAuth
headerX-Taiku-Token<token>

Your API key from taiku login. Also available as TAIKU_TOKEN env var.

Path Parameters

session_id*string

Your session name: the random-looking string from the URL, like cvmfNfOcKG.

Request Body

application/json
  1. body
method*string

Remote method name. These are the browser-side commands exposed through taiku func and the generic remote command endpoint.

Value in"splitShell""removeTile""resetLayout""toggleDirection""setRatio""swapTiles""maximize""focusTile""focusDirection""renameTile""getLayout""getTiles""getTabGroups""getWorkspaces""createWorkspace""switchWorkspace""getUserTiles""setup""getShells""createShell""closeShell""writeToShell""getShellOutput""getTerminalNames""getSession""getUsers""getUserRole""getShellOwnership""adoptShell""getChat""sendChat""broadcastEvent""getAgents""getAgentCostSummary""getAgentSessions""getAgentSessionEvents""getTunnelPorts""showToast""sendNotification""selectTab""nextTab""prevTab"
params?

Method-specific parameters. Omit or pass {} for read-only queries; mutation methods accept fields like tileKey, shellId, message, or index depending on the method.

Defaultnull
target_client_id?integer

Optional explicit browser client ID. Required for many client-local methods when multiple clients are connected.

Range0 <= value
source_shell_id?integer

Optional shell ID used for auto-routing when the caller is running inside a taiku shell. The CLI sets this automatically from TAIKU_SHELL_ID.

Range0 <= value

Response Body

Command executed successfully.

application/json
  1. response

Remote command success envelope. Transport-level or command-level failures use non-2xx HTTP responses.

result*unknown

Successful browser-side command result. Shape depends on the requested method.

curl -X POST '/api/v1/sessions/string/remote/command' \  -H 'Content-Type: application/json' \  -d '{  "method": "getLayout",  "params": {}}'
Example Response
{  "result": [    {      "key": 1,      "type": "shell",      "active": true    },    {      "key": 2,      "type": "shell",      "active": false    }  ]}