Requests

Every request requires a caller-selected string id, a method, and the method's params object. The response echoes the same id.

`ping`

Parameters: PingParams

No properties.

`server.stop`

Parameters: EmptyParams

No properties.

`server.live_handoff`

Parameters: ServerLiveHandoffParams

Property	Type	Required
`expected_protocol`	`integer \| null`	no
`expected_version`	`string \| null`	no
`import_exe`	`string \| null`	no

`server.reload_config`

Parameters: EmptyParams

No properties.

`server.agent_manifests`

Parameters: EmptyParams

No properties.

`server.reload_agent_manifests`

Parameters: EmptyParams

No properties.

`connection.list`

Parameters: EmptyParams

No properties.

`connection.save`

Parameters: ConnectionSaveParams

Property	Type	Required
`name`	`string`	yes
`profile_id`	`string`	yes
`suggested_directory`	`string \| null`	no
`target`	`string`	yes

`connection.delete`

Parameters: ConnectionTarget

Property	Type	Required	Description
`profile_id`	`string`	yes

`connection.test`

Parameters: ConnectionTarget

Property	Type	Required	Description
`profile_id`	`string`	yes

`connection.connect`

Parameters: ConnectionTarget

Property	Type	Required	Description
`profile_id`	`string`	yes

`connection.disconnect`

Parameters: ConnectionTarget

Property	Type	Required	Description
`profile_id`	`string`	yes

`connection.retire.start`

Parameters: ConnectionRetireParams

Property	Type	Required
`execution_host_id`	`string`	yes
`local_only`	`boolean`	no
`profile_id`	`string`	yes

`connection.retire.status`

Parameters: ConnectionRetireParams

Property	Type	Required
`execution_host_id`	`string`	yes
`local_only`	`boolean`	no
`profile_id`	`string`	yes

`notification.show`

Parameters: NotificationShowParams

Property	Type	Required
`body`	`string \| null`	no
`position`	`ToastPosition \| null`	no
`sound`	`NotificationShowSound`	no
`title`	`string`	yes

`group.create`

Parameters: GroupCreateParams

Property	Type	Required	Description
`default_location`	`ResourceLocationParams \| null`	no
`name`	`string`	yes

`group.list`

Parameters: EmptyParams

No properties.

`group.focus`

Parameters: GroupTarget

Property	Type	Required	Description
`group_id`	`string`	yes

`group.rename`

Parameters: GroupRenameParams

Property	Type	Required	Description
`group_id`	`string`	yes
`name`	`string`	yes

`group.delete`

Parameters: GroupTarget

Property	Type	Required	Description
`group_id`	`string`	yes

`client.window_title.set`

Parameters: ClientWindowTitleSetParams

Property	Type	Required	Description
`title`	`string`	yes

`client.window_title.clear`

Parameters: EmptyParams

No properties.

`session.snapshot`

Parameters: EmptyParams

No properties.

`workspace.create`

Parameters: WorkspaceCreateParams

Property	Type	Required
`cwd`	`string \| null`	no
`env`	`object`	no
`focus`	`boolean`	no
`label`	`string \| null`	no
`location`	`ResourceLocationParams \| null`	no

`workspace.list`

Parameters: EmptyParams

No properties.

`workspace.get`

Parameters: WorkspaceTarget

Property	Type	Required	Description
`workspace_id`	`string`	yes

`workspace.focus`

Parameters: WorkspaceTarget

Property	Type	Required	Description
`workspace_id`	`string`	yes

`workspace.rename`

Parameters: WorkspaceRenameParams

Property	Type	Required	Description
`label`	`string`	yes
`workspace_id`	`string`	yes

`workspace.close`

Parameters: WorkspaceTarget

Property	Type	Required	Description
`workspace_id`	`string`	yes

`workspace.move_to_group`

Parameters: WorkspaceMoveToGroupParams

Property	Type	Required	Description
`group_id`	`string`	yes
`workspace_id`	`string`	yes

`tab.create`

Parameters: TabCreateParams

Property	Type	Required
`cwd`	`string \| null`	no
`env`	`object`	no
`focus`	`boolean`	no
`label`	`string \| null`	no
`location`	`ResourceLocationParams \| null`	no
`workspace_id`	`string \| null`	no

`tab.list`

Parameters: TabListParams

Property	Type	Required	Description
`workspace_id`	`string \| null`	no

`tab.get`

Parameters: TabTarget

Property	Type	Required	Description
`tab_id`	`string`	yes

`tab.focus`

Parameters: TabTarget

Property	Type	Required	Description
`tab_id`	`string`	yes

`tab.rename`

Parameters: TabRenameParams

Property	Type	Required	Description
`label`	`string`	yes
`tab_id`	`string`	yes

`tab.close`

Parameters: TabTarget

Property	Type	Required	Description
`tab_id`	`string`	yes

`agent.list`

Parameters: EmptyParams

No properties.

`agent.get`

Parameters: AgentTarget

Property	Type	Required	Description
`target`	`string`	yes

`agent.read`

Parameters: AgentReadParams

Property	Type	Required
`format`	`ReadFormat`	no
`lines`	`integer \| null`	no
`source`	`ReadSource`	yes
`strip_ansi`	`boolean`	no
`target`	`string`	yes

`agent.explain`

Parameters: AgentTarget

Property	Type	Required	Description
`target`	`string`	yes

`agent.send_keys`

Parameters: AgentSendKeysParams

Property	Type	Required	Description
`keys`	`string[]`	yes
`target`	`string`	yes

`agent.prompt`

Parameters: AgentPromptParams

Property	Type	Required
`target`	`string`	yes
`text`	`string`	yes
`wait`	`AgentPromptWaitOptions \| null`	no

`agent.rename`

Parameters: AgentRenameParams

Property	Type	Required	Description
`name`	`string \| null`	no
`target`	`string`	yes

`agent.view.set`

Parameters: AgentViewSetParams

Property	Type	Required
`filter`	`AgentViewFilter \| null`	no
`label`	`string \| null`	no
`sort`	`AgentViewSort[]`	no
`source`	`string`	yes

`agent.view.clear`

Parameters: AgentViewClearParams

Property	Type	Required	Description
`source`	`string \| null`	no

`agent.focus`

Parameters: AgentTarget

Property	Type	Required	Description
`target`	`string`	yes

`agent.start`

Parameters: AgentStartParams

Property	Type	Required
`argv`	`string[]`	yes
`cwd`	`string \| null`	no
`env`	`object`	no
`focus`	`boolean`	no
`location`	`ResourceLocationParams \| null`	no
`name`	`string`	yes
`split`	`SplitDirection \| null`	no
`tab_id`	`string \| null`	no
`workspace_id`	`string \| null`	no

`agent.wait`

Parameters: AgentWaitParams

Property	Type	Required
`target`	`string`	yes
`timeout_ms`	`integer \| null`	no
`until`	`AgentStatus[]`	no

`pane.split`

Parameters: PaneSplitParams

Property	Type	Required
`cwd`	`string \| null`	no
`direction`	`SplitDirection`	yes
`env`	`object`	no
`focus`	`boolean`	no
`location`	`ResourceLocationParams \| null`	no
`ratio`	`number \| null`	no
`target_pane_id`	`string \| null`	no
`workspace_id`	`string \| null`	no

`pane.focus`

Parameters: PaneTarget

Property	Type	Required	Description
`pane_id`	`string`	yes

`pane.swap`

Parameters: PaneSwapParams

Property	Type	Required
`direction`	`PaneDirection \| null`	no
`pane_id`	`string \| null`	no
`source_pane_id`	`string \| null`	no
`target_pane_id`	`string \| null`	no

`pane.move`

Parameters: PaneMoveParams

Property	Type	Required
`destination`	`PaneMoveDestination`	yes
`focus`	`boolean`	no
`pane_id`	`string`	yes

`pane.zoom`

Parameters: PaneZoomParams

Property	Type	Required	Description
`mode`	`PaneZoomMode`	no
`pane_id`	`string \| null`	no

`pane.layout`

Parameters: PaneLayoutParams

Property	Type	Required	Description
`pane_id`	`string \| null`	no

`pane.process_info`

Parameters: PaneProcessInfoParams

Property	Type	Required	Description
`pane_id`	`string \| null`	no

`layout.export`

Parameters: LayoutExportParams

Property	Type	Required	Description
`pane_id`	`string \| null`	no
`tab_id`	`string \| null`	no

`layout.apply`

Parameters: LayoutApplyParams

Property	Type	Required
`focus`	`boolean`	no
`root`	`LayoutNode`	yes
`tab_id`	`string \| null`	no
`tab_label`	`string \| null`	no
`workspace_id`	`string \| null`	no

`pane.neighbor`

Parameters: PaneNeighborParams

Property	Type	Required	Description
`direction`	`PaneDirection`	yes
`pane_id`	`string \| null`	no

`pane.edges`

Parameters: PaneEdgesParams

Property	Type	Required	Description
`pane_id`	`string \| null`	no

`pane.focus_direction`

Parameters: PaneFocusDirectionParams

Property	Type	Required	Description
`direction`	`PaneDirection`	yes
`pane_id`	`string \| null`	no

`pane.resize`

Parameters: PaneResizeParams

Property	Type	Required
`amount`	`number \| null`	no
`direction`	`PaneDirection`	yes
`pane_id`	`string \| null`	no

`pane.list`

Parameters: PaneListParams

Property	Type	Required	Description
`workspace_id`	`string \| null`	no

`pane.current`

Parameters: PaneCurrentParams

Property	Type	Required	Description
`caller_pane_id`	`string \| null`	no

`pane.get`

Parameters: PaneTarget

Property	Type	Required	Description
`pane_id`	`string`	yes

`pane.rename`

Parameters: PaneRenameParams

Property	Type	Required	Description
`label`	`string \| null`	no
`pane_id`	`string`	yes

`pane.send_text`

Parameters: PaneSendTextParams

Property	Type	Required	Description
`pane_id`	`string`	yes
`text`	`string`	yes

`pane.send_keys`

Parameters: PaneSendKeysParams

Property	Type	Required	Description
`keys`	`string[]`	yes
`pane_id`	`string`	yes

`pane.send_input`

Parameters: PaneSendInputParams

Property	Type	Required
`keys`	`string[]`	no
`pane_id`	`string`	yes
`text`	`string`	no

`pane.read`

Parameters: PaneReadParams

Property	Type	Required
`format`	`ReadFormat`	no
`lines`	`integer \| null`	no
`pane_id`	`string`	yes
`source`	`ReadSource`	yes
`strip_ansi`	`boolean`	no

`pane.graphics.set`

Parameters: PaneGraphicsSetParams

Property	Type	Required
`data_base64`	`string`	no
`format`	`PaneGraphicsFormat`	yes
`image_height`	`integer`	yes
`image_width`	`integer`	yes
`layer_id`	`string \| null`	no
`pane_id`	`string`	yes
`placement`	`PaneGraphicsPlacementParams`	no
`z_index`	`integer`	no

`pane.graphics.clear`

Parameters: PaneGraphicsClearParams

Property	Type	Required	Description
`layer_id`	`string \| null`	no
`pane_id`	`string`	yes

`pane.graphics.info`

Parameters: PaneTarget

Property	Type	Required	Description
`pane_id`	`string`	yes

`pane.report_agent`

Parameters: PaneReportAgentParams

Property	Type	Required
`agent`	`string`	yes
`agent_session_id`	`string \| null`	no
`agent_session_path`	`string \| null`	no
`custom_status`	`string \| null`	no
`launch_env`	`object`	no
`message`	`string \| null`	no
`pane_id`	`string`	yes
`seq`	`integer \| null`	no
`source`	`string`	yes
`state`	`PaneAgentState`	yes

`pane.report_agent_session`

Parameters: PaneReportAgentSessionParams

Property	Type	Required
`agent`	`string`	yes
`agent_session_id`	`string \| null`	no
`agent_session_path`	`string \| null`	no
`launch_env`	`object`	no
`pane_id`	`string`	yes
`seq`	`integer \| null`	no
`session_start_source`	`string \| null`	no
`source`	`string`	yes

`pane.report_metadata`

Parameters: PaneReportMetadataParams

Property	Type	Required
`agent`	`string \| null`	no
`applies_to_source`	`string \| null`	no
`clear_custom_status`	`boolean`	no
`clear_display_agent`	`boolean`	no
`clear_state_labels`	`boolean`	no
`clear_title`	`boolean`	no
`custom_status`	`string \| null`	no
`display_agent`	`string \| null`	no
`pane_id`	`string`	yes
`seq`	`integer \| null`	no
`source`	`string`	yes
`state_labels`	`object`	no
`title`	`string \| null`	no
`tokens`	`object`	no
`ttl_ms`	`integer \| null`	no

`pane.clear_agent_authority`

Parameters: PaneClearAgentAuthorityParams

Property	Type	Required
`pane_id`	`string`	yes
`seq`	`integer \| null`	no
`source`	`string \| null`	no

`pane.release_agent`

Parameters: PaneReleaseAgentParams

Property	Type	Required
`agent`	`string`	yes
`agent_session_id`	`string \| null`	no
`agent_session_path`	`string \| null`	no
`pane_id`	`string`	yes
`seq`	`integer \| null`	no
`source`	`string`	yes

`pane.close`

Parameters: PaneTarget

Property	Type	Required	Description
`pane_id`	`string`	yes

`events.subscribe`

Parameters: EventsSubscribeParams

Property	Type	Required	Description
`subscriptions`	`Subscription[]`	yes

`events.wait`

Parameters: EventsWaitParams

Property	Type	Required	Description
`match_event`	`EventMatch`	yes
`timeout_ms`	`integer \| null`	no

`pane.wait_for_output`

Parameters: PaneWaitForOutputParams

Property	Type	Required
`lines`	`integer \| null`	no
`match`	`OutputMatch`	yes
`pane_id`	`string`	yes
`source`	`ReadSource`	yes
`strip_ansi`	`boolean`	no
`timeout_ms`	`integer \| null`	no

`integration.install`

Parameters: IntegrationInstallParams

Property	Type	Required	Description
`target`	`IntegrationTarget`	yes

`integration.uninstall`

Parameters: IntegrationUninstallParams

Property	Type	Required	Description
`target`	`IntegrationTarget`	yes

`plugin.link`

Parameters: PluginLinkParams

Property	Type	Required
`enabled`	`boolean`	no
`path`	`string`	yes
`source`	`PluginSourceInfo \| null`	no

`plugin.list`

Parameters: PluginListParams

Property	Type	Required	Description
`plugin_id`	`string \| null`	no

`plugin.unlink`

Parameters: PluginUnlinkParams

Property	Type	Required	Description
`plugin_id`	`string`	yes

`plugin.enable`

Parameters: PluginSetEnabledParams

Property	Type	Required	Description
`plugin_id`	`string`	yes

`plugin.disable`

Parameters: PluginSetEnabledParams

Property	Type	Required	Description
`plugin_id`	`string`	yes

`plugin.action.list`

Parameters: PluginActionListParams

Property	Type	Required	Description
`plugin_id`	`string \| null`	no

`plugin.action.invoke`

Parameters: PluginActionInvokeParams

Property	Type	Required
`action_id`	`string`	yes
`context`	`PluginInvocationContext \| null`	no
`plugin_id`	`string \| null`	no

`plugin.log.list`

Parameters: PluginLogListParams

Property	Type	Required	Description
`limit`	`integer \| null`	no
`plugin_id`	`string \| null`	no

`plugin.pane.open`

Parameters: PluginPaneOpenParams

Property	Type	Required
`cwd`	`string \| null`	no
`direction`	`SplitDirection \| null`	no
`entrypoint`	`string`	yes
`env`	`object`	no
`focus`	`boolean`	no
`placement`	`PluginPanePlacement \| null`	no
`plugin_id`	`string`	yes
`target_pane_id`	`string \| null`	no
`workspace_id`	`string \| null`	no

`plugin.pane.focus`

Parameters: PluginPaneFocusParams

Property	Type	Required	Description
`pane_id`	`string`	yes

`plugin.pane.close`

Parameters: PluginPaneCloseParams

Property	Type	Required	Description
`pane_id`	`string`	yes

Data types

`AgentPromptWaitOptions`

Property	Type	Required	Description
`timeout_ms`	`integer \| null`	no
`until`	`AgentStatus[]`	no

`AgentViewField`

Variants:

AgentViewBuiltinField
object

`AgentViewFilter`

Variants:

object
object
object
object
object
object

`AgentViewSort`

Property	Type	Required	Description
`field`	`AgentViewSortField`	yes
`order`	`AgentViewSortOrder`	no

`AgentViewSortField`

Variants:

AgentViewBuiltinSortField
object

`AgentViewValue`

Variants:

string
boolean
integer
object

`EventMatch`

Variants:

object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object

`LayoutNode`

Variants:

pane
split

`OutputMatch`

Variants:

substring
regex

`PaneGraphicsPlacementParams`

Property	Type	Required
`grid_cols`	`integer`	no
`grid_rows`	`integer`	no
`viewport_col`	`integer`	no
`viewport_row`	`integer`	no

`PaneMoveDestination`

Variants:

tab
new_tab
new_workspace

`PluginInvocationContext`

Property	Type	Required
`clicked_url`	`string \| null`	no
`correlation_id`	`string \| null`	no
`focused_pane_agent`	`string \| null`	no
`focused_pane_cwd`	`string \| null`	no
`focused_pane_id`	`string \| null`	no
`focused_pane_status`	`AgentStatus \| null`	no
`invocation_source`	`string \| null`	no
`link_handler_id`	`string \| null`	no
`selected_text`	`string \| null`	no
`tab_id`	`string \| null`	no
`tab_label`	`string \| null`	no
`workspace_cwd`	`string \| null`	no
`workspace_id`	`string \| null`	no
`workspace_label`	`string \| null`	no

`PluginSourceInfo`

Property	Type	Required
`installed_unix_ms`	`integer \| null`	no
`kind`	`PluginSourceKind`	no
`managed_path`	`string \| null`	no
`owner`	`string \| null`	no
`repo`	`string \| null`	no
`requested_ref`	`string \| null`	no
`resolved_commit`	`string \| null`	no
`subdir`	`string \| null`	no

`ResourceLocationParams`

Property	Type	Required	Description
`execution_host_id`	`string`	yes
`path`	`string`	yes

`Subscription`

Variants:

workspace.created
workspace.updated
workspace.renamed
workspace.closed
workspace.focused
tab.created
tab.closed
tab.focused
tab.renamed
pane.created
pane.closed
pane.focused
pane.moved
pane.exited
pane.agent_detected
pane.output_matched
pane.agent_status_changed
pane.scroll_changed
layout.updated
connection.status_changed

Requests

On this page