User GuidePluginsAPI Reference
Remote Commands
GET
/v1/sessions/{session_id}/remote/users

See who's connected: names, what they're focused on, their device type, and whether they have write access.

Authorization

apiKeyAuth
headerX-Taiku-Token<token>

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

Path Parameters

session_id*string

Query Parameters

client?integer

Optional target browser client ID. Useful when multiple clients are connected to the same session.

Range0 <= value

Response Body

Array of connected users.

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.

Example Request
curl -X GET '/api/v1/sessions/string/remote/users'
Example Response
{  "result": [    {      "name": "nathan",      "focus": 1,      "canWrite": true,      "device": "Mac Web"    },    {      "name": "guest",      "focus": null,      "canWrite": false,      "device": "iPhone Web"    }  ]}

List tunnel ports GET

Shows which local ports are being tunneled through the session. These are the ports accessible via the `/t/{name}/p/{port}/` URL pattern.

List workspaces GET

Get all workspace pages and which one is active. Workspaces are like virtual desktops: each one has its own layout of tiles.