# Codex SDK v0.16.1 - API Reference ## Modules - [Codex.Agent](Codex.Agent.md): Defines a reusable agent with instructions, tools, and hooks. - [Codex.AgentRunner](Codex.AgentRunner.md): Multi-turn runner that orchestrates agent execution over Codex threads. - [Codex.AppServer.Mcp](Codex.AppServer.Mcp.md): MCP (Model Context Protocol) server management for app-server connections. - [Codex.AppServer.V1](Codex.AppServer.V1.md): Legacy v1 app-server endpoints for compatibility with older servers. - [Codex.Auth](Codex.Auth.md): API key resolution with `CODEX_API_KEY` → `auth.json` → `OPENAI_API_KEY` precedence. - [Codex.Events.AccountLoginCompleted](Codex.Events.AccountLoginCompleted.md): Event emitted when account login completes. - [Codex.Events.AccountRateLimitsUpdated](Codex.Events.AccountRateLimitsUpdated.md): Event emitted when account rate limits are updated. - [Codex.Events.AccountUpdated](Codex.Events.AccountUpdated.md): Event emitted when account authentication state changes. - [Codex.Events.AppListUpdated](Codex.Events.AppListUpdated.md): Event emitted when the app catalog changes. - [Codex.Events.AppServerNotification](Codex.Events.AppServerNotification.md): Lossless wrapper for an app-server notification that is not yet mapped into a typed event. - [Codex.Events.ChatgptAuthTokensRefreshRequested](Codex.Events.ChatgptAuthTokensRefreshRequested.md): Event emitted when the app-server asks the client to refresh ChatGPT auth tokens. - [Codex.Events.CollabAgentInteractionBegin](Codex.Events.CollabAgentInteractionBegin.md): Collab event emitted when an agent interaction starts. - [Codex.Events.CollabAgentInteractionEnd](Codex.Events.CollabAgentInteractionEnd.md): Collab event emitted when an agent interaction completes. - [Codex.Events.CollabAgentSpawnBegin](Codex.Events.CollabAgentSpawnBegin.md): Collab event emitted when an agent spawn starts. - [Codex.Events.CollabAgentSpawnEnd](Codex.Events.CollabAgentSpawnEnd.md): Collab event emitted when an agent spawn completes. - [Codex.Events.CollabCloseBegin](Codex.Events.CollabCloseBegin.md): Collab event emitted when a collab session begins closing. - [Codex.Events.CollabCloseEnd](Codex.Events.CollabCloseEnd.md): Collab event emitted when a collab session closes. - [Codex.Events.CollabResumeBegin](Codex.Events.CollabResumeBegin.md): Collab event emitted when an agent resume begins. - [Codex.Events.CollabResumeEnd](Codex.Events.CollabResumeEnd.md): Collab event emitted when an agent resume completes. - [Codex.Events.CollabWaitingBegin](Codex.Events.CollabWaitingBegin.md): Collab event emitted when an agent begins waiting. - [Codex.Events.CollabWaitingEnd](Codex.Events.CollabWaitingEnd.md): Collab event emitted when an agent stops waiting. - [Codex.Events.CommandApprovalRequested](Codex.Events.CommandApprovalRequested.md): Event emitted when the app-server requests approval for a command execution. - [Codex.Events.CommandOutputDelta](Codex.Events.CommandOutputDelta.md): Event delta emitted while a command execution is producing output. - [Codex.Events.ConfigWarning](Codex.Events.ConfigWarning.md): Event emitted when configuration warnings are reported. - [Codex.Events.ContextCompacted](Codex.Events.ContextCompacted.md): Indicates that the conversation context was compacted. - [Codex.Events.DeprecationNotice](Codex.Events.DeprecationNotice.md): Event emitted when the server reports a deprecated feature or behavior. - [Codex.Events.DynamicToolCallRequested](Codex.Events.DynamicToolCallRequested.md): Event emitted when the app-server asks the client to execute a dynamic tool call. - [Codex.Events.ElicitationRequest](Codex.Events.ElicitationRequest.md): Event emitted for MCP elicitation requests. - [Codex.Events.EnteredReviewMode](Codex.Events.EnteredReviewMode.md): Event emitted when a review session starts. - [Codex.Events.Error](Codex.Events.Error.md): General error event emitted by the CLI. - [Codex.Events.ExitedReviewMode](Codex.Events.ExitedReviewMode.md): Event emitted when a review session ends. - [Codex.Events.FileApprovalRequested](Codex.Events.FileApprovalRequested.md): Event emitted when the app-server requests approval for a file change. - [Codex.Events.FileChangeOutputDelta](Codex.Events.FileChangeOutputDelta.md): Event delta emitted while a file change stream is producing output. - [Codex.Events.FuzzyFileSearchSessionCompleted](Codex.Events.FuzzyFileSearchSessionCompleted.md): Event emitted when a fuzzy file search session finishes. - [Codex.Events.FuzzyFileSearchSessionUpdated](Codex.Events.FuzzyFileSearchSessionUpdated.md): Event emitted when a fuzzy file search session publishes updated matches. - [Codex.Events.GuardianApprovalReview](Codex.Events.GuardianApprovalReview.md): Review payload emitted by guardian auto-approval review notifications. - [Codex.Events.GuardianApprovalReviewCompleted](Codex.Events.GuardianApprovalReviewCompleted.md): Event emitted when guardian review completes for an approval request. - [Codex.Events.GuardianApprovalReviewStarted](Codex.Events.GuardianApprovalReviewStarted.md): Event emitted when guardian review begins for an approval request. - [Codex.Events.HookCompleted](Codex.Events.HookCompleted.md): Event emitted when an app-server hook run completes. - [Codex.Events.HookStarted](Codex.Events.HookStarted.md): Event emitted when an app-server hook run starts. - [Codex.Events.ItemAgentMessageDelta](Codex.Events.ItemAgentMessageDelta.md): Event delta emitted when the agent produces message content. - [Codex.Events.ItemCompleted](Codex.Events.ItemCompleted.md): Event emitted when an item completes. - [Codex.Events.ItemInputTextDelta](Codex.Events.ItemInputTextDelta.md): Event delta emitted for user input text items. - [Codex.Events.ItemStarted](Codex.Events.ItemStarted.md): Event emitted when an item begins processing. - [Codex.Events.ItemUpdated](Codex.Events.ItemUpdated.md): Event emitted when an in-progress item receives an update. - [Codex.Events.McpElicitationRequested](Codex.Events.McpElicitationRequested.md): Event emitted when the app-server requests an MCP elicitation response from the client. - [Codex.Events.McpServerOauthLoginCompleted](Codex.Events.McpServerOauthLoginCompleted.md): Event emitted when an MCP server OAuth login completes. - [Codex.Events.McpServerStartupStatusUpdated](Codex.Events.McpServerStartupStatusUpdated.md): Event emitted when app-server observes an MCP server startup state transition. - [Codex.Events.McpStartupComplete](Codex.Events.McpStartupComplete.md): Summary of MCP server startup completion. - [Codex.Events.McpStartupUpdate](Codex.Events.McpStartupUpdate.md): Incremental status update for MCP server startup. - [Codex.Events.McpToolCallProgress](Codex.Events.McpToolCallProgress.md): Progress message emitted while an MCP tool call is running. - [Codex.Events.ModelRerouted](Codex.Events.ModelRerouted.md): Event emitted when Codex reroutes a turn to a different model. - [Codex.Events.PermissionsApprovalRequested](Codex.Events.PermissionsApprovalRequested.md): Event emitted when the app-server requests additional permissions from the client. - [Codex.Events.RawResponseItemCompleted](Codex.Events.RawResponseItemCompleted.md): Event emitted when a raw response item completes on the app-server stream. - [Codex.Events.ReasoningDelta](Codex.Events.ReasoningDelta.md): Event delta emitted while reasoning content is streaming. - [Codex.Events.ReasoningSummaryDelta](Codex.Events.ReasoningSummaryDelta.md): Event delta emitted while reasoning summary text is streaming. - [Codex.Events.ReasoningSummaryPartAdded](Codex.Events.ReasoningSummaryPartAdded.md): Event emitted when a new reasoning summary part is added. - [Codex.Events.RequestUserInput](Codex.Events.RequestUserInput.md): Event emitted when the agent requests user input. - [Codex.Events.ServerRequestResolved](Codex.Events.ServerRequestResolved.md): Event emitted when the app-server resolves a prior server request. - [Codex.Events.SessionConfigured](Codex.Events.SessionConfigured.md): Event emitted when a session is configured. - [Codex.Events.ShutdownComplete](Codex.Events.ShutdownComplete.md): Event emitted when the agent shuts down. - [Codex.Events.SkillsChanged](Codex.Events.SkillsChanged.md): Invalidation signal emitted when watched skill metadata changes. - [Codex.Events.TerminalInteraction](Codex.Events.TerminalInteraction.md): Event emitted when stdin is written to an interactive command execution. - [Codex.Events.ThreadArchived](Codex.Events.ThreadArchived.md): Event emitted when a thread is archived. - [Codex.Events.ThreadNameUpdated](Codex.Events.ThreadNameUpdated.md): Event emitted when the thread display name changes. - [Codex.Events.ThreadRealtimeClosed](Codex.Events.ThreadRealtimeClosed.md): Event emitted when thread realtime closes. - [Codex.Events.ThreadRealtimeError](Codex.Events.ThreadRealtimeError.md): Event emitted when thread realtime encounters an error. - [Codex.Events.ThreadRealtimeItemAdded](Codex.Events.ThreadRealtimeItemAdded.md): Event emitted when thread realtime adds a non-audio item. - [Codex.Events.ThreadRealtimeOutputAudioDelta](Codex.Events.ThreadRealtimeOutputAudioDelta.md): Event emitted when thread realtime streams output audio. - [Codex.Events.ThreadRealtimeStarted](Codex.Events.ThreadRealtimeStarted.md): Event emitted when thread realtime startup is accepted. - [Codex.Events.ThreadRolledBack](Codex.Events.ThreadRolledBack.md): Indicates that recent user turns were removed from context. - [Codex.Events.ThreadStarted](Codex.Events.ThreadStarted.md): Event emitted when a thread is first created. - [Codex.Events.ThreadStatusChanged](Codex.Events.ThreadStatusChanged.md): Event emitted when thread load or activity status changes. - [Codex.Events.ThreadTokenUsageUpdated](Codex.Events.ThreadTokenUsageUpdated.md): Incremental token usage update emitted while a turn is in flight. - [Codex.Events.ThreadUnarchived](Codex.Events.ThreadUnarchived.md): Event emitted when a thread is restored from the archive. - [Codex.Events.ToolCallCompleted](Codex.Events.ToolCallCompleted.md): Event emitted when a tool call has completed and returned output. - [Codex.Events.ToolCallRequested](Codex.Events.ToolCallRequested.md): Indicates Codex requires a tool invocation to continue auto-run. - [Codex.Events.TurnAborted](Codex.Events.TurnAborted.md): Event emitted when a turn is aborted. - [Codex.Events.TurnCompaction](Codex.Events.TurnCompaction.md): Signals that Codex compacted a turn's history. - [Codex.Events.TurnCompleted](Codex.Events.TurnCompleted.md): Final event for a turn, optionally carrying final response and usage data. - [Codex.Events.TurnContinuation](Codex.Events.TurnContinuation.md): Signals that a continuation token is available for resuming the turn. - [Codex.Events.TurnDiffUpdated](Codex.Events.TurnDiffUpdated.md): Event emitted when the app-server publishes a turn diff update. - [Codex.Events.TurnFailed](Codex.Events.TurnFailed.md): Event emitted when a turn fails. - [Codex.Events.TurnPlanUpdated](Codex.Events.TurnPlanUpdated.md): Event emitted when the app-server publishes an updated plan for the current turn. - [Codex.Events.TurnStarted](Codex.Events.TurnStarted.md): Event emitted when a new turn starts. - [Codex.Events.UndoCompleted](Codex.Events.UndoCompleted.md): Event emitted when an undo operation completes. - [Codex.Events.UndoStarted](Codex.Events.UndoStarted.md): Event emitted when an undo operation begins. - [Codex.Events.Warning](Codex.Events.Warning.md): Warning event emitted during a turn. - [Codex.Events.WindowsWorldWritableWarning](Codex.Events.WindowsWorldWritableWarning.md): Event emitted when world-writable Windows paths are detected. - [Codex.FileSearch](Codex.FileSearch.md): Configuration for file search capabilities in threads and runs. - [Codex.Files.Attachment](Codex.Files.Attachment.md): Represents a staged file attachment. - [Codex.FunctionTool](Codex.FunctionTool.md): Convenience macro for defining function-backed tools with JSON schemas. - [Codex.Guardrail](Codex.Guardrail.md): Represents an input or output guardrail invoked around agent execution. - [Codex.HTTPClient](Codex.HTTPClient.md): HTTP client abstraction for making HTTP requests. - [Codex.HTTPClient.Mock](Codex.HTTPClient.Mock.md): Mock HTTP client for testing. - [Codex.HTTPClient.Req](Codex.HTTPClient.Req.md): HTTP client implementation using Req. - [Codex.Handoff](Codex.Handoff.md): Represents a handoff from one agent to another, wrapping the downstream agent as a tool with optional input filtering and history nesting controls. - [Codex.Handoff.InputData](Codex.Handoff.InputData.md): Carries conversation history and run context into handoff input filters. - [Codex.IO.Buffer](Codex.IO.Buffer.md): Shared helpers for newline-delimited subprocess output buffering and JSON decoding. - [Codex.Items.AgentMessage](Codex.Items.AgentMessage.md): Assistant-authored message item emitted by the Codex runtime, with optional parsed payloads for structured output experiments. - [Codex.Items.CollabAgentToolCall](Codex.Items.CollabAgentToolCall.md): Represents a collaboration tool call between agents. - [Codex.Items.CommandExecution](Codex.Items.CommandExecution.md): Captures an execution request made by the agent, including aggregated output and status metadata. - [Codex.Items.Compaction](Codex.Items.Compaction.md): Raw response item emitted when compaction summaries are generated. - [Codex.Items.ContextCompaction](Codex.Items.ContextCompaction.md): Marker item emitted when context compaction occurred. - [Codex.Items.DynamicToolCall](Codex.Items.DynamicToolCall.md): Metadata describing a dynamic tool invocation handled outside the static tool registry. - [Codex.Items.Error](Codex.Items.Error.md): Normalised error record describing failures surfaced during a turn. - [Codex.Items.FileChange](Codex.Items.FileChange.md): Represents a file diff emitted by the agent, including per-path change metadata and completion status. - [Codex.Items.GhostSnapshot](Codex.Items.GhostSnapshot.md): Raw response item describing a ghost snapshot captured for undo. - [Codex.Items.ImageGeneration](Codex.Items.ImageGeneration.md): Image generation result item emitted by the app-server. - [Codex.Items.ImageView](Codex.Items.ImageView.md): An image view event emitted by the app-server when it renders a local image. - [Codex.Items.McpToolCall](Codex.Items.McpToolCall.md): Metadata describing a tool invocation routed through an MCP server. - [Codex.Items.Plan](Codex.Items.Plan.md): Planning item emitted when the agent publishes a plan as a first-class thread item. - [Codex.Items.RawResponseItem](Codex.Items.RawResponseItem.md): Fallback container for unparsed raw response items. - [Codex.Items.Reasoning](Codex.Items.Reasoning.md): Intermediate reasoning trace shared as part of tool or agent transparency. - [Codex.Items.ReviewMode](Codex.Items.ReviewMode.md): Indicates that review mode has been entered or exited. - [Codex.Items.TodoList](Codex.Items.TodoList.md): Structured checklist shared by the agent to track outstanding follow-up items. - [Codex.Items.UserMessage](Codex.Items.UserMessage.md): User-authored message item carrying a list of input blocks. - [Codex.Items.WebSearch](Codex.Items.WebSearch.md): Records a web search request issued by the agent, preserving the original query. - [Codex.ModelSettings](Codex.ModelSettings.md): Model tuning options and provider selection used to configure codex runs. - [Codex.Net.CA](Codex.Net.CA.md): Shared custom CA bundle resolution for subprocesses and outbound TLS clients. - [Codex.OAuth.Session](Codex.OAuth.Session.md): Internal OAuth session structs shared across flows and token stores. - [Codex.OAuth.Session.PendingDeviceLogin](Codex.OAuth.Session.PendingDeviceLogin.md): Pending device-code OAuth login state returned by `Codex.OAuth.begin_login/1`. - [Codex.OAuth.Session.PendingLogin](Codex.OAuth.Session.PendingLogin.md): Pending browser-based OAuth login state returned by `Codex.OAuth.begin_login/1`. - [Codex.Plugins.Paths](Codex.Plugins.Paths.md): Canonical local authoring paths for plugin manifests and marketplaces. - [Codex.Protocol.ByteRange](Codex.Protocol.ByteRange.md): Byte range for text element positioning. - [Codex.Protocol.CollaborationMode](Codex.Protocol.CollaborationMode.md): Collaboration mode configuration with presets. - [Codex.Protocol.ConfigTypes](Codex.Protocol.ConfigTypes.md): Protocol configuration type enums and converters. - [Codex.Protocol.Elicitation](Codex.Protocol.Elicitation.md): MCP elicitation request and action types. - [Codex.Protocol.Elicitation.Request](Codex.Protocol.Elicitation.Request.md): MCP elicitation request - [Codex.Protocol.Ops](Codex.Protocol.Ops.md): Encoders for Codex protocol operations submitted to the runtime. - [Codex.Protocol.Plugin](Codex.Protocol.Plugin.md): Typed app-server plugin request and response models. - [Codex.Protocol.Plugin.AppSummary](Codex.Protocol.Plugin.AppSummary.md): Plugin app metadata returned by `plugin/read` and `plugin/install`. - [Codex.Protocol.Plugin.AuthPolicy](Codex.Protocol.Plugin.AuthPolicy.md): Plugin auth policy values returned by the app-server plugin APIs. - [Codex.Protocol.Plugin.Detail](Codex.Protocol.Plugin.Detail.md): Plugin detail payload returned by `plugin/read`. - [Codex.Protocol.Plugin.InstallParams](Codex.Protocol.Plugin.InstallParams.md): Typed params for `plugin/install`. - [Codex.Protocol.Plugin.InstallPolicy](Codex.Protocol.Plugin.InstallPolicy.md): Plugin install policy values returned by the app-server plugin APIs. - [Codex.Protocol.Plugin.InstallResponse](Codex.Protocol.Plugin.InstallResponse.md): Typed response for `plugin/install`. - [Codex.Protocol.Plugin.Interface](Codex.Protocol.Plugin.Interface.md): Plugin presentation metadata returned on plugin summary/detail responses. - [Codex.Protocol.Plugin.ListParams](Codex.Protocol.Plugin.ListParams.md): Typed params for `plugin/list`. - [Codex.Protocol.Plugin.ListResponse](Codex.Protocol.Plugin.ListResponse.md): Typed response for `plugin/list`. - [Codex.Protocol.Plugin.Marketplace](Codex.Protocol.Plugin.Marketplace.md): Marketplace entries returned by `plugin/list`. - [Codex.Protocol.Plugin.MarketplaceInterface](Codex.Protocol.Plugin.MarketplaceInterface.md): Marketplace interface metadata surfaced by `plugin/list`. - [Codex.Protocol.Plugin.MarketplaceLoadError](Codex.Protocol.Plugin.MarketplaceLoadError.md): Marketplace load failure details returned by `plugin/list`. - [Codex.Protocol.Plugin.ReadParams](Codex.Protocol.Plugin.ReadParams.md): Typed params for `plugin/read`. - [Codex.Protocol.Plugin.ReadResponse](Codex.Protocol.Plugin.ReadResponse.md): Typed response for `plugin/read`. - [Codex.Protocol.Plugin.SkillSummary](Codex.Protocol.Plugin.SkillSummary.md): Plugin skill metadata returned by `plugin/read`. - [Codex.Protocol.Plugin.Source](Codex.Protocol.Plugin.Source.md): Plugin source metadata returned by the app-server plugin APIs. - [Codex.Protocol.Plugin.Summary](Codex.Protocol.Plugin.Summary.md): Plugin summary metadata returned by `plugin/list` and `plugin/read`. - [Codex.Protocol.Plugin.UninstallParams](Codex.Protocol.Plugin.UninstallParams.md): Typed params for `plugin/uninstall`. - [Codex.Protocol.Plugin.UninstallResponse](Codex.Protocol.Plugin.UninstallResponse.md): Typed response for `plugin/uninstall`. - [Codex.Protocol.RateLimit](Codex.Protocol.RateLimit.md): Rate limit snapshot types for TokenCount events. - [Codex.Protocol.RateLimit.CreditsSnapshot](Codex.Protocol.RateLimit.CreditsSnapshot.md): Credits balance snapshot - [Codex.Protocol.RateLimit.Snapshot](Codex.Protocol.RateLimit.Snapshot.md): Complete rate limit snapshot - [Codex.Protocol.RateLimit.Window](Codex.Protocol.RateLimit.Window.md): A rate limit window - [Codex.Protocol.RequestPermissions](Codex.Protocol.RequestPermissions.md): Types for app-server request-permissions approval requests and responses. - [Codex.Protocol.RequestPermissions.AdditionalFileSystemPermissions](Codex.Protocol.RequestPermissions.AdditionalFileSystemPermissions.md): Additional filesystem permissions requested or granted for a turn or session. - [Codex.Protocol.RequestPermissions.AdditionalMacOsPermissions](Codex.Protocol.RequestPermissions.AdditionalMacOsPermissions.md): Additional macOS permissions requested for a turn or session. - [Codex.Protocol.RequestPermissions.AdditionalNetworkPermissions](Codex.Protocol.RequestPermissions.AdditionalNetworkPermissions.md): Additional network permissions requested or granted for a turn or session. - [Codex.Protocol.RequestPermissions.GrantedMacOsPermissions](Codex.Protocol.RequestPermissions.GrantedMacOsPermissions.md): Additional macOS permissions granted for a turn or session. - [Codex.Protocol.RequestPermissions.GrantedPermissionProfile](Codex.Protocol.RequestPermissions.GrantedPermissionProfile.md): Permission profile included in request-permissions approval responses. - [Codex.Protocol.RequestPermissions.PermissionGrantScope](Codex.Protocol.RequestPermissions.PermissionGrantScope.md): Scope applied to granted permissions in a permissions approval response. - [Codex.Protocol.RequestPermissions.RequestPermissionProfile](Codex.Protocol.RequestPermissions.RequestPermissionProfile.md): Permission profile included in request-permissions approval requests. - [Codex.Protocol.RequestPermissions.Response](Codex.Protocol.RequestPermissions.Response.md): Structured response for an app-server permissions approval request. - [Codex.Protocol.RequestUserInput](Codex.Protocol.RequestUserInput.md): Types for agent-to-user input requests. - [Codex.Protocol.RequestUserInput.Answer](Codex.Protocol.RequestUserInput.Answer.md): An answer to a question - [Codex.Protocol.RequestUserInput.Option](Codex.Protocol.RequestUserInput.Option.md): An option for a question - [Codex.Protocol.RequestUserInput.Question](Codex.Protocol.RequestUserInput.Question.md): A question to present to the user - [Codex.Protocol.RequestUserInput.Response](Codex.Protocol.RequestUserInput.Response.md): Response containing answers to all questions - [Codex.Protocol.TextElement](Codex.Protocol.TextElement.md): Text element with byte range for rich text input. - [Codex.RateLimit](Codex.RateLimit.md): Rate limit detection and handling utilities. - [Codex.Realtime.Events.AgentEndEvent](Codex.Realtime.Events.AgentEndEvent.md): An agent has ended. - [Codex.Realtime.Events.AgentStartEvent](Codex.Realtime.Events.AgentStartEvent.md): A new agent has started. - [Codex.Realtime.Events.AudioEndEvent](Codex.Realtime.Events.AudioEndEvent.md): Audio generation ended. - [Codex.Realtime.Events.AudioEvent](Codex.Realtime.Events.AudioEvent.md): Audio data received. - [Codex.Realtime.Events.AudioInterruptedEvent](Codex.Realtime.Events.AudioInterruptedEvent.md): Audio was interrupted. - [Codex.Realtime.Events.ErrorEvent](Codex.Realtime.Events.ErrorEvent.md): Error occurred. - [Codex.Realtime.Events.EventInfo](Codex.Realtime.Events.EventInfo.md): Common information for all events. - [Codex.Realtime.Events.GuardrailTrippedEvent](Codex.Realtime.Events.GuardrailTrippedEvent.md): Guardrail was tripped. - [Codex.Realtime.Events.HandoffEvent](Codex.Realtime.Events.HandoffEvent.md): Agent handed off to another agent. - [Codex.Realtime.Events.HistoryAddedEvent](Codex.Realtime.Events.HistoryAddedEvent.md): Item added to history. - [Codex.Realtime.Events.HistoryUpdatedEvent](Codex.Realtime.Events.HistoryUpdatedEvent.md): Full history update. - [Codex.Realtime.Events.InputAudioTimeoutTriggeredEvent](Codex.Realtime.Events.InputAudioTimeoutTriggeredEvent.md): Input audio timeout triggered. - [Codex.Realtime.Events.RawModelEvent](Codex.Realtime.Events.RawModelEvent.md): Raw model event wrapper. - [Codex.Realtime.Events.ToolEndEvent](Codex.Realtime.Events.ToolEndEvent.md): Tool call completed. - [Codex.Realtime.Events.ToolStartEvent](Codex.Realtime.Events.ToolStartEvent.md): Tool call started. - [Codex.Realtime.Items.AssistantAudio](Codex.Realtime.Items.AssistantAudio.md): Audio content from assistant. - [Codex.Realtime.Items.AssistantMessageItem](Codex.Realtime.Items.AssistantMessageItem.md): An assistant message item. - [Codex.Realtime.Items.AssistantText](Codex.Realtime.Items.AssistantText.md): Text content from assistant. - [Codex.Realtime.Items.InputAudio](Codex.Realtime.Items.InputAudio.md): Audio input content. - [Codex.Realtime.Items.InputImage](Codex.Realtime.Items.InputImage.md): Image input content. - [Codex.Realtime.Items.InputText](Codex.Realtime.Items.InputText.md): Text input content. - [Codex.Realtime.Items.RealtimeToolCallItem](Codex.Realtime.Items.RealtimeToolCallItem.md): A tool/function call item. - [Codex.Realtime.Items.SystemMessageItem](Codex.Realtime.Items.SystemMessageItem.md): A system message item. - [Codex.Realtime.Items.UserMessageItem](Codex.Realtime.Items.UserMessageItem.md): A user message item. - [Codex.Realtime.ModelEvents.AudioDoneEvent](Codex.Realtime.ModelEvents.AudioDoneEvent.md): Audio generation completed for an item. - [Codex.Realtime.ModelEvents.AudioEvent](Codex.Realtime.ModelEvents.AudioEvent.md): Raw audio bytes from the model. - [Codex.Realtime.ModelEvents.AudioInterruptedEvent](Codex.Realtime.ModelEvents.AudioInterruptedEvent.md): Audio was interrupted. - [Codex.Realtime.ModelEvents.ConnectionStatusEvent](Codex.Realtime.ModelEvents.ConnectionStatusEvent.md): Connection status change event. - [Codex.Realtime.ModelEvents.ErrorEvent](Codex.Realtime.ModelEvents.ErrorEvent.md): Transport-layer error event. - [Codex.Realtime.ModelEvents.ExceptionEvent](Codex.Realtime.ModelEvents.ExceptionEvent.md): Exception during model operation. - [Codex.Realtime.ModelEvents.InputAudioTimeoutTriggeredEvent](Codex.Realtime.ModelEvents.InputAudioTimeoutTriggeredEvent.md): Input audio timeout triggered. - [Codex.Realtime.ModelEvents.InputAudioTranscriptionCompletedEvent](Codex.Realtime.ModelEvents.InputAudioTranscriptionCompletedEvent.md): Input audio transcription completed. - [Codex.Realtime.ModelEvents.ItemDeletedEvent](Codex.Realtime.ModelEvents.ItemDeletedEvent.md): Item deleted from history. - [Codex.Realtime.ModelEvents.ItemUpdatedEvent](Codex.Realtime.ModelEvents.ItemUpdatedEvent.md): Item added to the history or updated. - [Codex.Realtime.ModelEvents.OtherEvent](Codex.Realtime.ModelEvents.OtherEvent.md): Catchall for vendor-specific events. - [Codex.Realtime.ModelEvents.RawServerEvent](Codex.Realtime.ModelEvents.RawServerEvent.md): Raw event forwarded from server. - [Codex.Realtime.ModelEvents.ToolCallEvent](Codex.Realtime.ModelEvents.ToolCallEvent.md): Model attempted a tool/function call. - [Codex.Realtime.ModelEvents.TranscriptDeltaEvent](Codex.Realtime.ModelEvents.TranscriptDeltaEvent.md): Partial transcript update. - [Codex.Realtime.ModelEvents.TurnEndedEvent](Codex.Realtime.ModelEvents.TurnEndedEvent.md): Model finished generating a response. - [Codex.Realtime.ModelEvents.TurnStartedEvent](Codex.Realtime.ModelEvents.TurnStartedEvent.md): Model started generating a response. - [Codex.Realtime.ModelInputs.SendAudio](Codex.Realtime.ModelInputs.SendAudio.md): Send audio data to the model. - [Codex.Realtime.ModelInputs.SendInterrupt](Codex.Realtime.ModelInputs.SendInterrupt.md): Send an interrupt to the model. - [Codex.Realtime.ModelInputs.SendRawMessage](Codex.Realtime.ModelInputs.SendRawMessage.md): Send a raw message to the model. - [Codex.Realtime.ModelInputs.SendSessionUpdate](Codex.Realtime.ModelInputs.SendSessionUpdate.md): Send session settings update. - [Codex.Realtime.ModelInputs.SendToolOutput](Codex.Realtime.ModelInputs.SendToolOutput.md): Send tool output to the model. - [Codex.Realtime.ModelInputs.SendUserInput](Codex.Realtime.ModelInputs.SendUserInput.md): Send user input (text or structured message). - [Codex.Retry](Codex.Retry.md): Retry logic with configurable backoff strategies. - [Codex.RunConfig](Codex.RunConfig.md): Per-run configuration applied to agent execution. - [Codex.RunResultStreaming](Codex.RunResultStreaming.md): Streaming result wrapper exposing semantic and raw event streams plus cancellation controls. - [Codex.Runtime.Env](Codex.Runtime.Env.md): Subprocess environment construction (originator override, API key forwarding). - [Codex.Runtime.Exec](Codex.Runtime.Exec.md): Session-oriented runtime kit for the common Codex exec CLI family. - [Codex.Runtime.KeyringWarning](Codex.Runtime.KeyringWarning.md): Deduplicated warn-once logic for keyring-related warnings. - [Codex.Session](Codex.Session.md): Behaviour for persisting conversation state across runs. - [Codex.Session.Memory](Codex.Session.Memory.md): In-memory session adapter backed by an Agent. Suitable for tests and short-lived runs. - [Codex.Sessions](Codex.Sessions.md): Helpers for inspecting Codex CLI session files and replaying recorded changes. - [Codex.StreamEvent.AgentUpdated](Codex.StreamEvent.AgentUpdated.md): Signals that the agent or run configuration was updated for this stream. - [Codex.StreamEvent.GuardrailResult](Codex.StreamEvent.GuardrailResult.md): Guardrail evaluation outcome streamed to consumers. - [Codex.StreamEvent.RawResponses](Codex.StreamEvent.RawResponses.md): Batch of raw codex events emitted for a turn. - [Codex.StreamEvent.RunItem](Codex.StreamEvent.RunItem.md): Semantic wrapper for a streamed Codex event. - [Codex.StreamEvent.ToolApproval](Codex.StreamEvent.ToolApproval.md): Tool approval outcome emitted during streaming. - [Codex.ToolGuardrail](Codex.ToolGuardrail.md): Guardrail applied before or after tool invocation. - [Codex.ToolOutput](Codex.ToolOutput.md): Structured tool output helpers that mirror the Responses input payload shapes. - [Codex.ToolOutput.FileContent](Codex.ToolOutput.FileContent.md): File content tool output. - [Codex.ToolOutput.Image](Codex.ToolOutput.Image.md): Image tool output. - [Codex.ToolOutput.Text](Codex.ToolOutput.Text.md): Text tool output. - [Codex.Tools.ApplyPatchTool](Codex.Tools.ApplyPatchTool.md): Hosted tool for applying Codex apply_patch edits to files. - [Codex.Tools.CodeInterpreterTool](Codex.Tools.CodeInterpreterTool.md): Hosted code interpreter tool. - [Codex.Tools.ComputerTool](Codex.Tools.ComputerTool.md): Hosted computer action tool with safety callback. - [Codex.Tools.FileSearchTool](Codex.Tools.FileSearchTool.md): Hosted tool for searching files by name pattern and content. - [Codex.Tools.Handle](Codex.Tools.Handle.md): Registration handle returned from `Codex.Tools.register/2`. - [Codex.Tools.HostedMcpTool](Codex.Tools.HostedMcpTool.md): Hosted MCP tool wrapper that delegates to `Codex.MCP.Client`. - [Codex.Tools.ImageGenerationTool](Codex.Tools.ImageGenerationTool.md): Hosted image generation tool. - [Codex.Tools.ShellCommandTool](Codex.Tools.ShellCommandTool.md): Hosted tool for executing shell scripts via the user's default shell. - [Codex.Tools.ShellTool](Codex.Tools.ShellTool.md): Hosted tool for executing shell commands. - [Codex.Tools.VectorStoreSearchTool](Codex.Tools.VectorStoreSearchTool.md): Hosted vector store search tool for searching indexed documents. - [Codex.Tools.ViewImageTool](Codex.Tools.ViewImageTool.md): Hosted tool for attaching local images to the conversation. - [Codex.Tools.WebSearchTool](Codex.Tools.WebSearchTool.md): Hosted tool for performing web searches. - [Codex.Tools.WriteStdinTool](Codex.Tools.WriteStdinTool.md): Hosted tool for writing to an existing exec session. - [Codex.Transport](Codex.Transport.md): Behaviour for Codex transport implementations. - [Codex.Voice.Events.VoiceStreamEventAudio](Codex.Voice.Events.VoiceStreamEventAudio.md): Audio data event from the voice pipeline. - [Codex.Voice.Events.VoiceStreamEventError](Codex.Voice.Events.VoiceStreamEventError.md): Error event from the voice pipeline. - [Codex.Voice.Events.VoiceStreamEventLifecycle](Codex.Voice.Events.VoiceStreamEventLifecycle.md): Lifecycle event from the voice pipeline. - [Codex.Voice.Model.ModelProvider](Codex.Voice.Model.ModelProvider.md): Behaviour for voice model providers. - [Codex.Voice.Model.STTModel](Codex.Voice.Model.STTModel.md): Behaviour for speech-to-text models. - [Codex.Voice.Model.StreamedTranscriptionSession](Codex.Voice.Model.StreamedTranscriptionSession.md): Behaviour for streaming transcription sessions. - [Codex.Voice.Model.TTSModel](Codex.Voice.Model.TTSModel.md): Behaviour for text-to-speech models. - [Codex.Voice.Models.OpenAISTTSession](Codex.Voice.Models.OpenAISTTSession.md): Buffered streamed transcription session. - [CodexSdk](CodexSdk.md): Backwards-compatible entry module for the Codex SDK. - Public API - [Codex](Codex.md): Public entry point for the Codex SDK. - [Codex.AppServer](Codex.AppServer.md): App-server transport for stateful, bidirectional communication with Codex. - [Codex.CLI](Codex.CLI.md): Thin wrapper around the upstream `codex` terminal client. - [Codex.CLI.Session](Codex.CLI.Session.md): Raw `codex` CLI subprocess session backed by `CliSubprocessCore.Channel`. - [Codex.Models](Codex.Models.md): Codex model metadata projected from `cli_subprocess_core`. - [Codex.OAuth](Codex.OAuth.md): Native OAuth login and session management for Codex. - [Codex.OAuth.LoginResult](Codex.OAuth.LoginResult.md): Summary returned by `Codex.OAuth.login/1` and `Codex.OAuth.await_login/2`. - [Codex.OAuth.Status](Codex.OAuth.Status.md): Current OAuth auth state returned by `Codex.OAuth.status/1` and `refresh/1`. - [Codex.Options](Codex.Options.md): Global configuration for Codex interactions. - [Codex.Plugins](Codex.Plugins.md): Local plugin authoring helpers for manifests, marketplaces, and scaffold flows. - [Codex.Plugins.Manifest](Codex.Plugins.Manifest.md): Local authoring model for `.codex-plugin/plugin.json`. - [Codex.Plugins.Marketplace](Codex.Plugins.Marketplace.md): Local authoring model for `.agents/plugins/marketplace.json`. - [Codex.Subagents](Codex.Subagents.md): Deterministic host-side helpers for working with subagent threads over app-server. - [Codex.Thread](Codex.Thread.md): Represents a Codex conversation thread and exposes turn execution APIs. - [Codex.Thread.Options](Codex.Thread.Options.md): Per-thread configuration options. - [Codex.Turn.Result](Codex.Turn.Result.md): Result struct returned from turn execution. - Configuration - [Codex.Config.BaseURL](Codex.Config.BaseURL.md): Base URL resolution with option → env → default precedence. - [Codex.Config.Defaults](Codex.Config.Defaults.md): Single source of truth for all Codex SDK default configuration values. - [Codex.Config.OptionNormalizers](Codex.Config.OptionNormalizers.md): Shared validation for reasoning summary, verbosity, and history persistence. - [Codex.Config.Overrides](Codex.Config.Overrides.md): Config override serialization, nested map flattening, and TOML value validation. - Execution - [Codex.Events](Codex.Events.md): Typed event structs emitted during Codex turn execution. - [Codex.Exec](Codex.Exec.md): Process manager wrapping the `codex` binary via the shared CLI subprocess core. - [Codex.Items](Codex.Items.md): Typed representations of thread items emitted by the Codex runtime. - [Codex.Protocol.CollabAgentRef](Codex.Protocol.CollabAgentRef.md): Typed reference to a collaboration agent thread. - [Codex.Protocol.CollabAgentState](Codex.Protocol.CollabAgentState.md): Typed representation of a collaboration agent lifecycle state. - [Codex.Protocol.CollabAgentStatusEntry](Codex.Protocol.CollabAgentStatusEntry.md): Typed association between an agent reference and its lifecycle state. - [Codex.Protocol.SessionSource](Codex.Protocol.SessionSource.md): Typed representation of thread/session source metadata returned by Codex. - [Codex.Protocol.SubAgentSource](Codex.Protocol.SubAgentSource.md): Typed representation of sub-agent session source metadata. - [Codex.Telemetry](Codex.Telemetry.md): Telemetry helpers and default logging for Codex events. - Files - [Codex.Files](Codex.Files.md): Attachment staging helpers mirroring the Python SDK file APIs. - [Codex.Files.Registry](Codex.Files.Registry.md): GenServer-backed manifest that tracks staged file attachments, deduplicates by checksum, and prunes expired entries on a schedule. This powers the public `Codex.Files` helpers. - [Codex.OutputSchemaFile](Codex.OutputSchemaFile.md): Persists structured output schemas to temporary JSON files so they can be passed to the Codex CLI. Returns the generated path alongside a cleanup function for RAII-style usage. - Approvals - [Codex.ApprovalError](Codex.ApprovalError.md): Error returned when an approval policy denies a tool invocation. - [Codex.Approvals](Codex.Approvals.md): Approval helpers invoked by the auto-run pipeline when actions require consent. - [Codex.Approvals.Hook](Codex.Approvals.Hook.md): Behaviour for implementing pluggable approval hooks. - [Codex.Approvals.Registry](Codex.Approvals.Registry.md): ETS-based registry for tracking async approval requests. - [Codex.Approvals.StaticPolicy](Codex.Approvals.StaticPolicy.md): Simple allow/deny approval policy used for tests and defaults. - Tooling - [Codex.MCP.Client](Codex.MCP.Client.md): MCP JSON-RPC client for stdio and streamable HTTP transports. - [Codex.MCP.Config](Codex.MCP.Config.md): Helpers for managing MCP server configuration through app-server config APIs. - [Codex.MCP.OAuth](Codex.MCP.OAuth.md): Stores and refreshes OAuth credentials for streamable HTTP MCP servers. - [Codex.MCP.Transport.Stdio](Codex.MCP.Transport.Stdio.md): Runs MCP servers over stdio using the core JSON-RPC protocol session stack. - [Codex.MCP.Transport.StreamableHTTP](Codex.MCP.Transport.StreamableHTTP.md): Implements MCP JSON-RPC over HTTP with optional bearer or OAuth auth. - [Codex.Prompts](Codex.Prompts.md): Custom prompt discovery and expansion helpers. - [Codex.Skills](Codex.Skills.md): Helpers for discovering and loading Codex skills. - [Codex.Tool](Codex.Tool.md): Behaviour and helper macros for Codex tool modules. - [Codex.Tools](Codex.Tools.md): Public API for registering and invoking Codex tools. - [Codex.Tools.Registry](Codex.Tools.Registry.md): ETS-backed registry that stores Codex tool definitions, tracks invocation telemetry, and provides lookup/invoke helpers used by the auto-run pipeline. - Errors - [Codex.Error](Codex.Error.md): Base error struct for Codex failures. - [Codex.TransportError](Codex.TransportError.md): Raised when the codex executable exits unexpectedly. - Realtime - [Codex.Realtime](Codex.Realtime.md): Realtime audio streaming with OpenAI's Realtime API. - [Codex.Realtime.Agent](Codex.Realtime.Agent.md): A realtime agent optimized for voice interactions. - [Codex.Realtime.Audio](Codex.Realtime.Audio.md): Audio format utilities for realtime sessions. - [Codex.Realtime.Config](Codex.Realtime.Config.md): Configuration types for realtime sessions. - [Codex.Realtime.Config.GuardrailsSettings](Codex.Realtime.Config.GuardrailsSettings.md): Settings for output guardrails. - [Codex.Realtime.Config.ModelConfig](Codex.Realtime.Config.ModelConfig.md): Options for connecting to a realtime model. - [Codex.Realtime.Config.NoiseReductionConfig](Codex.Realtime.Config.NoiseReductionConfig.md): Configuration for input audio noise reduction. - [Codex.Realtime.Config.RunConfig](Codex.Realtime.Config.RunConfig.md): Configuration for running a realtime agent session. - [Codex.Realtime.Config.SessionModelSettings](Codex.Realtime.Config.SessionModelSettings.md): Model settings for a realtime session. - [Codex.Realtime.Config.TracingConfig](Codex.Realtime.Config.TracingConfig.md): Configuration for request tracing. - [Codex.Realtime.Config.TranscriptionConfig](Codex.Realtime.Config.TranscriptionConfig.md): Configuration for input audio transcription. - [Codex.Realtime.Config.TurnDetectionConfig](Codex.Realtime.Config.TurnDetectionConfig.md): Configuration for voice activity detection and turn-taking. - [Codex.Realtime.Diagnostics](Codex.Realtime.Diagnostics.md): Diagnostics helpers for OpenAI Realtime sessions. - [Codex.Realtime.Events](Codex.Realtime.Events.md): High-level session events for realtime applications. - [Codex.Realtime.Items](Codex.Realtime.Items.md): Conversation item types for realtime sessions. - [Codex.Realtime.Model](Codex.Realtime.Model.md): Behaviour for realtime model implementations. - [Codex.Realtime.ModelEvents](Codex.Realtime.ModelEvents.md): Low-level events from the realtime model transport layer. - [Codex.Realtime.ModelInputs](Codex.Realtime.ModelInputs.md): Input message types for sending events to the realtime model. - [Codex.Realtime.OpenAIWebSocket](Codex.Realtime.OpenAIWebSocket.md): WebSocket client for OpenAI Realtime API. - [Codex.Realtime.PlaybackTracker](Codex.Realtime.PlaybackTracker.md): Tracks audio playback progress for handling interruptions. - [Codex.Realtime.Runner](Codex.Realtime.Runner.md): Orchestrates realtime agent sessions. - [Codex.Realtime.Session](Codex.Realtime.Session.md): Manages a realtime session with WebSocket connection. - Voice - [Codex.Voice](Codex.Voice.md): Voice pipeline for speech-to-speech AI interactions. - [Codex.Voice.AgentWorkflow](Codex.Voice.AgentWorkflow.md): A workflow that wraps a Codex.Agent for voice interactions. - [Codex.Voice.Config](Codex.Voice.Config.md): Configuration for voice pipelines. - [Codex.Voice.Config.STTSettings](Codex.Voice.Config.STTSettings.md): Settings for speech-to-text models. - [Codex.Voice.Config.TTSSettings](Codex.Voice.Config.TTSSettings.md): Settings for text-to-speech models. - [Codex.Voice.Events](Codex.Voice.Events.md): Voice stream event types for the voice pipeline. - [Codex.Voice.Input](Codex.Voice.Input.md): Audio input types for voice pipelines. - [Codex.Voice.Input.AudioInput](Codex.Voice.Input.AudioInput.md): A single, complete audio input buffer. - [Codex.Voice.Input.StreamedAudioInput](Codex.Voice.Input.StreamedAudioInput.md): A streaming audio input that can be appended to. - [Codex.Voice.Model](Codex.Voice.Model.md): Behaviours for speech-to-text and text-to-speech models. - [Codex.Voice.Models.OpenAIProvider](Codex.Voice.Models.OpenAIProvider.md): OpenAI voice model provider. - [Codex.Voice.Models.OpenAISTT](Codex.Voice.Models.OpenAISTT.md): OpenAI speech-to-text model implementation. - [Codex.Voice.Models.OpenAITTS](Codex.Voice.Models.OpenAITTS.md): OpenAI text-to-speech model implementation. - [Codex.Voice.Pipeline](Codex.Voice.Pipeline.md): Orchestrates STT → Workflow → TTS voice pipelines. - [Codex.Voice.Result](Codex.Voice.Result.md): Streamed audio result from a voice pipeline. - [Codex.Voice.SimpleWorkflow](Codex.Voice.SimpleWorkflow.md): A simple workflow that uses a function to process transcriptions. - [Codex.Voice.Workflow](Codex.Voice.Workflow.md): Behaviour for voice workflows. - Exceptions - [Codex.GuardrailError](Codex.GuardrailError.md): Error raised when a guardrail rejects or trips during execution. ## Mix Tasks - Tasks - [mix codex.parity](Mix.Tasks.Codex.Parity.md): Summarises harvested Python fixtures and highlights gaps. - [mix codex.verify](Mix.Tasks.Codex.Verify.md): Runs the recommended verification steps (compile, format, test).