Workspaces
CompozyOS Workspaces HTTP endpoints.
curl -X GET "https://example.com/api/workspaces"{ "workspaces": [ { "add_dirs": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "sandbox_ref": "string", "updated_at": "2019-08-24T14:15:22Z" } ]}/api/workspacesRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/workspaces" \ -H "Content-Type: application/json" \ -d '{ "root_dir": "string" }'{ "workspace": { "add_dirs": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "sandbox_ref": "string", "updated_at": "2019-08-24T14:15:22Z" }}/api/workspaces/resolveRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/workspaces/resolve" \ -H "Content-Type: application/json" \ -d '{ "path": "string" }'{ "workspace": { "add_dirs": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "sandbox_ref": "string", "updated_at": "2019-08-24T14:15:22Z" }}/api/workspaces/{id}Path Parameters
Workspace id or path
Response Body
application/json
application/json
application/json
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", "sources": { "model": "string", "provider": "string", "reasoning_effort": "string", "speed": "string" }, "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", "shadows": [ { "layer": "string", "path": "string" } ], "skills": { "disabled": [ "string" ] }, "speed": "normal", "tools": [ "string" ], "toolsets": [ "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": "string", "busy_input": { "default_mode": "string", "steer_capability": "steer_ext", "steer_delivery": "injected" }, "created_at": "2019-08-24T14:15:22Z", "escalated": true, "failure": { "crash_bundle_path": "string", "kind": "string", "reason_code": "string", "summary": "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, "notify_creator": true, "parent_session_id": "string", "permission_policy": { "mcp_servers": [ "string" ], "network_channels": [ "string" ], "sandbox_profiles": [ "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" }, "name": "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", "queue": { "cap": 0, "entries": 0 }, "resolved_network_participation": { "mode": "local", "source": "explicit_request", "version": "network-participation/v1" }, "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_load_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, "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" }, "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" }, "sandbox": { "backend": "string", "instance_id": "string", "last_sync_error": "string", "profile": "string", "provider_state_json": null, "sandbox_id": "string", "state": "string" }, "state": "starting", "stop_cause": "string", "stop_detail": "string", "stop_reason": "completed", "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, "workspace_id": "string", "workspace_path": "string", "worktree_id": "string" } ], "skills": [ { "dir": "string", "name": "string", "source": "string" } ], "workspace": { "add_dirs": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "sandbox_ref": "string", "updated_at": "2019-08-24T14:15:22Z" }}/api/workspaces/{id}Path Parameters
Workspace id
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/workspaces/string" \ -H "Content-Type: application/json" \ -d '{ "add_dirs": [ "string" ], "default_agent": "string", "name": "string", "sandbox_ref": "string" }'{ "workspace": { "add_dirs": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "default_agent": "string", "id": "string", "name": "string", "root_dir": "string", "sandbox_ref": "string", "updated_at": "2019-08-24T14:15:22Z" }}/api/workspaces/{id}Path Parameters
Workspace id
Response Body
application/json
application/json
curl -X DELETE "https://example.com/api/workspaces/string"/api/workspaces/{workspace_id}/terminalsPath Parameters
Workspace id
Query Parameters
Read one profile's rows by name
Read the owner-labeled all-profiles aggregate
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" } ]}/api/workspaces/{workspace_id}/terminalsPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Header Parameters
Registered browser client attachment token
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" }}/api/workspaces/{workspace_id}/terminals/artifacts/{id}Path Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Response Body
*/*
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/workspaces/string/terminals/artifacts/string""string"/api/workspaces/{workspace_id}/terminals/execPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -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}/api/workspaces/{workspace_id}/terminals/input-requestsPath Parameters
Workspace id
Query Parameters
Filter by terminal id
Read one profile's rows by name
Read the owner-labeled all-profiles aggregate
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" } ]}/api/workspaces/{workspace_id}/terminals/journalPath Parameters
Workspace id
Query Parameters
Filter by actor kind
Value in
- "human"
- "agent"
Filter by relative duration
Only failed commands
Filter by terminal id
Page size
int32Opaque page cursor
Read one profile's rows by name
Read the owner-labeled all-profiles aggregate
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -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"}/api/workspaces/{workspace_id}/terminals/recordings/{id}Path Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Response Body
application/x-asciicast
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/workspaces/string/terminals/recordings/string""string"/api/workspaces/{workspace_id}/terminals/streamPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Header Parameters
Resume after the last terminal catalog event
Response Body
text/event-stream
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" } ]}/api/workspaces/{workspace_id}/terminals/{id}Path Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" }}/api/workspaces/{workspace_id}/terminals/{id}Path Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" }}/api/workspaces/{workspace_id}/terminals/{id}/attach-ticketPath Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Header Parameters
Registered browser client attachment token
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -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"}/api/workspaces/{workspace_id}/terminals/{id}/input-requests/{request_id}/answerPath Parameters
Workspace id
Terminal or retained artifact id
Terminal input request id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -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}/api/workspaces/{workspace_id}/terminals/{id}/input-requests/{request_id}/rejectPath Parameters
Workspace id
Terminal or retained artifact id
Terminal input request id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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"}/api/workspaces/{workspace_id}/terminals/{id}/readPath Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Terminal read view
Value in
- "screen"
- "tail"
- "lines"
Maximum returned bytes
int32Optional regular expression
Decimal uint64 after the last consumed sequence
^(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 <= 20First scrollback line
int32Last scrollback line
int32Act as this profile by name
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -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}/api/workspaces/{workspace_id}/terminals/{id}/recordingPath Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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" }}/api/workspaces/{workspace_id}/terminals/{id}/signalPath Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/workspaces/string/terminals/string/signal" \ -H "Content-Type: application/json" \ -d '{ "signal": "INT" }'{ "delivered": true}/api/workspaces/{workspace_id}/terminals/{id}/streamPath Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Single-use attach ticket
Attach mode
Value in
- "read"
- "write"
Proposed terminal columns
int32Proposed terminal rows
int32Decimal uint64 after the last parsed terminal sequence
^(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 <= 20Flow-control mode
Value in
- "ack"
- "drop"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/workspaces/string/terminals/string/stream?ticket=string"/api/workspaces/{workspace_id}/terminals/{id}/waitPath Parameters
Workspace id
Terminal or retained artifact id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -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}/api/workspaces/{workspace_id}/window-managerPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Response Body
application/json
application/json
application/json
curl -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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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"}/api/workspaces/{workspace_id}/window-manager/clientsPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Response Body
application/json
application/json
application/json
curl -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"}/api/workspaces/{workspace_id}/window-manager/clientsPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -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"}/api/workspaces/{workspace_id}/window-manager/clients/{client_id}Path Parameters
Workspace id
Connected window-manager client id
Query Parameters
Act as this profile by name
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/workspaces/string/window-manager/clients/string"/api/workspaces/{workspace_id}/window-manager/commandsPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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" }}/api/workspaces/{workspace_id}/window-manager/layoutPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Response Body
application/json
application/json
application/json
curl -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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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"}/api/workspaces/{workspace_id}/window-manager/layoutPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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" }}/api/workspaces/{workspace_id}/window-manager/layout-profilesPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Response Body
application/json
application/json
application/json
application/json
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 } ]}/api/workspaces/{workspace_id}/window-manager/layout-profiles/{profile_id}Path Parameters
Workspace id
Layout profile id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/workspaces/string/window-manager/layout-profiles/string" \ -H "Content-Type: application/json" \ -d '{ "expected_version": 0 }'/api/workspaces/{workspace_id}/window-manager/layout-profiles/{profile_id}Path Parameters
Workspace id
Layout profile id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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 }}/api/workspaces/{workspace_id}/window-manager/layout/validatePath Parameters
Workspace id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -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"}/api/workspaces/{workspace_id}/window-manager/previewPath Parameters
Workspace id
Query Parameters
Act as this profile by name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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" }}/api/workspaces/{workspace_id}/window-manager/streamPath Parameters
Workspace id
Query Parameters
Last applied window-manager revision
int64value <= 9007199254740991Optional connected client bound to presentation updates
Act as this profile by name
Response Body
application/json
application/json
application/json
application/json
application/json
curl -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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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": [ { "active_id": "string", "axis": "horizontal", "children": [ {} ], "id": "string", "kind": "leaf", "weights": [ 0.1 ], "window_id": "string", "window_ids": [ "string" ] } ], "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"}