Enum Op 

#[non_exhaustive]
pub enum Op {
    Interrupt,
    CleanBackgroundTerminals,
    RealtimeConversationStart(ConversationStartParams),
    RealtimeConversationAudio(ConversationAudioParams),
    RealtimeConversationText(ConversationTextParams),
    RealtimeConversationSpeech(ConversationSpeechParams),
    RealtimeConversationClose,
    RealtimeConversationListVoices,
    UserInput {
        items: Vec<UserInput>,
        final_output_json_schema: Option<Value>,
        responsesapi_client_metadata: Option<HashMap<String, String>>,
        additional_context: BTreeMap<String, AdditionalContextEntry>,
        thread_settings: ThreadSettingsOverrides,
    },
    ThreadSettings {
        thread_settings: ThreadSettingsOverrides,
    },
    InterAgentCommunication {
        communication: InterAgentCommunication,
    },
    ExecApproval {
        id: String,
        turn_id: Option<String>,
        decision: ReviewDecision,
    },
    PatchApproval {
        id: String,
        decision: ReviewDecision,
    },
    ResolveElicitation {
        server_name: String,
        request_id: RequestId,
        decision: ElicitationAction,
        content: Option<Value>,
        meta: Option<Value>,
    },
    UserInputAnswer {
        id: String,
        response: RequestUserInputResponse,
    },
    RequestPermissionsResponse {
        id: String,
        response: RequestPermissionsResponse,
    },
    DynamicToolResponse {
        id: String,
        response: DynamicToolResponse,
    },
    RefreshMcpServers {
        config: McpServerRefreshConfig,
    },
    ReloadUserConfig,
    Compact,
    SetThreadMemoryMode {
        mode: ThreadMemoryMode,
    },
    ThreadRollback {
        num_turns: u32,
    },
    Review {
        review_request: ReviewRequest,
    },
    ApproveGuardianDeniedAction {
        event: GuardianAssessmentEvent,
    },
    Shutdown,
    RunUserShellCommand {
        command: String,
    },
}

Submission operation

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Interrupt

Abort current task without terminating background terminal processes. This server sends EventMsg::TurnAborted in response.

CleanBackgroundTerminals

Terminate all running background terminal processes for this thread. Use this when callers intentionally want to stop long-lived background shells.

RealtimeConversationStart(ConversationStartParams)

Start a realtime conversation stream.

RealtimeConversationAudio(ConversationAudioParams)

Send audio input to the running realtime conversation stream.

RealtimeConversationText(ConversationTextParams)

Send text input to the running realtime conversation stream.

RealtimeConversationSpeech(ConversationSpeechParams)

Append speakable text to the running realtime conversation stream.

RealtimeConversationClose

Close the running realtime conversation stream.

RealtimeConversationListVoices

Request the list of voices supported by realtime conversation streams.

UserInput

User input, optionally with thread-settings overrides applied first.

Fields

items: Vec<UserInput>

User input items, see InputItem

final_output_json_schema: Option<Value>

Optional JSON Schema used to constrain the final assistant message for this turn.

responsesapi_client_metadata: Option<HashMap<String, String>>

Optional turn-scoped Responses API client_metadata.

additional_context: BTreeMap<String, AdditionalContextEntry>

Client-supplied context fragments keyed by an opaque source identifier.

thread_settings: ThreadSettingsOverrides

Persistent thread-settings overrides to apply before the input.

ThreadSettings

Apply persistent thread-settings overrides without starting a turn.

This uses the same submission queue as turn starts so app-server can preserve caller order between both kinds of mutation.

Fields

thread_settings: ThreadSettingsOverrides

Persistent thread-settings overrides to apply.

InterAgentCommunication

Inter-agent communication that should be recorded as agent-message history while still using the normal thread submission lifecycle.

Fields

communication: InterAgentCommunication

ExecApproval

Approve a command execution

Fields

id: String

The id of the submission we are approving

turn_id: Option<String>

Turn id associated with the approval event, when available.

decision: ReviewDecision

The user’s decision in response to the request.

PatchApproval

Approve a code patch

Fields

id: String

The id of the submission we are approving

decision: ReviewDecision

The user’s decision in response to the request.

ResolveElicitation

Resolve an MCP elicitation request.

Fields

server_name: String

Name of the MCP server that issued the request.

request_id: RequestId

Request identifier from the MCP server.

decision: ElicitationAction

User’s decision for the request.

content: Option<Value>

Structured user input supplied for accepted elicitations.

meta: Option<Value>

Optional client metadata associated with the elicitation response.

UserInputAnswer

Resolve a request_user_input tool call.

Fields

id: String

Turn id for the in-flight request.

response: RequestUserInputResponse

User-provided answers.

RequestPermissionsResponse

Resolve a request_permissions tool call.

Fields

id: String

Call id for the in-flight request.

response: RequestPermissionsResponse

User-granted permissions.

DynamicToolResponse

Resolve a dynamic tool call request.

Fields

id: String

Call id for the in-flight request.

response: DynamicToolResponse

Tool output payload.

RefreshMcpServers

Request MCP servers to reinitialize and refresh cached tool lists.

Fields

config: McpServerRefreshConfig

ReloadUserConfig

Reload user config layer overrides for the active session.

This updates runtime config-derived behavior (for example app enable/disable state) without restarting the thread.

Compact

Request the agent to summarize the current conversation context. The agent will use its existing context (either conversation history or previous response id) to generate a summary which will be returned as an AgentMessage event.

SetThreadMemoryMode

Set whether the thread remains eligible for memory generation.

This persists thread-level memory mode metadata without involving the model.

Fields

mode: ThreadMemoryMode

ThreadRollback

Request Codex to drop the last N user turns from in-memory context.

This does not attempt to revert local filesystem changes. Clients are responsible for undoing any edits on disk.

Fields

num_turns: u32

Review

Request a code review from the agent.

Fields

review_request: ReviewRequest

ApproveGuardianDeniedAction

Record that the user approved one retry of a concrete Guardian-denied action.

Fields

event: GuardianAssessmentEvent

Shutdown

Request to shut down codex instance.

RunUserShellCommand

Execute a user-initiated one-off shell command (triggered by “!cmd”).

The command string is executed using the user’s default shell and may include shell syntax (pipes, redirects, etc.). Output is streamed via ExecCommand* events and the UI regains control upon TurnComplete.

Fields

command: String

The raw command string after ‘!’

Implementations

impl Op

pub fn kind(&self) -> &'static str

Trait Implementations

impl Clone for Op

fn clone(&self) -> Op

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Op

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Vec<UserInput>> for Op

fn from(value: Vec<UserInput>) -> Self

Converts to this type from the input type.

impl PartialEq for Op

fn eq(&self, other: &Op) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Op