Skip to main content
GET
List sessions, optionally filtered.

Authorizations

Authorization
string
header
required

The token from api.json on the loopback listener; the remote token from remote.json (rakumux remote token) on the remote listener.

Headers

X-Rakumux-Session-Id
string

Act as this session (with X-Rakumux-Session-Token).

X-Rakumux-Session-Token
string

The session's RAKUMUX_SESSION_TOKEN.

X-Rakumux-Agent
string

Act for the session that bound this agent's conversation (with X-Rakumux-Agent-Conversation), e.g. opencode. Not with the session headers.

Pattern: ^[a-z0-9_-]{1,32}$
X-Rakumux-Agent-Conversation
string

The agent's conversation id, e.g. OpenCode's ses_….

Query Parameters

all
boolean
default:false

Every folder's sessions (user callers; session callers get 403 out_of_scope). Not with folder (400).

folder
string[]

Folder directory or name. Repeatable.

project
string[]

Deprecated alias of folder. With both, they must name the same folders (400 otherwise).

name
string

Exact session name.

q
string

Case-insensitive substring of the session name.

include_dead
boolean
default:false

Include sessions whose terminal is gone (status dead).

Response

Matching sessions.

sessions
object[]
required