codex

package module

Go to main page

Versions in this module

v0

v0.147.0

Aug 13, 2026

Changes in this version

+ const InputTypeAudio

+ const InputTypeLocalAudio

+ var ErrTurnConsumptionMode = errors.New("turn handle already has a consumer")

+ var ErrTurnFailed = errors.New("turn failed")

+ type ApprovalCallbackHandler interface

+ ApplyPatchApproval func(context.Context, protocol.ApplyPatchApprovalParams) (*protocol.ApplyPatchApprovalResponse, error)

+ ExecCommandApproval func(context.Context, protocol.ExecCommandApprovalParams) (*protocol.ExecCommandApprovalResponse, error)

+ ItemCommandExecutionRequestApproval func(context.Context, protocol.CommandExecutionRequestApprovalParams) (*protocol.CommandExecutionRequestApprovalResponse, error)

+ ItemFileChangeRequestApproval func(context.Context, protocol.FileChangeRequestApprovalParams) (*protocol.FileChangeRequestApprovalResponse, error)

+ ItemPermissionsRequestApproval func(context.Context, protocol.PermissionsRequestApprovalParams) (*protocol.PermissionsRequestApprovalResponse, error)

type AutoApproveHandler

+ func (h AutoApproveHandler) MCPServerElicitationRequest(ctx context.Context, params protocol.MCPServerElicitationRequestParams) (*protocol.MCPServerElicitationRequestResponse, error)

type Input

+ func AudioInput(url string) Input

+ func LocalAudioInput(path string) Input

type Options

+ RequestHandler *ServerRequestCallbacks

type RejectingApprovalHandler

+ func (RejectingApprovalHandler) MCPServerElicitationRequest(context.Context, protocol.MCPServerElicitationRequestParams) (*protocol.MCPServerElicitationRequestResponse, error)

+ type ServerRequestCallbacks struct

+ ApproveCommand func(context.Context, protocol.ExecCommandApprovalParams) (*protocol.ExecCommandApprovalResponse, error)

+ ApproveCommandExecution func(context.Context, protocol.CommandExecutionRequestApprovalParams) (*protocol.CommandExecutionRequestApprovalResponse, error)

+ ApproveFileChange func(context.Context, protocol.FileChangeRequestApprovalParams) (*protocol.FileChangeRequestApprovalResponse, error)

+ ApprovePatch func(context.Context, protocol.ApplyPatchApprovalParams) (*protocol.ApplyPatchApprovalResponse, error)

+ ApprovePermissions func(context.Context, protocol.PermissionsRequestApprovalParams) (*protocol.PermissionsRequestApprovalResponse, error)

+ CallTool func(context.Context, protocol.DynamicToolCallParams) (*protocol.DynamicToolCallResponse, error)

+ GenerateAttestation func(context.Context, protocol.AttestationGenerateParams) (*protocol.AttestationGenerateResponse, error)

+ RefreshAuthTokens func(context.Context, protocol.ChatgptAuthTokensRefreshParams) (*protocol.ChatgptAuthTokensRefreshResponse, error)

+ RequestMCPServerElicitation func(context.Context, protocol.MCPServerElicitationRequestParams) (*protocol.MCPServerElicitationRequestResponse, error)

+ RequestUserInput func(context.Context, protocol.ToolRequestUserInputParams) (*protocol.ToolRequestUserInputResponse, error)

+ func AutoApproveCallbacks(handler ApprovalCallbackHandler) *ServerRequestCallbacks

+ func RejectingApprovalCallbacks() *ServerRequestCallbacks

+ func (h ServerRequestCallbacks) AccountChatgptAuthTokensRefresh(ctx context.Context, params protocol.ChatgptAuthTokensRefreshParams) (*protocol.ChatgptAuthTokensRefreshResponse, error)

+ func (h ServerRequestCallbacks) ApplyPatchApproval(ctx context.Context, params protocol.ApplyPatchApprovalParams) (*protocol.ApplyPatchApprovalResponse, error)

+ func (h ServerRequestCallbacks) AttestationGenerate(ctx context.Context, params protocol.AttestationGenerateParams) (*protocol.AttestationGenerateResponse, error)

+ func (h ServerRequestCallbacks) ExecCommandApproval(ctx context.Context, params protocol.ExecCommandApprovalParams) (*protocol.ExecCommandApprovalResponse, error)

+ func (h ServerRequestCallbacks) ItemCommandExecutionRequestApproval(ctx context.Context, params protocol.CommandExecutionRequestApprovalParams) (*protocol.CommandExecutionRequestApprovalResponse, error)

+ func (h ServerRequestCallbacks) ItemFileChangeRequestApproval(ctx context.Context, params protocol.FileChangeRequestApprovalParams) (*protocol.FileChangeRequestApprovalResponse, error)

+ func (h ServerRequestCallbacks) ItemPermissionsRequestApproval(ctx context.Context, params protocol.PermissionsRequestApprovalParams) (*protocol.PermissionsRequestApprovalResponse, error)

+ func (h ServerRequestCallbacks) ItemToolCall(ctx context.Context, params protocol.DynamicToolCallParams) (*protocol.DynamicToolCallResponse, error)

+ func (h ServerRequestCallbacks) ItemToolRequestUserInput(ctx context.Context, params protocol.ToolRequestUserInputParams) (*protocol.ToolRequestUserInputResponse, error)

+ func (h ServerRequestCallbacks) MCPServerElicitationRequest(ctx context.Context, params protocol.MCPServerElicitationRequestParams) (*protocol.MCPServerElicitationRequestResponse, error)

+ func (h ServerRequestCallbacks) McpServerElicitationRequest(ctx context.Context, params protocol.MCPServerElicitationRequestParams) (*protocol.MCPServerElicitationRequestResponse, error)

type ThreadListOptions

+ IsPinned *bool

+ SectionID string

+ Unsectioned bool

+ type TurnError struct

+ Detail *protocol.TurnError

+ Method string

+ Raw json.RawMessage

+ Result *TurnResult

+ WillRetry bool

+ func (e *TurnError) Error() string

+ func (e *TurnError) Is(target error) bool

v0.145.0

Jul 21, 2026

Changes in this version

+ type CodexCompatibilityError struct

+ Cause error

+ GeneratedCommit string

+ GeneratedVersion string

+ Hint string

+ Path string

+ Reason string

+ RuntimeVersion string

+ func (e *CodexCompatibilityError) Error() string

+ func (e *CodexCompatibilityError) Unwrap() error

+ type CompatibilityPolicy uint8

+ const Ignore

+ const RequireMajorMinor

+ const Warn

type Options

+ CompatibilityPolicy CompatibilityPolicy

+ type RejectingApprovalHandler struct

+ func (RejectingApprovalHandler) AccountChatgptAuthTokensRefresh(context.Context, protocol.ChatgptAuthTokensRefreshParams) (*protocol.ChatgptAuthTokensRefreshResponse, error)

+ func (RejectingApprovalHandler) ApplyPatchApproval(context.Context, protocol.ApplyPatchApprovalParams) (*protocol.ApplyPatchApprovalResponse, error)

+ func (RejectingApprovalHandler) AttestationGenerate(context.Context, protocol.AttestationGenerateParams) (*protocol.AttestationGenerateResponse, error)

+ func (RejectingApprovalHandler) ExecCommandApproval(context.Context, protocol.ExecCommandApprovalParams) (*protocol.ExecCommandApprovalResponse, error)

+ func (RejectingApprovalHandler) ItemCommandExecutionRequestApproval(context.Context, protocol.CommandExecutionRequestApprovalParams) (*protocol.CommandExecutionRequestApprovalResponse, error)

+ func (RejectingApprovalHandler) ItemFileChangeRequestApproval(context.Context, protocol.FileChangeRequestApprovalParams) (*protocol.FileChangeRequestApprovalResponse, error)

+ func (RejectingApprovalHandler) ItemPermissionsRequestApproval(context.Context, protocol.PermissionsRequestApprovalParams) (*protocol.PermissionsRequestApprovalResponse, error)

+ func (RejectingApprovalHandler) ItemToolCall(context.Context, protocol.DynamicToolCallParams) (*protocol.DynamicToolCallResponse, error)

+ func (RejectingApprovalHandler) ItemToolRequestUserInput(context.Context, protocol.ToolRequestUserInputParams) (*protocol.ToolRequestUserInputResponse, error)

+ func (RejectingApprovalHandler) McpServerElicitationRequest(context.Context, protocol.McpServerElicitationRequestParams) (*protocol.McpServerElicitationRequestResponse, error)

type TurnHandle

+ func (h *TurnHandle) ID() string

+ type UnsafeLoggingAutoApproveHandler struct

+ func NewUnsafeLoggingAutoApproveHandler(logger *slog.Logger) UnsafeLoggingAutoApproveHandler

+ func (h UnsafeLoggingAutoApproveHandler) ApplyPatchApproval(ctx context.Context, params protocol.ApplyPatchApprovalParams) (*protocol.ApplyPatchApprovalResponse, error)

+ func (h UnsafeLoggingAutoApproveHandler) ExecCommandApproval(ctx context.Context, params protocol.ExecCommandApprovalParams) (*protocol.ExecCommandApprovalResponse, error)

+ func (h UnsafeLoggingAutoApproveHandler) ItemCommandExecutionRequestApproval(ctx context.Context, params protocol.CommandExecutionRequestApprovalParams) (*protocol.CommandExecutionRequestApprovalResponse, error)

+ func (h UnsafeLoggingAutoApproveHandler) ItemFileChangeRequestApproval(ctx context.Context, params protocol.FileChangeRequestApprovalParams) (*protocol.FileChangeRequestApprovalResponse, error)

+ func (h UnsafeLoggingAutoApproveHandler) ItemPermissionsRequestApproval(ctx context.Context, params protocol.PermissionsRequestApprovalParams) (*protocol.PermissionsRequestApprovalResponse, error)

v0.144.6

Jul 20, 2026

v0.144.5

Jul 16, 2026

v0.144.4

Jul 14, 2026

v0.144.1

Jul 10, 2026

v0.144.0

Jul 9, 2026

Changes in this version

type ThreadForkOptions

+ LastTurnID string

+ ServiceTier string

type ThreadResumeOptions

+ ServiceTier string

type ThreadStartOptions

+ Ephemeral *bool

+ ModelProvider string

+ ServiceName string

+ ServiceTier string

type TurnOptions

+ ClientUserMessageID string

+ ServiceTier string

v0.143.0

Jul 8, 2026

Changes in this version

+ const InputTypeImage

+ const InputTypeLocalImage

+ const InputTypeSkill

+ const InputTypeText

+ var ErrOverloaded = errors.New("codex overloaded")

+ func IsOverloaded(err error) bool

+ func IsRetryable(err error) bool

+ type AccountOptions struct

+ RefreshToken bool

+ type ApprovalPolicy = string

+ const ApprovalPolicyNever

+ const ApprovalPolicyOnFailure

+ const ApprovalPolicyOnRequest

+ const ApprovalPolicyUntrusted

+ type AutoApproveHandler struct

+ Logger *slog.Logger

+ func (h AutoApproveHandler) AccountChatgptAuthTokensRefresh(ctx context.Context, params protocol.ChatgptAuthTokensRefreshParams) (*protocol.ChatgptAuthTokensRefreshResponse, error)

+ func (h AutoApproveHandler) ApplyPatchApproval(ctx context.Context, params protocol.ApplyPatchApprovalParams) (*protocol.ApplyPatchApprovalResponse, error)

+ func (h AutoApproveHandler) AttestationGenerate(ctx context.Context, params protocol.AttestationGenerateParams) (*protocol.AttestationGenerateResponse, error)

+ func (h AutoApproveHandler) ExecCommandApproval(ctx context.Context, params protocol.ExecCommandApprovalParams) (*protocol.ExecCommandApprovalResponse, error)

+ func (h AutoApproveHandler) ItemCommandExecutionRequestApproval(ctx context.Context, params protocol.CommandExecutionRequestApprovalParams) (*protocol.CommandExecutionRequestApprovalResponse, error)

+ func (h AutoApproveHandler) ItemFileChangeRequestApproval(ctx context.Context, params protocol.FileChangeRequestApprovalParams) (*protocol.FileChangeRequestApprovalResponse, error)

+ func (h AutoApproveHandler) ItemPermissionsRequestApproval(ctx context.Context, params protocol.PermissionsRequestApprovalParams) (*protocol.PermissionsRequestApprovalResponse, error)

+ func (h AutoApproveHandler) ItemToolCall(ctx context.Context, params protocol.DynamicToolCallParams) (*protocol.DynamicToolCallResponse, error)

+ func (h AutoApproveHandler) ItemToolRequestUserInput(ctx context.Context, params protocol.ToolRequestUserInputParams) (*protocol.ToolRequestUserInputResponse, error)

+ func (h AutoApproveHandler) McpServerElicitationRequest(ctx context.Context, params protocol.McpServerElicitationRequestParams) (*protocol.McpServerElicitationRequestResponse, error)

+ type Codex struct

+ func New(ctx context.Context, opts Options) (*Codex, error)

+ func (c *Codex) Account(ctx context.Context, opts AccountOptions) (*protocol.GetAccountResponse, error)

+ func (c *Codex) ArchiveThread(ctx context.Context, threadID string) (*protocol.ThreadArchiveResponse, error)

+ func (c *Codex) CancelLogin(ctx context.Context, loginID string) (*protocol.CancelLoginAccountResponse, error)

+ func (c *Codex) Client() *rpc.Client

+ func (c *Codex) Close() error

+ func (c *Codex) CompactThread(ctx context.Context, threadID string, opts ThreadCompactOptions) (*protocol.ThreadCompactStartResponse, error)

+ func (c *Codex) ForkThread(ctx context.Context, threadID string, opts ThreadForkOptions) (*Thread, protocol.ThreadForkResponse, error)

+ func (c *Codex) ListModels(ctx context.Context, opts ListModelsOptions) (*protocol.ModelListResponse, error)

+ func (c *Codex) ListThreads(ctx context.Context, opts ThreadListOptions) (*protocol.ThreadListResponse, error)

+ func (c *Codex) Logout(ctx context.Context) (*protocol.LogoutAccountResponse, error)

+ func (c *Codex) ReadThread(ctx context.Context, threadID string, opts ThreadReadOptions) (*protocol.ThreadReadResponse, error)

+ func (c *Codex) ResumeThread(ctx context.Context, options ThreadResumeOptions) (*Thread, error)

+ func (c *Codex) SetThreadName(ctx context.Context, threadID, name string) (*protocol.ThreadSetNameResponse, error)

+ func (c *Codex) StartLogin(ctx context.Context, params protocol.LoginAccountParams) (*protocol.LoginAccountResponse, error)

+ func (c *Codex) StartThread(ctx context.Context, options ThreadStartOptions) (*Thread, error)

+ func (c *Codex) UnarchiveThread(ctx context.Context, threadID string) (*protocol.ThreadUnarchiveResponse, error)

+ type Input struct

+ Name string

+ Path string

+ Text string

+ TextElements []protocol.TextElement

+ Type string

+ URL string

+ func ImageInput(url string) Input

+ func LocalImageInput(path string) Input

+ func MentionInput(name string) Input

+ func SkillInput(name, path string) Input

+ func TextInput(text string) Input

+ type ListModelsOptions struct

+ Cursor string

+ IncludeHidden *bool

+ Limit *int

+ type Options struct

+ ApprovalHandler rpc.ServerRequestHandler

+ ClientInfo protocol.ClientInfo

+ Logger *slog.Logger

+ Spawn SpawnOptions

+ Transport rpc.Transport

+ type RawJSON = json.RawMessage

+ func JSON(value any) (RawJSON, error)

+ func MustJSON(value any) RawJSON

+ type ReasoningEffort = protocol.ReasoningEffort

+ const ReasoningEffortHigh

+ const ReasoningEffortLow

+ const ReasoningEffortMedium

+ const ReasoningEffortMinimal

+ const ReasoningEffortNone

+ const ReasoningEffortXHigh

+ type SandboxMode = protocol.SandboxMode

+ const SandboxModeDangerFullAccess

+ const SandboxModeReadOnly

+ const SandboxModeWorkspaceWrite

+ type SpawnOptions struct

+ CodexPath string

+ ConfigOverrides []string

+ ExtraArgs []string

+ Stderr io.Writer

+ type Thread struct

+ func (t *Thread) Archive(ctx context.Context) (*protocol.ThreadArchiveResponse, error)

+ func (t *Thread) Compact(ctx context.Context, opts ThreadCompactOptions) (*protocol.ThreadCompactStartResponse, error)

+ func (t *Thread) Fork(ctx context.Context, opts ThreadForkOptions) (*Thread, protocol.ThreadForkResponse, error)

+ func (t *Thread) ID() string

+ func (t *Thread) Read(ctx context.Context, opts ThreadReadOptions) (*protocol.ThreadReadResponse, error)

+ func (t *Thread) Run(ctx context.Context, prompt string, opts *TurnOptions) (*TurnResult, error)

+ func (t *Thread) RunInputs(ctx context.Context, inputs []Input, opts *TurnOptions) (*TurnResult, error)

+ func (t *Thread) RunStreamed(ctx context.Context, inputs []Input, opts *TurnOptions) (*TurnStream, error)

+ func (t *Thread) SetName(ctx context.Context, name string) (*protocol.ThreadSetNameResponse, error)

+ func (t *Thread) StartTurn(ctx context.Context, inputs []Input, opts *TurnOptions) (*TurnHandle, error)

+ func (t *Thread) Unarchive(ctx context.Context) (*protocol.ThreadUnarchiveResponse, error)

+ type ThreadCompactOptions struct

+ type ThreadForkOptions struct

+ ApprovalPolicy any

+ BaseInstructions string

+ Config map[string]any

+ Cwd string

+ DeveloperInstructions string

+ Ephemeral *bool

+ ExcludeTurns *bool

+ Model string

+ ModelProvider string

+ Sandbox any

+ type ThreadListOptions struct

+ Archived *bool

+ Cursor string

+ Cwd any

+ Limit *int

+ ModelProviders []string

+ SearchTerm string

+ SortDirection any

+ SortKey any

+ SourceKinds []protocol.ThreadSourceKind

+ UseStateDBOnly *bool

+ type ThreadReadOptions struct

+ IncludeTurns bool

+ type ThreadResumeHistoryElem = json.RawMessage

+ type ThreadResumeOptions struct

+ ApprovalPolicy any

+ BaseInstructions string

+ Config map[string]any

+ Cwd string

+ DeveloperInstructions string

+ History []ThreadResumeHistoryElem

+ Model string

+ ModelProvider string

+ Path string

+ Sandbox any

+ ThreadID string

+ type ThreadStartOptions struct

+ ApprovalPolicy any

+ BaseInstructions string

+ Config map[string]any

+ Cwd string

+ DeveloperInstructions string

+ ExperimentalRawEvents bool

+ Model string

+ SandboxPolicy any

+ type TurnHandle struct

+ func (h *TurnHandle) Close()

+ func (h *TurnHandle) Interrupt(ctx context.Context) (*protocol.TurnInterruptResponse, error)

+ func (h *TurnHandle) Next(ctx context.Context) (rpc.Notification, error)

+ func (h *TurnHandle) Run(ctx context.Context) (*TurnResult, error)

+ func (h *TurnHandle) Steer(ctx context.Context, inputs []Input) (*protocol.TurnSteerResponse, error)

+ func (h *TurnHandle) Stream() (*TurnStream, error)

+ type TurnOptions struct

+ ApprovalPolicy any

+ CollaborationMode any

+ Cwd string

+ Effort any

+ Model string

+ OutputSchema any

+ SandboxPolicy any

+ Summary any

+ type TurnResult struct

+ CompletedAt *time.Time

+ CreatedAt *time.Time

+ ErrorMessage string

+ FinalResponse string

+ Items []json.RawMessage

+ Notifications []rpc.Notification

+ Status string

+ TokenUsage *protocol.ThreadTokenUsage

+ TurnID string

+ type TurnStream struct

+ func (s *TurnStream) Close()

+ func (s *TurnStream) Next(ctx context.Context) (rpc.Notification, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL