pub enum ClientResponse {
Show 129 variants
Initialize {
request_id: RequestId,
response: InitializeResponse,
},
ThreadStart {
request_id: RequestId,
response: ThreadStartResponse,
},
ThreadResume {
request_id: RequestId,
response: ThreadResumeResponse,
},
ThreadFork {
request_id: RequestId,
response: ThreadForkResponse,
},
ThreadArchive {
request_id: RequestId,
response: ThreadArchiveResponse,
},
ThreadDelete {
request_id: RequestId,
response: ThreadDeleteResponse,
},
ThreadUnsubscribe {
request_id: RequestId,
response: ThreadUnsubscribeResponse,
},
ThreadIncrementElicitation {
request_id: RequestId,
response: ThreadIncrementElicitationResponse,
},
ThreadDecrementElicitation {
request_id: RequestId,
response: ThreadDecrementElicitationResponse,
},
ThreadSetName {
request_id: RequestId,
response: ThreadSetNameResponse,
},
ThreadGoalSet {
request_id: RequestId,
response: ThreadGoalSetResponse,
},
ThreadGoalGet {
request_id: RequestId,
response: ThreadGoalGetResponse,
},
ThreadGoalClear {
request_id: RequestId,
response: ThreadGoalClearResponse,
},
ThreadMetadataUpdate {
request_id: RequestId,
response: ThreadMetadataUpdateResponse,
},
ThreadSettingsUpdate {
request_id: RequestId,
response: ThreadSettingsUpdateResponse,
},
ThreadMemoryModeSet {
request_id: RequestId,
response: ThreadMemoryModeSetResponse,
},
MemoryReset {
request_id: RequestId,
response: MemoryResetResponse,
},
ThreadUnarchive {
request_id: RequestId,
response: ThreadUnarchiveResponse,
},
ThreadCompactStart {
request_id: RequestId,
response: ThreadCompactStartResponse,
},
ThreadShellCommand {
request_id: RequestId,
response: ThreadShellCommandResponse,
},
ThreadApproveGuardianDeniedAction {
request_id: RequestId,
response: ThreadApproveGuardianDeniedActionResponse,
},
ThreadBackgroundTerminalsClean {
request_id: RequestId,
response: ThreadBackgroundTerminalsCleanResponse,
},
ThreadBackgroundTerminalsList {
request_id: RequestId,
response: ThreadBackgroundTerminalsListResponse,
},
ThreadBackgroundTerminalsTerminate {
request_id: RequestId,
response: ThreadBackgroundTerminalsTerminateResponse,
},
ThreadRollback {
request_id: RequestId,
response: ThreadRollbackResponse,
},
ThreadList {
request_id: RequestId,
response: ThreadListResponse,
},
ThreadSearch {
request_id: RequestId,
response: ThreadSearchResponse,
},
ThreadSearchOccurrences {
request_id: RequestId,
response: ThreadSearchOccurrencesResponse,
},
ThreadLoadedList {
request_id: RequestId,
response: ThreadLoadedListResponse,
},
ThreadRead {
request_id: RequestId,
response: ThreadReadResponse,
},
ThreadTurnsList {
request_id: RequestId,
response: ThreadTurnsListResponse,
},
ThreadItemsList {
request_id: RequestId,
response: ThreadItemsListResponse,
},
ThreadInjectItems {
request_id: RequestId,
response: ThreadInjectItemsResponse,
},
SkillsList {
request_id: RequestId,
response: SkillsListResponse,
},
SkillsExtraRootsSet {
request_id: RequestId,
response: SkillsExtraRootsSetResponse,
},
HooksList {
request_id: RequestId,
response: HooksListResponse,
},
MarketplaceAdd {
request_id: RequestId,
response: MarketplaceAddResponse,
},
MarketplaceRemove {
request_id: RequestId,
response: MarketplaceRemoveResponse,
},
MarketplaceUpgrade {
request_id: RequestId,
response: MarketplaceUpgradeResponse,
},
PluginList {
request_id: RequestId,
response: PluginListResponse,
},
PluginInstalled {
request_id: RequestId,
response: PluginInstalledResponse,
},
PluginRead {
request_id: RequestId,
response: PluginReadResponse,
},
PluginSkillRead {
request_id: RequestId,
response: PluginSkillReadResponse,
},
PluginShareSave {
request_id: RequestId,
response: PluginShareSaveResponse,
},
PluginShareUpdateTargets {
request_id: RequestId,
response: PluginShareUpdateTargetsResponse,
},
PluginShareList {
request_id: RequestId,
response: PluginShareListResponse,
},
PluginShareCheckout {
request_id: RequestId,
response: PluginShareCheckoutResponse,
},
PluginShareDelete {
request_id: RequestId,
response: PluginShareDeleteResponse,
},
AppsRead {
request_id: RequestId,
response: AppsReadResponse,
},
AppsList {
request_id: RequestId,
response: AppsListResponse,
},
AppsInstalled {
request_id: RequestId,
response: AppsInstalledResponse,
},
FsReadFile {
request_id: RequestId,
response: FsReadFileResponse,
},
FsWriteFile {
request_id: RequestId,
response: FsWriteFileResponse,
},
FsCreateDirectory {
request_id: RequestId,
response: FsCreateDirectoryResponse,
},
FsGetMetadata {
request_id: RequestId,
response: FsGetMetadataResponse,
},
FsReadDirectory {
request_id: RequestId,
response: FsReadDirectoryResponse,
},
FsRemove {
request_id: RequestId,
response: FsRemoveResponse,
},
FsCopy {
request_id: RequestId,
response: FsCopyResponse,
},
FsWatch {
request_id: RequestId,
response: FsWatchResponse,
},
FsUnwatch {
request_id: RequestId,
response: FsUnwatchResponse,
},
SkillsConfigWrite {
request_id: RequestId,
response: SkillsConfigWriteResponse,
},
PluginInstall {
request_id: RequestId,
response: PluginInstallResponse,
},
PluginUninstall {
request_id: RequestId,
response: PluginUninstallResponse,
},
TurnStart {
request_id: RequestId,
response: TurnStartResponse,
},
TurnSteer {
request_id: RequestId,
response: TurnSteerResponse,
},
TurnInterrupt {
request_id: RequestId,
response: TurnInterruptResponse,
},
ThreadRealtimeStart {
request_id: RequestId,
response: ThreadRealtimeStartResponse,
},
ThreadRealtimeAppendAudio {
request_id: RequestId,
response: ThreadRealtimeAppendAudioResponse,
},
ThreadRealtimeAppendText {
request_id: RequestId,
response: ThreadRealtimeAppendTextResponse,
},
ThreadRealtimeAppendSpeech {
request_id: RequestId,
response: ThreadRealtimeAppendSpeechResponse,
},
ThreadRealtimeStop {
request_id: RequestId,
response: ThreadRealtimeStopResponse,
},
ThreadRealtimeListVoices {
request_id: RequestId,
response: ThreadRealtimeListVoicesResponse,
},
ReviewStart {
request_id: RequestId,
response: ReviewStartResponse,
},
ModelList {
request_id: RequestId,
response: ModelListResponse,
},
ModelProviderCapabilitiesRead {
request_id: RequestId,
response: ModelProviderCapabilitiesReadResponse,
},
ExperimentalFeatureList {
request_id: RequestId,
response: ExperimentalFeatureListResponse,
},
PermissionProfileList {
request_id: RequestId,
response: PermissionProfileListResponse,
},
ExperimentalFeatureEnablementSet {
request_id: RequestId,
response: ExperimentalFeatureEnablementSetResponse,
},
RemoteControlEnable {
request_id: RequestId,
response: RemoteControlEnableResponse,
},
RemoteControlDisable {
request_id: RequestId,
response: RemoteControlDisableResponse,
},
RemoteControlStatusRead {
request_id: RequestId,
response: RemoteControlStatusReadResponse,
},
RemoteControlPairingStart {
request_id: RequestId,
response: RemoteControlPairingStartResponse,
},
RemoteControlPairingStatus {
request_id: RequestId,
response: RemoteControlPairingStatusResponse,
},
RemoteControlClientsList {
request_id: RequestId,
response: RemoteControlClientsListResponse,
},
RemoteControlClientsRevoke {
request_id: RequestId,
response: RemoteControlClientsRevokeResponse,
},
CollaborationModeList {
request_id: RequestId,
response: CollaborationModeListResponse,
},
MockExperimentalMethod {
request_id: RequestId,
response: MockExperimentalMethodResponse,
},
EnvironmentAdd {
request_id: RequestId,
response: EnvironmentAddResponse,
},
EnvironmentInfo {
request_id: RequestId,
response: EnvironmentInfoResponse,
},
EnvironmentStatus {
request_id: RequestId,
response: EnvironmentStatusResponse,
},
McpServerOauthLogin {
request_id: RequestId,
response: McpServerOauthLoginResponse,
},
McpServerRefresh {
request_id: RequestId,
response: McpServerRefreshResponse,
},
McpServerStatusList {
request_id: RequestId,
response: ListMcpServerStatusResponse,
},
McpResourceRead {
request_id: RequestId,
response: McpResourceReadResponse,
},
McpServerToolCall {
request_id: RequestId,
response: McpServerToolCallResponse,
},
WindowsSandboxSetupStart {
request_id: RequestId,
response: WindowsSandboxSetupStartResponse,
},
WindowsSandboxReadiness {
request_id: RequestId,
response: WindowsSandboxReadinessResponse,
},
LoginAccount {
request_id: RequestId,
response: LoginAccountResponse,
},
CancelLoginAccount {
request_id: RequestId,
response: CancelLoginAccountResponse,
},
LogoutAccount {
request_id: RequestId,
response: LogoutAccountResponse,
},
GetAccountRateLimits {
request_id: RequestId,
response: GetAccountRateLimitsResponse,
},
ConsumeAccountRateLimitResetCredit {
request_id: RequestId,
response: ConsumeAccountRateLimitResetCreditResponse,
},
GetAccountTokenUsage {
request_id: RequestId,
response: GetAccountTokenUsageResponse,
},
GetWorkspaceMessages {
request_id: RequestId,
response: GetWorkspaceMessagesResponse,
},
SendAddCreditsNudgeEmail {
request_id: RequestId,
response: SendAddCreditsNudgeEmailResponse,
},
FeedbackUpload {
request_id: RequestId,
response: FeedbackUploadResponse,
},
OneOffCommandExec {
request_id: RequestId,
response: CommandExecResponse,
},
CommandExecWrite {
request_id: RequestId,
response: CommandExecWriteResponse,
},
CommandExecTerminate {
request_id: RequestId,
response: CommandExecTerminateResponse,
},
CommandExecResize {
request_id: RequestId,
response: CommandExecResizeResponse,
},
ProcessSpawn {
request_id: RequestId,
response: ProcessSpawnResponse,
},
ProcessWriteStdin {
request_id: RequestId,
response: ProcessWriteStdinResponse,
},
ProcessKill {
request_id: RequestId,
response: ProcessKillResponse,
},
ProcessResizePty {
request_id: RequestId,
response: ProcessResizePtyResponse,
},
ConfigRead {
request_id: RequestId,
response: ConfigReadResponse,
},
ExternalAgentConfigDetect {
request_id: RequestId,
response: ExternalAgentConfigDetectResponse,
},
ExternalAgentConfigImport {
request_id: RequestId,
response: ExternalAgentConfigImportResponse,
},
ExternalAgentConfigImportHistoriesRead {
request_id: RequestId,
response: ExternalAgentConfigImportHistoriesReadResponse,
},
ConfigValueWrite {
request_id: RequestId,
response: ConfigWriteResponse,
},
ConfigBatchWrite {
request_id: RequestId,
response: ConfigWriteResponse,
},
ConfigRequirementsRead {
request_id: RequestId,
response: ConfigRequirementsReadResponse,
},
GetAccount {
request_id: RequestId,
response: GetAccountResponse,
},
GetConversationSummary {
request_id: RequestId,
response: GetConversationSummaryResponse,
},
GitDiffToRemote {
request_id: RequestId,
response: GitDiffToRemoteResponse,
},
GetAuthStatus {
request_id: RequestId,
response: GetAuthStatusResponse,
},
FuzzyFileSearch {
request_id: RequestId,
response: FuzzyFileSearchResponse,
},
FuzzyFileSearchSessionStart {
request_id: RequestId,
response: FuzzyFileSearchSessionStartResponse,
},
FuzzyFileSearchSessionUpdate {
request_id: RequestId,
response: FuzzyFileSearchSessionUpdateResponse,
},
FuzzyFileSearchSessionStop {
request_id: RequestId,
response: FuzzyFileSearchSessionStopResponse,
},
}Expand description
Typed response from the server to the client.
Variants§
Initialize
ThreadStart
NEW APIs
ThreadResume
ThreadFork
ThreadArchive
ThreadDelete
ThreadUnsubscribe
ThreadIncrementElicitation
Increment the thread-local out-of-band elicitation counter.
This is used by external helpers to pause timeout accounting while a user approval or other elicitation is pending outside the app-server request flow.
ThreadDecrementElicitation
Decrement the thread-local out-of-band elicitation counter.
When the count reaches zero, timeout accounting resumes for the thread.
ThreadSetName
ThreadGoalSet
ThreadGoalGet
ThreadGoalClear
ThreadMetadataUpdate
ThreadSettingsUpdate
ThreadMemoryModeSet
MemoryReset
ThreadUnarchive
ThreadCompactStart
ThreadShellCommand
ThreadApproveGuardianDeniedAction
ThreadBackgroundTerminalsClean
ThreadBackgroundTerminalsList
ThreadBackgroundTerminalsTerminate
ThreadRollback
ThreadList
ThreadSearch
ThreadSearchOccurrences
ThreadLoadedList
ThreadRead
ThreadTurnsList
ThreadItemsList
ThreadInjectItems
Append raw Responses API items to the thread history without starting a user turn.
SkillsList
SkillsExtraRootsSet
HooksList
MarketplaceAdd
MarketplaceRemove
MarketplaceUpgrade
PluginList
PluginInstalled
PluginRead
PluginSkillRead
AppsRead
AppsList
AppsInstalled
FsReadFile
FsWriteFile
FsCreateDirectory
FsGetMetadata
FsReadDirectory
FsRemove
FsCopy
FsWatch
FsUnwatch
SkillsConfigWrite
PluginInstall
PluginUninstall
TurnStart
TurnSteer
TurnInterrupt
ThreadRealtimeStart
ThreadRealtimeAppendAudio
ThreadRealtimeAppendText
ThreadRealtimeAppendSpeech
ThreadRealtimeStop
ThreadRealtimeListVoices
ReviewStart
ModelList
ModelProviderCapabilitiesRead
ExperimentalFeatureList
PermissionProfileList
ExperimentalFeatureEnablementSet
RemoteControlEnable
RemoteControlDisable
RemoteControlStatusRead
RemoteControlPairingStart
RemoteControlPairingStatus
RemoteControlClientsList
RemoteControlClientsRevoke
CollaborationModeList
Lists collaboration mode presets.
MockExperimentalMethod
Test-only method used to validate experimental gating.
EnvironmentAdd
Adds or replaces a remote environment by id for later selection.
EnvironmentInfo
Reads information from a configured execution environment.
EnvironmentStatus
Reads the current status of a configured execution environment.
McpServerOauthLogin
McpServerRefresh
McpServerStatusList
McpResourceRead
McpServerToolCall
WindowsSandboxSetupStart
WindowsSandboxReadiness
LoginAccount
CancelLoginAccount
LogoutAccount
GetAccountRateLimits
ConsumeAccountRateLimitResetCredit
GetAccountTokenUsage
GetWorkspaceMessages
SendAddCreditsNudgeEmail
FeedbackUpload
OneOffCommandExec
Execute a standalone command (argv vector) under the server’s sandbox.
CommandExecWrite
Write stdin bytes to a running command/exec session or close stdin.
CommandExecTerminate
Terminate a running command/exec session by client-supplied processId.
CommandExecResize
Resize a running PTY-backed command/exec session by client-supplied processId.
ProcessSpawn
Spawn a standalone process (argv vector) without a Codex sandbox.
ProcessWriteStdin
Write stdin bytes to a running process/spawn session or close stdin.
ProcessKill
Terminate a running process/spawn session by client-supplied processHandle.
ProcessResizePty
Resize a running PTY-backed process/spawn session by client-supplied processHandle.
ConfigRead
ExternalAgentConfigDetect
ExternalAgentConfigImport
ExternalAgentConfigImportHistoriesRead
ConfigValueWrite
ConfigBatchWrite
ConfigRequirementsRead
GetAccount
GetConversationSummary
DEPRECATED APIs below
GitDiffToRemote
GetAuthStatus
DEPRECATED in favor of GetAccount
FuzzyFileSearch
FuzzyFileSearchSessionStart
FuzzyFileSearchSessionUpdate
FuzzyFileSearchSessionStop
Implementations§
Trait Implementations§
Source§impl Clone for ClientResponse
impl Clone for ClientResponse
Source§fn clone(&self) -> ClientResponse
fn clone(&self) -> ClientResponse
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for ClientResponse
impl Debug for ClientResponse
Source§impl<'de> Deserialize<'de> for ClientResponse
impl<'de> Deserialize<'de> for ClientResponse
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for ClientResponse
impl RefUnwindSafe for ClientResponse
impl Send for ClientResponse
impl Sync for ClientResponse
impl Unpin for ClientResponse
impl UnsafeUnpin for ClientResponse
impl UnwindSafe for ClientResponse
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more