codex

type AgentMessageItem struct {
	ID   string   `json:"id"`
	Type ItemType `json:"type"`
	Text string   `json:"text"`
}

type ApprovalMode string

type Args struct {
	Input string

	BaseURL           string
	APIKey            string
	ThreadID          string
	Images            []string
	Model             string
	SandboxMode       SandboxMode
	WorkingDirectory  string
	SkipGitRepoCheck  bool
	OutputSchemaFile  string
	OutputLastMessage string
	Enable            []string
	ConfigFile        string
	FullAuto          bool
	IncludePlanTool   bool
}

type CommandExecutionItem struct {
	ID               string                 `json:"id"`
	Type             ItemType               `json:"type"`
	Command          string                 `json:"command"`
	AggregatedOutput string                 `json:"aggregated_output"`
	ExitCode         *int                   `json:"exit_code,omitempty"`
	Status           CommandExecutionStatus `json:"status"`
}

type CommandExecutionStatus string

type ErrorItem struct {
	ID      string   `json:"id"`
	Type    ItemType `json:"type"`
	Message string   `json:"message"`
}

type EventType string

type Exec struct {
	// contains filtered or unexported fields
}

type ExecStream struct {
	// contains filtered or unexported fields
}

type FileChangeItem struct {
	ID      string             `json:"id"`
	Type    ItemType           `json:"type"`
	Changes []FileUpdateChange `json:"changes"`
	Status  PatchApplyStatus   `json:"status"`
}

type FileUpdateChange struct {
	Path string          `json:"path"`
	Kind PatchChangeKind `json:"kind"`
}

type Input struct {
	// Prompt is the base textual prompt sent to the CLI.
	Prompt string
	// Parts augments the prompt with additional inputs such as local images.
	Parts []UserInput
}

type InputType string

type ItemType string

type McpToolCallItem struct {
	ID     string            `json:"id"`
	Type   ItemType          `json:"type"`
	Server string            `json:"server"`
	Tool   string            `json:"tool"`
	Status McpToolCallStatus `json:"status"`
}

type McpToolCallStatus string

type Options struct {
	// CodexPathOverride points to a specific codex binary. When empty the SDK searches
	// for the bundled binary that ships with this module.
	CodexPathOverride string
	// BaseURL overrides the default API base URL used by the codex CLI. When empty,
	// the CLI's default value is used.
	BaseURL string
	// APIKey overrides the API key used by the codex CLI. When empty, the CLI falls
	// back to the CODEX_API_KEY environment variable.
	APIKey string
}

type PatchApplyStatus string

type PatchChangeKind string

type ReasoningItem struct {
	ID   string   `json:"id"`
	Type ItemType `json:"type"`
	Text string   `json:"text"`
}

type RunResult = Turn

type RunStreamedResult = StreamedTurn

type SandboxMode string

type StreamedTurn struct {
	// Events yields parsed events in the order emitted by the CLI.
	Events <-chan ThreadEvent
	// contains filtered or unexported fields
}

type Thread struct {
	// contains filtered or unexported fields
}

type ThreadError struct {
	Message string `json:"message"`
}

type ThreadEvent struct {
	// Type identifies the event kind.
	Type EventType `json:"type"`
	// ThreadID is populated on thread.started events with the server-issued identifier.
	ThreadID string `json:"thread_id,omitempty"`
	// Usage is populated on turn.completed events with token usage.
	Usage *Usage `json:"usage,omitempty"`
	// Error is populated on turn.failed events with the failure message.
	Error *ThreadError `json:"error,omitempty"`
	// Item contains the thread item payload for item.* events. It is nil for other event types.
	Item ThreadItem `json:"item,omitempty"`
	// Message is populated on top-level error events.
	Message string `json:"message,omitempty"`
}

type ThreadItem interface {
	ItemType() ItemType
}

type ThreadOptions struct {
	// Model selects the model identifier to run the agent with.
	Model string
	// SandboxMode controls the filesystem sandbox granted to the agent.
	SandboxMode SandboxMode
	// WorkingDirectory sets the directory provided to --cd when launching the CLI.
	WorkingDirectory string
	// SkipGitRepoCheck mirrors --skip-git-repo-check on the CLI.
	SkipGitRepoCheck bool
}

type TodoItem struct {
	Text      string `json:"text"`
	Completed bool   `json:"completed"`
}

type TodoListItem struct {
	ID    string     `json:"id"`
	Type  ItemType   `json:"type"`
	Items []TodoItem `json:"items"`
}

type Turn struct {
	// Items are the completed thread items emitted during the turn.
	Items []ThreadItem
	// FinalResponse is the assistant's last agent_message, when present.
	FinalResponse string
	// Usage reports token consumption for the turn. A nil value indicates the CLI
	// did not emit usage information.
	Usage *Usage
}

type TurnOptions struct {
	// OutputSchema describes the expected JSON structure when requesting structured output.
	// The value must marshal to a JSON object; validation occurs before each run.
	OutputSchema any
}

type UnknownThreadItem struct {
	// Type holds the raw item type returned by the CLI.
	Type ItemType `json:"type"`
	// Raw retains the original JSON payload for callers that want to decode the item manually.
	Raw json.RawMessage `json:"-"`
}

type Usage struct {
	InputTokens       int `json:"input_tokens"`
	CachedInputTokens int `json:"cached_input_tokens"`
	OutputTokens      int `json:"output_tokens"`
}

type UserInput struct {
	// Type differentiates the payload stored in the other fields.
	Type InputType `json:"type"`
	// Text contains the textual prompt for InputTypeText entries.
	Text string `json:"text,omitempty"`
	// Path contains the local filesystem path for InputTypeLocalImage entries.
	Path string `json:"path,omitempty"`
}

type WebSearchItem struct {
	ID    string   `json:"id"`
	Type  ItemType `json:"type"`
	Query string   `json:"query"`
}