DocumentationLocal APIReferenceShape reference

Events

Generated operational and subscription event shapes.

Events

`EventEnvelope`

Property	Type	Required	Description
`data`	`EventData`	yes
`event`	`EventKind`	yes

`PaneOutputMatchedEvent`

Property	Type	Required	Description
`matched_line`	`string`	yes
`pane_id`	`string`	yes
`read`	`PaneReadResult`	yes

`PaneAgentStatusChangedEvent`

Property	Type	Required	Description
`agent`	`string \| null`	no
`agent_status`	`AgentStatus`	yes
`custom_status`	`string \| null`	no
`display_agent`	`string \| null`	no
`pane_id`	`string`	yes
`state_labels`	`object`	no
`title`	`string \| null`	no
`tokens`	`object`	no
`workspace_id`	`string`	yes

`PaneScrollChangedEvent`

Property	Type	Required	Description
`pane_id`	`string`	yes
`scroll`	`PaneScrollInfo`	yes
`workspace_id`	`string`	yes

Last updated on

Responses

Generated successful Local API response result shapes.

Errors

Generated Local API error response shape.

On this page

Events EventEnvelopePaneOutputMatchedEventPaneAgentStatusChangedEventPaneScrollChangedEvent