Get workspace status

Returns a snapshot of one workspace: whether it is registered and still on disk, its assigned teams, the inputs its agents need, its latest run and the runs going now.

An unregistered path is not an error: the reply has registered: false. With config_team_ref the reply also has the settings snapshot taken when that team was assigned.

From the CLI: cliq status.

No credential is needed from this machine. From another host, send Authorization: Bearer with a dispatch token CliqHub signed for this daemon or a cliq_tok_… personal token of a user in the daemon’s realm; this only works once the daemon is connected to CliqHub. See Authentication.

POST

workspaces

status

curl --request POST \
  --url http://127.0.0.1:4900/v1/workspaces/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_dir": "/home/dev/acme-api"
}
'

{
  "ok": true,
  "data": {
    "workspace_dir": "/home/dev/acme-api",
    "registered": true,
    "exists": true,
    "workspace_id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
    "name": "acme-api",
    "assembled": true,
    "teams": [
      {
        "scope": "acme",
        "slug": "code-review",
        "team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
        "assembled_at": 1759830600000
      }
    ],
    "agent_inputs": [
      {
        "name": "pr_url",
        "description": "Pull request to review",
        "required": true,
        "agent": "claude-code",
        "phase": "review"
      }
    ],
    "last_run": {
      "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
      "state": "completed",
      "started_at": 1759834200000
    }
  }
}

Authorizations

Authorization

string

header

required

Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.

Body

application/json

workspace_dir

string

Absolute workspace path

Minimum string length: 1

config_team_ref

string

Include this team's assembly-time config snapshot

Minimum string length: 1

Response

Success.

boolean

required

data

object

required

A snapshot of one workspace.

Show child attributes

curl --request POST \
  --url http://127.0.0.1:4900/v1/workspaces/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_dir": "/home/dev/acme-api"
}
'

{
  "ok": true,
  "data": {
    "workspace_dir": "/home/dev/acme-api",
    "registered": true,
    "exists": true,
    "workspace_id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
    "name": "acme-api",
    "assembled": true,
    "teams": [
      {
        "scope": "acme",
        "slug": "code-review",
        "team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
        "assembled_at": 1759830600000
      }
    ],
    "agent_inputs": [
      {
        "name": "pr_url",
        "description": "Pull request to review",
        "required": true,
        "agent": "claude-code",
        "phase": "review"
      }
    ],
    "last_run": {
      "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
      "state": "completed",
      "started_at": 1759834200000
    }
  }
}

Introduction

System

Teams

Workspaces

Runs

Artifacts

Agents

Settings

Instances

Daemon

Sign-in

Local tokens

HUG

Hub commands

Get workspace status

Authorizations

Body

Response