Enum Op 

#[non_exhaustive]
pub enum Op {
    Interrupt,
    CleanBackgroundTerminals,
    UserInput {
        items: Vec<UserInput>,
        final_output_json_schema: Option<Value>,
    },
    UserTurn {
        items: Vec<UserInput>,
        cwd: PathBuf,
        approval_policy: AskForApproval,
        sandbox_policy: SandboxPolicy,
        model: String,
        effort: Option<ReasoningEffort>,
        summary: ReasoningSummary,
        final_output_json_schema: Option<Value>,
        collaboration_mode: Option<CollaborationMode>,
        personality: Option<Personality>,
    },
    OverrideTurnContext {
        cwd: Option<PathBuf>,
        approval_policy: Option<AskForApproval>,
        sandbox_policy: Option<SandboxPolicy>,
        windows_sandbox_level: Option<WindowsSandboxLevel>,
        model: Option<String>,
        effort: Option<Option<ReasoningEffort>>,
        summary: Option<ReasoningSummary>,
        collaboration_mode: Option<CollaborationMode>,
        personality: Option<Personality>,
    },
    ExecApproval {
        id: String,
        turn_id: Option<String>,
        decision: ReviewDecision,
    },
    PatchApproval {
        id: String,
        decision: ReviewDecision,
    },
    ResolveElicitation {
        server_name: String,
        request_id: RequestId,
        decision: ElicitationAction,
    },
    UserInputAnswer {
        id: String,
        response: RequestUserInputResponse,
    },
    DynamicToolResponse {
        id: String,
        response: DynamicToolResponse,
    },
    AddToHistory {
        text: String,
    },
    GetHistoryEntryRequest {
        offset: usize,
        log_id: u64,
    },
    ListMcpTools,
    RefreshMcpServers {
        config: McpServerRefreshConfig,
    },
    ListCustomPrompts,
    ListSkills {
        cwds: Vec<PathBuf>,
        force_reload: bool,
    },
    ListRemoteSkills,
    DownloadRemoteSkill {
        hazelnut_id: String,
        is_preload: bool,
    },
    Compact,
    SetThreadName {
        name: String,
    },
    Undo,
    ThreadRollback {
        num_turns: u32,
    },
    Review {
        review_request: ReviewRequest,
    },
    Shutdown,
    RunUserShellCommand {
        command: String,
    },
    ListModels,
}

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. This server sends EventMsg::TurnAborted in response.

CleanBackgroundTerminals

Terminate all running background terminal processes for this thread.

UserInput

Legacy user input.

Prefer Op::UserTurn so the caller provides full turn context (cwd/approval/sandbox/model/etc.) for each turn.

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.

UserTurn

Similar to Op::UserInput, but contains additional context required for a turn of a [crate::codex_thread::CodexThread].

Fields

items: Vec<UserInput>

User input items, see InputItem

cwd: PathBuf

cwd to use with the SandboxPolicy and potentially tool calls such as local_shell.

approval_policy: AskForApproval

Policy to use for command approval.

sandbox_policy: SandboxPolicy

Policy to use for tool calls such as local_shell.

model: String

Must be a valid model slug for the configured client session associated with this conversation.

effort: Option<ReasoningEffort>

Will only be honored if the model is configured to use reasoning.

summary: ReasoningSummary

Will only be honored if the model is configured to use reasoning.

final_output_json_schema: Option<Value>

collaboration_mode: Option<CollaborationMode>

EXPERIMENTAL - set a pre-set collaboration mode. Takes precedence over model, effort, and developer instructions if set.

personality: Option<Personality>

Optional personality override for this turn.

OverrideTurnContext

Override parts of the persistent turn context for subsequent turns.

All fields are optional; when omitted, the existing value is preserved. This does not enqueue any input – it only updates defaults used for turns that rely on persistent session-level context (for example, Op::UserInput).

Fields

cwd: Option<PathBuf>

Updated cwd for sandbox/tool calls.

approval_policy: Option<AskForApproval>

Updated command approval policy.

sandbox_policy: Option<SandboxPolicy>

Updated sandbox policy for tool calls.

windows_sandbox_level: Option<WindowsSandboxLevel>

Updated Windows sandbox mode for tool execution.

model: Option<String>

Updated model slug. When set, the model info is derived automatically.

effort: Option<Option<ReasoningEffort>>

Updated reasoning effort (honored only for reasoning-capable models).

Use Some(Some(_)) to set a specific effort, Some(None) to clear the effort, or None to leave the existing value unchanged.

summary: Option<ReasoningSummary>

Updated reasoning summary preference (honored only for reasoning-capable models).

collaboration_mode: Option<CollaborationMode>

EXPERIMENTAL - set a pre-set collaboration mode. Takes precedence over model, effort, and developer instructions if set.

personality: Option<Personality>

Updated personality preference.

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.

UserInputAnswer

Resolve a request_user_input tool call.

Fields

id: String

Turn id for the in-flight request.

response: RequestUserInputResponse

User-provided answers.

DynamicToolResponse

Resolve a dynamic tool call request.

Fields

id: String

Call id for the in-flight request.

response: DynamicToolResponse

Tool output payload.

AddToHistory

Append an entry to the persistent cross-session message history.

Note the entry is not guaranteed to be logged if the user has history disabled, it matches the list of “sensitive” patterns, etc.

Fields

text: String

The message text to be stored.

GetHistoryEntryRequest

Request a single history entry identified by log_id + offset.

Fields

offset: usize

log_id: u64

ListMcpTools

Request the list of MCP tools available across all configured servers. Reply is delivered via EventMsg::McpListToolsResponse.

RefreshMcpServers

Request MCP servers to reinitialize and refresh cached tool lists.

Fields

config: McpServerRefreshConfig

ListCustomPrompts

Request the list of available custom prompts.

ListSkills

Request the list of skills for the provided cwd values or the session default.

Fields

cwds: Vec<PathBuf>

Working directories to scope repo skills discovery.

When empty, the session default working directory is used.

force_reload: bool

When true, recompute skills even if a cached result exists.

ListRemoteSkills

Request the list of remote skills available via ChatGPT sharing.

DownloadRemoteSkill

Download a remote skill by id into the local skills cache.

Fields

hazelnut_id: String

is_preload: bool

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.

SetThreadName

Set a user-facing thread name in the persisted rollout metadata. This is a local-only operation handled by codex-core; it does not involve the model.

Fields

name: String

Undo

Request Codex to undo a turn (turn are stacked so it is the same effect as CMD + Z).

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

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 ‘!’

ListModels

Request the list of available models.

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<'de> Deserialize<'de> for Op

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Op

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Op

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Op

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Op