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

agui

package

Go to main page

Versions in this module

v0

v0.704.1

Sep 8, 2026

v0.703.4

Sep 7, 2026

v0.700.1

Sep 1, 2026

Changes in this version

type Config

+ Persona string

v0.700.0

Aug 31, 2026

v0.647.6

Aug 19, 2026

v0.647.5

Aug 19, 2026

v0.646.5

Aug 17, 2026

v0.646.4

Aug 17, 2026

v0.644.3

Aug 7, 2026

v0.644.0

Aug 3, 2026

v0.643.1

Aug 3, 2026

v0.641.3

Jul 30, 2026

v0.641.2

Jul 29, 2026

v0.641.1

Jul 29, 2026

v0.640.1

Jul 29, 2026

Changes in this version

+ const ContentAudio

+ const ContentDocument

+ const ContentImage

+ const ContentText

+ const ContentVideo

+ const FileActionEdit

+ const FileActionPatched

+ const FileActionRead

+ const FileActionWrite

+ const OutcomeInterrupt

+ const OutcomeSuccess

+ const RoleActivity

+ const RoleAssistant

+ const RoleDeveloper

+ const RoleReasoning

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ var ErrInvalidInput = errors.New("agui: invalid RunAgentInput")

+ var ErrStreamingUnsupported = errors.New("agui: streaming unsupported by the response writer")

+ type ActivitySnapshotEvent struct

+ ActivityType string

+ Content any

+ MessageID string

+ Replace bool

+ func NewActivitySnapshot(messageID, activityType string, content any) ActivitySnapshotEvent

+ type AgentDescriptor struct

+ Description string

+ Model *ModelDescriptor

+ Name string

+ URL string

+ type BaseEvent struct

+ RawEvent any

+ Timestamp int64

+ Type EventType

+ func (b BaseEvent) EventType() EventType

+ type Capabilities struct

+ FrontendTools bool

+ HumanInTheLoop bool

+ Interrupts bool

+ SharedState bool

+ type Config struct

+ AgentPoolSize int

+ AgentPoolTTL time.Duration

+ Agents []config.AgentName

+ AllowedOrigins []string

+ AutoApprove bool

+ FrontendTools bool

+ HumanInTheLoop bool

+ Path string

+ Port int

+ RequireToken bool

+ func ConfigFromApp(c config.AGUIConfig) Config

+ type Context struct

+ Description string

+ Value string

+ type CustomEvent struct

+ Name string

+ Value any

+ func NewCustom(name string, value any) CustomEvent

+ type Deps struct

+ DB *sql.DB

+ Gateway *mcpgateway.Gateway

+ History history.Service

+ LSP tools.LSPProvider

+ Messages message.Service

+ Orchestrator *orchestrator.Orchestrator

+ Remembrances *rag.RemembrancesService

+ Sessions session.Service

+ Skills *skills.SkillManager

+ Token string

+ type Event interface

+ EventType func() EventType

+ type EventType string

+ const EventActivityDelta

+ const EventActivitySnapshot

+ const EventCustom

+ const EventMessagesSnapshot

+ const EventRaw

+ const EventReasoningEnd

+ const EventReasoningMessageContent

+ const EventReasoningMessageEnd

+ const EventReasoningMessageStart

+ const EventReasoningStart

+ const EventRunError

+ const EventRunFinished

+ const EventRunStarted

+ const EventStateDelta

+ const EventStateSnapshot

+ const EventStepFinished

+ const EventStepStarted

+ const EventTextMessageChunk

+ const EventTextMessageContent

+ const EventTextMessageEnd

+ const EventTextMessageStart

+ const EventToolCallArgs

+ const EventToolCallEnd

+ const EventToolCallResult

+ const EventToolCallStart

+ type FileState struct

+ Action string

+ Name string

+ Path string

+ type InfoResponse struct

+ Agents []AgentDescriptor

+ Capabilities Capabilities

+ Path string

+ Protocol string

+ Version string

+ type InputContent struct

+ Data string

+ MimeType string

+ Text string

+ Type string

+ URL string

+ type JSONPatchOperation struct

+ From string

+ Op string

+ Path string

+ Value any

+ type Listener struct

+ func (l *Listener) Addr() string

+ func (l *Listener) Shutdown(ctx context.Context) error

+ func (l *Listener) URL() string

+ func (l *Listener) Wait() error

+ type ListenerOptions struct

+ CertFile string

+ Host string

+ KeyFile string

+ type Message struct

+ ActivityType string

+ Content MessageContent

+ Error string

+ ID string

+ Name string

+ Role string

+ ToolCallID string

+ ToolCalls []ToolCall

+ type MessageContent struct

+ Parts []InputContent

+ Text string

+ func (m *MessageContent) UnmarshalJSON(data []byte) error

+ func (m MessageContent) HasNonTextParts() bool

+ func (m MessageContent) MarshalJSON() ([]byte, error)

+ func (m MessageContent) String() string

+ type MessagesSnapshotEvent struct

+ Messages []Message

+ func NewMessagesSnapshot(msgs []Message) MessagesSnapshotEvent

+ type ModelDescriptor struct

+ ContextWindow int64

+ ID string

+ Name string

+ Provider string

+ type ModelState struct

+ ContextWindow int64

+ ID string

+ Name string

+ Provider string

+ type RawEvent struct

+ Event any

+ Source string

+ func NewRaw(event any, source string) RawEvent

+ type ReasoningEndEvent struct

+ MessageID string

+ func NewReasoningEnd(messageID string) ReasoningEndEvent

+ type ReasoningMessageContentEvent struct

+ Delta string

+ MessageID string

+ func NewReasoningMessageContent(messageID, delta string) ReasoningMessageContentEvent

+ type ReasoningMessageEndEvent struct

+ MessageID string

+ func NewReasoningMessageEnd(messageID string) ReasoningMessageEndEvent

+ type ReasoningMessageStartEvent struct

+ MessageID string

+ Role string

+ func NewReasoningMessageStart(messageID string) ReasoningMessageStartEvent

+ type ReasoningStartEvent struct

+ MessageID string

+ func NewReasoningStart(messageID string) ReasoningStartEvent

+ type RunAgentInput struct

+ Context []Context

+ ForwardedProps any

+ Messages []Message

+ ParentRunID string

+ RunID string

+ State any

+ ThreadID string

+ Tools []Tool

+ func DecodeRunAgentInput(r io.Reader, maxBytes int64) (*RunAgentInput, error)

+ func (in *RunAgentInput) ContextBlock() string

+ func (in *RunAgentInput) LastUserMessage() (Message, bool)

+ func (in *RunAgentInput) TrailingToolMessages() []Message

+ func (in *RunAgentInput) Validate() error

+ type RunErrorEvent struct

+ Code string

+ Message string

+ func NewRunError(msg, code string) RunErrorEvent

+ type RunFinishedEvent struct

+ Outcome string

+ Result any

+ RunID string

+ ThreadID string

+ func NewRunFinished(threadID, runID, outcome string, result any) RunFinishedEvent

+ type RunStartedEvent struct

+ ParentRunID string

+ RunID string

+ ThreadID string

+ func NewRunStarted(threadID, runID string) RunStartedEvent

+ type Runtime struct

+ func New(deps Deps, cfg Config) (*Runtime, error)

+ func (r *Runtime) Close()

+ func (r *Runtime) Handler() http.Handler

+ func (r *Runtime) Register(mux *http.ServeMux)

+ func (r *Runtime) StartListener(opts ListenerOptions) (*Listener, error)

+ type SSEWriter struct

+ func NewSSEWriter(w http.ResponseWriter) (*SSEWriter, error)

+ func (s *SSEWriter) Close()

+ func (s *SSEWriter) Comment(text string) error

+ func (s *SSEWriter) Write(ev Event) error

+ func (s *SSEWriter) WriteAll(events []Event) error

+ type StateDeltaEvent struct

+ Delta []JSONPatchOperation

+ func NewStateDelta(ops []JSONPatchOperation) StateDeltaEvent

+ type StateDoc struct

+ Agent string

+ Client any

+ Files []FileState

+ Model ModelState

+ Session string

+ SubAgents []SubAgentState

+ Thread string

+ Todos []tools.TodoItem

+ TokenUsage *TokenUsageState

+ type StateSnapshotEvent struct

+ Snapshot any

+ func NewStateSnapshot(snapshot any) StateSnapshotEvent

+ type StepFinishedEvent struct

+ StepName string

+ func NewStepFinished(name string) StepFinishedEvent

+ type StepStartedEvent struct

+ StepName string

+ func NewStepStarted(name string) StepStartedEvent

+ type SubAgentState struct

+ Conclusion string

+ Engine string

+ Error string

+ ExitCode *int

+ ID string

+ Model string

+ Persona string

+ Prompt string

+ Role string

+ Status string

+ Summary string

+ type TextMessageContentEvent struct

+ Delta string

+ MessageID string

+ func NewTextMessageContent(messageID, delta string) TextMessageContentEvent

+ type TextMessageEndEvent struct

+ MessageID string

+ func NewTextMessageEnd(messageID string) TextMessageEndEvent

+ type TextMessageStartEvent struct

+ MessageID string

+ Role string

+ func NewTextMessageStart(messageID string) TextMessageStartEvent

+ type TokenUsageState struct

+ CacheReadTokens int64

+ CacheWriteTokens int64

+ CompletionTokens int64

+ ContextWindow int64

+ Cost float64

+ Estimated bool

+ PromptTokens int64

+ ReasoningTokens int64

+ type Tool struct

+ Description string

+ Name string

+ Parameters any

+ type ToolCall struct

+ Function ToolCallFunction

+ ID string

+ Type string

+ type ToolCallArgsEvent struct

+ Delta string

+ ToolCallID string

+ func NewToolCallArgs(id, delta string) ToolCallArgsEvent

+ type ToolCallEndEvent struct

+ ToolCallID string

+ func NewToolCallEnd(id string) ToolCallEndEvent

+ type ToolCallFunction struct

+ Arguments string

+ Name string

+ type ToolCallResultEvent struct

+ Content string

+ MessageID string

+ Role string

+ ToolCallID string

+ func NewToolCallResult(messageID, toolCallID, content string) ToolCallResultEvent

+ type ToolCallStartEvent struct

+ ParentMessageID string

+ ToolCallID string

+ ToolCallName string

+ func NewToolCallStart(id, name, parentMessageID string) ToolCallStartEvent