Events

99 types. Import any of them from opencode.types.

AgentUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['agent.updated'] = 'agent.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

CommandUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['command.updated'] = 'command.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

ConfigUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['config.updated'] = 'config.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

CredentialSwitchedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["credential.switched"] = "credential.switched"

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: CredentialSwitchedEventData

CredentialUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['credential.updated'] = 'credential.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

Event module-attribute

Event: TypeAlias = Annotated[
    Annotated[
        LocationShutdownEvent, Tag("location.shutdown")
    ]
    | Annotated[
        ModelsDevRefreshedEvent, Tag("models-dev.refreshed")
    ]
    | Annotated[
        CredentialUpdatedEvent, Tag("credential.updated")
    ]
    | Annotated[
        CredentialSwitchedEvent, Tag("credential.switched")
    ]
    | Annotated[
        IntegrationUpdatedEvent, Tag("integration.updated")
    ]
    | Annotated[
        ProviderUpdatedEvent, Tag("provider.updated")
    ]
    | Annotated[ModelUpdatedEvent, Tag("model.updated")]
    | Annotated[AgentUpdatedEvent, Tag("agent.updated")]
    | Annotated[SessionCreatedEvent, Tag("session.created")]
    | Annotated[
        SessionAgentSelectedEvent,
        Tag("session.agent.selected"),
    ]
    | Annotated[
        SessionModelSelectedEvent,
        Tag("session.model.selected"),
    ]
    | Annotated[SessionMovedEvent, Tag("session.moved")]
    | Annotated[SessionRenamedEvent, Tag("session.renamed")]
    | Annotated[
        SessionMetadataUpdatedEvent,
        Tag("session.metadata.updated"),
    ]
    | Annotated[
        SessionPermissionsEvent, Tag("session.permissions")
    ]
    | Annotated[SessionViewedEvent, Tag("session.viewed")]
    | Annotated[
        SessionArchivedEvent, Tag("session.archived")
    ]
    | Annotated[
        SessionUnarchivedEvent, Tag("session.unarchived")
    ]
    | Annotated[
        SessionUsageUpdatedEvent,
        Tag("session.usage.updated"),
    ]
    | Annotated[SessionDeletedEvent, Tag("session.deleted")]
    | Annotated[SessionForkedEvent, Tag("session.forked")]
    | Annotated[
        SessionInboxDeliveredEvent,
        Tag("session.inbox.delivered"),
    ]
    | Annotated[
        SessionInboxEnqueuedEvent,
        Tag("session.inbox.enqueued"),
    ]
    | Annotated[
        SessionInboxCancelledEvent,
        Tag("session.inbox.cancelled"),
    ]
    | Annotated[
        SessionInboxDeliveryChangedEvent,
        Tag("session.inbox.delivery.changed"),
    ]
    | Annotated[
        SessionExecutionStartedEvent,
        Tag("session.execution.started"),
    ]
    | Annotated[
        SessionExecutionSucceededEvent,
        Tag("session.execution.succeeded"),
    ]
    | Annotated[
        SessionExecutionFailedEvent,
        Tag("session.execution.failed"),
    ]
    | Annotated[
        SessionExecutionInterruptedEvent,
        Tag("session.execution.interrupted"),
    ]
    | Annotated[
        SessionInstructionsUpdatedEvent,
        Tag("session.instructions.updated"),
    ]
    | Annotated[
        SessionSyntheticEvent, Tag("session.synthetic")
    ]
    | Annotated[
        SessionSkillActivatedEvent,
        Tag("session.skill.activated"),
    ]
    | Annotated[
        SessionShellStartedEvent,
        Tag("session.shell.started"),
    ]
    | Annotated[
        SessionShellEndedEvent, Tag("session.shell.ended")
    ]
    | Annotated[
        SessionStepStartedEvent, Tag("session.step.started")
    ]
    | Annotated[
        SessionStepStreamedEvent,
        Tag("session.step.streamed"),
    ]
    | Annotated[
        SessionStepEndedEvent, Tag("session.step.ended")
    ]
    | Annotated[
        SessionStepFailedEvent, Tag("session.step.failed")
    ]
    | Annotated[
        SessionTextStartedEvent, Tag("session.text.started")
    ]
    | Annotated[
        SessionTextDeltaEvent, Tag("session.text.delta")
    ]
    | Annotated[
        SessionTextEndedEvent, Tag("session.text.ended")
    ]
    | Annotated[
        SessionReasoningStartedEvent,
        Tag("session.reasoning.started"),
    ]
    | Annotated[
        SessionReasoningDeltaEvent,
        Tag("session.reasoning.delta"),
    ]
    | Annotated[
        SessionReasoningEndedEvent,
        Tag("session.reasoning.ended"),
    ]
    | Annotated[
        SessionToolInputStartedEvent,
        Tag("session.tool.input.started"),
    ]
    | Annotated[
        SessionToolInputDeltaEvent,
        Tag("session.tool.input.delta"),
    ]
    | Annotated[
        SessionToolInputEndedEvent,
        Tag("session.tool.input.ended"),
    ]
    | Annotated[
        SessionToolCalledEvent, Tag("session.tool.called")
    ]
    | Annotated[
        SessionToolProgressEvent,
        Tag("session.tool.progress"),
    ]
    | Annotated[
        SessionToolSuccessEvent, Tag("session.tool.success")
    ]
    | Annotated[
        SessionToolFailedEvent, Tag("session.tool.failed")
    ]
    | Annotated[
        SessionRetryScheduledEvent,
        Tag("session.retry.scheduled"),
    ]
    | Annotated[
        SessionCompactionStartedEvent,
        Tag("session.compaction.started"),
    ]
    | Annotated[
        SessionCompactionDeltaEvent,
        Tag("session.compaction.delta"),
    ]
    | Annotated[
        SessionCompactionEndedEvent,
        Tag("session.compaction.ended"),
    ]
    | Annotated[
        SessionCompactionFailedEvent,
        Tag("session.compaction.failed"),
    ]
    | Annotated[
        SessionRevertStagedEvent,
        Tag("session.revert.staged"),
    ]
    | Annotated[
        SessionRevertClearedEvent,
        Tag("session.revert.cleared"),
    ]
    | Annotated[
        SessionRevertCommittedEvent,
        Tag("session.revert.committed"),
    ]
    | Annotated[
        FilesystemChangedEvent, Tag("filesystem.changed")
    ]
    | Annotated[
        ReferenceUpdatedEvent, Tag("reference.updated")
    ]
    | Annotated[
        PermissionAskedEvent, Tag("permission.asked")
    ]
    | Annotated[
        PermissionRepliedEvent, Tag("permission.replied")
    ]
    | Annotated[PluginUpdatedEvent, Tag("plugin.updated")]
    | Annotated[ProjectUpdatedEvent, Tag("project.updated")]
    | Annotated[
        WorktreeUpdatedEvent, Tag("worktree.updated")
    ]
    | Annotated[
        WorktreeResolvedEvent, Tag("worktree.resolved")
    ]
    | Annotated[CommandUpdatedEvent, Tag("command.updated")]
    | Annotated[ConfigUpdatedEvent, Tag("config.updated")]
    | Annotated[SkillUpdatedEvent, Tag("skill.updated")]
    | Annotated[PtyCreatedEvent, Tag("pty.created")]
    | Annotated[PtyUpdatedEvent, Tag("pty.updated")]
    | Annotated[PtyExitedEvent, Tag("pty.exited")]
    | Annotated[PtyDeletedEvent, Tag("pty.deleted")]
    | Annotated[
        PersistentPtyAddedEvent, Tag("persistent-pty.added")
    ]
    | Annotated[
        PersistentPtyRemovedEvent,
        Tag("persistent-pty.removed"),
    ]
    | Annotated[ShellCreatedEvent, Tag("shell.created")]
    | Annotated[ShellExitedEvent, Tag("shell.exited")]
    | Annotated[ShellDeletedEvent, Tag("shell.deleted")]
    | Annotated[FormCreatedEvent, Tag("form.created")]
    | Annotated[FormRepliedEvent, Tag("form.replied")]
    | Annotated[FormCancelledEvent, Tag("form.cancelled")]
    | Annotated[
        WebsearchUpdatedEvent, Tag("websearch.updated")
    ]
    | Annotated[SessionStatusUpdated, Tag("session.status")]
    | Annotated[SessionIdleEvent, Tag("session.idle")]
    | Annotated[
        TuiPromptAppendEvent, Tag("tui.prompt.append")
    ]
    | Annotated[
        TuiCommandExecuteEvent, Tag("tui.command.execute")
    ]
    | Annotated[TuiToastShowEvent, Tag("tui.toast.show")]
    | Annotated[
        TuiSessionSelectEvent, Tag("tui.session.select")
    ]
    | Annotated[
        InstallationUpdatedEvent,
        Tag("installation.updated"),
    ]
    | Annotated[
        InstallationUpdateAvailableEvent,
        Tag("installation.update-available"),
    ]
    | Annotated[
        VcsBranchUpdatedEvent, Tag("vcs.branch.updated")
    ]
    | Annotated[
        McpStatusChangedEvent, Tag("mcp.status.changed")
    ]
    | Annotated[
        McpResourcesChangedEvent,
        Tag("mcp.resources.changed"),
    ]
    | Annotated[RpcEvent, Tag("pattern:^rpc\\.[\\s\\S]*?$")]
    | Annotated[
        ServerConnectedEvent, Tag("server.connected")
    ]
    | Annotated[UnknownEvent, Tag("__unknown__")],
    Discriminator(
        discriminator(
            "type",
            "type",
            [
                "location.shutdown",
                "models-dev.refreshed",
                "credential.updated",
                "credential.switched",
                "integration.updated",
                "provider.updated",
                "model.updated",
                "agent.updated",
                "session.created",
                "session.agent.selected",
                "session.model.selected",
                "session.moved",
                "session.renamed",
                "session.metadata.updated",
                "session.permissions",
                "session.viewed",
                "session.archived",
                "session.unarchived",
                "session.usage.updated",
                "session.deleted",
                "session.forked",
                "session.inbox.delivered",
                "session.inbox.enqueued",
                "session.inbox.cancelled",
                "session.inbox.delivery.changed",
                "session.execution.started",
                "session.execution.succeeded",
                "session.execution.failed",
                "session.execution.interrupted",
                "session.instructions.updated",
                "session.synthetic",
                "session.skill.activated",
                "session.shell.started",
                "session.shell.ended",
                "session.step.started",
                "session.step.streamed",
                "session.step.ended",
                "session.step.failed",
                "session.text.started",
                "session.text.delta",
                "session.text.ended",
                "session.reasoning.started",
                "session.reasoning.delta",
                "session.reasoning.ended",
                "session.tool.input.started",
                "session.tool.input.delta",
                "session.tool.input.ended",
                "session.tool.called",
                "session.tool.progress",
                "session.tool.success",
                "session.tool.failed",
                "session.retry.scheduled",
                "session.compaction.started",
                "session.compaction.delta",
                "session.compaction.ended",
                "session.compaction.failed",
                "session.revert.staged",
                "session.revert.cleared",
                "session.revert.committed",
                "filesystem.changed",
                "reference.updated",
                "permission.asked",
                "permission.replied",
                "plugin.updated",
                "project.updated",
                "worktree.updated",
                "worktree.resolved",
                "command.updated",
                "config.updated",
                "skill.updated",
                "pty.created",
                "pty.updated",
                "pty.exited",
                "pty.deleted",
                "persistent-pty.added",
                "persistent-pty.removed",
                "shell.created",
                "shell.exited",
                "shell.deleted",
                "form.created",
                "form.replied",
                "form.cancelled",
                "websearch.updated",
                "session.status",
                "session.idle",
                "tui.prompt.append",
                "tui.command.execute",
                "tui.toast.show",
                "tui.session.select",
                "installation.updated",
                "installation.update-available",
                "vcs.branch.updated",
                "mcp.status.changed",
                "mcp.resources.changed",
                "server.connected",
            ],
            patterns=[
                (
                    "^rpc\\.[\\s\\S]*?$",
                    "pattern:^rpc\\.[\\s\\S]*?$",
                )
            ],
        )
    ),
]

FilesystemChangedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['filesystem.changed'] = 'filesystem.changed'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: FilesystemChangedEventData

FormCancelledEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['form.cancelled'] = 'form.cancelled'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: FormCancelledEventData

FormCreatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['form.created'] = 'form.created'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: FormCreatedEventData

FormRepliedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['form.replied'] = 'form.replied'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: FormRepliedEventData

InstallationUpdateAvailableEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["installation.update-available"] = (
    "installation.update-available"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: InstallationUpdateAvailableEventData

InstallationUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["installation.updated"] = (
    "installation.updated"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: InstallationUpdatedEventData

IntegrationUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["integration.updated"] = "integration.updated"

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

LocationShutdownEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['location.shutdown'] = 'location.shutdown'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

McpResourcesChangedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["mcp.resources.changed"] = (
    "mcp.resources.changed"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: McpResourcesChangedEventData

McpStatusChangedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['mcp.status.changed'] = 'mcp.status.changed'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: McpStatusChangedEventData

ModelUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['model.updated'] = 'model.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

ModelsDevRefreshedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["models-dev.refreshed"] = (
    "models-dev.refreshed"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

PermissionAskedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['permission.asked'] = 'permission.asked'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PermissionAskedEventData

PermissionRepliedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['permission.replied'] = 'permission.replied'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PermissionRepliedEventData

PersistentPtyAddedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["persistent-pty.added"] = (
    "persistent-pty.added"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PersistentPtyAddedEventData

PersistentPtyRemovedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["persistent-pty.removed"] = (
    "persistent-pty.removed"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PersistentPtyRemovedEventData

PluginUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['plugin.updated'] = 'plugin.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

ProjectUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['project.updated'] = 'project.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: ProjectUpdatedEventData

ProviderUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['provider.updated'] = 'provider.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

PtyCreatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['pty.created'] = 'pty.created'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PtyCreatedEventData

PtyDeletedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['pty.deleted'] = 'pty.deleted'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PtyDeletedEventData

PtyExitedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['pty.exited'] = 'pty.exited'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PtyExitedEventData

PtyUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['pty.updated'] = 'pty.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: PtyUpdatedEventData

ReferenceUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['reference.updated'] = 'reference.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

RpcEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = None

type instance-attribute

type: str

location instance-attribute

location: LocationPublicRef

data instance-attribute

data: dict[str, Any]

ServerConnectedEvent

id instance-attribute

id: EventID

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = None

location class-attribute instance-attribute

location: LocationPublicRef | None = None

type class-attribute instance-attribute

type: Literal['server.connected'] = 'server.connected'

data instance-attribute

data: Any

SessionAgentSelectedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.agent.selected"] = (
    "session.agent.selected"
)

durable instance-attribute

durable: SessionAgentSelectedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionAgentSelectedEventData

SessionArchivedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.archived'] = 'session.archived'

durable instance-attribute

durable: SessionArchivedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionArchivedEventData

SessionCompactionDeltaEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.compaction.delta"] = (
    "session.compaction.delta"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionCompactionDeltaEventData

SessionCompactionEndedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.compaction.ended"] = (
    "session.compaction.ended"
)

durable instance-attribute

durable: SessionCompactionEndedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionCompactionEndedEventData

SessionCompactionFailedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.compaction.failed"] = (
    "session.compaction.failed"
)

durable instance-attribute

durable: SessionCompactionFailedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionCompactionFailedEventData

SessionCompactionStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.compaction.started"] = (
    "session.compaction.started"
)

durable instance-attribute

durable: SessionCompactionStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionCompactionStartedEventData

SessionCreatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.created'] = 'session.created'

durable instance-attribute

durable: SessionCreatedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionCreatedEventData

SessionDeletedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.deleted'] = 'session.deleted'

durable instance-attribute

durable: SessionDeletedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionDeletedEventData

SessionExecutionFailedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.execution.failed"] = (
    "session.execution.failed"
)

durable instance-attribute

durable: SessionExecutionFailedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionExecutionFailedEventData

SessionExecutionInterruptedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.execution.interrupted"] = (
    "session.execution.interrupted"
)

durable instance-attribute

durable: SessionExecutionInterruptedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionExecutionInterruptedEventData

SessionExecutionStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.execution.started"] = (
    "session.execution.started"
)

durable instance-attribute

durable: SessionExecutionStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionExecutionStartedEventData

SessionExecutionSucceededEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.execution.succeeded"] = (
    "session.execution.succeeded"
)

durable instance-attribute

durable: SessionExecutionSucceededEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionExecutionSucceededEventData

SessionForkedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.forked'] = 'session.forked'

durable instance-attribute

durable: SessionForkedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionForkedEventData

SessionIdleEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.idle'] = 'session.idle'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionIdleEventData

SessionInboxCancelledEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.inbox.cancelled"] = (
    "session.inbox.cancelled"
)

durable instance-attribute

durable: SessionInboxCancelledEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionInboxCancelledEventData

SessionInboxDeliveredEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.inbox.delivered"] = (
    "session.inbox.delivered"
)

durable instance-attribute

durable: SessionInboxDeliveredEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionInboxDeliveredEventData

SessionInboxDeliveryChangedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.inbox.delivery.changed"] = (
    "session.inbox.delivery.changed"
)

durable instance-attribute

durable: SessionInboxDeliveryChangedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionInboxDeliveryChangedEventData

SessionInboxEnqueuedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.inbox.enqueued"] = (
    "session.inbox.enqueued"
)

durable instance-attribute

durable: SessionInboxEnqueuedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionInboxEnqueuedEventData

SessionInstructionsUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.instructions.updated"] = (
    "session.instructions.updated"
)

durable instance-attribute

durable: SessionInstructionsUpdatedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionInstructionsUpdatedEventData

SessionMessageContentUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.message.content.updated"] = (
    "session.message.content.updated"
)

durable instance-attribute

durable: SessionMessageContentUpdatedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionMessageContentUpdatedEventData

SessionMetadataUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.metadata.updated"] = (
    "session.metadata.updated"
)

durable instance-attribute

durable: SessionMetadataUpdatedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionMetadataUpdatedEventData

SessionModelSelectedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.model.selected"] = (
    "session.model.selected"
)

durable instance-attribute

durable: SessionModelSelectedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionModelSelectedEventData

SessionMovedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.moved'] = 'session.moved'

durable instance-attribute

durable: SessionMovedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionMovedEventData

SessionPermissionsEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.permissions"] = "session.permissions"

durable instance-attribute

durable: SessionPermissionsEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionPermissionsEventData

SessionReasoningDeltaEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.reasoning.delta"] = (
    "session.reasoning.delta"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionReasoningDeltaEventData

SessionReasoningEndedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.reasoning.ended"] = (
    "session.reasoning.ended"
)

durable instance-attribute

durable: SessionReasoningEndedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionReasoningEndedEventData

SessionReasoningStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.reasoning.started"] = (
    "session.reasoning.started"
)

durable instance-attribute

durable: SessionReasoningStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionReasoningStartedEventData

SessionRenamedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.renamed'] = 'session.renamed'

durable instance-attribute

durable: SessionRenamedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionRenamedEventData

SessionRetryScheduledEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.retry.scheduled"] = (
    "session.retry.scheduled"
)

durable instance-attribute

durable: SessionRetryScheduledEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionRetryScheduledEventData

SessionRevertClearedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.revert.cleared"] = (
    "session.revert.cleared"
)

durable instance-attribute

durable: SessionRevertClearedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionRevertClearedEventData

SessionRevertCommittedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.revert.committed"] = (
    "session.revert.committed"
)

durable instance-attribute

durable: SessionRevertCommittedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionRevertCommittedEventData

SessionRevertStagedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.revert.staged"] = (
    "session.revert.staged"
)

durable instance-attribute

durable: SessionRevertStagedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionRevertStagedEventData

SessionShellEndedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.shell.ended"] = "session.shell.ended"

durable instance-attribute

durable: SessionShellEndedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionShellEndedEventData

SessionShellStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.shell.started"] = (
    "session.shell.started"
)

durable instance-attribute

durable: SessionShellStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionShellStartedEventData

SessionSkillActivatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.skill.activated"] = (
    "session.skill.activated"
)

durable instance-attribute

durable: SessionSkillActivatedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionSkillActivatedEventData

SessionStepEndedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.step.ended'] = 'session.step.ended'

durable instance-attribute

durable: SessionStepEndedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionStepEndedEventData

SessionStepFailedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.step.failed"] = "session.step.failed"

durable instance-attribute

durable: SessionStepFailedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionStepFailedEventData

SessionStepStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.step.started"] = (
    "session.step.started"
)

durable instance-attribute

durable: SessionStepStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionStepStartedEventData

SessionStepStreamedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.step.streamed"] = (
    "session.step.streamed"
)

durable instance-attribute

durable: SessionStepStreamedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionStepStreamedEventData

SessionSyntheticEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.synthetic'] = 'session.synthetic'

durable instance-attribute

durable: SessionSyntheticEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionSyntheticEventData

SessionTextDeltaEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.text.delta'] = 'session.text.delta'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionTextDeltaEventData

SessionTextEndedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.text.ended'] = 'session.text.ended'

durable instance-attribute

durable: SessionTextEndedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionTextEndedEventData

SessionTextStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.text.started"] = (
    "session.text.started"
)

durable instance-attribute

durable: SessionTextStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionTextStartedEventData

SessionToolCalledEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.called"] = "session.tool.called"

durable instance-attribute

durable: SessionToolCalledEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolCalledEventData

SessionToolFailedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.failed"] = "session.tool.failed"

durable instance-attribute

durable: SessionToolFailedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolFailedEventData

SessionToolInputDeltaEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.input.delta"] = (
    "session.tool.input.delta"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolInputDeltaEventData

SessionToolInputEndedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.input.ended"] = (
    "session.tool.input.ended"
)

durable instance-attribute

durable: SessionToolInputEndedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolInputEndedEventData

SessionToolInputStartedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.input.started"] = (
    "session.tool.input.started"
)

durable instance-attribute

durable: SessionToolInputStartedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolInputStartedEventData

SessionToolProgressEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.progress"] = (
    "session.tool.progress"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolProgressEventData

SessionToolSuccessEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.tool.success"] = (
    "session.tool.success"
)

durable instance-attribute

durable: SessionToolSuccessEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionToolSuccessEventData

SessionUnarchivedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.unarchived'] = 'session.unarchived'

durable instance-attribute

durable: SessionUnarchivedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionUnarchivedEventData

SessionUsageRecordedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.usage.recorded"] = (
    "session.usage.recorded"
)

durable instance-attribute

durable: SessionUsageRecordedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionUsageRecordedEventData

SessionUsageUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["session.usage.updated"] = (
    "session.usage.updated"
)

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionUsageUpdatedEventData

SessionViewedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['session.viewed'] = 'session.viewed'

durable instance-attribute

durable: SessionViewedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: SessionViewedEventData

ShellCreatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['shell.created'] = 'shell.created'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: ShellCreatedEventData

ShellDeletedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['shell.deleted'] = 'shell.deleted'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: ShellDeletedEventData

ShellExitedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['shell.exited'] = 'shell.exited'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: ShellExitedEventData

SkillUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['skill.updated'] = 'skill.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

TuiCommandExecuteEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal["tui.command.execute"] = "tui.command.execute"

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: TuiCommandExecuteEventData

TuiPromptAppendEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['tui.prompt.append'] = 'tui.prompt.append'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: TuiPromptAppendEventData

TuiSessionSelectEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['tui.session.select'] = 'tui.session.select'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: TuiSessionSelectEventData

TuiToastShowEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['tui.toast.show'] = 'tui.toast.show'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: TuiToastShowEventData

UnknownEvent

A Event variant this client version does not recognize.

Newer OpenCode servers can add variants. The raw fields are kept and available as attributes and through model_extra.

type class-attribute instance-attribute

type: Any = None

id class-attribute instance-attribute

id: EventID | None = None

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = None

VcsBranchUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['vcs.branch.updated'] = 'vcs.branch.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: VcsBranchUpdatedEventData

WebsearchUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['websearch.updated'] = 'websearch.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: Any

WorktreeResolvedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['worktree.resolved'] = 'worktree.resolved'

durable instance-attribute

durable: WorktreeResolvedEventDurable

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: WorktreeResolvedEventData

WorktreeUpdatedEvent

id instance-attribute

id: EventID

created instance-attribute

created: float

metadata class-attribute instance-attribute

metadata: dict[str, Any] | None = Field(
    default=None, exclude_if=is_none
)

type class-attribute instance-attribute

type: Literal['worktree.updated'] = 'worktree.updated'

location class-attribute instance-attribute

location: LocationRef | None = Field(
    default=None, exclude_if=is_none
)

data instance-attribute

data: WorktreeUpdatedEventData