taikutaiku
User GuidePluginsAPI Reference
Remote Commands
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
X-Taiku-Token<token>

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

In: header

Path Parameters

session_id*string

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

text/plain

text/plain

text/plain

text/plain

text/plain

text/plain

curl -X POST "/api/v1/sessions/string/remote/command" \  -H "Content-Type: application/json" \  -d '{    "method": "getLayout",    "params": {}  }'
{
  "result": [
    {
      "key": 1,
      "type": "shell",
      "active": true
    },
    {
      "key": 2,
      "type": "shell",
      "active": false
    }
  ]
}
"shellId is required"
"Unauthorized"
"Not the session owner"
"Session not found"
"Session closed"
"No active browser clients responded"