Expand description
Generated types for the Codex app-server v2 JSON-RPC protocol.
Everything in this module is generated at build time by build.rs (via
typify) from schema/protocol.schema.json. See the crate README for how
that schema was derived and how to regenerate it against a newer codex
CLI version.
Modules§
Structs§
- Absolute
Path Buf - A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).
- Account
Login Completed Notification AccountLoginCompletedNotification- Account
Rate Limits Updated Notification - Sparse rolling rate-limit update.
- Account
Token Usage Daily Bucket AccountTokenUsageDailyBucket- Account
Token Usage Summary AccountTokenUsageSummary- Account
Updated Notification AccountUpdatedNotification- Active
Permission Profile ActivePermissionProfile- Additional
Context Entry AdditionalContextEntry- Additional
File System Permissions AdditionalFileSystemPermissions- Additional
Network Permissions AdditionalNetworkPermissions- Additional
Permission Profile AdditionalPermissionProfile- Agent
Message Delta Notification AgentMessageDeltaNotification- Agent
Path AgentPath- Analytics
Config AnalyticsConfig- AppBranding
- EXPERIMENTAL - app metadata returned by app-list APIs.
- AppConfig
AppConfig- AppInfo
- EXPERIMENTAL - app metadata returned by app-list APIs.
- AppList
Updated Notification - EXPERIMENTAL - notification emitted when the app list changes.
- AppMetadata
AppMetadata- AppReview
AppReview- AppScreenshot
AppScreenshot- AppSummary
- EXPERIMENTAL - app metadata summary for plugin responses.
- AppTemplate
Summary AppTemplateSummary- AppTool
Config AppToolConfig- AppTools
Config AppToolsConfig- Apply
Patch Approval Params ApplyPatchApprovalParams- Apply
Patch Approval Response ApplyPatchApprovalResponse- Apps
Config AppsConfig- Apps
Default Config AppsDefaultConfig- Apps
List Params - EXPERIMENTAL - list available apps/connectors.
- Apps
List Response - EXPERIMENTAL - app list response.
- Attestation
Generate Params AttestationGenerateParams- Attestation
Generate Response AttestationGenerateResponse- Byte
Range ByteRange- Cancel
Login Account Params CancelLoginAccountParams- Cancel
Login Account Response CancelLoginAccountResponse- Chatgpt
Auth Tokens Refresh Params ChatgptAuthTokensRefreshParams- Chatgpt
Auth Tokens Refresh Response ChatgptAuthTokensRefreshResponse- Client
Info ClientInfo- Codex
AppServer Protocol Combined - Merged, flat-ref, self-contained v2-only Codex app-server protocol schema (master envelope/ServerRequest/ClientNotification types ref-rewritten to flat + v2 client-request/notification surface). Generated by
cargo xtask codex-schema regen. - Collab
Agent State CollabAgentState- Collaboration
Mode - Collaboration mode for a Codex session.
- Collaboration
Mode List Params - EXPERIMENTAL - list collaboration mode presets.
- Collaboration
Mode List Response - EXPERIMENTAL - collaboration mode presets response.
- Collaboration
Mode Mask - EXPERIMENTAL - collaboration mode preset metadata for clients.
- Command
Exec Output Delta Notification - Base64-encoded output chunk emitted for a streaming
command/execrequest. - Command
Exec Params - Run a standalone command (argv vector) in the server sandbox without creating a thread or turn.
- Command
Exec Resize Params - Resize a running PTY-backed
command/execsession. - Command
Exec Resize Response - Empty success response for
command/exec/resize. - Command
Exec Response - Final buffered result for
command/exec. - Command
Exec Terminal Size - PTY size in character cells for
command/execPTY sessions. - Command
Exec Terminate Params - Terminate a running
command/execsession. - Command
Exec Terminate Response - Empty success response for
command/exec/terminate. - Command
Exec Write Params - Write stdin bytes to a running
command/execsession, close stdin, or both. - Command
Exec Write Response - Empty success response for
command/exec/write. - Command
Execution Output Delta Notification CommandExecutionOutputDeltaNotification- Command
Execution Request Approval Params CommandExecutionRequestApprovalParams- Command
Execution Request Approval Response CommandExecutionRequestApprovalResponse- Command
Migration CommandMigration- Computer
UseRequirements ComputerUseRequirements- Config
Config- Config
Batch Write Params ConfigBatchWriteParams- Config
Edit ConfigEdit- Config
Layer ConfigLayer- Config
Layer Metadata ConfigLayerMetadata- Config
Read Params ConfigReadParams- Config
Read Response ConfigReadResponse- Config
Requirements ConfigRequirements- Config
Requirements Read Response ConfigRequirementsReadResponse- Config
Value Write Params ConfigValueWriteParams- Config
Warning Notification ConfigWarningNotification- Config
Write Response ConfigWriteResponse- Configured
Hook Matcher Group ConfiguredHookMatcherGroup- Consume
Account Rate Limit Reset Credit Params ConsumeAccountRateLimitResetCreditParams- Consume
Account Rate Limit Reset Credit Response ConsumeAccountRateLimitResetCreditResponse- Context
Compacted Notification - Deprecated: Use
ContextCompactionitem type instead. - Credits
Snapshot CreditsSnapshot- Current
Time Read Params CurrentTimeReadParams- Current
Time Read Response CurrentTimeReadResponse- Deprecation
Notice Notification DeprecationNoticeNotification- Dynamic
Tool Call Params DynamicToolCallParams- Dynamic
Tool Call Response DynamicToolCallResponse- Environment
AddParams EnvironmentAddParams- Environment
AddResponse EnvironmentAddResponse- Environment
Info Params EnvironmentInfoParams- Environment
Info Response EnvironmentInfoResponse- Environment
Shell Info EnvironmentShellInfo- Error
Notification ErrorNotification- Exec
Command Approval Params ExecCommandApprovalParams- Exec
Command Approval Response ExecCommandApprovalResponse- Experimental
Feature ExperimentalFeature- Experimental
Feature Enablement SetParams ExperimentalFeatureEnablementSetParams- Experimental
Feature Enablement SetResponse ExperimentalFeatureEnablementSetResponse- Experimental
Feature List Params ExperimentalFeatureListParams- Experimental
Feature List Response ExperimentalFeatureListResponse- External
Agent Config Detect Params ExternalAgentConfigDetectParams- External
Agent Config Detect Response ExternalAgentConfigDetectResponse- External
Agent Config Import Completed Notification ExternalAgentConfigImportCompletedNotification- External
Agent Config Import Histories Read Response ExternalAgentConfigImportHistoriesReadResponse- External
Agent Config Import History ExternalAgentConfigImportHistory- External
Agent Config Import Item Type Failure ExternalAgentConfigImportItemTypeFailure- External
Agent Config Import Item Type Success ExternalAgentConfigImportItemTypeSuccess- External
Agent Config Import Params ExternalAgentConfigImportParams- External
Agent Config Import Progress Notification ExternalAgentConfigImportProgressNotification- External
Agent Config Import Response ExternalAgentConfigImportResponse- External
Agent Config Import Type Result ExternalAgentConfigImportTypeResult- External
Agent Config Migration Item ExternalAgentConfigMigrationItem- Feedback
Upload Params FeedbackUploadParams- Feedback
Upload Response FeedbackUploadResponse- File
Change Output Delta Notification - Deprecated legacy notification for
apply_patchtextual output. - File
Change Patch Updated Notification FileChangePatchUpdatedNotification- File
Change Request Approval Params FileChangeRequestApprovalParams- File
Change Request Approval Response FileChangeRequestApprovalResponse- File
System Sandbox Entry FileSystemSandboxEntry- File
Update Change FileUpdateChange- FsChanged
Notification - Filesystem watch notification emitted for
fs/watchsubscribers. - FsCopy
Params - Copy a file or directory tree on the host filesystem.
- FsCopy
Response - Successful response for
fs/copy. - FsCreate
Directory Params - Create a directory on the host filesystem.
- FsCreate
Directory Response - Successful response for
fs/createDirectory. - FsGet
Metadata Params - Request metadata for an absolute path.
- FsGet
Metadata Response - Metadata returned by
fs/getMetadata. - FsRead
Directory Entry - A directory entry returned by
fs/readDirectory. - FsRead
Directory Params - List direct child names for a directory.
- FsRead
Directory Response - Directory entries returned by
fs/readDirectory. - FsRead
File Params - Read a file from the host filesystem.
- FsRead
File Response - Base64-encoded file contents returned by
fs/readFile. - FsRemove
Params - Remove a file or directory tree from the host filesystem.
- FsRemove
Response - Successful response for
fs/remove. - FsUnwatch
Params - Stop filesystem watch notifications for a prior
fs/watch. - FsUnwatch
Response - Successful response for
fs/unwatch. - FsWatch
Params - Start filesystem watch notifications for an absolute path.
- FsWatch
Response - Successful response for
fs/watch. - FsWrite
File Params - Write a file on the host filesystem.
- FsWrite
File Response - Successful response for
fs/writeFile. - Fuzzy
File Search Params FuzzyFileSearchParams- Fuzzy
File Search Response FuzzyFileSearchResponse- Fuzzy
File Search Result - Superset of [
codex_file_search::FileMatch] - Fuzzy
File Search Session Completed Notification FuzzyFileSearchSessionCompletedNotification- Fuzzy
File Search Session Start Params FuzzyFileSearchSessionStartParams- Fuzzy
File Search Session Start Response FuzzyFileSearchSessionStartResponse- Fuzzy
File Search Session Stop Params FuzzyFileSearchSessionStopParams- Fuzzy
File Search Session Stop Response FuzzyFileSearchSessionStopResponse- Fuzzy
File Search Session Update Params FuzzyFileSearchSessionUpdateParams- Fuzzy
File Search Session Update Response FuzzyFileSearchSessionUpdateResponse- Fuzzy
File Search Session Updated Notification FuzzyFileSearchSessionUpdatedNotification- GetAccount
Params GetAccountParams- GetAccount
Rate Limits Response GetAccountRateLimitsResponse- GetAccount
Response GetAccountResponse- GetAccount
Token Usage Response GetAccountTokenUsageResponse- GetWorkspace
Messages Response GetWorkspaceMessagesResponse- GitInfo
GitInfo- Granted
Permission Profile GrantedPermissionProfile- Guardian
Approval Review - [UNSTABLE] Temporary approval auto-review payload used by
item/autoApprovalReview/*notifications. This shape is expected to change soon. - Guardian
Warning Notification GuardianWarningNotification- Hook
Completed Notification HookCompletedNotification- Hook
Error Info HookErrorInfo- Hook
Metadata HookMetadata- Hook
Migration HookMigration- Hook
Output Entry HookOutputEntry- Hook
Prompt Fragment HookPromptFragment- Hook
RunSummary HookRunSummary- Hook
Started Notification HookStartedNotification- Hooks
List Entry HooksListEntry- Hooks
List Params HooksListParams- Hooks
List Response HooksListResponse- Initialize
Capabilities - Client-declared capabilities negotiated during initialize.
- Initialize
Params InitializeParams- Initialize
Response InitializeResponse- Internal
Chat Message Metadata Passthrough - Internal Responses API passthrough metadata copied into underlying chat messages.
- Item
Completed Notification ItemCompletedNotification- Item
Guardian Approval Review Completed Notification - [UNSTABLE] Temporary notification payload for approval auto-review. This shape is expected to change soon.
- Item
Guardian Approval Review Started Notification - [UNSTABLE] Temporary notification payload for approval auto-review. This shape is expected to change soon.
- Item
Started Notification ItemStartedNotification- Jsonrpc
Error - A response to a request that indicates an error occurred.
- Jsonrpc
Error Error JsonrpcErrorError- Jsonrpc
Notification - A notification which does not expect a response.
- Jsonrpc
Request - A request that expects a response.
- Jsonrpc
Response - A successful (non-error) response to a request.
- Legacy
AppPath String LegacyAppPathString- List
McpServer Status Params ListMcpServerStatusParams- List
McpServer Status Response ListMcpServerStatusResponse- Logout
Account Response LogoutAccountResponse- Managed
Hooks Requirements ManagedHooksRequirements- Marketplace
AddParams MarketplaceAddParams- Marketplace
AddResponse MarketplaceAddResponse- Marketplace
Interface MarketplaceInterface- Marketplace
Load Error Info MarketplaceLoadErrorInfo- Marketplace
Remove Params MarketplaceRemoveParams- Marketplace
Remove Response MarketplaceRemoveResponse- Marketplace
Upgrade Error Info MarketplaceUpgradeErrorInfo- Marketplace
Upgrade Params MarketplaceUpgradeParams- Marketplace
Upgrade Response MarketplaceUpgradeResponse- McpElicitation
Boolean Schema McpElicitationBooleanSchema- McpElicitation
Const Option McpElicitationConstOption- McpElicitation
Enum Schema McpElicitationEnumSchema- McpElicitation
Legacy Titled Enum Schema McpElicitationLegacyTitledEnumSchema- McpElicitation
Multi Select Enum Schema McpElicitationMultiSelectEnumSchema- McpElicitation
Number Schema McpElicitationNumberSchema- McpElicitation
Primitive Schema McpElicitationPrimitiveSchema- McpElicitation
Schema - Typed form schema for MCP
elicitation/createrequests. - McpElicitation
String Schema McpElicitationStringSchema- McpElicitation
Titled Enum Items McpElicitationTitledEnumItems- McpElicitation
Titled Multi Select Enum Schema McpElicitationTitledMultiSelectEnumSchema- McpElicitation
Titled Single Select Enum Schema McpElicitationTitledSingleSelectEnumSchema- McpElicitation
Untitled Enum Items McpElicitationUntitledEnumItems- McpElicitation
Untitled Multi Select Enum Schema McpElicitationUntitledMultiSelectEnumSchema- McpElicitation
Untitled Single Select Enum Schema McpElicitationUntitledSingleSelectEnumSchema- McpResource
Read Params McpResourceReadParams- McpResource
Read Response McpResourceReadResponse- McpServer
Elicitation Request Response McpServerElicitationRequestResponse- McpServer
Info - Presentation metadata advertised by an initialized MCP server.
- McpServer
Migration McpServerMigration- McpServer
Oauth Login Completed Notification McpServerOauthLoginCompletedNotification- McpServer
Oauth Login Params McpServerOauthLoginParams- McpServer
Oauth Login Response McpServerOauthLoginResponse- McpServer
Refresh Response McpServerRefreshResponse- McpServer
Status McpServerStatus- McpServer
Status Updated Notification McpServerStatusUpdatedNotification- McpServer
Tool Call Params McpServerToolCallParams- McpServer
Tool Call Response McpServerToolCallResponse- McpTool
Call AppContext McpToolCallAppContext- McpTool
Call Error McpToolCallError- McpTool
Call Progress Notification McpToolCallProgressNotification- McpTool
Call Result McpToolCallResult- Memory
Citation MemoryCitation- Memory
Citation Entry MemoryCitationEntry- Memory
Reset Response MemoryResetResponse- Migration
Details MigrationDetails- Mock
Experimental Method Params MockExperimentalMethodParams- Mock
Experimental Method Response MockExperimentalMethodResponse- Model
Model- Model
Availability Nux ModelAvailabilityNux- Model
List Params ModelListParams- Model
List Response ModelListResponse- Model
Provider Capabilities Read Params ModelProviderCapabilitiesReadParams- Model
Provider Capabilities Read Response ModelProviderCapabilitiesReadResponse- Model
Rerouted Notification ModelReroutedNotification- Model
Safety Buffering Updated Notification ModelSafetyBufferingUpdatedNotification- Model
Service Tier ModelServiceTier- Model
Upgrade Info ModelUpgradeInfo- Model
Verification Notification ModelVerificationNotification- Models
Requirements ModelsRequirements- Network
Approval Context NetworkApprovalContext- Network
Policy Amendment NetworkPolicyAmendment- Network
Requirements NetworkRequirements- NewThread
Model Defaults NewThreadModelDefaults- Nullable
Remote Control Disable Params NullableRemoteControlDisableParams- Nullable
Remote Control Enable Params NullableRemoteControlEnableParams- Overridden
Metadata OverriddenMetadata- PathUri
PathUri- Permission
Profile List Params PermissionProfileListParams- Permission
Profile List Response PermissionProfileListResponse- Permission
Profile Summary PermissionProfileSummary- Permissions
Request Approval Params PermissionsRequestApprovalParams- Permissions
Request Approval Response PermissionsRequestApprovalResponse- Plan
Delta Notification - EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content.
- Plugin
Detail PluginDetail- Plugin
Hook Summary PluginHookSummary- Plugin
Install Params PluginInstallParams- Plugin
Install Response PluginInstallResponse- Plugin
Installed Params PluginInstalledParams- Plugin
Installed Response PluginInstalledResponse- Plugin
Interface PluginInterface- Plugin
List Params PluginListParams- Plugin
List Response PluginListResponse- Plugin
Marketplace Entry PluginMarketplaceEntry- Plugin
Read Params PluginReadParams- Plugin
Read Response PluginReadResponse- Plugin
Share Checkout Params PluginShareCheckoutParams- Plugin
Share Checkout Response PluginShareCheckoutResponse- Plugin
Share Context PluginShareContext- Plugin
Share Delete Params PluginShareDeleteParams- Plugin
Share Delete Response PluginShareDeleteResponse- Plugin
Share List Item PluginShareListItem- Plugin
Share List Params PluginShareListParams- Plugin
Share List Response PluginShareListResponse- Plugin
Share Principal PluginSharePrincipal- Plugin
Share Save Params PluginShareSaveParams- Plugin
Share Save Response PluginShareSaveResponse- Plugin
Share Target PluginShareTarget- Plugin
Share Update Targets Params PluginShareUpdateTargetsParams- Plugin
Share Update Targets Response PluginShareUpdateTargetsResponse- Plugin
Skill Read Params PluginSkillReadParams- Plugin
Skill Read Response PluginSkillReadResponse- Plugin
Summary PluginSummary- Plugin
Uninstall Params PluginUninstallParams- Plugin
Uninstall Response PluginUninstallResponse- Plugins
Migration PluginsMigration- Process
Exited Notification - Final process exit notification for
process/spawn. - Process
Kill Params - Terminate a running
process/spawnsession. - Process
Kill Response - Empty success response for
process/kill. - Process
Output Delta Notification - Base64-encoded output chunk emitted for a streaming
process/spawnrequest. - Process
Resize PtyParams - Resize a running PTY-backed
process/spawnsession. - Process
Resize PtyResponse - Empty success response for
process/resizePty. - Process
Spawn Params - Spawn a standalone process (argv vector) without a Codex sandbox on the host where the app server is running.
- Process
Spawn Response - Successful response for
process/spawn. - Process
Terminal Size - PTY size in character cells for
process/spawnPTY sessions. - Process
Write Stdin Params - Write stdin bytes to a running
process/spawnsession, close stdin, or both. - Process
Write Stdin Response - Empty success response for
process/writeStdin. - Rate
Limit Reset Credit RateLimitResetCredit- Rate
Limit Reset Credits Summary RateLimitResetCreditsSummary- Rate
Limit Snapshot RateLimitSnapshot- Rate
Limit Window RateLimitWindow- RawResponse
Item Completed Notification RawResponseItemCompletedNotification- Realtime
Voices List RealtimeVoicesList- Reasoning
Effort - A non-empty reasoning effort value advertised by the model.
- Reasoning
Effort Option ReasoningEffortOption- Reasoning
Summary Part Added Notification ReasoningSummaryPartAddedNotification- Reasoning
Summary Text Delta Notification ReasoningSummaryTextDeltaNotification- Reasoning
Text Delta Notification ReasoningTextDeltaNotification- Remote
Control Client RemoteControlClient- Remote
Control Clients List Params RemoteControlClientsListParams- Remote
Control Clients List Response RemoteControlClientsListResponse- Remote
Control Clients Revoke Params RemoteControlClientsRevokeParams- Remote
Control Clients Revoke Response RemoteControlClientsRevokeResponse- Remote
Control Disable Params RemoteControlDisableParams- Remote
Control Disable Response RemoteControlDisableResponse- Remote
Control Enable Params RemoteControlEnableParams- Remote
Control Enable Response RemoteControlEnableResponse- Remote
Control Pairing Start Params RemoteControlPairingStartParams- Remote
Control Pairing Start Response RemoteControlPairingStartResponse- Remote
Control Pairing Status Params RemoteControlPairingStatusParams- Remote
Control Pairing Status Response RemoteControlPairingStatusResponse- Remote
Control Status Changed Notification - Current remote-control connection status and remote identity exposed to clients.
- Remote
Control Status Read Response RemoteControlStatusReadResponse- Request
Permission Profile RequestPermissionProfile- Resource
- A known resource that the server is capable of reading.
- Resource
Template - A template description for resources available on the server.
- Review
Start Params ReviewStartParams- Review
Start Response ReviewStartResponse- Sandbox
Workspace Write SandboxWorkspaceWrite- Selected
Capability Root - A user-selected root that can expose one or more runtime capabilities.
- Send
AddCredits Nudge Email Params SendAddCreditsNudgeEmailParams- Send
AddCredits Nudge Email Response SendAddCreditsNudgeEmailResponse- Server
Request Resolved Notification ServerRequestResolvedNotification- Session
Migration SessionMigration- Settings
- Settings for a collaboration mode.
- Skill
Dependencies SkillDependencies- Skill
Error Info SkillErrorInfo- Skill
Interface SkillInterface- Skill
Metadata SkillMetadata- Skill
Migration SkillMigration- Skill
Summary SkillSummary- Skill
Tool Dependency SkillToolDependency- Skills
Changed Notification - Notification emitted when watched local skill files change.
- Skills
Config Write Params SkillsConfigWriteParams- Skills
Config Write Response SkillsConfigWriteResponse- Skills
Extra Roots SetParams SkillsExtraRootsSetParams- Skills
Extra Roots SetResponse SkillsExtraRootsSetResponse- Skills
List Entry SkillsListEntry- Skills
List Params SkillsListParams- Skills
List Response SkillsListResponse- Spend
Control Limit Snapshot SpendControlLimitSnapshot- Subagent
Migration SubagentMigration- Terminal
Interaction Notification TerminalInteractionNotification- Text
Element TextElement- Text
Position TextPosition- Text
Range TextRange- Thread
Thread- Thread
Approve Guardian Denied Action Params ThreadApproveGuardianDeniedActionParams- Thread
Approve Guardian Denied Action Response ThreadApproveGuardianDeniedActionResponse- Thread
Archive Params ThreadArchiveParams- Thread
Archive Response ThreadArchiveResponse- Thread
Archived Notification ThreadArchivedNotification- Thread
Background Terminal ThreadBackgroundTerminal- Thread
Background Terminals Clean Params ThreadBackgroundTerminalsCleanParams- Thread
Background Terminals Clean Response ThreadBackgroundTerminalsCleanResponse- Thread
Background Terminals List Params ThreadBackgroundTerminalsListParams- Thread
Background Terminals List Response ThreadBackgroundTerminalsListResponse- Thread
Background Terminals Terminate Params ThreadBackgroundTerminalsTerminateParams- Thread
Background Terminals Terminate Response ThreadBackgroundTerminalsTerminateResponse- Thread
Closed Notification ThreadClosedNotification- Thread
Compact Start Params ThreadCompactStartParams- Thread
Compact Start Response ThreadCompactStartResponse- Thread
Decrement Elicitation Params - Parameters for
thread/decrement_elicitation. - Thread
Decrement Elicitation Response - Response for
thread/decrement_elicitation. - Thread
Delete Params ThreadDeleteParams- Thread
Delete Response ThreadDeleteResponse- Thread
Deleted Notification ThreadDeletedNotification- Thread
Extra - Extra app-server data for a thread.
- Thread
Fork Params - There are two ways to fork a thread: 1. By thread_id: load the thread from disk by thread_id and fork it into a new thread. 2. By path: load the thread from disk by path and fork it into a new thread.
- Thread
Fork Response ThreadForkResponse- Thread
Goal ThreadGoal- Thread
Goal Clear Params ThreadGoalClearParams- Thread
Goal Clear Response ThreadGoalClearResponse- Thread
Goal Cleared Notification ThreadGoalClearedNotification- Thread
Goal GetParams ThreadGoalGetParams- Thread
Goal GetResponse ThreadGoalGetResponse- Thread
Goal SetParams ThreadGoalSetParams- Thread
Goal SetResponse ThreadGoalSetResponse- Thread
Goal Updated Notification ThreadGoalUpdatedNotification- Thread
Id ThreadId- Thread
Increment Elicitation Params - Parameters for
thread/increment_elicitation. - Thread
Increment Elicitation Response - Response for
thread/increment_elicitation. - Thread
Inject Items Params ThreadInjectItemsParams- Thread
Inject Items Response ThreadInjectItemsResponse- Thread
Items List Params ThreadItemsListParams- Thread
Items List Response ThreadItemsListResponse- Thread
List Params ThreadListParams- Thread
List Response ThreadListResponse- Thread
Loaded List Params ThreadLoadedListParams- Thread
Loaded List Response ThreadLoadedListResponse- Thread
Memory Mode SetParams ThreadMemoryModeSetParams- Thread
Memory Mode SetResponse ThreadMemoryModeSetResponse- Thread
Metadata GitInfo Update Params ThreadMetadataGitInfoUpdateParams- Thread
Metadata Update Params ThreadMetadataUpdateParams- Thread
Metadata Update Response ThreadMetadataUpdateResponse- Thread
Name Updated Notification ThreadNameUpdatedNotification- Thread
Read Params ThreadReadParams- Thread
Read Response ThreadReadResponse- Thread
Realtime Append Audio Params - EXPERIMENTAL - append audio input to thread realtime.
- Thread
Realtime Append Audio Response - EXPERIMENTAL - response for appending realtime audio input.
- Thread
Realtime Append Speech Params - EXPERIMENTAL - append speakable text to thread realtime.
- Thread
Realtime Append Speech Response - EXPERIMENTAL - response for appending realtime speech.
- Thread
Realtime Append Text Params - EXPERIMENTAL - append text input to thread realtime.
- Thread
Realtime Append Text Response - EXPERIMENTAL - response for appending realtime text input.
- Thread
Realtime Audio Chunk - EXPERIMENTAL - thread realtime audio chunk.
- Thread
Realtime Closed Notification - EXPERIMENTAL - emitted when thread realtime transport closes.
- Thread
Realtime Error Notification - EXPERIMENTAL - emitted when thread realtime encounters an error.
- Thread
Realtime Item Added Notification - EXPERIMENTAL - raw non-audio thread realtime item emitted by the backend.
- Thread
Realtime List Voices Params - EXPERIMENTAL - list voices supported by thread realtime.
- Thread
Realtime List Voices Response - EXPERIMENTAL - response for listing supported realtime voices.
- Thread
Realtime Output Audio Delta Notification - EXPERIMENTAL - streamed output audio emitted by thread realtime.
- Thread
Realtime SdpNotification - EXPERIMENTAL - emitted with the remote SDP for a WebRTC realtime session.
- Thread
Realtime Start Params - EXPERIMENTAL - start a thread-scoped realtime session.
- Thread
Realtime Start Response - EXPERIMENTAL - response for starting thread realtime.
- Thread
Realtime Started Notification - EXPERIMENTAL - emitted when thread realtime startup is accepted.
- Thread
Realtime Stop Params - EXPERIMENTAL - stop thread realtime.
- Thread
Realtime Stop Response - EXPERIMENTAL - response for stopping thread realtime.
- Thread
Realtime Transcript Delta Notification - EXPERIMENTAL - flat transcript delta emitted whenever realtime transcript text changes.
- Thread
Realtime Transcript Done Notification - EXPERIMENTAL - final transcript text emitted when realtime completes a transcript part.
- Thread
Resume Initial Turns Page Params ThreadResumeInitialTurnsPageParams- Thread
Resume Params - There are three ways to resume a thread: 1. By thread_id: load the thread from disk by thread_id and resume it. 2. By history: instantiate the thread from memory and resume it. 3. By path: load the thread from disk by path and resume it.
- Thread
Resume Response ThreadResumeResponse- Thread
Rollback Params - DEPRECATED:
thread/rollbackwill be removed soon. - Thread
Rollback Response ThreadRollbackResponse- Thread
Search Params ThreadSearchParams- Thread
Search Response ThreadSearchResponse- Thread
Search Result ThreadSearchResult- Thread
SetName Params ThreadSetNameParams- Thread
SetName Response ThreadSetNameResponse- Thread
Settings ThreadSettings- Thread
Settings Update Params ThreadSettingsUpdateParams- Thread
Settings Update Response ThreadSettingsUpdateResponse- Thread
Settings Updated Notification ThreadSettingsUpdatedNotification- Thread
Shell Command Params ThreadShellCommandParams- Thread
Shell Command Response ThreadShellCommandResponse- Thread
Source ThreadSource- Thread
Start Params ThreadStartParams- Thread
Start Response ThreadStartResponse- Thread
Started Notification ThreadStartedNotification- Thread
Status Changed Notification ThreadStatusChangedNotification- Thread
Token Usage ThreadTokenUsage- Thread
Token Usage Updated Notification ThreadTokenUsageUpdatedNotification- Thread
Turns List Params ThreadTurnsListParams- Thread
Turns List Response ThreadTurnsListResponse- Thread
Unarchive Params ThreadUnarchiveParams- Thread
Unarchive Response ThreadUnarchiveResponse- Thread
Unarchived Notification ThreadUnarchivedNotification- Thread
Unsubscribe Params ThreadUnsubscribeParams- Thread
Unsubscribe Response ThreadUnsubscribeResponse- Token
Usage Breakdown TokenUsageBreakdown- Tool
- Definition for a tool the client can call.
- Tool
Request User Input Answer - EXPERIMENTAL. Captures a user’s answer to a request_user_input question.
- Tool
Request User Input Option - EXPERIMENTAL. Defines a single selectable option for request_user_input.
- Tool
Request User Input Params - EXPERIMENTAL. Params sent with a request_user_input event.
- Tool
Request User Input Question - EXPERIMENTAL. Represents one request_user_input question and its required options.
- Tool
Request User Input Response - EXPERIMENTAL. Response payload mapping question ids to answers.
- ToolsV2
ToolsV2- Turn
Turn- Turn
Completed Notification TurnCompletedNotification- Turn
Diff Updated Notification - Notification that the turn-level unified diff has changed. Contains the latest aggregated diff across all file changes in the turn.
- Turn
Environment Params TurnEnvironmentParams- Turn
Error TurnError- Turn
Interrupt Params TurnInterruptParams- Turn
Interrupt Response TurnInterruptResponse- Turn
Moderation Metadata Notification TurnModerationMetadataNotification- Turn
Plan Step TurnPlanStep- Turn
Plan Updated Notification TurnPlanUpdatedNotification- Turn
Start Params TurnStartParams- Turn
Start Response TurnStartResponse- Turn
Started Notification TurnStartedNotification- Turn
Steer Params TurnSteerParams- Turn
Steer Response TurnSteerResponse- Turns
Page TurnsPage- W3cTrace
Context W3cTraceContext- Warning
Notification WarningNotification- WebSearch
Location WebSearchLocation- WebSearch
Tool Config WebSearchToolConfig- Windows
Sandbox Readiness Response WindowsSandboxReadinessResponse- Windows
Sandbox Setup Completed Notification WindowsSandboxSetupCompletedNotification- Windows
Sandbox Setup Start Params WindowsSandboxSetupStartParams- Windows
Sandbox Setup Start Response WindowsSandboxSetupStartResponse- Windows
World Writable Warning Notification WindowsWorldWritableWarningNotification- Workspace
Message WorkspaceMessage
Enums§
- Account
Account- AddCredits
Nudge Credit Type AddCreditsNudgeCreditType- AddCredits
Nudge Email Status AddCreditsNudgeEmailStatus- Additional
Context Kind AdditionalContextKind- Agent
Message Input Content AgentMessageInputContent- Amazon
Bedrock Credential Source AmazonBedrockCredentialSource- AppTemplate
Unavailable Reason AppTemplateUnavailableReason- AppTool
Approval AppToolApproval- Approvals
Reviewer - Configures who approval requests are routed to for review. Examples include sandbox escapes, blocked network access, MCP approval prompts, and ARC escalations. Defaults to
user.auto_reviewuses a carefully prompted subagent to gather relevant context and apply a risk-based decision framework before approving or denying the request. The legacy valueguardian_subagentis accepted for compatibility. - AskFor
Approval AskForApproval- Auth
Mode - Authentication mode for OpenAI-backed providers.
- Auto
Compact Token Limit Scope - Selects which part of the active context is charged against
model_auto_compact_token_limit. - Auto
Review Decision Source - [UNSTABLE] Source that produced a terminal approval auto-review decision.
- Cancel
Login Account Status CancelLoginAccountStatus- Capability
Root Location - Location used to resolve a selected capability root.
- Chatgpt
Auth Tokens Refresh Reason ChatgptAuthTokensRefreshReason- Client
Notification ClientNotification- Client
Request - Request from the client to the server.
- Codex
Error Info - This translation layer make sure that we expose codex error code in camel case.
- Collab
Agent Status CollabAgentStatus- Collab
Agent Tool CollabAgentTool- Collab
Agent Tool Call Status CollabAgentToolCallStatus- Command
Action CommandAction- Command
Exec Output Stream - Stream label for
command/exec/outputDeltanotifications. - Command
Execution Approval Decision CommandExecutionApprovalDecision- Command
Execution Source CommandExecutionSource- Command
Execution Status CommandExecutionStatus- Config
Layer Source ConfigLayerSource- Configured
Hook Handler ConfiguredHookHandler- Consume
Account Rate Limit Reset Credit Outcome ConsumeAccountRateLimitResetCreditOutcome- Content
Item ContentItem- Conversation
Text Role ConversationTextRole- Dynamic
Tool Call Output Content Item DynamicToolCallOutputContentItem- Dynamic
Tool Call Status DynamicToolCallStatus- Dynamic
Tool Namespace Tool DynamicToolNamespaceTool- Dynamic
Tool Spec DynamicToolSpec- Experimental
Feature Stage ExperimentalFeatureStage- External
Agent Config Migration Item Type ExternalAgentConfigMigrationItemType- File
Change FileChange- File
Change Approval Decision FileChangeApprovalDecision- File
System Access Mode FileSystemAccessMode- File
System Path FileSystemPath- File
System Special Path FileSystemSpecialPath- Forced
Chatgpt Workspace Ids - Backward-compatible API shape for ChatGPT workspace login restrictions.
- Forced
Login Method ForcedLoginMethod- Function
Call Output Body FunctionCallOutputBody- Function
Call Output Content Item - Responses API compatible content items that can be returned by a tool call. This is a subset of ContentItem with the types we support as function call outputs.
- Fuzzy
File Search Match Type FuzzyFileSearchMatchType- Guardian
Approval Review Action GuardianApprovalReviewAction- Guardian
Approval Review Status - [UNSTABLE] Lifecycle state for an approval auto-review.
- Guardian
Command Source GuardianCommandSource- Guardian
Risk Level - [UNSTABLE] Risk level assigned by approval auto-review.
- Guardian
User Authorization - [UNSTABLE] Authorization level assigned by approval auto-review.
- Hook
Event Name HookEventName- Hook
Execution Mode HookExecutionMode- Hook
Handler Type HookHandlerType- Hook
Output Entry Kind HookOutputEntryKind- Hook
RunStatus HookRunStatus- Hook
Scope HookScope- Hook
Source HookSource- Hook
Trust Status HookTrustStatus- Image
Detail ImageDetail- Initialized
Notification Method InitializedNotificationMethod- Input
Modality - Canonical user-input modality tags advertised by a model.
- Jsonrpc
Message - Refers to any valid JSON-RPC object that can be decoded off the wire, or encoded to be sent.
- Local
Shell Action LocalShellAction- Local
Shell Status LocalShellStatus- Login
Account Params LoginAccountParams- Login
Account Response LoginAccountResponse- Login
AppBrand LoginAppBrand- McpAuth
Status McpAuthStatus- McpElicitation
Array Type McpElicitationArrayType- McpElicitation
Boolean Type McpElicitationBooleanType- McpElicitation
Number Type McpElicitationNumberType- McpElicitation
Object Type McpElicitationObjectType- McpElicitation
Single Select Enum Schema McpElicitationSingleSelectEnumSchema- McpElicitation
String Format McpElicitationStringFormat- McpElicitation
String Type McpElicitationStringType- McpServer
Elicitation Action McpServerElicitationAction- McpServer
Elicitation Request Params McpServerElicitationRequestParams- McpServer
Startup Failure Reason McpServerStartupFailureReason- McpServer
Startup State McpServerStartupState- McpServer
Status Detail McpServerStatusDetail- McpTool
Call Status McpToolCallStatus- Merge
Strategy MergeStrategy- Message
Phase - Classifies an assistant message as interim commentary or final answer text.
- Mode
Kind - Initial collaboration mode to use when the TUI starts.
- Model
Reroute Reason ModelRerouteReason- Model
Verification ModelVerification- Multi
Agent Mode - Controls the effective multi-agent delegation instructions for a turn.
custommeans the configured mode hint defines the policy instead of a built-in policy. - Network
Access NetworkAccess- Network
Approval Protocol NetworkApprovalProtocol- Network
Domain Permission NetworkDomainPermission- Network
Policy Rule Action NetworkPolicyRuleAction- Network
Unix Socket Permission NetworkUnixSocketPermission- NonSteerable
Turn Kind NonSteerableTurnKind- Parsed
Command ParsedCommand- Patch
Apply Status PatchApplyStatus- Patch
Change Kind PatchChangeKind- Permission
Grant Scope PermissionGrantScope- Personality
Personality- Plan
Type PlanType- Plugin
Auth Policy PluginAuthPolicy- Plugin
Availability PluginAvailability- Plugin
Install Policy PluginInstallPolicy- Plugin
Install Policy Source PluginInstallPolicySource- Plugin
List Marketplace Kind PluginListMarketplaceKind- Plugin
Share Discoverability PluginShareDiscoverability- Plugin
Share Principal Role PluginSharePrincipalRole- Plugin
Share Principal Type PluginSharePrincipalType- Plugin
Share Target Role PluginShareTargetRole- Plugin
Share Update Discoverability PluginShareUpdateDiscoverability- Plugin
Source PluginSource- Process
Output Stream - Stream label for
process/outputDeltanotifications. - Rate
Limit Reached Type RateLimitReachedType- Rate
Limit Reset Credit Status RateLimitResetCreditStatus- Rate
Limit Reset Type RateLimitResetType- Realtime
Conversation Version RealtimeConversationVersion- Realtime
Output Modality RealtimeOutputModality- Realtime
Voice RealtimeVoice- Reasoning
Item Content ReasoningItemContent- Reasoning
Item Reasoning Summary ReasoningItemReasoningSummary- Reasoning
Summary - A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model’s reasoning process. See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#reasoning-summaries
- Remote
Control Clients List Order RemoteControlClientsListOrder- Remote
Control Connection Status RemoteControlConnectionStatus- Request
Id RequestId- Residency
Requirement ResidencyRequirement- Resource
Content - Contents returned when reading a resource from an MCP server.
- Response
Item ResponseItem- Responses
ApiWeb Search Action ResponsesApiWebSearchAction- Review
Decision - User’s decision in response to an ExecApprovalRequest.
- Review
Delivery ReviewDelivery- Review
Target ReviewTarget- Sandbox
Mode SandboxMode- Sandbox
Policy SandboxPolicy- Server
Notification - Notification sent from the server to the client.
- Server
Request - Request initiated from the server and sent to the client.
- Session
Source SessionSource- Skill
Scope SkillScope- Sort
Direction SortDirection- SubAgent
Activity Kind SubAgentActivityKind- SubAgent
Source SubAgentSource- Thread
Active Flag ThreadActiveFlag- Thread
Goal Status ThreadGoalStatus- Thread
History Mode ThreadHistoryMode- Thread
Item ThreadItem- Thread
List CwdFilter ThreadListCwdFilter- Thread
Memory Mode ThreadMemoryMode- Thread
Realtime Start Transport - EXPERIMENTAL - transport used by thread realtime.
- Thread
Sort Key ThreadSortKey- Thread
Source Kind ThreadSourceKind- Thread
Start Source ThreadStartSource- Thread
Status ThreadStatus- Thread
Unsubscribe Status ThreadUnsubscribeStatus- Turn
Items View TurnItemsView- Turn
Plan Step Status TurnPlanStepStatus- Turn
Status TurnStatus- User
Input UserInput- Verbosity
- Controls output length/detail on GPT-5 models via the Responses API. Serialized with lowercase values to match the OpenAI API.
- WebSearch
Action WebSearchAction- WebSearch
Context Size WebSearchContextSize- WebSearch
Mode WebSearchMode- Windows
Sandbox Readiness WindowsSandboxReadiness- Windows
Sandbox Setup Mode WindowsSandboxSetupMode- Workspace
Message Type WorkspaceMessageType- Write
Status WriteStatus