Zuse

Get workspace

GET/v1/api/workspaces/{workspaceId}

Returns the state of a workspace and whether its agent is working.

Authorization

apiKey
AuthorizationBearer <token>

An API key that starts with zk_. Create one in the Zuse app.

In: header

Path Parameters

workspaceId*string

Workspace ID.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/api/workspaces/workspace_Q2x8mN4pR7sT1vWz"
{  "workspace": {    "workspaceId": "workspace_Q2x8mN4pR7sT1vWz",    "providerId": "box",    "projectId": "proj_8f2c1a",    "branch": "fix-order-validation",    "baseRef": "main",    "state": "queued",    "statusCode": "agent-running",    "startupPhase": "allocating",    "runtimeState": "offline",    "agentStatus": "working",    "latestSeq": 4,    "lastTurn": {      "turnId": "turn_7a2c9e",      "outcome": "completed",      "completedAt": 1760697600000    },    "createdAt": 1760697600000,    "updatedAt": 1760697600000  }}
{  "error": "invalid_api_key",  "detail": "string"}
{  "error": "invalid_api_key",  "detail": "string"}
{  "error": "invalid_api_key",  "detail": "string"}

Create workspace POST

Starts a cloud workspace on a fresh branch and, if you pass a `prompt`, sends it to the agent. The machine starts right away; poll [Get workspace](/api-reference/workspaces/get-workspace) or subscribe to [webhooks](/api-reference/webhook-signatures) to follow progress.

List workspaces GET

Lists every workspace on your account that hasn't been deleted, including ones started from the app or Slack.