agentsdk

package module

Go to main page

Versions in this module

v0

v0.4.0-rc.18

Jul 11, 2026

v0.4.0-rc.17

Jul 11, 2026

v0.4.0-rc.16

Jul 11, 2026

v0.4.0-rc.15

Jul 10, 2026

v0.4.0-rc.14

Jul 8, 2026

v0.4.0-rc.13

Jul 8, 2026

v0.4.0-rc.12

Jul 8, 2026

v0.4.0-rc.11

Jul 8, 2026

v0.4.0-rc.10

Jul 8, 2026

v0.4.0-rc.9

Jul 7, 2026

v0.4.0-rc.8

Jul 6, 2026

v0.4.0-rc.7

Jul 6, 2026

v0.4.0-rc.6

Jul 3, 2026

v0.4.0-rc.5

Jul 3, 2026

v0.4.0-rc.4

Jul 2, 2026

v0.4.0-rc.2

Jul 1, 2026

v0.4.0-rc.1

Jun 29, 2026

v0.3.1-rc.6

Jun 25, 2026

v0.3.1-rc.5

Jun 24, 2026

v0.3.1-rc.4

Jun 23, 2026

v0.3.1-rc.3

Jun 23, 2026

v0.3.1-rc.2

Jun 17, 2026

v0.3.1-rc.1

Jun 14, 2026

v0.3.0

Jun 13, 2026

Changes in this version

+ const HTMXVersion

+ const MaxBufferedResponseBytes

+ var Assets = struct{ ... }

+ var ErrOutputTooLarge = errors.New(...)

+ func RequestJSON[T any](ctx context.Context, h *ConnectionHandle, opts RequestOpts) (T, error)

type Agent

+ func (a *Agent) Logger(ctx context.Context) *zap.Logger

+ func (a *Agent) OpenFileRange(ctx context.Context, path string, start, end int64) (io.ReadCloser, error)

+ func (a *Agent) ReadRange(ctx context.Context, path string, start, end int64) ([]byte, error)

+ func (a *Agent) RegisterExecEndpoint(e *ExecEndpoint) *ExecHandle

+ func (a *Agent) Seal(ctx context.Context, plaintext string) (string, error)

+ func (a *Agent) Unseal(ctx context.Context, sealed string) (string, error)

+ type Capabilities struct

+ Embedding bool

+ Image bool

+ Search bool

+ Speech bool

+ Transcription bool

+ Vision bool

type Config

+ Emoji string

type Connection

+ AuthParams map[string]string

+ Headers map[string]string

type ConnectionDef

+ AuthParams map[string]string

+ Headers map[string]string

type ConnectionHandle

+ func (h *ConnectionHandle) RequestStream(ctx context.Context, opts RequestOpts) (*ConnectionResponse, error)

+ type ConnectionResponse struct

+ Body io.ReadCloser

+ Headers http.Header

+ StatusCode int

+ type DirPath string

type Directory

+ Scope DirectoryScope

type DirectoryDef

+ Scope DirectoryScope

type DirectoryOpts

+ Scope DirectoryScope

+ type DirectoryScope string

+ const ScopeConv

+ const ScopeNone

+ const ScopeRun

+ const ScopeUser

+ type EnvVarValueResponse struct

+ Value string

+ type ExecCommand struct

+ Args []string

+ Command string

+ Stdin []byte

+ Timeout time.Duration

+ type ExecEndpoint struct

+ Access Access

+ Description string

+ LLMHint string

+ Slug string

+ type ExecEndpointDef struct

+ Access Access

+ Description string

+ LLMHint string

+ type ExecError struct

+ Kind string

+ Message string

+ func (e *ExecError) Error() string

+ type ExecExit struct

+ DurationMs int64

+ ExitCode int

+ type ExecHandle struct

+ func (h *ExecHandle) Run(ctx context.Context, cmd ExecCommand) (ExecResult, error)

+ func (h *ExecHandle) RunStream(ctx context.Context, cmd ExecCommand) (*ExecStream, error)

+ func (h *ExecHandle) Slug() string

+ type ExecRequest struct

+ Args []string

+ Command string

+ StdinB64 string

+ TimeoutMs int64

+ type ExecResult struct

+ DurationMs int64

+ ExitCode int

+ Stderr []byte

+ Stdout []byte

+ type ExecStream struct

+ Stderr io.ReadCloser

+ Stdout io.ReadCloser

+ Wait func() (ExecExit, error)

+ type FilePath string

type HTTPRequest

+ AllHeaders bool

type HTTPResponse

+ BodyPreview string

type LogLevel

+ const LogLevelDebug

type MCPAuthStatus

+ Instructions string

type MCPContent

+ Data string

+ MimeType string

+ Name string

+ URI string

+ type PromptData struct

+ AgentDashboardURL string

+ AgentRouteURL string

+ Capabilities Capabilities

+ Siblings []SiblingInfo

+ SupportedModalities []string

type PromptInput

+ AutoConfirm bool

+ DirectTools bool

+ Platform string

+ UserDisplayName string

+ UserEmail string

+ VisibleSiblings []uuid.UUID

type ProxyRequest

+ Headers map[string]string

+ type RequestOpts struct

+ Body any

+ Headers map[string]string

+ Method string

+ Path string

+ type SealRequest struct

+ Plaintext string

+ type SealResponse struct

+ Sealed string

+ type SessionCompactRequest struct

+ Summary []session.Message

+ TokensFreed int

+ type SiblingHandle struct

+ func (h *SiblingHandle) CallTool(ctx context.Context, callerRunID, toolName string, args any) (any, error)

+ type SiblingInfo struct

+ Description string

+ ID uuid.UUID

+ Name string

+ Slug string

+ Tools []MCPToolSchema

type SyncRequest

+ Emoji string

type SyncResponse

+ PromptData PromptData

+ type UnsealRequest struct

+ Sealed string

+ type UnsealResponse struct

+ Plaintext string

v0.2.4

May 7, 2026

Changes in this version

type SyncResponse

+ SystemPromptPublic string

+ SystemPromptUser string

v0.2.3

May 7, 2026

Changes in this version

+ func IsLikelySecret(v string) bool

type Agent

+ func (a *Agent) RegisterEnvVar(e *EnvVar) *EnvVarHandle

type AuthInjectionType

+ const AuthInjectQueryParam

+ type EnvVar struct

+ Default string

+ Description string

+ Pattern string

+ Secret bool

+ Slug string

+ type EnvVarDef struct

+ Default string

+ Description string

+ Pattern string

+ Secret bool

+ Slug string

+ type EnvVarHandle struct

+ func (h *EnvVarHandle) Get(ctx context.Context) (string, error)

+ func (h *EnvVarHandle) IsSecret() bool

+ func (h *EnvVarHandle) Refresh()

+ func (h *EnvVarHandle) Slug() string

type MCP

+ AuthInjection AuthInjection

type MCPDef

+ AuthInjection AuthInjection

type SyncRequest

+ EnvVars []EnvVarDef

v0.2.3-rc.2

May 7, 2026

v0.2.3-rc.1

May 7, 2026

v0.2.3-rc.0

May 6, 2026

v0.2.2

May 5, 2026

v0.2.1

May 5, 2026

Changes in this version

type Agent

+ func (a *Agent) ShareFileURL(ctx context.Context, path string, ttl time.Duration) (*ShareFileResponse, error)

+ func (a *Agent) SyncDown(ctx context.Context, prefix, localDir string) error

+ func (a *Agent) SyncUp(ctx context.Context, localDir, prefix string) error

+ type AuthInjectionType string

+ const AuthInjectAPIKey

+ const AuthInjectBearer

+ const AuthInjectPathPrefix

type Directory

+ LLMHint string

+ RetentionHours int

type DirectoryDef

+ LLMHint string

+ RetentionHours int

type DirectoryOpts

+ LLMHint string

+ RetentionHours int

+ type ShareFileRequest struct

+ ExpiresSeconds int64

+ Path string

+ type ShareFileResponse struct

+ ExpiresAtMs int64

+ URL string

type Tool

+ LLMHint string

type ToolDef

+ LLMHint string

type Topic

+ LLMHint string

type TopicDef

+ LLMHint string

v0.2.1-rc.2

May 5, 2026

v0.2.1-rc.1

May 4, 2026

v0.2.1-rc.0

May 2, 2026

v0.2.0

Apr 30, 2026

Changes in this version

+ var ErrInvalidPath = errors.New("agentsdk: invalid path")

+ var ErrNotFound = errors.New("agentsdk: file not found")

+ func WithCaller(ctx context.Context, c Caller) context.Context

type Agent

+ func (a *Agent) CheckFileAccess(ctx context.Context, path string, op FileOp) error

+ func (a *Agent) CopyFile(ctx context.Context, src, dst string) error

+ func (a *Agent) DeleteFile(ctx context.Context, path string) error

+ func (a *Agent) ListDir(ctx context.Context, path string, opts ListOpts) ([]FileInfo, error)

+ func (a *Agent) OpenFile(ctx context.Context, path string) (io.ReadCloser, error)

+ func (a *Agent) ReadFile(ctx context.Context, path string) ([]byte, error)

+ func (a *Agent) RegisterDirectory(path string, opts DirectoryOpts)

+ func (a *Agent) StatFile(ctx context.Context, path string) (FileInfo, error)

+ func (a *Agent) WriteFile(ctx context.Context, path string, data io.Reader, contentType string) (FileInfo, error)

+ type Caller struct

+ Access Access

+ RunID string

+ UserID string

+ func CallerFrom(ctx context.Context) Caller

+ type Directory struct

+ Description string

+ List Access

+ Path string

+ Read Access

+ Write Access

+ type DirectoryDef struct

+ Description string

+ List Access

+ Path string

+ Read Access

+ Write Access

+ type DirectoryOpts struct

+ Description string

+ List Access

+ Read Access

+ Write Access

+ type FileInfo struct

+ ContentType string

+ Filename string

+ LastModified time.Time

+ Path string

+ Size int64

+ type FileOp string

+ const OpList

+ const OpRead

+ const OpWrite

+ type ListOpts struct

+ Recursive bool

type SyncRequest

+ Directories []DirectoryDef

v0.1.2

Apr 29, 2026

v0.1.1

Apr 29, 2026

Changes in this version

+ const ErrorKindAgent

+ const ErrorKindPlatform

+ const Version

+ func GetDeps[T any](ctx context.Context) T

+ func IsValidatingMigrations() bool

+ func ResolveDisplayPart(p *DisplayPart)

+ type Access string

+ const AccessAdmin

+ const AccessInternal

+ const AccessPublic

+ const AccessUser

+ type Action struct

+ DurationMs int64

+ Error string

+ Request any

+ Response any

+ Timestamp time.Time

+ Type string

+ type Agent struct

+ Deps any

+ func AgentFromContext(ctx context.Context) *Agent

+ func AgentFromMigrationContext(ctx context.Context) *Agent

+ func New(cfg Config) *Agent

+ func (a *Agent) AddExtraPrompt(p *ExtraPrompt)

+ func (a *Agent) AddSensitive(values ...string)

+ func (a *Agent) Attachment(ctx context.Context, fileID string) (io.ReadCloser, error)

+ func (a *Agent) DB() *AgentDB

+ func (a *Agent) EmbeddingModel(ctx context.Context, slug string, opts ModelOpts) model.EmbeddingModel

+ func (a *Agent) ImageModel(ctx context.Context, slug string, opts ModelOpts) model.ImageModel

+ func (a *Agent) LLM(ctx context.Context, slug string, opts ModelOpts) stream.Model

+ func (a *Agent) Log(ctx context.Context, level LogLevel, msg string)

+ func (a *Agent) Logf(ctx context.Context, level LogLevel, format string, args ...any)

+ func (a *Agent) RegisterConnection(c *Connection) *ConnectionHandle

+ func (a *Agent) RegisterCron(c *Cron)

+ func (a *Agent) RegisterMCP(m *MCP) *MCPHandle

+ func (a *Agent) RegisterModel(slot *ModelSlot)

+ func (a *Agent) RegisterRoute(r *Route)

+ func (a *Agent) RegisterStorage(s *Storage) *StorageHandle

+ func (a *Agent) RegisterTool(def AnyTool)

+ func (a *Agent) RegisterTopic(t *Topic) *TopicHandle

+ func (a *Agent) RegisterWebhook(w *Webhook)

+ func (a *Agent) Serve()

+ func (a *Agent) SpeechModel(ctx context.Context, slug string, opts ModelOpts) model.SpeechModel

+ func (a *Agent) TranscriptionModel(ctx context.Context, slug string, opts ModelOpts) model.TranscriptionModel

+ type AgentDB struct

+ func (a *AgentDB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*AgentTx, error)

+ func (a *AgentDB) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)

+ func (a *AgentDB) PingContext(ctx context.Context) error

+ func (a *AgentDB) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)

+ func (a *AgentDB) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ func (a *AgentDB) QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row

+ func (a *AgentDB) Underlying() *sql.DB

+ type AgentTx struct

+ func (a *AgentTx) Commit() error

+ func (a *AgentTx) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)

+ func (a *AgentTx) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)

+ func (a *AgentTx) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ func (a *AgentTx) QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row

+ func (a *AgentTx) Rollback() error

+ func (a *AgentTx) Underlying() *sql.Tx

+ type AnyTool interface

+ type AuthInjection struct

+ Name string

+ Type string

+ type AuthRequiredError struct

+ AuthURL string

+ ConnName string

+ Slug string

+ func IsAuthRequired(err error) (*AuthRequiredError, bool)

+ func (e *AuthRequiredError) Error() string

+ type Config struct

+ Description string

+ type Connection struct

+ Access Access

+ AuthInjection AuthInjection

+ AuthMode ConnectionAuth

+ AuthURL string

+ BaseURL string

+ Description string

+ LLMHint string

+ Name string

+ Scopes []string

+ SetupInstructions string

+ Slug string

+ TokenURL string

+ type ConnectionAuth string

+ const ConnectionAuthNone

+ const ConnectionAuthOAuth

+ const ConnectionAuthToken

+ type ConnectionDef struct

+ Access Access

+ AuthInjection AuthInjection

+ AuthMode ConnectionAuth

+ AuthURL string

+ BaseURL string

+ Description string

+ LLMHint string

+ Name string

+ Scopes []string

+ SetupInstructions string

+ TokenURL string

+ type ConnectionHandle struct

+ func (h *ConnectionHandle) Request(ctx context.Context, method, path string, body any) ([]byte, error)

+ type ConversationVM struct

+ type ConversationVMConfig struct

+ GCSweepInterval time.Duration

+ IdleTimeout time.Duration

+ MaxStoreSize int64

+ func DefaultConversationVMConfig() ConversationVMConfig

+ type CreateRunRequest struct

+ TriggerRef string

+ TriggerType string

+ type CreateRunResponse struct

+ RunID string

+ type Cron struct

+ Description string

+ Handler CronHandlerFunc

+ Name string

+ Schedule string

+ Timeout time.Duration

+ type CronDef struct

+ Description string

+ Name string

+ Schedule string

+ TimeoutMs int64

+ type CronHandlerFunc func(ctx context.Context, ew *EventWriter) error

+ type DisplayPart struct

+ Alt string

+ Data []byte

+ Duration float64

+ Filename string

+ MimeType string

+ Source string

+ Text string

+ Type string

+ URL string

+ type EventWriter struct

+ func (ew *EventWriter) WriteError(err error) error

+ func (ew *EventWriter) WriteEvent(event stream.Event) error

+ func (ew *EventWriter) WriteProgress(message string) error

+ type ExtraPrompt struct

+ Access []Access

+ Text string

+ type ExtraPromptDef struct

+ Access []Access

+ Text string

+ type FileRef struct

+ ContentType string

+ Filename string

+ ID string

+ Size int64

+ type HTTPRequest struct

+ Body string

+ Headers map[string]string

+ Method string

+ Raw bool

+ SaveAs string

+ Timeout int

+ URL string

+ type HTTPResponse struct

+ Body string

+ ContentType string

+ Headers map[string]string

+ Note string

+ SavedTo string

+ Size int

+ Status int

+ type HTTPSessionStore struct

+ func NewHTTPSessionStore(client *airlockClient, convID, runID, source string) *HTTPSessionStore

+ func (s *HTTPSessionStore) Append(ctx context.Context, msgs []session.Message) error

+ func (s *HTTPSessionStore) Compact(ctx context.Context, summary []session.Message, tokensFreed int) error

+ func (s *HTTPSessionStore) Load(ctx context.Context) ([]session.Message, error)

+ type LLMProxyRequest struct

+ Capability string

+ Options json.RawMessage

+ Slug string

+ type LogEntry struct

+ Level LogLevel

+ Message string

+ type LogLevel string

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ type MCP struct

+ Access Access

+ AuthMode MCPAuth

+ AuthURL string

+ Name string

+ Scopes []string

+ Slug string

+ TokenURL string

+ URL string

+ type MCPAuth string

+ const MCPAuthNone

+ const MCPAuthOAuth

+ const MCPAuthOAuthDiscovery

+ const MCPAuthToken

+ type MCPAuthStatus struct

+ AuthMode MCPAuth

+ AuthURL string

+ Authorized bool

+ Slug string

+ type MCPContent struct

+ Text string

+ Type string

+ type MCPDef struct

+ Access Access

+ AuthMode MCPAuth

+ AuthURL string

+ Name string

+ Scopes []string

+ Slug string

+ TokenURL string

+ URL string

+ type MCPHandle struct

+ func (h *MCPHandle) CallTool(ctx context.Context, toolName string, args any) (*MCPToolCallResponse, error)

+ type MCPToolCallRequest struct

+ Arguments json.RawMessage

+ Tool string

+ type MCPToolCallResponse struct

+ Content []MCPContent

+ IsError bool

+ type MCPToolSchema struct

+ Description string

+ InputSchema json.RawMessage

+ Name string

+ ServerSlug string

+ type MockAirlock struct

+ LLMResponse []byte

+ Server *httptest.Server

+ func NewMockAirlock() (*MockAirlock, string)

+ func (m *MockAirlock) Close()

+ func (m *MockAirlock) Requests() []MockRequest

+ func (m *MockAirlock) RequestsByPath(prefix string) []MockRequest

+ func (m *MockAirlock) Reset()

+ type MockRequest struct

+ Body []byte

+ Method string

+ Path string

+ type ModelCapability string

+ const CapEmbedding

+ const CapImage

+ const CapSpeech

+ const CapText

+ const CapTranscription

+ const CapVision

+ type ModelOpts struct

+ Capability ModelCapability

+ Description string

+ type ModelProxyRequest struct

+ Capability string

+ Options json.RawMessage

+ Slug string

+ type ModelSlot struct

+ Capability ModelCapability

+ Description string

+ Slug string

+ type ModelSlotDef struct

+ Capability string

+ Description string

+ Slug string

+ type PrintRequest struct

+ ConversationID string

+ Parts []DisplayPart

+ RunID string

+ Topic string

+ type PromptInput struct

+ Approved *bool

+ CallerAccess Access

+ ConversationID string

+ ExtraSystemPrompt string

+ Files []FileRef

+ ForceCompact bool

+ MaxOutputTokens *int

+ Message string

+ Messages []message.Message

+ ModelID string

+ ProviderID string

+ ProviderOptions json.RawMessage

+ ResumeRunID string

+ Source string

+ SupportedModalities []string

+ Temperature *float64

+ type ProxyRequest struct

+ Body string

+ Method string

+ Path string

+ type Route struct

+ Access Access

+ Description string

+ Handler RouteHandlerFunc

+ Method string

+ Path string

+ type RouteDef struct

+ Access Access

+ Description string

+ Method string

+ Path string

+ type RouteHandlerFunc func(ctx context.Context, w http.ResponseWriter, r *http.Request)

+ type RunCompleteRequest struct

+ Actions json.RawMessage

+ Checkpoint json.RawMessage

+ Error string

+ ErrorKind string

+ Logs []LogEntry

+ PanicTrace string

+ RunID string

+ Status string

+ type Storage struct

+ Description string

+ Read Access

+ Slug string

+ Write Access

+ type StorageDef struct

+ Description string

+ Read Access

+ Slug string

+ Write Access

+ type StorageHandle struct

+ func (h *StorageHandle) Copy(ctx context.Context, src, dst string) error

+ func (h *StorageHandle) CopyTo(ctx context.Context, src string, dstZone *StorageHandle, dst string) error

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

+ func (h *StorageHandle) Get(ctx context.Context, key string) (io.ReadCloser, error)

+ func (h *StorageHandle) List(ctx context.Context, prefix string) ([]StoredFile, error)

+ func (h *StorageHandle) Put(ctx context.Context, key string, data io.Reader, contentType string) error

+ func (h *StorageHandle) ReadAccess() Access

+ func (h *StorageHandle) Ref(key string) StorageRef

+ func (h *StorageHandle) Slug() string

+ func (h *StorageHandle) Stat(ctx context.Context, key string) (StoredFile, error)

+ func (h *StorageHandle) URL(key string) string

+ func (h *StorageHandle) WriteAccess() Access

+ type StorageRef struct

+ func (r *StorageRef) UnmarshalJSON(data []byte) error

+ func (r StorageRef) Key() string

+ func (r StorageRef) MarshalJSON() ([]byte, error)

+ func (r StorageRef) String() string

+ func (r StorageRef) Zone() string

+ type StoredFile struct

+ ContentType string

+ Key string

+ LastModified time.Time

+ Size int64

+ type SyncRequest struct

+ Crons []CronDef

+ Description string

+ ExtraPrompts []ExtraPromptDef

+ MCPServers []MCPDef

+ ModelSlots []ModelSlotDef

+ Routes []RouteDef

+ Storages []StorageDef

+ Tools []ToolDef

+ Topics []TopicDef

+ Version string

+ Webhooks []WebhookDef

+ type SyncResponse struct

+ MCPAuthStatus []MCPAuthStatus

+ MCPSchemas map[string][]MCPToolSchema

+ PublicStorageBase string

+ SystemPrompt string

+ type Tool struct

+ Access Access

+ Description string

+ Execute func(ctx context.Context, input In) (Out, error)

+ InputExamples []In

+ Name string

+ type ToolDef struct

+ Access Access

+ Description string

+ InputExamples []json.RawMessage

+ InputSchema json.RawMessage

+ Name string

+ OutputSchema json.RawMessage

+ type Topic struct

+ Access Access

+ Description string

+ Slug string

+ type TopicDef struct

+ Access Access

+ Description string

+ Slug string

+ type TopicHandle struct

+ func (h *TopicHandle) Publish(ctx context.Context, parts []DisplayPart) error

+ type Webhook struct

+ Access Access

+ Description string

+ Handler WebhookHandlerFunc

+ Header string

+ Path string

+ Timeout time.Duration

+ Verify string

+ type WebhookDef struct

+ Description string

+ Header string

+ Path string

+ TimeoutMs int64

+ Verify string

+ type WebhookHandlerFunc func(ctx context.Context, data []byte, ew *EventWriter) error

v0.1.0

Apr 24, 2026

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