Workspaces
CompozyOS Workspaces HTTP endpoints.
GET
all_workspaces?booleanRead all projects and User rows
workspace_ids?array<string>Repeatable project IDs or @user; requires all_workspaces=true
profile?stringRead one profile's rows by name
all_profiles?booleanRead the owner-labeled all-profiles aggregate
OK
application/json- response
terminals*array<>curl -X GET "https://example.com/api/terminals"{ "terminals": [ { "bound_run": { "generation": 0, "run_id": "string", "session_id": "string" }, "capabilities": { "interactive": true }, "created_at": "2019-08-24T14:15:22Z", "cwd": "string", "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }, "id": "string", "mode": "pty", "profile_id": "string", "profile_name": "string", "shell": "string", "state": "running", "title": "string", "viewers": 0, "workspace_id": "string" } ]}GET
all_workspaces?booleanRead all projects and User rows
workspace_ids?array<string>Repeatable project IDs or @user; requires all_workspaces=true
profile?stringAct as this profile by name
Last-Event-ID?stringResume after the last terminal catalog event
Terminal catalog event stream
text/event-stream- response
terminals*array<>curl -X GET "https://example.com/api/terminals/catalog-stream"{ "terminals": [ { "bound_run": { "generation": 0, "run_id": "string", "session_id": "string" }, "capabilities": { "interactive": true }, "created_at": "2019-08-24T14:15:22Z", "cwd": "string", "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }, "id": "string", "mode": "pty", "profile_id": "string", "profile_name": "string", "shell": "string", "state": "running", "title": "string", "viewers": 0, "workspace_id": "string" } ]}GET
archived?booleanList archived projects instead of active projects
OK
application/json- response
workspaces*array<>curl -X GET "https://example.com/api/workspaces"{ "workspaces": [ { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" } ]}POST
JSON request body
application/json- body
add_dirs?array<string>default_agent?stringMatch
^(?:|[a-z][a-z0-9_-]{0,105})$Length
length <= 106name?stringroot_dir*stringCreated
application/json- response
workspace*curl -X POST "https://example.com/api/workspaces" \ -H "Content-Type: application/json" \ -d '{ "root_dir": "string" }'{ "workspace": { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" }}POST
JSON request body
application/json- body
path*stringOK
application/json- response
workspace*curl -X POST "https://example.com/api/workspaces/resolve" \ -H "Content-Type: application/json" \ -d '{ "path": "string" }'{ "workspace": { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" }}GET
id*stringWorkspace id or path
OK
application/json- response
agents?array<>profile_hints?array<>providers?array<>sessions?array<>skills?array<>workspace*curl -X GET "https://example.com/api/workspaces/string"{ "agents": [ { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "category_path": [ "string" ], "command": "string", "definition_digest": "string", "deny_tools": [ "string" ], "diagnostics": [ { "error_kind": "string", "message": "string", "path": "string" } ], "effective_runtime": { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "model": "string", "provider": "string", "reasoning_effort": "string", "session_env": { "property1": { "ref": "string", "required": true }, "property2": { "ref": "string", "required": true } }, "session_env_status": [ { "kind": "string", "name": "string", "present": true, "required": true, "secret_ref": "string", "source": "string", "target_env": "string" } ], "sources": { "model": "string", "provider": "string", "reasoning_effort": "string", "speed": "string" }, "speed": "normal" }, "fallback_chain": [ { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "command": "string", "command_fingerprint": "string", "model": "string", "provider": "string", "reasoning_effort": "string", "session_env": { "property1": { "ref": "string", "required": true }, "property2": { "ref": "string", "required": true } }, "speed": "normal" } ], "layer": "string", "mcp_servers": [ { "args": [ "string" ], "auth": { "client_id": "string", "client_secret_configured": true, "issuer_url": "string", "registration": "string", "scopes": [ "string" ] }, "command": "string", "env": { "property1": "string", "property2": "string" }, "name": "string", "secret_env": { "property1": "string", "property2": "string" }, "transport": "string", "url": "string" } ], "model": "string", "name": "string", "origin": "global", "permissions": "string", "prompt": "string", "provider": "string", "reasoning_effort": "string", "session_env": { "property1": { "ref": "string", "required": true }, "property2": { "ref": "string", "required": true } }, "shadows": [ { "layer": "string", "path": "string" } ], "skills": { "disabled": [ "string" ] }, "speed": "normal", "tools": [ "string" ], "toolsets": [ "string" ], "workspace_access": "string", "workspace_id": "string" } ], "profile_hints": [ { "action": "string", "message": "string", "name": "string", "path": "string" } ], "providers": [ { "auth_mode": "string", "display_name": "string", "env_policy": "string", "harness": "string", "home_policy": "string", "name": "string", "runtime_provider": "string", "runtime_strategy": "session_config" } ], "sessions": [ { "activity": { "current_tool": "string", "deadline_at": "2019-08-24T14:15:22Z", "elapsed_ms": 0, "elapsed_seconds": 0, "idle_seconds": 0, "iteration_current": 0, "iteration_max": 0, "last_activity_at": "2019-08-24T14:15:22Z", "last_activity_detail": "string", "last_activity_kind": "string", "last_progress_at": "2019-08-24T14:15:22Z", "tool_call_id": "string", "turn_id": "string", "turn_source": "string", "turn_started_at": "2019-08-24T14:15:22Z" }, "agent_name": "string", "archived_at": "2019-08-24T14:15:22Z", "attach_expires_at": "2019-08-24T14:15:22Z", "attachable": true, "attached_to": "string", "attention": "string", "attention_changed_at": "2019-08-24T14:15:22Z", "available_commands": [ { "description": "string", "input": { "hint": "string" }, "name": "string" } ], "badge": "running", "board_column": "needs_you", "branch": "string", "busy_input": { "default_mode": "string", "steer_capability": "steer_ext", "steer_delivery": "injected" }, "children": { "done": 0, "in_review": 0, "needs_you": 0, "total": 0, "working": 0 }, "created_at": "2019-08-24T14:15:22Z", "derivation": { "first_prompt": "string", "kind": "", "native_fork_error": "string", "native_state": "string", "seed": "string", "source_session_id": "string" }, "diagnostics": [ { "category": "string", "code": "string", "data_freshness": "string", "doc_url": "string", "evidence": { "property1": null, "property2": null }, "id": "string", "message": "string", "severity": "string", "suggested_command": "string", "title": "string" } ], "effective_workspace_access": "string", "escalated": true, "failure": { "crash_bundle_path": "string", "kind": "string", "reason_code": "string", "summary": "string" }, "folder_id": "string", "health": { "active_prompt": true, "agent_name": "string", "attachable": true, "attention": "string", "eligible_for_wake": true, "escalated": true, "health": "healthy", "ineligibility_reason": "session_prompt_active", "last_activity_at": "2019-08-24T14:15:22Z", "last_error": "string", "last_presence_at": "2019-08-24T14:15:22Z", "lifecycle_state": "starting", "session_id": "string", "state": "idle", "updated_at": "2019-08-24T14:15:22Z", "verified": true, "workspace_id": "string" }, "id": "string", "lineage": { "auto_stop_on_parent": true, "kind": "", "notify_creator": true, "origin_agent_name": "string", "origin_message_id": "string", "parent_session_id": "string", "permission_policy": { "mcp_servers": [ "string" ], "skills": [ "string" ], "tools": [ "string" ], "workspace_paths": [ "string" ] }, "root_session_id": "string", "spawn_budget": { "max_active_per_workspace": 0, "max_children": 0, "max_depth": 0, "ttl_seconds": 0 }, "spawn_depth": 0, "spawn_role": "string", "ttl_expires_at": "2019-08-24T14:15:22Z" }, "monitor_summary": { "active": 0 }, "name": "string", "parent_title": "string", "pending_interactions": [ { "choices": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "decisions": [ "string" ], "interaction_id": "string", "kind": "string", "provider_request_id": "string", "resolution": "string", "resolved_at": "2019-08-24T14:15:22Z", "resolved_by": "string", "status": "string", "title": "string", "tool_id": "string", "turn_id": "string" } ], "profile_archived": true, "profile_color": "string", "profile_emoji": "string", "profile_icon": "string", "profile_id": "string", "profile_name": "string", "pull_request": { "checks": { "failed": 0, "failed_names": [ "string" ], "passed": 0, "pending": 0, "state": "passing" }, "draft": true, "head_sha": "string", "mergeable": "mergeable", "number": 0, "provider": "string", "ready_to_merge": true, "review_decision": "approved", "state": "open", "url": "string" }, "pull_request_lookup": { "cause": "string", "observed_at": "2019-08-24T14:15:22Z", "stale": true, "state": "ok" }, "queue": { "cap": 0, "entries": 0 }, "reply_watches": [ { "created_at": "2019-08-24T14:15:22Z", "id": "string", "message_id": "string", "state": "string", "target_session_id": "string" } ], "runtime": { "acp_caps": { "config_options": [ { "category": "string", "current_bool": true, "current_value_id": "string", "description": "string", "id": "string", "kind": "string", "label": "string", "values": [ { "description": "string", "group_id": "string", "group_label": "string", "label": "string", "value": "string" } ] } ], "prompt_audio": true, "prompt_embedded_context": true, "prompt_image": true, "supported_modes": [ "string" ], "supports_fork_session": true, "supports_load_session": true, "supports_resume_session": true }, "acp_session_id": "string", "effective": { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "model": "string", "provider": "string", "reasoning_effort": "string", "speed": "normal", "speed_resolution": { "reason": "capability_absent", "requested": "normal", "status": "applied" } }, "failure": "string", "generation": 0, "last_known": { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "model": "string", "provider": "string", "reasoning_effort": "string", "speed": "normal", "speed_resolution": { "reason": "capability_absent", "requested": "normal", "status": "applied" } }, "recovery": { "attempt": 0, "generation": 0, "last_attempt_at": "2019-08-24T14:15:22Z", "last_error": "string", "max_attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z" }, "requested": { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "model": "string", "provider": "string", "reasoning_effort": "string", "speed": "normal" }, "selected": { "acp_options": [ { "bool_value": true, "id": "string", "value_id": "string" } ], "model": "string", "provider": "string", "reasoning_effort": "string", "speed": "normal" }, "selection_revision": 0, "status": "string", "transition": "string" }, "scope": "string", "state": "starting", "stop_cause": "string", "stop_detail": "string", "stop_reason": "completed", "subagent_summary": { "attention": 0, "failed": 0, "live": 0, "most_urgent": "string", "total": 0 }, "supervision": { "quiet_warning": { "quiet_since": "2019-08-24T14:15:22Z", "stop_at": "2019-08-24T14:15:22Z", "warned_at": "2019-08-24T14:15:22Z" }, "sources": [ { "error": "string", "kind": "agent_progress", "ref": "string", "state": "string" } ], "work_signals": [ { "kind": "agent_progress", "ref": "string", "since": "2019-08-24T14:15:22Z" } ] }, "transcript_epoch": 0, "type": "user", "updated_at": "2019-08-24T14:15:22Z", "verified": true, "waiting_on": "sessions", "workspace_id": "string", "workspace_path": "string", "worktree_binding": { "available": true, "unavailable_reason": "string" }, "worktree_id": "string" } ], "skills": [ { "dir": "string", "name": "string", "source": "string" } ], "workspace": { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" }}PATCH
id*stringWorkspace id
JSON request body
application/json- body
add_dirs*array<string>|nulldefault_agent*|Match
^(?:|[a-z][a-z0-9_-]{0,105})$Length
length <= 106name*string|nullOK
application/json- response
workspace*curl -X PATCH "https://example.com/api/workspaces/string" \ -H "Content-Type: application/json" \ -d '{ "add_dirs": [ "string" ], "default_agent": "string", "name": "string" }'{ "workspace": { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" }}curl -X DELETE "https://example.com/api/workspaces/string"Empty
POST
id*stringWorkspace name or id
OK
application/json- response
workspace*curl -X POST "https://example.com/api/workspaces/string/archive"{ "workspace": { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" }}POST
id*stringWorkspace name or id
OK
application/json- response
workspace*curl -X POST "https://example.com/api/workspaces/string/unarchive"{ "workspace": { "add_dirs": [ "string" ], "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "root_missing": true, "updated_at": "2019-08-24T14:15:22Z" }}GET
workspace_id*stringWorkspace id
profile?stringRead one profile's rows by name
all_profiles?booleanRead the owner-labeled all-profiles aggregate
OK
application/json- response
terminals*array<>curl -X GET "https://example.com/api/workspaces/string/terminals"{ "terminals": [ { "bound_run": { "generation": 0, "run_id": "string", "session_id": "string" }, "capabilities": { "interactive": true }, "created_at": "2019-08-24T14:15:22Z", "cwd": "string", "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }, "id": "string", "mode": "pty", "profile_id": "string", "profile_name": "string", "shell": "string", "state": "running", "title": "string", "viewers": 0, "workspace_id": "string" } ]}POST
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
X-Compozy-Client-Token?stringRegistered browser client attachment token
X-Compozy-Client-Workspace?stringBrowser client registration partition (project id, global, or user); defaults to the terminal workspace
JSON request body
application/json- body
client_id?stringcols?integerRange
0 <= value <= 65535cwd?stringrows?integerRange
0 <= value <= 65535shell?stringtitle?stringCreated
application/json- response
terminal*curl -X POST "https://example.com/api/workspaces/string/terminals" \ -H "Content-Type: application/json" \ -d '{}'{ "terminal": { "bound_run": { "generation": 0, "run_id": "string", "session_id": "string" }, "capabilities": { "interactive": true }, "created_at": "2019-08-24T14:15:22Z", "cwd": "string", "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }, "id": "string", "mode": "pty", "profile_id": "string", "profile_name": "string", "shell": "string", "state": "running", "title": "string", "viewers": 0, "workspace_id": "string" }}GET
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
Artifact bytes
response?unknown*/*curl -X GET "https://example.com/api/workspaces/string/terminals/artifacts/string"nullPOST
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
JSON request body
application/json- body
args?array<string>command*stringcwd?stringenv?output?visible?booleanyield_ms?integerCommand finished
application/json- response
command_id*stringduration_ms*integerFormat
int64exit_code*integer|nulloutput*stringsignal*|Value in
"INT""TERM""KILL""HUP"spill?|still_running?booleanterminal_id*string|nulltruncated*booleanuntrusted*booleancurl -X POST "https://example.com/api/workspaces/string/terminals/exec" \ -H "Content-Type: application/json" \ -d '{ "command": "string" }'{ "command_id": "string", "duration_ms": 0, "exit_code": 0, "output": "string", "signal": "INT", "spill": { "artifact_id": "string", "bytes": 0 }, "still_running": true, "terminal_id": "string", "truncated": true, "untrusted": true}GET
workspace_id*stringWorkspace id
terminal_id?stringFilter by terminal id
profile?stringRead one profile's rows by name
all_profiles?booleanRead the owner-labeled all-profiles aggregate
OK
application/json- response
pending*array<>resolved*array<>curl -X GET "https://example.com/api/workspaces/string/terminals/input-requests"{ "pending": [ { "id": "string", "profile_id": "string", "profile_name": "string", "prompt_excerpt": "string", "reason": "string", "redacted": true, "requested_at": "2019-08-24T14:15:22Z", "requester": { "id": "string", "kind": "human" }, "terminal_id": "string", "workspace_id": "string" } ], "resolved": [ { "id": "string", "length": 0, "outcome": "answered", "profile_id": "string", "profile_name": "string", "reason": "string", "redacted": true, "requested_at": "2019-08-24T14:15:22Z", "requester": { "id": "string", "kind": "human" }, "resolved_at": "2019-08-24T14:15:22Z", "resolved_by": { "id": "string", "kind": "human" }, "terminal_id": "string", "workspace_id": "string" } ]}GET
workspace_id*stringWorkspace id
actor?stringFilter by actor kind
Value in
"human""agent"since?stringFilter by relative duration
failed?booleanOnly failed commands
terminal_id?stringFilter by terminal id
limit?integerPage size
Format
int32cursor?stringOpaque page cursor
profile?stringRead one profile's rows by name
all_profiles?booleanRead the owner-labeled all-profiles aggregate
OK
application/json- response
entries*array<>next*string|nullcurl -X GET "https://example.com/api/workspaces/string/terminals/journal"{ "entries": [ { "actor": { "id": "string", "kind": "human" }, "approval": "approved_once", "argv_digest": "string", "command": "string", "command_id": "string", "cwd": "string", "detected_by": "exact", "duration_ms": 0, "exit_cause": "exited", "exit_code": 0, "output_bytes": 0, "profile_id": "string", "profile_name": "string", "recording": "string", "signal": "INT", "started_at": "2019-08-24T14:15:22Z", "terminal_id": "string", "truncated": true } ], "next": "string"}GET
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
Artifact bytes
response?unknownapplication/x-asciicastcurl -X GET "https://example.com/api/workspaces/string/terminals/recordings/string"nullGET
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
Last-Event-ID?stringResume after the last terminal catalog event
Terminal catalog event stream
text/event-stream- response
terminals*array<>curl -X GET "https://example.com/api/workspaces/string/terminals/stream"{ "terminals": [ { "bound_run": { "generation": 0, "run_id": "string", "session_id": "string" }, "capabilities": { "interactive": true }, "created_at": "2019-08-24T14:15:22Z", "cwd": "string", "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }, "id": "string", "mode": "pty", "profile_id": "string", "profile_name": "string", "shell": "string", "state": "running", "title": "string", "viewers": 0, "workspace_id": "string" } ]}GET
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
OK
application/json- response
terminal*curl -X GET "https://example.com/api/workspaces/string/terminals/string"{ "terminal": { "bound_run": { "generation": 0, "run_id": "string", "session_id": "string" }, "capabilities": { "interactive": true }, "created_at": "2019-08-24T14:15:22Z", "cwd": "string", "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }, "id": "string", "mode": "pty", "profile_id": "string", "profile_name": "string", "shell": "string", "state": "running", "title": "string", "viewers": 0, "workspace_id": "string" }}DELETE
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
JSON request body
application/json- body
signal*stringValue in
"INT""TERM""KILL""HUP"Terminated
application/json- response
exit*|curl -X DELETE "https://example.com/api/workspaces/string/terminals/string" \ -H "Content-Type: application/json" \ -d '{ "signal": "INT" }'{ "exit": { "at": "2019-08-24T14:15:22Z", "cause": "exited", "code": 0, "signal": "INT" }}POST
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
X-Compozy-Client-Token?stringRegistered browser client attachment token
X-Compozy-Client-Workspace?stringBrowser client registration partition (project id, global, or user); defaults to the terminal workspace
JSON request body
application/json- body
client_id?stringmode*stringValue in
"read""write"Created
application/json- response
expires_at*stringFormat
date-timeticket*stringcurl -X POST "https://example.com/api/workspaces/string/terminals/string/attach-ticket" \ -H "Content-Type: application/json" \ -d '{ "mode": "read" }'{ "expires_at": "2019-08-24T14:15:22Z", "ticket": "string"}POST
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
request_id*stringTerminal input request id
profile?stringAct as this profile by name
JSON request body
application/json- body
input*stringDelivered
application/json- response
delivered_bytes*integerredacted*booleancurl -X POST "https://example.com/api/workspaces/string/terminals/string/input-requests/string/answer" \ -H "Content-Type: application/json" \ -d '{ "input": "string" }'{ "delivered_bytes": 0, "redacted": true}POST
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
request_id*stringTerminal input request id
profile?stringAct as this profile by name
JSON request body
application/json- body
reason*stringRejected
application/json- response
outcome*"rejected"Value in
"rejected"curl -X POST "https://example.com/api/workspaces/string/terminals/string/input-requests/string/reject" \ -H "Content-Type: application/json" \ -d '{ "reason": "string" }'{ "outcome": "rejected"}GET
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
view?stringTerminal read view
Value in
"screen""tail""lines"max_bytes?integerMaximum returned bytes
Format
int32grep?stringOptional regular expression
since_seq?stringDecimal uint64 after the last consumed sequence
Match
^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$Length
length <= 20from?integerFirst scrollback line
Format
int32to?integerLast scrollback line
Format
int32profile?stringAct as this profile by name
OK
application/json- response
busy*booleancontent*stringseq*stringMatch
^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$Length
length <= 20spill?|truncated*booleanuntrusted*booleancurl -X GET "https://example.com/api/workspaces/string/terminals/string/read"{ "busy": true, "content": "string", "seq": "string", "spill": { "artifact_id": "string", "bytes": 0 }, "truncated": true, "untrusted": true}POST
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
JSON request body
application/json- body
action*stringValue in
"start""stop"Recording state
application/json- response
recording*curl -X POST "https://example.com/api/workspaces/string/terminals/string/recording" \ -H "Content-Type: application/json" \ -d '{ "action": "start" }'{ "recording": { "bytes": 0, "digest": "string", "expires_at": "2019-08-24T14:15:22Z", "id": "string", "profile_id": "string", "started_at": "2019-08-24T14:15:22Z", "state": "recording", "stopped_at": "2019-08-24T14:15:22Z", "terminal_id": "string" }}POST
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
JSON request body
application/json- body
signal*stringValue in
"INT""TERM""KILL""HUP"Delivered
application/json- response
delivered*booleancurl -X POST "https://example.com/api/workspaces/string/terminals/string/signal" \ -H "Content-Type: application/json" \ -d '{ "signal": "INT" }'{ "delivered": true}GET
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
ticket*stringSingle-use attach ticket
mode?stringAttach mode
Value in
"read""write"cols?integerProposed terminal columns
Format
int32rows?integerProposed terminal rows
Format
int32after_seq?stringDecimal uint64 after the last parsed terminal sequence
Match
^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$Length
length <= 20flow?stringFlow-control mode
Value in
"ack""drop"WebSocket upgrade using the binary compozy.terminal.v3 subprotocol. Server frames: OUTPUT=0x01, ATTACHED=0x02, EXIT=0x03, ERROR=0x04, TITLE=0x05, RESIZED=0x06, GAP=0x07, PRESENCE=0x08, REDACTED_INPUT=0x09. Client frames: INPUT=0x01, ACK=0x02, RESIZE=0x03, SIGNAL=0x04, DETACH=0x05. OUTPUT is one opcode byte, one u64 big-endian sequence, then raw bytes; every control frame is one opcode byte followed by JSON.
curl -X GET "https://example.com/api/workspaces/string/terminals/string/stream?ticket=string"Empty
POST
workspace_id*stringWorkspace id
id*stringTerminal or retained artifact id
profile?stringAct as this profile by name
JSON request body
application/json- body
pattern?stringtimeout_ms?integeruntil*stringWait result
application/json- response
exit_code?integer|nullreason*stringscreen*stringuntrusted*booleancurl -X POST "https://example.com/api/workspaces/string/terminals/string/wait" \ -H "Content-Type: application/json" \ -d '{ "until": "string" }'{ "exit_code": 0, "reason": "string", "screen": "string", "untrusted": true}GET
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
OK
application/json- response
closed_entry_count*integerdesktops*array<>overrides*revision*integerRange
0 <= value <= 9007199254740991updated_at*stringFormat
date-timeversion*integerRange
0 <= value <= 4294967295windows*workspace_id*stringcurl -X GET "https://example.com/api/workspaces/string/window-manager"{ "closed_entry_count": 0, "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "active_id": "string", "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": { "bindings": { "bottom_center": "string", "top_center": "string" }, "closed_entry_limit": 0, "desktop_transition": "string", "drag_away_policy": "string", "focus_follows_pointer": true, "focus_policy": "string", "focus_wrap": true, "gaps": { "bottom": 0.1, "inner": 0.1, "left": 0.1, "right": 0.1, "top": 0.1 }, "group_move_modifier": "string", "history_limit": 0, "nav_stack_limit": 0, "new_window_policy": "string", "raise_on_focus": true, "shortcuts": { "property1": "string", "property2": "string" }, "small_viewport_policy": "string", "snap": { "corner_reach": 0.1, "edge_band": 0.1, "exit_slack": 0.1, "repeat_ratios": [ 0.1 ] }, "swap_modifier": "string" }, "revision": 0, "updated_at": "2019-08-24T14:15:22Z", "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string"}GET
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
OK
application/json- response
clients*array<>workspace_id*stringcurl -X GET "https://example.com/api/workspaces/string/window-manager/clients"{ "clients": [ { "active_desktop_id": "string", "attachment_token": "string", "client_id": "string", "connected_at": "2019-08-24T14:15:22Z", "context_revision": 0, "focus_order": [ "string" ], "focused_window_id": "string", "global_shortcuts": [ { "active_chord": "string", "command_id": "string", "intended_chord": "string", "reason": "string", "settings_url": "string", "status": "string" } ], "kind": "string", "palette_context": { "desktop_window_count": 0, "destination_intent": { "pathname": "string", "search": { "property1": null, "property2": null } }, "focused_session_state": "string", "scope_global": true, "shell_desktop": true, "window_floating": true, "window_focused": true, "window_stacked": true, "workspace_trusted": true }, "presentation_revision": 0, "stack_active": { "property1": "string", "property2": "string" }, "workspace_id": "string" } ], "workspace_id": "string"}POST
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
JSON request body
application/json- body
active_desktop_id?stringclient_id?stringcontext*kind?stringworkspace_id*stringRegistered
application/json- response
active_desktop_id*stringattachment_token?stringclient_id*stringconnected_at*stringFormat
date-timecontext_revision*integerRange
0 <= value <= 9007199254740991focus_order*array<string>focused_window_id?string|nullglobal_shortcuts*array<>kind*stringpalette_context*presentation_revision*integerRange
0 <= value <= 9007199254740991stack_active*workspace_id*stringcurl -X POST "https://example.com/api/workspaces/string/window-manager/clients" \ -H "Content-Type: application/json" \ -d '{ "context": { "global_shortcuts": [ { "command_id": "string", "intended_chord": "string", "status": "string" } ], "scope_global": true, "workspace_trusted": true }, "workspace_id": "string" }'{ "active_desktop_id": "string", "attachment_token": "string", "client_id": "string", "connected_at": "2019-08-24T14:15:22Z", "context_revision": 0, "focus_order": [ "string" ], "focused_window_id": "string", "global_shortcuts": [ { "active_chord": "string", "command_id": "string", "intended_chord": "string", "reason": "string", "settings_url": "string", "status": "string" } ], "kind": "string", "palette_context": { "desktop_window_count": 0, "destination_intent": { "pathname": "string", "search": { "property1": null, "property2": null } }, "focused_session_state": "string", "scope_global": true, "shell_desktop": true, "window_floating": true, "window_focused": true, "window_stacked": true, "workspace_trusted": true }, "presentation_revision": 0, "stack_active": { "property1": "string", "property2": "string" }, "workspace_id": "string"}DELETE
workspace_id*stringWorkspace id
client_id*stringConnected window-manager client id
profile?stringAct as this profile by name
No Content
curl -X DELETE "https://example.com/api/workspaces/string/window-manager/clients/string"Empty
POST
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
JSON request body
application/json- body
actor*client_id?string|nullcommand_id*stringValue in
"desktop.create""desktop.update""desktop.reorder""desktop.switch""desktop.delete""window.open""window.navigate""window.close""window.focus""window.move""window.resize""window.swap""window.toggle_floating""window.zoom""window.stack.group""window.stack.reorder""window.stack.set_active""window.pin""window.reopen""layout.arrange""layout.resize""layout.frame_resize""layout.balance""layout.undo""layout.redo""layout.replace"expected_revision*integerRange
0 <= value <= 9007199254740991origin*stringpayload*unknownrebase?|workspace_id*stringOK
application/json- response
applied*booleanchanges*client?|diagnostics?array<>rebased_from?integerRange
0 <= value <= 9007199254740991snapshot*curl -X POST "https://example.com/api/workspaces/string/window-manager/commands" \ -H "Content-Type: application/json" \ -d '{ "actor": {}, "command_id": "desktop.create", "expected_revision": 0, "origin": "string", "payload": null, "workspace_id": "string" }'{ "applied": true, "changes": { "client_ids": [ "string" ], "desktop_ids": [ "string" ], "group_ids": [ "string" ], "node_ids": [ "string" ], "stack_grouped": [ "string" ], "stack_ungrouped": [ "string" ], "window_ids": [ "string" ] }, "client": { "active_desktop_id": "string", "attachment_token": "string", "client_id": "string", "connected_at": "2019-08-24T14:15:22Z", "context_revision": 0, "focus_order": [ "string" ], "focused_window_id": "string", "global_shortcuts": [ { "active_chord": "string", "command_id": "string", "intended_chord": "string", "reason": "string", "settings_url": "string", "status": "string" } ], "kind": "string", "palette_context": { "desktop_window_count": 0, "destination_intent": { "pathname": "string", "search": { "property1": null, "property2": null } }, "focused_session_state": "string", "scope_global": true, "shell_desktop": true, "window_floating": true, "window_focused": true, "window_stacked": true, "workspace_trusted": true }, "presentation_revision": 0, "stack_active": { "property1": "string", "property2": "string" }, "workspace_id": "string" }, "diagnostics": [ { "code": "string", "message": "string", "path": "string" } ], "rebased_from": 0, "snapshot": { "closed_entry_count": 0, "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "active_id": "string", "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": { "bindings": { "bottom_center": "string", "top_center": "string" }, "closed_entry_limit": 0, "desktop_transition": "string", "drag_away_policy": "string", "focus_follows_pointer": true, "focus_policy": "string", "focus_wrap": true, "gaps": { "bottom": 0.1, "inner": 0.1, "left": 0.1, "right": 0.1, "top": 0.1 }, "group_move_modifier": "string", "history_limit": 0, "nav_stack_limit": 0, "new_window_policy": "string", "raise_on_focus": true, "shortcuts": { "property1": "string", "property2": "string" }, "small_viewport_policy": "string", "snap": { "corner_reach": 0.1, "edge_band": 0.1, "exit_slack": 0.1, "repeat_ratios": [ 0.1 ] }, "swap_modifier": "string" }, "revision": 0, "updated_at": "2019-08-24T14:15:22Z", "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string" }}GET
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
OK
application/json- response
desktops*array<>overrides*version*integerRange
0 <= value <= 4294967295windows*workspace_id*stringcurl -X GET "https://example.com/api/workspaces/string/window-manager/layout"{ "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "active_id": "string", "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": { "bindings": { "bottom_center": "string", "top_center": "string" }, "closed_entry_limit": 0, "desktop_transition": "string", "drag_away_policy": "string", "focus_follows_pointer": true, "focus_policy": "string", "focus_wrap": true, "gaps": { "bottom": 0.1, "inner": 0.1, "left": 0.1, "right": 0.1, "top": 0.1 }, "group_move_modifier": "string", "history_limit": 0, "nav_stack_limit": 0, "new_window_policy": "string", "raise_on_focus": true, "shortcuts": { "property1": "string", "property2": "string" }, "small_viewport_policy": "string", "snap": { "corner_reach": 0.1, "edge_band": 0.1, "exit_slack": 0.1, "repeat_ratios": [ 0.1 ] }, "swap_modifier": "string" }, "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string"}PUT
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
JSON request body
application/json- body
actor*client_id?string|nulldocument*expected_revision*integerRange
0 <= value <= 9007199254740991origin*stringworkspace_id*stringApplied
application/json- response
applied*booleanchanges*client?|diagnostics?array<>rebased_from?integerRange
0 <= value <= 9007199254740991snapshot*curl -X PUT "https://example.com/api/workspaces/string/window-manager/layout" \ -H "Content-Type: application/json" \ -d '{ "actor": {}, "document": { "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "id": "string", "kind": "leaf" } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": {}, "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string" }, "expected_revision": 0, "origin": "string", "workspace_id": "string" }'{ "applied": true, "changes": { "client_ids": [ "string" ], "desktop_ids": [ "string" ], "group_ids": [ "string" ], "node_ids": [ "string" ], "stack_grouped": [ "string" ], "stack_ungrouped": [ "string" ], "window_ids": [ "string" ] }, "client": { "active_desktop_id": "string", "attachment_token": "string", "client_id": "string", "connected_at": "2019-08-24T14:15:22Z", "context_revision": 0, "focus_order": [ "string" ], "focused_window_id": "string", "global_shortcuts": [ { "active_chord": "string", "command_id": "string", "intended_chord": "string", "reason": "string", "settings_url": "string", "status": "string" } ], "kind": "string", "palette_context": { "desktop_window_count": 0, "destination_intent": { "pathname": "string", "search": { "property1": null, "property2": null } }, "focused_session_state": "string", "scope_global": true, "shell_desktop": true, "window_floating": true, "window_focused": true, "window_stacked": true, "workspace_trusted": true }, "presentation_revision": 0, "stack_active": { "property1": "string", "property2": "string" }, "workspace_id": "string" }, "diagnostics": [ { "code": "string", "message": "string", "path": "string" } ], "rebased_from": 0, "snapshot": { "closed_entry_count": 0, "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "active_id": "string", "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": { "bindings": { "bottom_center": "string", "top_center": "string" }, "closed_entry_limit": 0, "desktop_transition": "string", "drag_away_policy": "string", "focus_follows_pointer": true, "focus_policy": "string", "focus_wrap": true, "gaps": { "bottom": 0.1, "inner": 0.1, "left": 0.1, "right": 0.1, "top": 0.1 }, "group_move_modifier": "string", "history_limit": 0, "nav_stack_limit": 0, "new_window_policy": "string", "raise_on_focus": true, "shortcuts": { "property1": "string", "property2": "string" }, "small_viewport_policy": "string", "snap": { "corner_reach": 0.1, "edge_band": 0.1, "exit_slack": 0.1, "repeat_ratios": [ 0.1 ] }, "swap_modifier": "string" }, "revision": 0, "updated_at": "2019-08-24T14:15:22Z", "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string" }}GET
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
OK
application/json- response
records*array<>curl -X GET "https://example.com/api/workspaces/string/window-manager/layout-profiles"{ "records": [ { "created_at": "2019-08-24T14:15:22Z", "id": "string", "kind": "string", "owner": { "id": "string", "kind": "string" }, "scope": { "id": "string", "kind": "user" }, "source": { "id": "string", "kind": "string" }, "spec": null, "updated_at": "2019-08-24T14:15:22Z", "version": 0 } ]}DELETE
workspace_id*stringWorkspace id
profile_id*stringLayout profile id
profile?stringAct as this profile by name
JSON request body
application/json- body
expected_version*integerFormat
int64No Content
curl -X DELETE "https://example.com/api/workspaces/string/window-manager/layout-profiles/string" \ -H "Content-Type: application/json" \ -d '{ "expected_version": 0 }'Empty
PUT
workspace_id*stringWorkspace id
profile_id*stringLayout profile id
profile?stringAct as this profile by name
JSON request body
application/json- body
expected_version?integerFormat
int64scope*spec*unknownUpdated
application/json- response
record*curl -X PUT "https://example.com/api/workspaces/string/window-manager/layout-profiles/string" \ -H "Content-Type: application/json" \ -d '{ "scope": { "kind": "user" }, "spec": null }'{ "record": { "created_at": "2019-08-24T14:15:22Z", "id": "string", "kind": "string", "owner": { "id": "string", "kind": "string" }, "scope": { "id": "string", "kind": "user" }, "source": { "id": "string", "kind": "string" }, "spec": null, "updated_at": "2019-08-24T14:15:22Z", "version": 0 }}POST
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
JSON request body
application/json- body
document*workspace_id*stringValidation result
application/json- response
diagnostics?array<>valid*booleanworkspace_id*stringcurl -X POST "https://example.com/api/workspaces/string/window-manager/layout/validate" \ -H "Content-Type: application/json" \ -d '{ "document": { "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "id": "string", "kind": "leaf" } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": {}, "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string" }, "workspace_id": "string" }'{ "diagnostics": [ { "code": "string", "message": "string", "path": "string" } ], "valid": true, "workspace_id": "string"}POST
workspace_id*stringWorkspace id
profile?stringAct as this profile by name
JSON request body
application/json- body
actor*client_id?string|nullcommand_id*stringValue in
"desktop.create""desktop.update""desktop.reorder""desktop.switch""desktop.delete""window.open""window.navigate""window.close""window.focus""window.move""window.resize""window.swap""window.toggle_floating""window.zoom""window.stack.group""window.stack.reorder""window.stack.set_active""window.pin""window.reopen""layout.arrange""layout.resize""layout.frame_resize""layout.balance""layout.undo""layout.redo""layout.replace"expected_revision*integerRange
0 <= value <= 9007199254740991origin*stringpayload*unknownrebase?|workspace_id*stringOK
application/json- response
changed*booleanchanges*client?|diagnostics?array<>snapshot*curl -X POST "https://example.com/api/workspaces/string/window-manager/preview" \ -H "Content-Type: application/json" \ -d '{ "actor": {}, "command_id": "desktop.create", "expected_revision": 0, "origin": "string", "payload": null, "workspace_id": "string" }'{ "changed": true, "changes": { "client_ids": [ "string" ], "desktop_ids": [ "string" ], "group_ids": [ "string" ], "node_ids": [ "string" ], "stack_grouped": [ "string" ], "stack_ungrouped": [ "string" ], "window_ids": [ "string" ] }, "client": { "active_desktop_id": "string", "attachment_token": "string", "client_id": "string", "connected_at": "2019-08-24T14:15:22Z", "context_revision": 0, "focus_order": [ "string" ], "focused_window_id": "string", "global_shortcuts": [ { "active_chord": "string", "command_id": "string", "intended_chord": "string", "reason": "string", "settings_url": "string", "status": "string" } ], "kind": "string", "palette_context": { "desktop_window_count": 0, "destination_intent": { "pathname": "string", "search": { "property1": null, "property2": null } }, "focused_session_state": "string", "scope_global": true, "shell_desktop": true, "window_floating": true, "window_focused": true, "window_stacked": true, "workspace_trusted": true }, "presentation_revision": 0, "stack_active": { "property1": "string", "property2": "string" }, "workspace_id": "string" }, "diagnostics": [ { "code": "string", "message": "string", "path": "string" } ], "snapshot": { "closed_entry_count": 0, "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "active_id": "string", "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": { "bindings": { "bottom_center": "string", "top_center": "string" }, "closed_entry_limit": 0, "desktop_transition": "string", "drag_away_policy": "string", "focus_follows_pointer": true, "focus_policy": "string", "focus_wrap": true, "gaps": { "bottom": 0.1, "inner": 0.1, "left": 0.1, "right": 0.1, "top": 0.1 }, "group_move_modifier": "string", "history_limit": 0, "nav_stack_limit": 0, "new_window_policy": "string", "raise_on_focus": true, "shortcuts": { "property1": "string", "property2": "string" }, "small_viewport_policy": "string", "snap": { "corner_reach": 0.1, "edge_band": 0.1, "exit_slack": 0.1, "repeat_ratios": [ 0.1 ] }, "swap_modifier": "string" }, "revision": 0, "updated_at": "2019-08-24T14:15:22Z", "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string" }}GET
workspace_id*stringWorkspace id
after_revision?integerLast applied window-manager revision
Format
int64Range
value <= 9007199254740991client_id?stringOptional connected client bound to presentation updates
profile?stringAct as this profile by name
WebSocket upgrade and frame contract
application/json- response
client?|revision*integerRange
0 <= value <= 9007199254740991snapshot*type*"snapshot"Value in
"snapshot"workspace_id*stringcurl -X GET "https://example.com/api/workspaces/string/window-manager/stream"{ "client": { "active_desktop_id": "string", "attachment_token": "string", "client_id": "string", "connected_at": "2019-08-24T14:15:22Z", "context_revision": 0, "focus_order": [ "string" ], "focused_window_id": "string", "global_shortcuts": [ { "active_chord": "string", "command_id": "string", "intended_chord": "string", "reason": "string", "settings_url": "string", "status": "string" } ], "kind": "string", "palette_context": { "desktop_window_count": 0, "destination_intent": { "pathname": "string", "search": { "property1": null, "property2": null } }, "focused_session_state": "string", "scope_global": true, "shell_desktop": true, "window_floating": true, "window_focused": true, "window_stacked": true, "workspace_trusted": true }, "presentation_revision": 0, "stack_active": { "property1": "string", "property2": "string" }, "workspace_id": "string" }, "revision": 0, "snapshot": { "closed_entry_count": 0, "desktops": [ { "floating": [ "string" ], "floating_stacks": [ { "active_id": "string", "id": "string", "minimized": true, "rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "window_ids": [ "string" ] } ], "groups": [ { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } } ], "id": "string", "name": "string", "order": 0 } ], "overrides": { "bindings": { "bottom_center": "string", "top_center": "string" }, "closed_entry_limit": 0, "desktop_transition": "string", "drag_away_policy": "string", "focus_follows_pointer": true, "focus_policy": "string", "focus_wrap": true, "gaps": { "bottom": 0.1, "inner": 0.1, "left": 0.1, "right": 0.1, "top": 0.1 }, "group_move_modifier": "string", "history_limit": 0, "nav_stack_limit": 0, "new_window_policy": "string", "raise_on_focus": true, "shortcuts": { "property1": "string", "property2": "string" }, "small_viewport_policy": "string", "snap": { "corner_reach": 0.1, "edge_band": 0.1, "exit_slack": 0.1, "repeat_ratios": [ 0.1 ] }, "swap_modifier": "string" }, "revision": 0, "updated_at": "2019-08-24T14:15:22Z", "version": 0, "windows": { "property1": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true }, "property2": { "app": "string", "desktop_id": "string", "floating_rect": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "instance_key": "string", "minimized": true, "nav_stack": [ { "pathname": "string", "search": { "property1": null, "property2": null } } ], "pinned": true, "placement": "tiled", "return_anchor": { "child_index": 0, "desktop_id": "string", "group_id": "string", "neighbor_ids": [ "string" ], "parent_split_id": "string", "source_group": { "frame": { "height": 0.1, "width": 0.1, "x": 0.1, "y": 0.1 }, "id": "string", "root": { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } }, "source_revision": 0, "weight": 0, "zoomed": true }, "route": { "pathname": "string", "search": { "property1": null, "property2": null } }, "zoomed": true } }, "workspace_id": "string" }, "type": "snapshot", "workspace_id": "string"}