taikutaiku
User GuidePluginsAPI Reference
CLI Filesystem
GET/v1/sessions/{session_id}/ls

CLI-backed directory listing route. Requires challenge-based session auth and writer access because it asks the connected CLI to inspect the host filesystem. Direct session callers first fetch /api/s/{session_id}/auth-challenge, then send X-Taiku-Session-Nonce and X-Taiku-Session-Key. If the session is write-protected, also send X-Taiku-Session-Auth. The plugin SDK and host bridge handle this automatically.

Authorization

X-Taiku-Session-Nonce<token>

One-time session auth challenge returned by /api/s/{session_id}/auth-challenge.

In: header

X-Taiku-Session-Key<token>

Base64-encoded proof of the one-time challenge, derived from the session secret.

In: header

Path Parameters

session_id*string

Current session identifier.

Query Parameters

path?string

Directory path to list. Defaults to . when omitted.

Header Parameters

X-Taiku-Session-Nonce?string

Fresh one-time challenge/nonce returned by /api/s/{session_id}/auth-challenge. Must match the nonce used to derive the session proof headers.

X-Taiku-Session-Key?string

Base64-encoded proof of the server-provided challenge, derived from the session secret for viewer access.

X-Taiku-Session-Auth?string

Base64-encoded proof of the same challenge, derived from the session write/admin secret. Required for writer routes when the session is write-protected, and required for admin routes.

Response Body

application/json

text/plain

text/plain

text/plain

text/plain

text/plain

text/plain

text/plain

curl -X GET "/api/v1/sessions/string/ls"
[
  {
    "name": "string",
    "is_dir": true,
    "size": 0
  }
]

"missing session auth challenge"

"write auth required"
"Session not found."
"CLI returned an error from the remote read."
"CLI not connected"

"Too many file reads in progress for this user"

"CLI did not respond"