codexsdk

package module

Go to main page

Versions in this module

v0

v0.0.6

Mar 13, 2026

Changes in this version

+ const BlockTypeImage

+ const BlockTypeLocalImage

+ const BlockTypeMention

+ const BlockTypeText

+ const BlockTypeThinking

+ const BlockTypeToolResult

+ const BlockTypeToolUse

type Client

+ StartWithContent func(ctx context.Context, content UserMessageContent, opts ...Option) error

+ type InputImageBlock = message.InputImageBlock

+ func ImageFileInput(path string) (*InputImageBlock, error)

+ func ImageInput(url string) *InputImageBlock

+ type InputLocalImageBlock = message.InputLocalImageBlock

+ func LocalImageInput(path string) *InputLocalImageBlock

+ type InputMentionBlock = message.InputMentionBlock

+ func PathInput(path string) *InputMentionBlock

type TextBlock

+ func TextInput(text string) *TextBlock

+ type UnknownBlock = message.UnknownBlock

type UserMessageContent

+ func Blocks(blocks ...ContentBlock) UserMessageContent

+ func Text(text string) UserMessageContent

v0.0.5

Mar 7, 2026

v0.0.4

Mar 7, 2026

v0.0.3

Mar 7, 2026

v0.0.2

Mar 7, 2026

Changes in this version

+ const MCPAuthStatusBearerToken

+ const MCPAuthStatusNotLoggedIn

+ const MCPAuthStatusOAuth

+ const MCPAuthStatusUnsupported

type Client

+ ListModelsResponse func(ctx context.Context) (*ModelListResponse, error)

+ type MCPAuthStatus = mcp.AuthStatus

+ type MCPResource = mcp.Resource

+ type MCPResourceTemplate = mcp.ResourceTemplate

+ type MCPTool = mcp.Tool

type Message

+ func GetSessionMessages(ctx context.Context, sessionID string, opts ...Option) ([]Message, error)

type ModelListResponse

+ func ListModelsResponse(ctx context.Context, opts ...Option) (*ModelListResponse, error)

type SessionStat

+ func ListSessions(ctx context.Context, opts ...Option) ([]SessionStat, error)

+ type TaskCompleteMessage = message.TaskCompleteMessage

+ type TaskStartedMessage = message.TaskStartedMessage

+ type ThreadRolledBackMessage = message.ThreadRolledBackMessage

v0.0.1

Mar 5, 2026

Changes in this version

+ const AssistantMessageErrorAuthFailed

+ const AssistantMessageErrorBilling

+ const AssistantMessageErrorInvalidReq

+ const AssistantMessageErrorRateLimit

+ const AssistantMessageErrorServer

+ const AssistantMessageErrorUnknown

+ const EffortHigh

+ const EffortLow

+ const EffortMax

+ const EffortMedium

+ const HookEventNotification

+ const HookEventPermissionRequest

+ const HookEventPostToolUse

+ const HookEventPostToolUseFailure

+ const HookEventPreCompact

+ const HookEventPreToolUse

+ const HookEventStop

+ const HookEventSubagentStart

+ const HookEventSubagentStop

+ const HookEventUserPromptSubmit

+ const MCPServerTypeHTTP

+ const MCPServerTypeSDK

+ const MCPServerTypeSSE

+ const MCPServerTypeStdio

+ const MinimumCLIVersion

+ const PermissionBehaviorAllow

+ const PermissionBehaviorAsk

+ const PermissionBehaviorDeny

+ const PermissionModeAcceptEdits

+ const PermissionModeBypassPermissions

+ const PermissionModeDefault

+ const PermissionModePlan

+ const PermissionUpdateDestLocalSettings

+ const PermissionUpdateDestProjectSettings

+ const PermissionUpdateDestSession

+ const PermissionUpdateDestUserSettings

+ const PermissionUpdateTypeAddDirectories

+ const PermissionUpdateTypeAddRules

+ const PermissionUpdateTypeRemoveDirectories

+ const PermissionUpdateTypeRemoveRules

+ const PermissionUpdateTypeReplaceRules

+ const PermissionUpdateTypeSetMode

+ const SdkBetaContext1M

+ const SettingSourceLocal

+ const SettingSourceProject

+ const SettingSourceUser

+ const Version

+ var ErrClientAlreadyConnected = errors.ErrClientAlreadyConnected

+ var ErrClientClosed = errors.ErrClientClosed

+ var ErrClientNotConnected = errors.ErrClientNotConnected

+ var ErrRequestTimeout = errors.ErrRequestTimeout

+ var ErrSessionNotFound = errors.ErrSessionNotFound

+ var ErrTransportNotConnected = errors.ErrTransportNotConnected

+ var ErrUnsupportedControlRequest = errors.ErrUnsupportedControlRequest

+ var ErrUnsupportedOption = errors.ErrUnsupportedOption

+ var NewUserMessageContent = message.NewUserMessageContent

+ var NewUserMessageContentBlocks = message.NewUserMessageContentBlocks

+ var WithAgentLogger = WithLogger

+ func ErrorResult(message string) *mcp.CallToolResult

+ func ImageResult(data []byte, mimeType string) *mcp.CallToolResult

+ func MessagesFromChannel(ch <-chan StreamingMessage) iter.Seq[StreamingMessage]

+ func MessagesFromSlice(msgs []StreamingMessage) iter.Seq[StreamingMessage]

+ func NewMcpTool(name, description string, inputSchema *jsonschema.Schema) *mcp.Tool

+ func NopLogger() *slog.Logger

+ func ParseArguments(req *mcp.CallToolRequest) (map[string]any, error)

+ func Query(ctx context.Context, prompt string, opts ...Option) iter.Seq2[Message, error]

+ func QueryStream(ctx context.Context, messages iter.Seq[StreamingMessage], opts ...Option) iter.Seq2[Message, error]

+ func SimpleSchema(props map[string]string) *jsonschema.Schema

+ func SingleMessage(content string) iter.Seq[StreamingMessage]

+ func TextResult(text string) *mcp.CallToolResult

+ func WithClient(ctx context.Context, fn func(Client) error, opts ...Option) error

+ type AgentDefinition = config.AgentDefinition

+ type AssistantMessage = message.AssistantMessage

+ type AssistantMessageError = message.AssistantMessageError

+ type AsyncHookJSONOutput = hook.AsyncJSONOutput

+ type BaseHookInput = hook.BaseInput

+ type CLIConnectionError = errors.CLIConnectionError

+ type CLIJSONDecodeError = errors.CLIJSONDecodeError

+ type CLINotFoundError = errors.CLINotFoundError

+ type CallToolRequest = mcp.CallToolRequest

+ type CallToolResult = mcp.CallToolResult

+ type Client interface

+ Close func() error

+ GetMCPStatus func(ctx context.Context) (*MCPStatus, error)

+ GetServerInfo func() map[string]any

+ Interrupt func(ctx context.Context) error

+ ListModels func(ctx context.Context) ([]ModelInfo, error)

+ Query func(ctx context.Context, prompt string, sessionID ...string) error

+ ReceiveMessages func(ctx context.Context) iter.Seq2[Message, error]

+ ReceiveResponse func(ctx context.Context) iter.Seq2[Message, error]

+ RewindFiles func(ctx context.Context, userMessageID string) error

+ SetModel func(ctx context.Context, model *string) error

+ SetPermissionMode func(ctx context.Context, mode string) error

+ Start func(ctx context.Context, opts ...Option) error

+ StartWithPrompt func(ctx context.Context, prompt string, opts ...Option) error

+ StartWithStream func(ctx context.Context, messages iter.Seq[StreamingMessage], opts ...Option) error

+ func NewClient() Client

+ type CodexAgentOptions = config.Options

+ type CodexSDKError = errors.CodexSDKError

+ type ContentBlock = message.ContentBlock

+ type Effort = config.Effort

+ type HookCallback = hook.Callback

+ type HookContext = hook.Context

+ type HookEvent = hook.Event

+ type HookInput = hook.Input

+ type HookJSONOutput = hook.JSONOutput

+ type HookMatcher = hook.Matcher

+ type HookSpecificOutput = hook.SpecificOutput

+ type MCPHTTPServerConfig = mcp.HTTPServerConfig

+ type MCPSSEServerConfig = mcp.SSEServerConfig

+ type MCPSdkServerConfig = mcp.SdkServerConfig

+ func CreateSdkMcpServer(name, version string, tools ...*SdkMcpTool) *MCPSdkServerConfig

+ type MCPServerConfig = mcp.ServerConfig

+ type MCPServerStatus = mcp.ServerStatus

+ type MCPServerType = mcp.ServerType

+ type MCPStatus = mcp.Status

+ type MCPStdioServerConfig = mcp.StdioServerConfig

+ type McpAudioContent = mcp.AudioContent

+ type McpContent = mcp.Content

+ type McpImageContent = mcp.ImageContent

+ type McpTextContent = mcp.TextContent

+ type McpTool = mcp.Tool

+ type McpToolAnnotations = mcp.ToolAnnotations

+ type McpToolHandler = mcp.ToolHandler

+ type Message = message.Message

+ type MessageParseError = errors.MessageParseError

+ type MessageStream = iter.Seq[StreamingMessage]

+ type ModelInfo = model.Info

+ func ListModels(ctx context.Context, opts ...Option) ([]ModelInfo, error)

+ type ModelListResponse = model.ListResponse

+ type NotificationHookInput = hook.NotificationInput

+ type NotificationHookSpecificOutput = hook.NotificationSpecificOutput

+ type Option func(*CodexAgentOptions)

+ func WithAddDirs(dirs ...string) Option

+ func WithAllowedTools(tools ...string) Option

+ func WithCanUseTool(callback ToolPermissionCallback) Option

+ func WithCliPath(path string) Option

+ func WithCodexHome(path string) Option

+ func WithConfig(cfg map[string]string) Option

+ func WithContinueConversation(cont bool) Option

+ func WithCwd(cwd string) Option

+ func WithDisallowedTools(tools ...string) Option

+ func WithEffort(effort config.Effort) Option

+ func WithEnv(env map[string]string) Option

+ func WithExtraArgs(args map[string]*string) Option

+ func WithForkSession(fork bool) Option

+ func WithHooks(hooks map[HookEvent][]*HookMatcher) Option

+ func WithImages(images ...string) Option

+ func WithIncludePartialMessages(include bool) Option

+ func WithInitializeTimeout(timeout time.Duration) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithMCPServers(servers map[string]MCPServerConfig) Option

+ func WithModel(model string) Option

+ func WithOnUserInput(callback UserInputCallback) Option

+ func WithOutputFormat(format map[string]any) Option

+ func WithOutputSchema(schema string) Option

+ func WithPermissionMode(mode string) Option

+ func WithPermissionPromptToolName(name string) Option

+ func WithResume(sessionID string) Option

+ func WithSDKTools(tools ...Tool) Option

+ func WithSandbox(sandbox string) Option

+ func WithSkipVersionCheck(skip bool) Option

+ func WithStderr(handler func(string)) Option

+ func WithSystemPrompt(prompt string) Option

+ func WithSystemPromptPreset(preset *SystemPromptPreset) Option

+ func WithTools(tools config.ToolsConfig) Option

+ func WithTransport(transport config.Transport) Option

+ type PermissionBehavior = permission.Behavior

+ type PermissionMode = permission.Mode

+ type PermissionRequestHookInput = hook.PermissionRequestInput

+ type PermissionRequestHookSpecificOutput = hook.PermissionRequestSpecificOutput

+ type PermissionResult = permission.Result

+ type PermissionResultAllow = permission.ResultAllow

+ type PermissionResultDeny = permission.ResultDeny

+ type PermissionRuleValue = permission.RuleValue

+ type PermissionUpdate = permission.Update

+ type PermissionUpdateDestination = permission.UpdateDestination

+ type PermissionUpdateType = permission.UpdateType

+ type PostToolUseFailureHookInput = hook.PostToolUseFailureInput

+ type PostToolUseFailureHookSpecificOutput = hook.PostToolUseFailureSpecificOutput

+ type PostToolUseHookInput = hook.PostToolUseInput

+ type PostToolUseHookSpecificOutput = hook.PostToolUseSpecificOutput

+ type PreCompactHookInput = hook.PreCompactInput

+ type PreToolUseHookInput = hook.PreToolUseInput

+ type PreToolUseHookSpecificOutput = hook.PreToolUseSpecificOutput

+ type ProcessError = errors.ProcessError

+ type ReasoningEffortOption = model.ReasoningEffortOption

+ type ResultMessage = message.ResultMessage

+ type SandboxIgnoreViolations = sandbox.IgnoreViolations

+ type SandboxNetworkConfig = sandbox.NetworkConfig

+ type SandboxSettings = sandbox.Settings

+ type Schema = jsonschema.Schema

+ type SdkBeta = config.Beta

+ type SdkMcpServerInstance = mcp.ServerInstance

+ type SdkMcpTool struct

+ ToolAnnotations *mcp.ToolAnnotations

+ ToolDescription string

+ ToolHandler SdkMcpToolHandler

+ ToolName string

+ ToolSchema *jsonschema.Schema

+ func NewSdkMcpTool(name, description string, inputSchema *jsonschema.Schema, ...) *SdkMcpTool

+ func (t *SdkMcpTool) Annotations() *mcp.ToolAnnotations

+ func (t *SdkMcpTool) Description() string

+ func (t *SdkMcpTool) Handler() SdkMcpToolHandler

+ func (t *SdkMcpTool) InputSchema() *jsonschema.Schema

+ func (t *SdkMcpTool) Name() string

+ type SdkMcpToolHandler = mcp.ToolHandler

+ type SdkMcpToolOption func(*SdkMcpTool)

+ func WithAnnotations(annotations *mcp.ToolAnnotations) SdkMcpToolOption

+ type SdkPluginConfig = config.PluginConfig

+ type SessionStat struct

+ AgentNickname *string

+ AgentRole *string

+ ApprovalMode string

+ Archived bool

+ ArchivedAt *time.Time

+ CLIVersion string

+ CreatedAt time.Time

+ Cwd string

+ FirstUserMessage string

+ GitBranch *string

+ GitOriginURL *string

+ GitSHA *string

+ LastModified time.Time

+ MemoryMode string

+ ModelProvider string

+ RolloutPath string

+ SandboxPolicy string

+ SessionID string

+ SizeBytes int64

+ Source string

+ Title string

+ TokensUsed int64

+ UpdatedAt time.Time

+ func StatSession(ctx context.Context, sessionID string, opts ...Option) (*SessionStat, error)

+ type SettingSource = config.SettingSource

+ type StopHookInput = hook.StopInput

+ type StreamEvent = message.StreamEvent

+ type StreamingMessage = message.StreamingMessage

+ func NewUserMessage(content string) StreamingMessage

+ type StreamingMessageContent = message.StreamingMessageContent

+ type SubagentStartHookInput = hook.SubagentStartInput

+ type SubagentStartHookSpecificOutput = hook.SubagentStartSpecificOutput

+ type SubagentStopHookInput = hook.SubagentStopInput

+ type SyncHookJSONOutput = hook.SyncJSONOutput

+ type SystemMessage = message.SystemMessage

+ type SystemPromptPreset = config.SystemPromptPreset

+ type TextBlock = message.TextBlock

+ type ThinkingBlock = message.ThinkingBlock

+ type ThinkingConfig = config.ThinkingConfig

+ type ThinkingConfigAdaptive = config.ThinkingConfigAdaptive

+ type ThinkingConfigDisabled = config.ThinkingConfigDisabled

+ type ThinkingConfigEnabled = config.ThinkingConfigEnabled

+ type Tool interface

+ Description func() string

+ Execute func(ctx context.Context, input map[string]any) (map[string]any, error)

+ InputSchema func() map[string]any

+ Name func() string

+ func NewTool(name, description string, schema map[string]any, fn ToolFunc) Tool

+ type ToolFunc func(ctx context.Context, input map[string]any) (map[string]any, error)

+ type ToolPermissionCallback = permission.Callback

+ type ToolPermissionContext = permission.Context

+ type ToolResultBlock = message.ToolResultBlock

+ type ToolUseBlock = message.ToolUseBlock

+ type ToolsConfig = config.ToolsConfig

+ type ToolsList = config.ToolsList

+ type ToolsPreset = config.ToolsPreset

+ type Transport = config.Transport

+ type Usage = message.Usage

+ type UserInputAnswer = userinput.Answer

+ type UserInputCallback = userinput.Callback

+ type UserInputQuestion = userinput.Question

+ type UserInputQuestionOption = userinput.QuestionOption

+ type UserInputRequest = userinput.Request

+ type UserInputResponse = userinput.Response

+ type UserMessage = message.UserMessage

+ type UserMessageContent = message.UserMessageContent

+ type UserPromptSubmitHookInput = hook.UserPromptSubmitInput

+ type UserPromptSubmitHookSpecificOutput = hook.UserPromptSubmitSpecificOutput

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