Sign in
OpenAPI 3.1.0raw.githubusercontent.com2026-08-21163196629.4 KB

91764f0b41d6

workspace-activation

Get Workspace Activation

Where a workspace stands on its first successful request.

Readable by any member who can see the workspace. Whether the guide should actually be offered to this caller is experience_eligible, which also answers false when the deployment has the flow turned off (activation_guide), so a dashboard left open stops offering it without needing to be reloaded.

get/v1/workspaces/{workspace_id}/activation

Path parameters

workspace_idstring uuid required

Response

Successful Response

dismissedboolean required

Whether someone skipped the guide for this workspace.

experience_eligibleboolean required

Whether the dashboard should offer the guide to this caller right now: the deployment has it enabled, the workspace is classified for it, nobody dismissed it, no request has succeeded yet, and the caller may manage the workspace.

status'waiting' | 'failed' | 'activated' required

'activated' once a gateway request in this workspace has succeeded, 'failed' when the last one failed and none has yet succeeded, 'waiting' when there has been none at all.