agentapi

package

Go to main page

Versions in this module

v0

v0.11.1

Sep 27, 2026

v0.11.0

Sep 27, 2026

Changes in this version

+ const SteerAccepted

+ const SteerNotDelivered

+ var ErrItemNotFound = errors.New("recorded item not found")

+ type FileDeclaration struct

+ ArtifactID string

+ Path string

+ Title string

+ TypeHint string

+ type HistoryPager interface

+ ReadHistoryWindow func(ctx context.Context, req WindowRequest) (HistoryWindow, error)

+ type HistoryWindow struct

+ At int

+ Items []Item

+ Next string

+ Start bool

type Item

+ Clipped bool

+ SteerStatus string

type OpenRequest

+ ValidateFile func(context.Context, string) (string, error)

type Subagent

+ Result string

+ type SubagentPager interface

+ ReadSubagents func(ctx context.Context, req SubagentRequest) (SubagentWindow, error)

+ type SubagentRequest struct

+ AgentID string

+ Before int

+ type SubagentSummarizer interface

+ SummarizeSubagent func(context.Context, SubagentSummaryRequest) (string, error)

+ type SubagentSummaryRequest struct

+ Description string

+ Model string

+ Result string

+ Workdir string

+ type SubagentWindow struct

+ Start bool

+ Subagents []Subagent

type ToolCall

+ Declaration *FileDeclaration

+ type WindowRequest struct

+ After int

+ AgentID string

+ Before int

+ ItemID string

v0.11.0-beta.5

Sep 27, 2026

v0.11.0-beta.4

Sep 27, 2026

v0.11.0-beta.3

Sep 27, 2026

v0.11.0-beta.2

Sep 26, 2026

v0.11.0-beta.1

Sep 26, 2026

v0.10.8

Sep 25, 2026

v0.10.7

Sep 25, 2026

v0.10.6

Sep 25, 2026

Changes in this version

type Item

+ EndedAt time.Time

v0.10.5

Sep 25, 2026

v0.10.4

Sep 25, 2026

Changes in this version

+ const UploadsDir

type Attachment

+ NotNative bool

type Blob

+ Path string

v0.10.3

Sep 25, 2026

v0.10.2

Sep 25, 2026

v0.10.1

Sep 25, 2026

Changes in this version

type Interaction

+ Auto bool

v0.10.0

Sep 25, 2026

v0.9.0

Sep 24, 2026

Changes in this version

+ type CustomModel struct

+ APIKeyEnv string

+ BaseURL string

+ DisplayName string

+ ModelID string

+ Name string

+ WireAPI string

+ func (m CustomModel) SelectionID() string

+ type CustomModelUser interface

+ SetCustomModels func([]CustomModel)

v0.8.1

Sep 24, 2026

v0.8.0

Sep 24, 2026

Changes in this version

+ const CommandPrompt

+ const CommandSkill

+ const CostHigh

+ const CostLow

+ const CostMedium

+ const CostVeryHigh

+ const DeliveryAutopilot

+ const DeliverySteer

+ const ProviderCopilot

+ const ProviderOpenCode

+ var ErrBackgroundTaskInactive = errors.New("background shell task is not running")

+ var ErrBackgroundTaskNotFound = errors.New("background shell task not found")

+ var ErrBusy = errors.New("a turn is already running")

+ var ErrClosed = errors.New("conversation is closed")

+ var ErrConversationNotFound = errors.New("provider conversation not found")

+ var ErrInteractionGone = errors.New("interaction is no longer pending")

+ var ErrSubmissionUncertain = errors.New("prompt submission outcome is unknown")

+ var ErrUnsupported = errors.New("operation not supported by this provider")

+ type Answer struct

+ Answers [][]string

+ Auto bool

+ Decision string

+ Reject bool

+ type Attachment struct

+ ID string

+ MIME string

+ Name string

+ SHA256 string

+ Size int64

+ type AutopilotObjective struct

+ CompletionSummary string

+ CreditLimit *float64

+ CreditsUsed *float64

+ ID int64

+ Objective string

+ PauseReason string

+ Status string

+ TurnCount int64

+ type BackgroundTask struct

+ Command string

+ Description string

+ EndedAt time.Time

+ ID string

+ StartedAt time.Time

+ Status string

+ type BackgroundTaskController interface

+ CancelBackgroundTask func(context.Context, string) (BackgroundTasks, error)

+ type BackgroundTasks struct

+ Known bool

+ Tasks []BackgroundTask

+ type Blob struct

+ Data []byte

+ MIME string

+ Name string

+ type Capabilities struct

+ Cancel bool

+ ContextSize bool

+ ExecutionModes bool

+ History bool

+ Import bool

+ Permissions bool

+ Questions bool

+ SessionDiff bool

+ Titles bool

+ Usage bool

+ type Command struct

+ Aliases []string

+ AllowDuringTurn bool

+ Description string

+ DisabledReason string

+ InputChoices []CommandOption

+ InputHint string

+ InputRequired bool

+ Kind string

+ Name string

+ type CommandExecutor interface

+ ExecuteCommand func(context.Context, string, Prompt) (*CommandResult, error)

+ type CommandOption struct

+ Description string

+ Group string

+ Name string

+ type CommandResult struct

+ Action string

+ Command string

+ Kind string

+ Markdown bool

+ Options []CommandOption

+ PrefillInput string

+ Text string

+ Title string

+ type Context struct

+ Cached int64

+ Limit int64

+ Prompt int64

+ Used int64

+ type ContextSize struct

+ ID string

+ Tokens int64

+ type Conversation interface

+ Cancel func(ctx context.Context) error

+ CancelSubagent func(ctx context.Context, agentID string) error

+ Close func(ctx context.Context) error

+ Commands func(ctx context.Context) ([]Command, error)

+ Diff func(ctx context.Context) ([]FileDiff, error)

+ History func(ctx context.Context) (History, error)

+ ID func() string

+ PromptSubagent func(ctx context.Context, agentID, text string) error

+ Respond func(ctx context.Context, interactionID string, answer Answer) error

+ RunCommand func(ctx context.Context, name string, args Prompt) error

+ Send func(ctx context.Context, prompt Prompt) error

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

+ SetTitle func(ctx context.Context, title string) error

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

+ type Delta struct

+ AgentID string

+ ItemID string

+ Kind ItemKind

+ Text string

+ type Event struct

+ BackgroundTasks *BackgroundTasks

+ Context *Context

+ Delta *Delta

+ Error string

+ Execution *ExecutionState

+ Interaction *Interaction

+ Item *Item

+ Kind EventKind

+ Subagent *Subagent

+ Title string

+ Turn *Turn

+ Usage *Usage

+ type EventKind string

+ const EventBackgroundTasks

+ const EventContext

+ const EventDelta

+ const EventExecution

+ const EventExit

+ const EventInteraction

+ const EventItem

+ const EventSubagent

+ const EventTitle

+ const EventTurn

+ const EventUsage

+ type EventSink interface

+ Emit func(Event)

+ type ExecutionState struct

+ Known bool

+ Mode string

+ Objective *AutopilotObjective

+ type File struct

+ Dir bool

+ Path string

+ Rel string

+ type FileDiff struct

+ Additions int

+ After string

+ Before string

+ Deletions int

+ Patch string

+ Path string

+ Status string

+ type History struct

+ Items []Item

+ Model string

+ Subagents []Subagent

+ Truncated bool

+ Usage *Usage

+ type HistoryReader interface

+ ReadHistory func(ctx context.Context, req ReadRequest) (History, error)

+ type Image struct

+ Data []byte

+ ID string

+ MIME string

+ Name string

+ SHA256 string

+ Size int64

+ type Importer interface

+ InUse func(ctx context.Context, ids []string) ([]string, error)

+ Previous func(ctx context.Context, workdir string) ([]PreviousConversation, error)

+ type Interaction struct

+ AgentID string

+ Detail string

+ ID string

+ Kind InteractionKind

+ Options []Option

+ Questions []Question

+ Resolution string

+ State InteractionState

+ Time time.Time

+ Title string

+ ToolCallID string

+ type InteractionKind string

+ const InteractionPermission

+ const InteractionQuestion

+ type InteractionState string

+ const InteractionAnswered

+ const InteractionExpired

+ const InteractionPending

+ const InteractionRejected

+ type Item struct

+ AgentID string

+ Attachments []Attachment

+ Delivery string

+ ID string

+ Images []Image

+ ImagesNote string

+ Kind ItemKind

+ Text string

+ Time time.Time

+ Tool *ToolCall

+ type ItemKind string

+ const ItemAssistant

+ const ItemNotice

+ const ItemReasoning

+ const ItemTool

+ const ItemUser

+ type Media struct

+ Images bool

+ MaxImages int

+ PDF bool

+ Types []string

+ type Model struct

+ ContextSizes []ContextSize

+ CostTier string

+ DiscountPercent int

+ Efforts []string

+ ID string

+ Media *Media

+ Name string

+ Prices *Prices

+ type OpenRequest struct

+ ContextSize string

+ ConversationID string

+ Effort string

+ Events EventSink

+ Model string

+ SessionID string

+ Title string

+ Workdir string

+ type Option struct

+ AllowOnce bool

+ ID string

+ Label string

+ Reject bool

+ type PreviousConversation struct

+ CreatedAt time.Time

+ ID string

+ Title string

+ UpdatedAt time.Time

+ Workdir string

+ type Prices struct

+ BatchSize int64

+ LongContext *TierPrices

+ type Prompt struct

+ Attachments []Blob

+ Files []File

+ Text string

+ type Provider interface

+ Capabilities func() Capabilities

+ Check func(ctx context.Context) error

+ DisplayName func() string

+ Models func(ctx context.Context) ([]Model, error)

+ Name func() string

+ Open func(ctx context.Context, req OpenRequest) (Conversation, error)

+ Shutdown func(ctx context.Context) error

+ type Question struct

+ Choices []string

+ Custom bool

+ Header string

+ Multiple bool

+ Text string

+ type Quota struct

+ Entitlement int64

+ Overage float64

+ RemainingPercent float64

+ ResetAt time.Time

+ Type string

+ Unlimited bool

+ Used int64

+ type QuotaReporter interface

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

+ type ReadRequest struct

+ ConversationID string

+ Workdir string

+ type Subagent struct

+ Description string

+ Effort string

+ EndedAt time.Time

+ Error string

+ ID string

+ Model string

+ Name string

+ ParentToolCallID string

+ StartedAt time.Time

+ Status SubagentStatus

+ type SubagentStatus string

+ const SubagentCancelled

+ const SubagentCompleted

+ const SubagentFailed

+ const SubagentIdle

+ const SubagentRunning

+ func (s SubagentStatus) Terminal() bool

+ type TierPrices struct

+ CacheRead *float64

+ CacheWrite *float64

+ Input *float64

+ MaxPromptTokens int64

+ Output *float64

+ type TitleRequest struct

+ Model string

+ Text string

+ Workdir string

+ type Titler interface

+ Title func(ctx context.Context, req TitleRequest) (string, error)

+ type ToolCall struct

+ Input string

+ Name string

+ Output string

+ Status ToolStatus

+ Title string

+ type ToolStatus string

+ const ToolCompleted

+ const ToolFailed

+ const ToolPending

+ const ToolRunning

+ type Turn struct

+ Error string

+ Model string

+ State TurnState

+ type TurnState string

+ const TurnCancelled

+ const TurnCompleted

+ const TurnFailed

+ const TurnWorking

+ type Usage struct

+ AIUnits float64

v0.8.0-beta.1

Sep 24, 2026

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