Help us shape the future of Go! Take the 2026 Go Developer Survey

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

runtime

package

Go to main page

Versions in this module

v0

v0.7.2

Oct 23, 2026

v0.7.1

Oct 22, 2026

v0.7.0

Oct 13, 2026

v0.6.1

Oct 6, 2026

v0.6.0

Oct 1, 2026

v0.5.1

Aug 28, 2026

Changes in this version

+ const EventAvailableCommands

+ const EventConfigOptions

+ const EventContent

+ const EventDelta

+ const EventDone

+ const EventError

+ const EventMode

+ const EventPermission

+ const EventPlan

+ const EventReasoning

+ const EventSession

+ const EventSessionInfo

+ const EventToolCall

+ const EventUsage

+ const StopReasonCancelled

+ const StopReasonPermissionRequired

+ const TurnOptionsVersionV1

+ var ErrAgentDisabled = &Error

+ var ErrAgentNotFound = &Error

+ var ErrBackendTimeout = &Error

+ var ErrBackendUnavailable = &Error

+ var ErrCapabilityNotSupported = &Error

+ var ErrInvalidRequest = &Error

+ var ErrPermissionExpired = &Error

+ var ErrPermissionNotFound = &Error

+ var ErrPermissionRequired = &Error

+ var ErrRunNotFound = &Error

+ var ErrRuntimeNotExecutable = &Error

+ var ErrSessionBusy = &Error

+ var ErrSessionLimitExceeded = &Error

+ var ErrSessionNotFound = &Error

+ var ErrTurnCancelled = &Error

+ var ErrTurnFailed = &Error

+ var ErrTurnLimitExceeded = &Error

+ var ErrUnsupportedOption = &Error

+ func DecodeRuntimeOptions(raw json.RawMessage, dst any) error

+ func HTTPStatus(err error) int

+ func IsAgentRetirementCancellation(ctx context.Context) bool

+ func IsNormalized(err error) bool

+ func MergeIdentities(ctx context.Context, overlay Identities) context.Context

+ func NewContinuationToken() (string, error)

+ func NewError(code ErrorCode, message string) error

+ func NewRunID() (string, error)

+ func NormalizeError(err error) error

+ func ValidRunID(id string) bool

+ func WithIdentities(ctx context.Context, ids Identities) context.Context

+ func WithPermissionSource(ctx context.Context, source string) context.Context

+ func WrapError(code ErrorCode, message string, cause error) error

+ type Backend interface

+ Capabilities func(context.Context, agent.Agent) (Capabilities, error)

+ RuntimeType func() string

+ ServeTurn func(context.Context, agent.Agent, TurnRequest, EventSink) error

+ type CancelCapabilities struct

+ Force bool

+ Graceful bool

+ type CancelMode string

+ const CancelModeForce

+ const CancelModeGraceful

+ type CancelRequest struct

+ Mode CancelMode

+ RunID string

+ type CancelResult struct

+ FinishedAt time.Time

+ RunID string

+ State RunState

+ StopReason string

+ type Capabilities struct

+ Cancellation CancelCapabilities

+ Events []string

+ Executable bool

+ Permissions PermissionCapabilities

+ Sessions SessionCapabilities

+ Turn TurnCapabilities

+ type ContinuationCursorBackend interface

+ LoadContinuationCursor func(context.Context, agent.Agent, string) (EventCursor, error)

+ StoreContinuationCursor func(context.Context, agent.Agent, string, EventCursor) error

+ type ContinuationResolver interface

+ ExpireContinuation func(context.Context, string) error

+ ResolveContinuation func(context.Context, string, PermissionDecision, time.Time) error

+ ValidateContinuationDecision func(string, PendingPermission, PermissionDecision) error

+ type Error struct

+ Cause error

+ Code ErrorCode

+ Message string

+ func (e *Error) Error() string

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

+ func (e *Error) Unwrap() error

+ type ErrorCode string

+ const ErrorAgentDisabled

+ const ErrorAgentNotFound

+ const ErrorBackendTimeout

+ const ErrorBackendUnavailable

+ const ErrorCapabilityNotSupported

+ const ErrorInvalidRequest

+ const ErrorPermissionExpired

+ const ErrorPermissionNotFound

+ const ErrorPermissionRequired

+ const ErrorRunNotFound

+ const ErrorRuntimeNotExecutable

+ const ErrorSessionBusy

+ const ErrorSessionLimitExceeded

+ const ErrorSessionNotFound

+ const ErrorTurnCancelled

+ const ErrorTurnFailed

+ const ErrorTurnLimitExceeded

+ const ErrorUnsupportedOption

+ func ErrorCodeOf(err error) (ErrorCode, bool)

+ type EventCursor struct

+ NextSegment uint32

+ NextSequence uint64

+ RunID string

+ type EventSink func(TurnEvent) error

+ type ExecutionOptions struct

+ LogicalExecutionKey string

+ type Health struct

+ CheckedAt time.Time

+ Details json.RawMessage

+ Healthy bool

+ Message string

+ State RuntimeState

+ type HealthChecker interface

+ Health func(context.Context, agent.Agent) (Health, error)

+ type Identities struct

+ AgentID string

+ ParentSpanID string

+ RequestID string

+ RunID string

+ RuntimeType string

+ SegmentIndex uint32

+ SessionID string

+ SpanID string

+ TraceID string

+ func IdentitiesFromContext(ctx context.Context) (Identities, bool)

+ type ListSessionsRequest struct

+ CWD string

+ Cursor string

+ type ListSessionsResponse struct

+ NextCursor string

+ Sessions []Session

+ type OptionalCapabilities struct

+ HealthCheck bool

+ PermissionResolve bool

+ RunCancel bool

+ RuntimeInspect bool

+ SessionList bool

+ Transcript bool

+ func DetectOptionalCapabilities(backend Backend) OptionalCapabilities

+ type PendingPermission struct

+ Actions []PermissionAction

+ AgentID string

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ Options []PermissionOption

+ RequestID string

+ ResumeMode PermissionResumeMode

+ RunID string

+ RuntimeType string

+ SessionID string

+ TTL time.Duration

+ type PermissionAction struct

+ ActionID string

+ Name string

+ type PermissionActionDecision struct

+ ActionID string

+ Outcome string

+ type PermissionAudit struct

+ AgentID string

+ At time.Time

+ RequestID string

+ Result string

+ RunID string

+ RuntimeType string

+ SessionID string

+ Source string

+ type PermissionBroker struct

+ func NewPermissionBroker() *PermissionBroker

+ func (b *PermissionBroker) Audits(agentID string) []PermissionAudit

+ func (b *PermissionBroker) ClaimAgent(agentID string) func(context.Context) int

+ func (b *PermissionBroker) Close(ctx context.Context)

+ func (b *PermissionBroker) DrainAgent(ctx context.Context, agentID string) int

+ func (b *PermissionBroker) DrainAll(ctx context.Context) int

+ func (b *PermissionBroker) DrainRun(ctx context.Context, agentID, runID string) int

+ func (b *PermissionBroker) Expire(ctx context.Context, agentID, requestID string) error

+ func (b *PermissionBroker) List(agentID string) []PendingPermission

+ func (b *PermissionBroker) LookupPermission(requestID string) (PermissionCorrelation, bool)

+ func (b *PermissionBroker) RecordContinuationLost(ctx context.Context, agentID, requestID string)

+ func (b *PermissionBroker) Register(info PendingPermission, token string, resolver ContinuationResolver) (string, error)

+ func (b *PermissionBroker) Resolve(ctx context.Context, agentID string, decision PermissionDecision) error

+ type PermissionCapabilities struct

+ Interactive bool

+ ResumeMode PermissionResumeMode

+ type PermissionCorrelation struct

+ AgentID string

+ RequestID string

+ RunID string

+ RuntimeType string

+ SessionID string

+ type PermissionDecision struct

+ Decisions []PermissionActionDecision

+ OptionID string

+ Outcome string

+ RequestID string

+ type PermissionOption struct

+ Kind string

+ Name string

+ OptionID string

+ type PermissionResolver interface

+ ResolvePermission func(context.Context, agent.Agent, PermissionDecision) error

+ type PermissionResumeMode string

+ const PermissionResumeActiveStream

+ const PermissionResumeNewStream

+ type PublicErrorPayload struct

+ ErrorType ErrorCode

+ Message string

+ func PublicError(err error) PublicErrorPayload

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) Has(runtimeType string) bool

+ func (r *Registry) Register(backend Backend) error

+ func (r *Registry) RegisterAll(backends ...Backend) error

+ func (r *Registry) Resolve(runtimeType string) (Backend, error)

+ func (r *Registry) RuntimeTypes() []string

+ func (r *Registry) ValidateRequired(runtimeTypes ...string) error

+ type RunCanceller interface

+ CancelRun func(context.Context, agent.Agent, CancelRequest) (CancelResult, error)

+ type RunInfo struct

+ AgentID string

+ FinishedAt time.Time

+ RunID string

+ RuntimeType string

+ SessionID string

+ StartedAt time.Time

+ State RunState

+ StopReason string

+ type RunRegistry struct

+ func NewRunRegistry() *RunRegistry

+ func (r *RunRegistry) Begin(agentID, runtimeType, runID, sessionID string, ...) error

+ func (r *RunRegistry) Cancel(ctx context.Context, agentID string, req CancelRequest) (CancelResult, error)

+ func (r *RunRegistry) CancelAgent(ctx context.Context, agentID string) error

+ func (r *RunRegistry) Complete(agentID, runID string, state RunState, stopReason string)

+ func (r *RunRegistry) List(agentID string) []RunInfo

+ func (r *RunRegistry) Rebind(agentID, runtimeType, runID, sessionID string, ...) error

+ func (r *RunRegistry) SetSession(agentID, runID, sessionID string)

+ type RunSequencer struct

+ func NewRunSequencer(agentID, runtimeType string) (*RunSequencer, error)

+ func NewTurnSequencer(ctx context.Context, backend Backend, a agent.Agent, req TurnRequest) (*RunSequencer, error)

+ func RestoreRunSequencer(agentID, runtimeType string, cursor EventCursor) (*RunSequencer, error)

+ func (r *RunSequencer) Cursor() EventCursor

+ func (r *RunSequencer) RunID() string

+ func (r *RunSequencer) ServeSegment(ctx context.Context, backend Backend, a agent.Agent, req TurnRequest, ...) (SegmentResult, error)

+ type RunState string

+ const RunStateCancelled

+ const RunStateCompleted

+ const RunStateFailed

+ const RunStateRunning

+ type RuntimeInspector interface

+ RuntimeSummary func(context.Context, agent.Agent) (RuntimeSummary, error)

+ type RuntimeState string

+ const RuntimeStateDegraded

+ const RuntimeStateDisabled

+ const RuntimeStateNotExecutable

+ const RuntimeStateReady

+ const RuntimeStateStarting

+ const RuntimeStateUnhealthy

+ const RuntimeStateUnknown

+ type RuntimeSummary struct

+ ActiveRuns int

+ Details json.RawMessage

+ Executable bool

+ Healthy bool

+ LastActivityAt *time.Time

+ PendingPermissions int

+ SessionCount int

+ State RuntimeState

+ Type string

+ type SegmentResult struct

+ Started bool

+ Terminal bool

+ type Session struct

+ Details json.RawMessage

+ SessionID string

+ Title string

+ UpdatedAt *time.Time

+ type SessionCapabilities struct

+ Durable bool

+ List bool

+ Resume bool

+ Transcript bool

+ type SessionLister interface

+ ListSessions func(context.Context, agent.Agent, ListSessionsRequest) (ListSessionsResponse, error)

+ type TranscriptLoader interface

+ LoadTranscript func(context.Context, agent.Agent, TranscriptRequest) (TranscriptResponse, error)

+ type TranscriptMessage struct

+ Role string

+ Text string

+ type TranscriptRequest struct

+ CWD string

+ SessionID string

+ type TranscriptResponse struct

+ Messages []TranscriptMessage

+ SessionID string

+ type TurnCapabilities struct

+ Streaming bool

+ type TurnEvent struct

+ AgentID string

+ Data json.RawMessage

+ Event string

+ RequestID string

+ RunID string

+ SegmentIndex uint32

+ Sequence uint64

+ SessionID string

+ Text string

+ type TurnOptions struct

+ Execution ExecutionOptions

+ Runtime json.RawMessage

+ Version string

+ type TurnRequest struct

+ Input string

+ Options TurnOptions

+ Permission *PermissionDecision

+ RunID string

+ SessionID string

+ func DecodeTurnRequest(r io.Reader) (TurnRequest, error)