Skip to main content

Module types

Module types 

Source

Structs§

AbsolutePathBuf
A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).
AccountLoginCompletedNotification
AccountRateLimitsUpdatedNotification
AccountTokenUsageDailyBucket
AccountTokenUsageSummary
AccountUpdatedNotification
ActivePermissionProfile
AdditionalFileSystemPermissions
AdditionalNetworkPermissions
AgentMessageDeltaNotification
AgentPath
AnalyticsConfig
AppBranding
AppInfo
AppListUpdatedNotification
AppMetadata
AppReview
AppScreenshot
AppSummary
AppTemplateSummary
AppToolSummary
ApplyPatchApprovalParams
ApplyPatchApprovalResponse
AppsInstalledParams
AppsInstalledResponse
AppsListParams
AppsListResponse
AppsReadParams
AppsReadResponse
AsyncUserInputQuestion
A question the agent asks the user asynchronously alongside an agentMessage item (upstream AsyncUserInputQuestion).
AttestationGenerateParams
AttestationGenerateResponse
AuthRecoveryNotification
modelProvider/authRecoveryStarted / modelProvider/authRecoveryCompleted params — the server is re-establishing a model provider’s credentials mid-turn (0.148 upstream).
AutoReviewRequirements
BrowserUseConfig
Browser-use configuration (config side, snake_case wire).
BrowserUseOriginPolicy
Per-origin browser-use policy (requirements side, camelCase wire).
BrowserUseOriginPolicyConfig
Per-origin browser-use policy (config side, snake_case wire).
BrowserUseRequirements
ByteRange
CancelLoginAccountParams
CancelLoginAccountResponse
ChatgptAuthTokensRefreshParams
ChatgptAuthTokensRefreshResponse
ClientInfo
CollabAgentState
CollaborationMode
CommandExecOutputDeltaNotification
CommandExecParams
CommandExecResizeParams
CommandExecResizeResponse
CommandExecResponse
CommandExecTerminalSize
CommandExecTerminateParams
CommandExecTerminateResponse
CommandExecWriteParams
CommandExecWriteResponse
CommandExecutionOutputDeltaNotification
CommandExecutionRequestApprovalParams
CommandExecutionRequestApprovalResponse
CommandMigration
ComputerUseConfig
Computer-use configuration (config side, snake_case wire).
ComputerUseMacosConfig
ComputerUseMacosRequirements
Per-platform computer-use requirements (camelCase wire).
ComputerUseRequirements
ComputerUseWindowsConfig
ComputerUseWindowsExeConfig
ComputerUseWindowsExeRequirement
ComputerUseWindowsRequirements
Config
ConfigBatchWriteParams
ConfigEdit
ConfigLayer
ConfigLayerMetadata
ConfigReadParams
ConfigReadResponse
ConfigRequirements
ConfigRequirementsReadResponse
ConfigValueWriteParams
ConfigWarningNotification
ConfigWriteResponse
ConnectorMetadata
ConsumeAccountRateLimitResetCreditParams
ConsumeAccountRateLimitResetCreditResponse
ContextCompactedNotification
CreditsSnapshot
DeprecationNoticeNotification
DynamicToolCallParams
DynamicToolCallResponse
EnvironmentConnectionNotification
ErrorNotification
ExecCommandApprovalParams
ExecCommandApprovalResponse
ExperimentalFeature
ExperimentalFeatureEnablementSetParams
ExperimentalFeatureEnablementSetResponse
ExperimentalFeatureListParams
ExperimentalFeatureListResponse
ExternalAgentConfigDetectParams
ExternalAgentConfigDetectResponse
ExternalAgentConfigImportCompletedNotification
ExternalAgentConfigImportHistoriesReadResponse
ExternalAgentConfigImportHistory
ExternalAgentConfigImportHistoryRecordParams
ExternalAgentConfigImportHistoryRecordResponse
ExternalAgentConfigImportHistoryRecordSuccessParams
ExternalAgentConfigImportHistoryRecordTypeResultParams
ExternalAgentConfigImportItemTypeFailure
ExternalAgentConfigImportItemTypeSuccess
ExternalAgentConfigImportParams
ExternalAgentConfigImportProgressNotification
ExternalAgentConfigImportResponse
ExternalAgentConfigImportTypeResult
ExternalAgentConfigMigrationItem
ExternalAgentDetectedConnectorCandidate
ExternalAgentImportedConnectorCandidate
FeedbackRequirements
FeedbackUploadParams
FeedbackUploadResponse
FileChangeOutputDeltaNotification
FileChangePatchUpdatedNotification
FileChangeRequestApprovalParams
FileChangeRequestApprovalResponse
FileSystemSandboxEntry
FileUpdateChange
FsChangedNotification
FsCopyParams
FsCopyResponse
FsCreateDirectoryParams
FsCreateDirectoryResponse
FsGetMetadataParams
FsGetMetadataResponse
FsReadDirectoryEntry
FsReadDirectoryParams
FsReadDirectoryResponse
FsReadFileParams
FsReadFileResponse
FsRemoveParams
FsRemoveResponse
FsUnwatchParams
FsUnwatchResponse
FsWatchParams
FsWatchResponse
FsWriteFileParams
FsWriteFileResponse
FuzzyFileSearchParams
FuzzyFileSearchResponse
FuzzyFileSearchResult
FuzzyFileSearchSessionCompletedNotification
FuzzyFileSearchSessionUpdatedNotification
GetAccountParams
GetAccountRateLimitsResponse
GetAccountResponse
GetAccountTokenUsageParams
GetAccountTokenUsageResponse
GetWorkspaceMessagesResponse
GitInfo
GrantedPermissionProfile
GuardianApprovalReview
GuardianWarningNotification
HookCompletedNotification
HookErrorInfo
HookMetadata
HookMigration
HookOutputEntry
HookPromptFragment
HookRunSummary
HookStartedNotification
HooksListEntry
HooksListParams
HooksListResponse
InAppBrowserRequirements
In-app browser requirements (0.148 upstream).
InitializeCapabilities
InitializeParams
InitializeResponse
InstalledApp
ItemCompletedNotification
ItemGuardianApprovalReviewCompletedNotification
ItemGuardianApprovalReviewStartedNotification
ItemStartedNotification
JSONRPCResponse
LegacyAppPathString
ListMcpServerStatusParams
ListMcpServerStatusResponse
LogoutAccountResponse
MarketplaceAddParams
MarketplaceAddResponse
MarketplaceInterface
MarketplaceLoadErrorInfo
MarketplaceRemoveParams
MarketplaceRemoveResponse
MarketplaceUpgradeErrorInfo
MarketplaceUpgradeParams
MarketplaceUpgradeResponse
McpElicitationBooleanSchema
McpElicitationConstOption
McpElicitationLegacyTitledEnumSchema
McpElicitationNumberSchema
McpElicitationSchema
McpElicitationStringSchema
McpElicitationTitledEnumItems
McpElicitationTitledMultiSelectEnumSchema
McpElicitationTitledSingleSelectEnumSchema
McpElicitationUntitledEnumItems
McpElicitationUntitledMultiSelectEnumSchema
McpElicitationUntitledSingleSelectEnumSchema
McpResourceReadParams
McpResourceReadResponse
McpServerElicitationRequestResponse
McpServerEventNotification
One MCP-server-originated notification, relayed verbatim.
McpServerEventStreamNotification
mcpServer/event/stream/notification — an MCP server’s own notification stream, forwarded to subscribers.
McpServerInfo
McpServerMigration
McpServerOauthLoginCompletedNotification
McpServerOauthLoginParams
McpServerOauthLoginResponse
McpServerRefreshResponse
McpServerStatus
McpServerStatusUpdatedNotification
McpServerToolCallParams
McpServerToolCallResponse
McpToolCallAppContext
McpToolCallError
McpToolCallProgressNotification
McpToolCallResult
MemoryCitation
MemoryCitationEntry
MigrationDetails
MisalignmentErrorDetails
Public explanation and continuation instruction attached to a misalignment-blocked turn error (0.148 upstream).
MisalignmentSteer
The steering instruction inside MisalignmentErrorDetails.
Model
ModelAvailabilityNux
ModelListParams
ModelListResponse
ModelProviderCapabilitiesReadParams
ModelProviderCapabilitiesReadResponse
ModelReroutedNotification
ModelSafetyBufferingUpdatedNotification
ModelServiceTier
ModelUpgradeInfo
ModelVerificationNotification
ModelsRequirements
NetworkApprovalContext
NetworkPolicyAmendment
NewThreadModelDefaults
OverriddenMetadata
PermissionProfileListParams
PermissionProfileListResponse
PermissionProfileSummary
PermissionsRequestApprovalParams
PermissionsRequestApprovalResponse
PlanDeltaNotification
PluginDetail
PluginHookSummary
PluginInstallParams
PluginInstallResponse
PluginInstalledParams
PluginInstalledResponse
PluginInterface
PluginListParams
PluginListResponse
PluginMarketplaceEntry
PluginReadParams
PluginReadResponse
PluginReconcileChangedPlugin
Runtime categories affected by this change, not just capabilities currently present. Flags describe declarations before runtime policy filtering. Updates OR the old and new bundle flags; enablement changes and cached reinstalls use the cached bundle; removals retain the old bundle’s flags.
PluginReconcileParams
PluginReconcileResponse
Bundle and installed-state changes observed by this pass, not a runtime-readiness acknowledgement or a cumulative diff since the client’s last request. Other metadata-only changes are not listed.
PluginShareCheckoutParams
PluginShareCheckoutResponse
PluginShareContext
PluginShareDeleteParams
PluginShareDeleteResponse
PluginShareListItem
PluginShareListParams
PluginShareListResponse
PluginSharePrincipal
PluginShareSaveParams
PluginShareSaveResponse
PluginShareTarget
PluginShareUpdateTargetsParams
PluginShareUpdateTargetsResponse
PluginSkillReadParams
PluginSkillReadResponse
PluginSummary
PluginUninstallParams
PluginUninstallResponse
PluginsMigration
ProcessExitedNotification
ProcessOutputDeltaNotification
Project
A project grouping threads, owned by app-server.
ProjectChangedNotification
project/changed — a project was created, updated, or deleted.
ProjectRoot
QueuedSubmission
A user submission waiting in a thread’s queue.
RateLimitResetCredit
RateLimitResetCreditsSummary
RateLimitSnapshot
RateLimitWindow
ReasoningEffort
A non-empty reasoning effort value advertised by the model.
ReasoningEffortOption
ReasoningSummaryPartAddedNotification
ReasoningSummaryTextDeltaNotification
ReasoningTextDeltaNotification
RemoteControlStatusChangedNotification
RequestPermissionProfile
Resource
ResourceTemplate
ResponseUsageMetadata
Usage metadata reported for one upstream response (0.148 upstream).
ReviewStartParams
ReviewStartResponse
SandboxWorkspaceWrite
ScheduledTaskSummary
SendAddCreditsNudgeEmailParams
SendAddCreditsNudgeEmailResponse
ServerRequestResolvedNotification
SessionMigration
Settings
SkillDependencies
SkillErrorInfo
SkillInterface
SkillMetadata
SkillMigration
SkillSummary
SkillToolDependency
SkillsChangedNotification
SkillsConfigWriteParams
SkillsConfigWriteResponse
SkillsExtraRootsSetParams
SkillsExtraRootsSetResponse
SkillsListEntry
SkillsListParams
SkillsListResponse
SpendControlLimitSnapshot
StrictReviewRequiredNotification
autoApprovalReview/strictReviewRequired — a strict review gate opened.
SubagentMigration
TerminalInteractionNotification
TextElement
TextPosition
TextRange
Thread
ThreadApproveGuardianDeniedActionParams
ThreadApproveGuardianDeniedActionResponse
ThreadArchiveParams
ThreadArchiveResponse
ThreadArchivedNotification
ThreadClosedNotification
ThreadCompactStartParams
ThreadCompactStartResponse
ThreadDeleteParams
ThreadDeleteResponse
ThreadDeletedNotification
ThreadForkParams
ThreadForkResponse
ThreadGoal
ThreadGoalClearParams
ThreadGoalClearResponse
ThreadGoalClearedNotification
ThreadGoalGetParams
ThreadGoalGetResponse
ThreadGoalSetParams
ThreadGoalSetResponse
ThreadGoalUpdatedNotification
ThreadId
ThreadInjectItemsParams
ThreadInjectItemsResponse
ThreadItemEntry
One item plus the turn that contains it, as returned by thread/items/list (0.148 upstream).
ThreadItemsListParams
Params for thread/items/list — paginated item hydration (0.148 upstream).
ThreadItemsListResponse
Response to thread/items/list (0.148 upstream).
ThreadListParams
ThreadListResponse
ThreadLoadedListParams
ThreadLoadedListResponse
ThreadMetadataGitInfoUpdateParams
ThreadMetadataUpdateParams
ThreadMetadataUpdateResponse
ThreadNameUpdatedNotification
ThreadProjectUpdatedNotification
thread/project/updated — a thread’s project assignment changed.
ThreadQueueChangedNotification
thread/queue/changed — the thread’s queued submissions changed.
ThreadReadParams
ThreadReadResponse
ThreadRealtimeAudioChunk
ThreadRealtimeClosedNotification
ThreadRealtimeErrorNotification
ThreadRealtimeItem
EXPERIMENTAL upstream — a thread-scoped realtime item in the canonical timeline (0.148). Top-level identity fields are camelCase on the wire while variant payload fields are snake_case; mirrored exactly.
ThreadRealtimeItemAddedNotification
ThreadRealtimeItemCompletedNotification
EXPERIMENTAL upstream — thread/realtime/item/completed params (0.148).
ThreadRealtimeItemStartedNotification
EXPERIMENTAL upstream — thread/realtime/item/started params (0.148).
ThreadRealtimeItemTranscriptDeltaNotification
EXPERIMENTAL upstream — thread/realtime/item/transcript/delta params: text appended to an active realtime transcript item (0.148).
ThreadRealtimeOutputAudioDeltaNotification
ThreadRealtimeSdpNotification
ThreadRealtimeStartedNotification
ThreadRealtimeTranscriptDeltaNotification
ThreadRealtimeTranscriptDoneNotification
ThreadResumeParams
ThreadResumeResponse
ThreadRevertParams
Params for thread/revert — replace a paginated thread’s durable history with the prefix before one turn; local file changes are untouched (0.148 upstream).
ThreadRevertResponse
Response to thread/revert (0.148 upstream). thread.turns is always empty; retained history hydrates through thread/turns/list.
ThreadRevertedNotification
thread/reverted — the thread was rolled back.
ThreadRollbackParams
ThreadRollbackResponse
ThreadSection
ThreadSectionAppearance
ThreadSectionCreateParams
ThreadSectionCreateResponse
ThreadSectionDeleteParams
ThreadSectionDeleteResponse
ThreadSectionListParams
ThreadSectionListResponse
ThreadSectionMoveParams
ThreadSectionMoveResponse
ThreadSectionUpdateParams
ThreadSectionUpdateResponse
ThreadSetNameParams
ThreadSetNameResponse
ThreadSettings
ThreadSettingsUpdatedNotification
ThreadShellCommandParams
ThreadShellCommandResponse
ThreadSource
ThreadStartParams
ThreadStartResponse
ThreadStartedNotification
ThreadStatusChangedNotification
ThreadTokenUsage
ThreadTokenUsageUpdatedNotification
ThreadTurnsListParams
Params for thread/turns/list — paginated turn hydration (0.148 upstream).
ThreadTurnsListResponse
Response to thread/turns/list (0.148 upstream).
ThreadUnarchiveParams
ThreadUnarchiveResponse
ThreadUnarchivedNotification
ThreadUnsubscribeParams
ThreadUnsubscribeResponse
ThreadUsage
ThreadUsageBreakdownGroup
TokenUsageBreakdown
Tool
ToolRequestUserInputAnswer
ToolRequestUserInputOption
ToolRequestUserInputParams
ToolRequestUserInputQuestion
ToolRequestUserInputResponse
ToolsV2
Turn
TurnCompletedNotification
TurnDiffUpdatedNotification
TurnError
TurnInterruptParams
TurnInterruptResponse
TurnModerationMetadataNotification
TurnPlanStep
TurnPlanUpdatedNotification
TurnStartParams
TurnStartResponse
TurnStartedNotification
TurnSteerParams
TurnSteerResponse
TurnToolOutput
A pre-computed tool output supplied when starting a turn (TurnStartParams.toolOutput, 0.148 upstream).
WarningNotification
WebSearchLocation
WebSearchToolConfig
WindowsSandboxReadinessResponse
WindowsSandboxSetupCompletedNotification
WindowsSandboxSetupStartParams
WindowsSandboxSetupStartResponse
WindowsWorldWritableWarningNotification
WorkspaceMessage

Enums§

Account
AddCreditsNudgeCreditType
AddCreditsNudgeEmailStatus
AgentMessageDelivery
Delivery mode for an agent message item (0.147: currently only async).
AllowDenyRequirement
Allow/deny switch used across the browser-use / computer-use policy surface (0.148 upstream).
AppTemplateUnavailableReason
ApprovalsReviewer
AskForApproval
AuthMode
AutoCompactTokenLimitScope
AutoReviewDecisionSource
BrowserUseAccessApprovalLifetime
How long a granted browser-use access approval lasts.
CancelLoginAccountStatus
ChatgptAuthTokensRefreshReason
CliAuthCredentialsStoreMode
Where the CLI stores auth credentials.
CodexErrorInfo
CollabAgentStatus
CollabAgentTool
CollabAgentToolCallStatus
CommandAction
CommandExecOutputStream
CommandExecutionApprovalDecision
CommandExecutionApprovalKind
Distinguishes a command approval from input sent to an existing terminal (v1 commandExecution/requestApproval, 0.148 upstream).
CommandExecutionSource
CommandExecutionStatus
ConfigLayerSource
ConsumeAccountRateLimitResetCreditOutcome
CyberAccessProgram
Requested cyber treatment for a ChatGPT-authenticated turn; authorization and model-tier restrictions stay server-owned (0.148 upstream).
DesktopOnboardingEntrypoint
DynamicToolCallOutputContentItem
DynamicToolCallStatus
ExperimentalFeatureStage
ExternalAgentConfigMigrationItemType
ExternalAgentDetectedConnectorSource
ExternalAgentImportedConnectorSource
FileChange
FileChangeApprovalDecision
FileSystemAccessMode
FileSystemPath
FileSystemSpecialPath
ForcedChatgptWorkspaceIds
ForcedLoginMethod
FunctionCallOutputBody
A tool call’s output body: either a plain string or Responses-API compatible content items (0.148 upstream).
FunctionCallOutputContentItem
Responses-API compatible content items a tool call can return — the subset of ContentItem supported as function call outputs (0.148 upstream). Wire tags and fields are snake_case, unlike most v2 types.
FuzzyFileSearchMatchType
GuardianApprovalReviewAction
GuardianApprovalReviewStatus
GuardianCommandSource
GuardianRiskLevel
GuardianUserAuthorization
HookEventName
HookExecutionMode
HookHandlerType
HookOutputEntryKind
HookRunStatus
HookScope
HookSource
HookTrustStatus
ImageDetail
ImageGenerationFailure
InputModality
LoginAccountParams
LoginAccountResponse
LoginAppBrand
McpAuthStatus
McpElicitationArrayType
McpElicitationBooleanType
McpElicitationEnumSchema
McpElicitationMultiSelectEnumSchema
McpElicitationNumberType
McpElicitationObjectType
McpElicitationPrimitiveSchema
McpElicitationSingleSelectEnumSchema
McpElicitationStringFormat
McpElicitationStringType
McpServerConnectionStatus
Current thread-runtime MCP server connection state.
McpServerElicitationAction
McpServerElicitationRequestParams
McpServerOauthClientRegistration
McpServerStartupFailureReason
McpServerStartupState
McpServerStatusDetail
McpToolCallStatus
MergeStrategy
MessagePhase
ModeKind
ModelRerouteReason
ModelVerification
MultiAgentVersion
NetworkAccess
NetworkApprovalProtocol
NetworkPolicyRuleAction
NonSteerableTurnKind
ParsedCommand
PatchApplyStatus
PatchChangeKind
PermissionGrantScope
Personality
PlanType
PluginAuthPolicy
PluginAvailability
PluginDisabledReason
PluginInstallPolicy
PluginInstallPolicySource
PluginListMarketplaceKind
PluginShareDiscoverability
PluginSharePrincipalRole
PluginSharePrincipalType
PluginShareTargetRole
PluginShareUpdateDiscoverability
PluginSource
ProcessOutputStream
ProjectChangeType
ProjectSortKey
Sort order for project listings (0.148 upstream).
RateLimitReachedType
RateLimitResetCreditStatus
RateLimitResetType
RealtimeConversationVersion
ReasoningSummary
RemoteControlConnectionStatus
RequestId
ResidencyRequirement
ResourceContent
ReviewDecision
ReviewDelivery
ReviewTarget
SandboxMode
SandboxPolicy
ScheduledTaskSchedule
ScheduledTaskWeekday
SessionSource
SkillScope
SortDirection
SubAgentActivityKind
SubAgentSource
ThreadActiveFlag
ThreadGoalStatus
ThreadHistoryMode
Persisted thread history contract (0.148 upstream).
ThreadItem
ThreadListCwdFilter
ThreadRealtimeBemItemPresentation
EXPERIMENTAL upstream — how an existing agent item appears in a realtime conversation (0.148).
ThreadRealtimeItemDetail
The type-tagged payload of a ThreadRealtimeItem.
ThreadRealtimeSessionOutcome
EXPERIMENTAL upstream — outcome of a closed realtime session (0.148).
ThreadRealtimeTranscriptRole
EXPERIMENTAL upstream — speaker role in a realtime transcript (0.148).
ThreadSortKey
ThreadSourceKind
ThreadStartSource
ThreadStatus
ThreadTimelineEntry
EXPERIMENTAL upstream — one item or turn boundary in canonical rollout order (0.148). Wire quirk mirrored exactly: the item variant uses camelCase turnId while the turn-boundary variants use snake_case turn_id/started_at/completed_at/duration_ms.
ThreadUnsubscribeStatus
TurnItemsView
TurnPlanStepStatus
TurnStatus
UserInput
Verbosity
WebSearchAction
WebSearchContextSize
WebSearchMode
WindowsSandboxReadiness
WindowsSandboxSetupMode
WorkspaceMessageType
WriteStatus