Skip to main content
GET
Get Workspace Status

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Query Parameters

agent_id
string
required
session_id
string
required

Response

Successful Response

Where a session is pointed, and the git state of that place.

workdir
string
required

Absolute path of the workspace root. Backend-dependent — a host directory locally, a fixed path inside the sandbox otherwise — so the client cannot derive it.

cwd
string
required

Absolute path the session is focused on, resolved from :attr:SessionConfig.cwd. Equals :attr:workdir when that is unset.

git
GitStatus · object | null

Git state of :attr:cwd, or null when there is none to report — not a repository, git unavailable, the command timed out, or the backend could not run it. The caller shows no branch either way, so the reasons are logged rather than returned.