Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sdk

package

Go to main page

Versions in this module

v0

v0.2.0

Jul 14, 2026

Changes in this version

+ const DefaultOpenAIDeviceClientID

type ClientConfig

+ AutomationAPIKey string

+ AutomationServiceURL string

+ WebSearchKeys map[string]string

+ type OAuthDeviceChallenge struct

+ DeviceCode string

+ ExpiresIn int

+ Interval int

+ UserCode string

+ VerificationURL string

+ VerificationURLComplete string

+ type OAuthDeviceFlow struct

+ func NewOAuthDeviceFlow(config OAuthDeviceFlowConfig) (*OAuthDeviceFlow, error)

+ func (f *OAuthDeviceFlow) AuthPath() string

+ func (f *OAuthDeviceFlow) CredentialResolver() CredentialResolver

+ func (f *OAuthDeviceFlow) ResolveAccessToken(ctx context.Context) (string, error)

+ func (f *OAuthDeviceFlow) SaveToken(ctx context.Context, token *publicoauth.Token) error

+ func (f *OAuthDeviceFlow) Start(ctx context.Context) (*OAuthDeviceChallenge, error)

+ func (f *OAuthDeviceFlow) Wait(ctx context.Context, challenge *OAuthDeviceChallenge) (*publicoauth.Token, error)

+ type OAuthDeviceFlowConfig struct

+ AuthPath string

+ ClientID string

+ Persist bool

+ Provider string

+ type StoredCredentialResolver struct

+ func NewStoredCredentialResolver(config StoredCredentialResolverConfig) *StoredCredentialResolver

+ func (r *StoredCredentialResolver) ResolveAPIKey(ctx context.Context, provider string) (string, error)

+ type StoredCredentialResolverConfig struct

+ AuthPath string

+ EnvFirst bool

v0.1.0

Jun 22, 2026

Changes in this version

+ const APIProviderAnthropic

+ const APIProviderBedrock

+ const APIProviderCodex

+ const APIProviderDeepSeek

+ const APIProviderFoundry

+ const APIProviderGemini

+ const APIProviderKimi

+ const APIProviderMiniMax

+ const APIProviderMistral

+ const APIProviderOllama

+ const APIProviderOpenAI

+ const APIProviderOpenCode

+ const APIProviderOpenRouter

+ const APIProviderVertex

+ const APIProviderWorkersAI

+ const APIProviderZAi

+ const EntryTypeCompact

+ const EntryTypeControl

+ const EntryTypeMessage

+ const EntryTypeSystem

+ const EntryTypeTurn

+ const ExecutionModeExecute

+ const ExecutionModePairProgramming

+ const ExecutionModePlan

+ const HookEventConfigChange

+ const HookEventCwdChanged

+ const HookEventElicitation

+ const HookEventElicitationResult

+ const HookEventFileChanged

+ const HookEventInstructionsLoaded

+ const HookEventIterationComplete

+ const HookEventIterationContinue

+ const HookEventIterationStart

+ const HookEventIterationStop

+ const HookEventNotification

+ const HookEventOnError

+ const HookEventPermissionDenied

+ const HookEventPermissionRequest

+ const HookEventPostAPICall

+ const HookEventPostCompact

+ const HookEventPostToolUse

+ const HookEventPostToolUseFail

+ const HookEventPreAPICall

+ const HookEventPreCompact

+ const HookEventPreToolUse

+ const HookEventQueryComplete

+ const HookEventQueryStart

+ const HookEventSessionEnd

+ const HookEventSessionStart

+ const HookEventSetup

+ const HookEventStopFailure

+ const HookEventSubagentStart

+ const HookEventSubagentStop

+ const HookEventTaskCompleted

+ const HookEventTaskCreated

+ const HookEventTeammateIdle

+ const HookEventToolUsesComplete

+ const HookEventToolUsesStart

+ const HookEventTurnEnd

+ const HookEventTurnStart

+ const HookEventTurnStop

+ const HookEventUserPromptSubmit

+ const HookEventWorktreeCreate

+ const HookEventWorktreeRemove

+ const HookStateActive

+ const HookStateDead

+ const HookStateInactive

+ const HookStatePaused

+ const MCPTransportHTTP

+ const MCPTransportSSE

+ const MCPTransportStdio

+ const MCPTransportWebSocket

+ const NamespaceBrowserDownloads

+ const NamespaceBrowserScreenshots

+ const NamespaceDocuments

+ const NamespaceRAGDocuments

+ const NamespaceWebArtifacts

+ const PermissionBehaviorAllow

+ const PermissionBehaviorAsk

+ const PermissionBehaviorDeny

+ const PermissionBehaviorPassthrough

+ const PermissionModeAcceptEdits

+ const PermissionModeAuto

+ const PermissionModeBypass

+ const PermissionModeGranular

+ const PermissionModeNever

+ const PermissionModeOnRequest

+ const ResponseChunkTypeContentBlockDelta

+ const ResponseChunkTypeContentBlockStart

+ const ResponseChunkTypeContentBlockStop

+ const ResponseChunkTypeError

+ const ResponseChunkTypeMessageDelta

+ const ResponseChunkTypeMessageStop

+ const RetentionDurable

+ const RetentionSession

+ const RetentionTemporary

+ const RoleAssistant

+ const RoleSystem

+ const RoleUser

+ const RuntimeEventTypeBrowserAction

+ const RuntimeEventTypeBrowserPage

+ const RuntimeEventTypeBrowserScreenshot

+ const RuntimeEventTypeBrowserSession

+ const RuntimeEventTypeBrowserSnapshot

+ const RuntimeEventTypeExecutionModeChanged

+ const RuntimeEventTypePlanStatusChanged

+ const RuntimeEventTypePlanSubmitted

+ const RuntimeEventTypeResponseChunk

+ const RuntimeEventTypeTaskChanged

+ const RuntimeEventTypeToolProgress

+ const RuntimeEventTypeTurnCompleted

+ const RuntimeEventTypeTurnFailed

+ const RuntimeEventTypeTurnStarted

+ const SessionStatusActive

+ const SessionStatusClosed

+ const ToolHookStagePost

+ const ToolHookStagePre

+ const ToolProgressStageCompleted

+ const ToolProgressStageFailed

+ const ToolProgressStagePending

+ const ToolProgressStageRunning

+ type APIProvider = types.APIProvider

+ type ArtifactGCOptions = storage.GCOptions

+ type ArtifactGCReport = storage.GCReport

+ type ArtifactListOptions = storage.ListOptions

+ type ArtifactMetadata = storage.ArtifactMetadata

+ type ArtifactNamespace = storage.ArtifactNamespace

+ type ArtifactPutRequest = storage.ArtifactPutRequest

+ type ArtifactRef = storage.ArtifactRef

+ type ArtifactRetentionClass = storage.ArtifactRetentionClass

+ type ArtifactStore interface

+ Delete func(ctx context.Context, key string) error

+ Exists func(ctx context.Context, key string) (bool, error)

+ GarbageCollect func(ctx context.Context, options ArtifactGCOptions) (ArtifactGCReport, error)

+ Get func(ctx context.Context, key string) ([]byte, error)

+ List func(ctx context.Context, options ArtifactListOptions) ([]ArtifactRef, error)

+ ListMetadata func(ctx context.Context, options ArtifactListOptions) ([]ArtifactMetadata, error)

+ Metadata func(ctx context.Context, key string) (ArtifactMetadata, error)

+ OpenReader func(ctx context.Context, key string) (io.ReadCloser, ArtifactRef, error)

+ Put func(ctx context.Context, key string, body []byte, contentType string) (ArtifactRef, error)

+ PutArtifact func(ctx context.Context, request ArtifactPutRequest, body []byte) (ArtifactRef, error)

+ Stat func(ctx context.Context, key string) (ArtifactRef, error)

+ URL func(ctx context.Context, key string) (string, error)

+ func DefaultArtifactStore() (ArtifactStore, error)

+ func NewArtifactStoreFromConfig(cfg StorageConfig) (ArtifactStore, error)

+ type AskResponse struct

+ Content string

+ IsComplete bool

+ Thinking string

+ ToolResults []CallResult

+ ToolUses []ToolUseContent

+ Usage *TokenUsage

+ type CallResult = contract.CallResult

+ type Checkpoint = state.Checkpoint

+ type Client struct

+ func NewClient(config *ClientConfig) (*Client, error)

+ func (c *Client) AddToolHook(hook ToolHook)

+ func (c *Client) Ask(ctx context.Context, prompt string, tools []Tool) (*AskResponse, error)

+ func (c *Client) AutoModeAvailable() bool

+ func (c *Client) BuildToolSurface(ctx context.Context) (*Surface, error)

+ func (c *Client) Close() error

+ func (c *Client) CreateSession(ctx context.Context) (*Session, error)

+ func (c *Client) CreateSessionWithAdditional(ctx context.Context, additional map[string]any) (*Session, error)

+ func (c *Client) DeleteSession(sessionID SessionID) error

+ func (c *Client) GetArtifactStore() ArtifactStore

+ func (c *Client) GetMonitoring() *MonitoringSystem

+ func (c *Client) GetSessionStore() SessionStore

+ func (c *Client) HookRegistry() *HookRegistry

+ func (c *Client) ListSessions() ([]*SessionInfo, error)

+ func (c *Client) LoadSession(ctx context.Context, sessionID SessionID) (*Session, error)

+ func (c *Client) LoadSessionWithAdditional(ctx context.Context, sessionID SessionID, additional map[string]any) (*Session, error)

+ func (c *Client) MCPResult() *MCPIntegrationResult

+ func (c *Client) MemoryInitError() error

+ func (c *Client) RegisterHook(event HookEvent, handler HookHandler) string

+ func (c *Client) RegisterTool(tool Tool) error

+ func (c *Client) RegisterTools(tools []Tool) error

+ func (c *Client) ReloadMCPServers(ctx context.Context, servers []MCPServerConfig) error

+ func (c *Client) SetProgressFn(progressFn func(ToolProgress))

+ func (c *Client) SetPromptFn(promptFn PromptFn)

+ func (c *Client) SetResponseChunkFn(chunkFn func(ResponseChunk))

+ func (c *Client) SetRuntimeEventFn(runtimeEventFn func(RuntimeEvent))

+ func (c *Client) SetWebSearchRunner(fn websearchtool.RunnerFn)

+ func (c *Client) ToolNames() []string

+ type ClientConfig struct

+ APIKey string

+ ArtifactStore ArtifactStore

+ AutoCompact bool

+ BrowserExecutablePath string

+ BrowserRemoteControlURL string

+ BudgetContinuationLimit int

+ ContinuationNudgeLimit int

+ CredentialResolver CredentialResolver

+ DisableTitleGeneration bool

+ DoclingURL string

+ EnableHooks bool

+ EnableMemory bool

+ EnableMonitoring bool

+ EnablePromptReaderFallback bool

+ ImageGeneration *ImageGenerationConfig

+ LongTermMemory LongTermMemory

+ MCPServers []MCPServerConfig

+ MaxConsecutiveDenials int

+ MaxIterations int

+ MaxTokens int

+ MaxTurns int

+ MemoryFailFast bool

+ Model ModelIdentifier

+ Monitoring *MonitoringSystem

+ OnSessionTitled func(id SessionID, title string)

+ PermissionMode PermissionMode

+ PersistSessions bool

+ PlanStore PlanStore

+ PreToolHooks []PreToolHookConfig

+ ProgressFn func(ToolProgress)

+ PromptConfig *PromptConfig

+ PromptFn PromptFn

+ ProviderConfig *providers.Config

+ RAGService *RAGService

+ ResponseChunkFn func(ResponseChunk)

+ RuntimeEventFn func(RuntimeEvent)

+ SessionBackend SessionBackend

+ SessionSQLitePath string

+ SessionStorageDir string

+ SessionStore SessionStore

+ SpeechToText *SpeechToTextConfig

+ StopHooks []StopHook

+ StorageConfig *StorageConfig

+ StorageGCEnabled bool

+ StorageGCInterval time.Duration

+ StorageGCLimit int

+ StorageGCNamespaces []string

+ SystemPromptTemplate string

+ TextToSpeech *TextToSpeechConfig

+ TurnTokenBudget int

+ WorkingDir string

+ func DefaultClientConfig() *ClientConfig

+ type ContentBlock = types.ContentBlock

+ type CredentialResolver interface

+ ResolveAPIKey func(ctx context.Context, provider string) (string, error)

+ type DenialLimitConfig = types.DenialLimitConfig

+ type DenialTrackingState = types.DenialTrackingState

+ type EntryType = types.EntryType

+ type EventQueue = execution.EventQueue

+ type EventQueueStats = execution.EventQueueStats

+ type ExecutionMode = modes.ExecutionMode

+ type ExecutionStage = prompt.ExecutionStage

+ const StageContinuation

+ const StageDefault

+ const StagePlan

+ const StageToolCall

+ const StageToolResult

+ type HookEvent = types.HookEvent

+ type HookHandler = hooks.HookHandler

+ type HookProgress = types.HookProgress

+ type HookRegistration = hooks.HookRegistration

+ type HookRegistry = hooks.Registry

+ type HookResult = types.HookResult

+ type HookState = hooks.HookState

+ type ImageContent = types.ImageContent

+ type ImageGenerationConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Provider string

+ type LongTermMemory = longterm.Store

+ type MCPIntegrationOptions = mcp.IntegrationOptions

+ type MCPIntegrationResult = mcp.IntegrationResult

+ type MCPServerConfig = mcp.ServerConfig

+ type MCPServerResult = mcp.ServerResult

+ type MCPTransportType = mcp.TransportType

+ type Message = types.Message

+ type MessageID = types.MessageID

+ type ModelIdentifier = types.ModelIdentifier

+ type MonitoringSystem = monitoring.System

+ type PermissionBehavior = types.PermissionBehavior

+ type PermissionContext = types.PermissionContext

+ type PermissionMode = types.PermissionMode

+ type PermissionResult = types.PermissionResult

+ type PlanRuntimeEvent = types.PlanRuntimeEvent

+ type PlanStore = builtin.PlanStore

+ type PreToolHookConfig struct

+ Command string

+ Matcher string

+ Timeout int

+ type PromptConfig struct

+ AppendSystemPrompt *string

+ Stage ExecutionStage

+ StageOverrides map[ExecutionStage]string

+ SystemPrompt *string

+ ToolHints map[string]string

+ type PromptFn = types.PromptFn

+ type PromptOption = types.PromptOption

+ type PromptRequest = types.PromptRequest

+ type PromptResponse = types.PromptResponse

+ type RAGService = rag.Service

+ type ResponseChunk = types.APIResponseChunk

+ type ResponseChunkType = types.APIChunkType

+ type Role = types.Role

+ type RuntimeEvent = types.RuntimeEvent

+ type RuntimeEventQueue = execution.RuntimeEventQueue

+ type RuntimeEventQueueStats = execution.RuntimeEventQueueStats

+ type RuntimeEventType = types.RuntimeEventType

+ type Session struct

+ func (s *Session) ClearPlanMode()

+ func (s *Session) Close() error

+ func (s *Session) GetEventQueue() *EventQueue

+ func (s *Session) GetExecutionMode() ExecutionMode

+ func (s *Session) GetID() SessionID

+ func (s *Session) GetMessages() []Message

+ func (s *Session) GetMetadata() *SessionMetadata

+ func (s *Session) GetPermissionContext() *PermissionContext

+ func (s *Session) GetPermissionMode() PermissionMode

+ func (s *Session) GetRuntimeEventQueue() *RuntimeEventQueue

+ func (s *Session) GetStatus() SessionStatus

+ func (s *Session) GetToolNames() []string

+ func (s *Session) GetTotalTokens() int

+ func (s *Session) GetTurnNumber() int

+ func (s *Session) Interrupt() error

+ func (s *Session) RegisterTool(tool Tool) error

+ func (s *Session) SetAppendSystemPrompt(text string)

+ func (s *Session) SetPermissionMode(mode PermissionMode)

+ func (s *Session) SetProgressFn(progressFn func(ToolProgress))

+ func (s *Session) SetResponseChunkFn(chunkFn func(ResponseChunk))

+ func (s *Session) SetRuntimeEventFn(runtimeEventFn func(RuntimeEvent))

+ func (s *Session) SetSystemPromptTemplate(text string)

+ func (s *Session) SetWorkingDirectory(path string)

+ func (s *Session) SubmitMessage(ctx context.Context, content string) (*SessionResponse, error)

+ func (s *Session) SubmitMessageWithContent(ctx context.Context, text string, images []ImageContent) (*SessionResponse, error)

+ func (s *Session) UnregisterTool(name string) error

+ type SessionBackend interface

+ AppendTranscriptEntries func(sessionID SessionID, entries []TranscriptEntry) error

+ DeleteSession func(sessionID SessionID) error

+ ListSessions func() ([]SessionID, error)

+ LoadCheckpoint func(sessionID SessionID) (*Checkpoint, error)

+ LoadSession func(sessionID SessionID) (*SessionMetadata, error)

+ LoadTranscript func(sessionID SessionID) ([]TranscriptEntry, error)

+ ReplaceTranscript func(sessionID SessionID, entries []TranscriptEntry) error

+ SaveCheckpoint func(sessionID SessionID, checkpoint *Checkpoint) error

+ SaveSession func(sessionID SessionID, metadata *SessionMetadata) error

+ SearchTranscriptsByContent func(needle string, limit int) ([]SessionID, error)

+ func NewFilesystemSessionBackend(baseDir string) (SessionBackend, error)

+ func NewMemorySessionBackend() SessionBackend

+ func OpenSQLiteSessionBackend(path string) (SessionBackend, error)

+ type SessionID = types.SessionID

+ type SessionInfo = state.SessionInfo

+ type SessionMetadata = types.SessionMetadata

+ type SessionResponse struct

+ Compacted bool

+ IsComplete bool

+ Messages []Message

+ StopReason string

+ ToolResults []CallResult

+ ToolUses []ToolUseContent

+ TotalTokens int

+ TurnNumber int

+ Usage *TokenUsage

+ type SessionStatus = types.SessionStatus

+ type SessionStore interface

+ AppendTranscriptEntries func(sessionID SessionID, entries []TranscriptEntry) error

+ Close func() error

+ DeleteSession func(sessionID SessionID) error

+ GetAllSessionsInfo func() ([]*SessionInfo, error)

+ GetSessionInfo func(sessionID SessionID) (*SessionInfo, error)

+ ListSessions func() ([]SessionID, error)

+ LoadCanonicalMessages func(sessionID SessionID) ([]Message, error)

+ LoadCheckpoint func(sessionID SessionID) (*Checkpoint, error)

+ LoadSession func(sessionID SessionID) (*SessionMetadata, error)

+ LoadTranscript func(sessionID SessionID) ([]TranscriptEntry, error)

+ ReplaceTranscript func(sessionID SessionID, entries []TranscriptEntry) error

+ RestoreSessionState func(sessionID SessionID) (*SessionMetadata, []Message, error)

+ SaveCanonicalMessages func(sessionID SessionID, messages []Message) error

+ SaveCheckpoint func(sessionID SessionID, checkpoint *Checkpoint) error

+ SaveSession func(sessionID SessionID, metadata *SessionMetadata) error

+ SaveSessionState func(sessionID SessionID, metadata *SessionMetadata, previousMessages []Message, ...) error

+ func NewSessionStore(baseDir string) (SessionStore, error)

+ func NewSessionStoreWithBackend(backend SessionBackend) (SessionStore, error)

+ type SpeechToTextConfig struct

+ APIKey string

+ BaseURL string

+ Language string

+ Model string

+ Provider string

+ type StopHook = engine.StopHook

+ type StopHookInput = engine.StopHookInput

+ type StopHookResult = engine.StopHookResult

+ type StorageConfig struct

+ LocalPath string

+ Provider StorageProviderType

+ S3AccessKeyID string

+ S3Bucket string

+ S3Endpoint string

+ S3KeyPrefix string

+ S3Region string

+ S3SecretAccessKey string

+ type StorageProviderType string

+ const StorageProviderLocal

+ const StorageProviderS3

+ type Surface = registry.Surface

+ type TaskRuntimeEvent = types.TaskRuntimeEvent

+ type TextContent = types.TextContent

+ type TextToSpeechConfig struct

+ APIKey string

+ BaseURL string

+ Format string

+ Model string

+ Provider string

+ Voice string

+ type ThinkingContent = types.ThinkingContent

+ type TokenUsage = types.TokenUsage

+ type Tool = contract.Tool

+ type ToolDefinition = registry.ToolDefinition

+ type ToolHook = execution.ToolHook

+ type ToolHookInput = execution.ToolHookInput

+ type ToolHookStage = execution.ToolHookStage

+ type ToolProgress = types.ToolProgress

+ type ToolProgressStage = types.ToolProgressStage

+ type ToolResultContent = types.ToolResultContent

+ type ToolUseContent = types.ToolUseContent

+ type TranscriptEntry = types.TranscriptEntry

+ type TurnID = types.TurnID

+ type WebSearchRunnerFn = websearchtool.RunnerFn