contract

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 27, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	HostAPIMethodSessionsList                = extensionprotocol.HostAPIMethodSessionsList
	HostAPIMethodSessionsCreate              = extensionprotocol.HostAPIMethodSessionsCreate
	HostAPIMethodSessionsPrompt              = extensionprotocol.HostAPIMethodSessionsPrompt
	HostAPIMethodSessionsStop                = extensionprotocol.HostAPIMethodSessionsStop
	HostAPIMethodSessionsStatus              = extensionprotocol.HostAPIMethodSessionsStatus
	HostAPIMethodSessionsEvents              = extensionprotocol.HostAPIMethodSessionsEvents
	HostAPIMethodSessionsSoulRefresh         = extensionprotocol.HostAPIMethodSessionsSoulRefresh
	HostAPIMethodSessionsHealthGet           = extensionprotocol.HostAPIMethodSessionsHealthGet
	HostAPIMethodSessionsStatusGet           = extensionprotocol.HostAPIMethodSessionsStatusGet
	HostAPIMethodSandboxList                 = extensionprotocol.HostAPIMethodSandboxList
	HostAPIMethodSandboxInfo                 = extensionprotocol.HostAPIMethodSandboxInfo
	HostAPIMethodSandboxExec                 = extensionprotocol.HostAPIMethodSandboxExec
	HostAPIMethodMemoryRecall                = extensionprotocol.HostAPIMethodMemoryRecall
	HostAPIMethodMemoryStore                 = extensionprotocol.HostAPIMethodMemoryStore
	HostAPIMethodMemoryForget                = extensionprotocol.HostAPIMethodMemoryForget
	HostAPIMethodObserveHealth               = extensionprotocol.HostAPIMethodObserveHealth
	HostAPIMethodListLogs                    = extensionprotocol.HostAPIMethodListLogs
	HostAPIMethodSkillsList                  = extensionprotocol.HostAPIMethodSkillsList
	HostAPIMethodModelsList                  = extensionprotocol.HostAPIMethodModelsList
	HostAPIMethodModelsRefresh               = extensionprotocol.HostAPIMethodModelsRefresh
	HostAPIMethodModelsStatus                = extensionprotocol.HostAPIMethodModelsStatus
	HostAPIMethodAgentsSoulGet               = extensionprotocol.HostAPIMethodAgentsSoulGet
	HostAPIMethodAgentsSoulValidate          = extensionprotocol.HostAPIMethodAgentsSoulValidate
	HostAPIMethodAgentsSoulPut               = extensionprotocol.HostAPIMethodAgentsSoulPut
	HostAPIMethodAgentsSoulDelete            = extensionprotocol.HostAPIMethodAgentsSoulDelete
	HostAPIMethodAgentsSoulHistory           = extensionprotocol.HostAPIMethodAgentsSoulHistory
	HostAPIMethodAgentsSoulRollback          = extensionprotocol.HostAPIMethodAgentsSoulRollback
	HostAPIMethodAgentsHeartbeatGet          = extensionprotocol.HostAPIMethodAgentsHeartbeatGet
	HostAPIMethodAgentsHeartbeatValidate     = extensionprotocol.HostAPIMethodAgentsHeartbeatValidate
	HostAPIMethodAgentsHeartbeatPut          = extensionprotocol.HostAPIMethodAgentsHeartbeatPut
	HostAPIMethodAgentsHeartbeatDelete       = extensionprotocol.HostAPIMethodAgentsHeartbeatDelete
	HostAPIMethodAgentsHeartbeatHistory      = extensionprotocol.HostAPIMethodAgentsHeartbeatHistory
	HostAPIMethodAgentsHeartbeatRollback     = extensionprotocol.HostAPIMethodAgentsHeartbeatRollback
	HostAPIMethodAgentsHeartbeatStatus       = extensionprotocol.HostAPIMethodAgentsHeartbeatStatus
	HostAPIMethodAgentsHeartbeatWake         = extensionprotocol.HostAPIMethodAgentsHeartbeatWake
	HostAPIMethodAutomationJobs              = extensionprotocol.HostAPIMethodAutomationJobs
	HostAPIMethodAutomationJobsGet           = extensionprotocol.HostAPIMethodAutomationJobsGet
	HostAPIMethodAutomationJobsCreate        = extensionprotocol.HostAPIMethodAutomationJobsCreate
	HostAPIMethodAutomationJobsUpdate        = extensionprotocol.HostAPIMethodAutomationJobsUpdate
	HostAPIMethodAutomationJobsDelete        = extensionprotocol.HostAPIMethodAutomationJobsDelete
	HostAPIMethodAutomationJobsTrigger       = extensionprotocol.HostAPIMethodAutomationJobsTrigger
	HostAPIMethodAutomationJobsRuns          = extensionprotocol.HostAPIMethodAutomationJobsRuns
	HostAPIMethodAutomationTriggers          = extensionprotocol.HostAPIMethodAutomationTriggers
	HostAPIMethodAutomationTriggersGet       = extensionprotocol.HostAPIMethodAutomationTriggersGet
	HostAPIMethodAutomationTriggersCreate    = extensionprotocol.HostAPIMethodAutomationTriggersCreate
	HostAPIMethodAutomationTriggersUpdate    = extensionprotocol.HostAPIMethodAutomationTriggersUpdate
	HostAPIMethodAutomationTriggersDelete    = extensionprotocol.HostAPIMethodAutomationTriggersDelete
	HostAPIMethodAutomationTriggersRuns      = extensionprotocol.HostAPIMethodAutomationTriggersRuns
	HostAPIMethodAutomationTriggersFire      = extensionprotocol.HostAPIMethodAutomationTriggersFire
	HostAPIMethodAutomationRuns              = extensionprotocol.HostAPIMethodAutomationRuns
	HostAPIMethodTasks                       = extensionprotocol.HostAPIMethodTasks
	HostAPIMethodTasksGet                    = extensionprotocol.HostAPIMethodTasksGet
	HostAPIMethodTasksTimeline               = extensionprotocol.HostAPIMethodTasksTimeline
	HostAPIMethodTasksTree                   = extensionprotocol.HostAPIMethodTasksTree
	HostAPIMethodTasksDashboard              = extensionprotocol.HostAPIMethodTasksDashboard
	HostAPIMethodTasksInbox                  = extensionprotocol.HostAPIMethodTasksInbox
	HostAPIMethodTasksCreate                 = extensionprotocol.HostAPIMethodTasksCreate
	HostAPIMethodTasksUpdate                 = extensionprotocol.HostAPIMethodTasksUpdate
	HostAPIMethodTasksCancel                 = extensionprotocol.HostAPIMethodTasksCancel
	HostAPIMethodTasksRuns                   = extensionprotocol.HostAPIMethodTasksRuns
	HostAPIMethodTasksRunsGet                = extensionprotocol.HostAPIMethodTasksRunsGet
	HostAPIMethodTasksRunsEnqueue            = extensionprotocol.HostAPIMethodTasksRunsEnqueue
	HostAPIMethodTasksRunsClaim              = extensionprotocol.HostAPIMethodTasksRunsClaim
	HostAPIMethodTasksRunsStart              = extensionprotocol.HostAPIMethodTasksRunsStart
	HostAPIMethodTasksRunsAttachSession      = extensionprotocol.HostAPIMethodTasksRunsAttachSession
	HostAPIMethodTasksRunsComplete           = extensionprotocol.HostAPIMethodTasksRunsComplete
	HostAPIMethodTasksRunsFail               = extensionprotocol.HostAPIMethodTasksRunsFail
	HostAPIMethodTasksRunsCancel             = extensionprotocol.HostAPIMethodTasksRunsCancel
	HostAPIMethodNetworkStatus               = extensionprotocol.HostAPIMethodNetworkStatus
	HostAPIMethodNetworkChannels             = extensionprotocol.HostAPIMethodNetworkChannels
	HostAPIMethodNetworkPeers                = extensionprotocol.HostAPIMethodNetworkPeers
	HostAPIMethodNetworkThreads              = extensionprotocol.HostAPIMethodNetworkThreads
	HostAPIMethodNetworkThreadGet            = extensionprotocol.HostAPIMethodNetworkThreadGet
	HostAPIMethodNetworkThreadMessages       = extensionprotocol.HostAPIMethodNetworkThreadMessages
	HostAPIMethodNetworkDirects              = extensionprotocol.HostAPIMethodNetworkDirects
	HostAPIMethodNetworkDirectResolve        = extensionprotocol.HostAPIMethodNetworkDirectResolve
	HostAPIMethodNetworkDirectMessages       = extensionprotocol.HostAPIMethodNetworkDirectMessages
	HostAPIMethodNetworkWorkGet              = extensionprotocol.HostAPIMethodNetworkWorkGet
	HostAPIMethodNetworkSend                 = extensionprotocol.HostAPIMethodNetworkSend
	HostAPIMethodResourcesList               = extensionprotocol.HostAPIMethodResourcesList
	HostAPIMethodResourcesGet                = extensionprotocol.HostAPIMethodResourcesGet
	HostAPIMethodResourcesSnapshot           = extensionprotocol.HostAPIMethodResourcesSnapshot
	HostAPIMethodBridgesInstancesList        = extensionprotocol.HostAPIMethodBridgesInstancesList
	HostAPIMethodBridgesMessagesIngest       = extensionprotocol.HostAPIMethodBridgesMessagesIngest
	HostAPIMethodBridgesInstancesGet         = extensionprotocol.HostAPIMethodBridgesInstancesGet
	HostAPIMethodBridgesInstancesReportState = extensionprotocol.HostAPIMethodBridgesInstancesReportState
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentHeartbeatDeleteParams 

type AgentHeartbeatDeleteParams = apicontract.HeartbeatDeleteRequest

AgentHeartbeatDeleteParams deletes HEARTBEAT.md through managed authoring.

type AgentHeartbeatGetParams 

type AgentHeartbeatGetParams struct {
	WorkspaceID string `json:"workspace_id,omitempty"`
	AgentName   string `json:"agent_name"`
}

AgentHeartbeatGetParams identifies one workspace-visible Heartbeat policy.

type AgentHeartbeatHistoryParams 

type AgentHeartbeatHistoryParams = apicontract.HeartbeatHistoryRequest

AgentHeartbeatHistoryParams lists managed Heartbeat authoring revisions.

type AgentHeartbeatPutParams 

type AgentHeartbeatPutParams = apicontract.HeartbeatPutRequest

AgentHeartbeatPutParams creates or replaces HEARTBEAT.md through managed authoring.

type AgentHeartbeatRollbackParams 

type AgentHeartbeatRollbackParams = apicontract.HeartbeatRollbackRequest

AgentHeartbeatRollbackParams restores a prior Heartbeat revision or snapshot digest.

type AgentHeartbeatStatusParams 

type AgentHeartbeatStatusParams = apicontract.HeartbeatStatusRequest

AgentHeartbeatStatusParams composes Heartbeat policy, wake state, health, and wake audit.

type AgentHeartbeatValidateParams 

type AgentHeartbeatValidateParams = apicontract.HeartbeatValidateRequest

AgentHeartbeatValidateParams validates proposed HEARTBEAT.md content.

type AgentHeartbeatWakeParams 

type AgentHeartbeatWakeParams = apicontract.HeartbeatWakeRequest

AgentHeartbeatWakeParams requests one managed advisory wake decision.

type AgentSoulDeleteParams 

type AgentSoulDeleteParams = apicontract.AgentSoulDeleteRequest

AgentSoulDeleteParams deletes SOUL.md through managed authoring.

type AgentSoulGetParams 

type AgentSoulGetParams struct {
	WorkspaceID string `json:"workspace_id,omitempty"`
	AgentName   string `json:"agent_name"`
}

AgentSoulGetParams identifies one workspace-visible Soul read model.

type AgentSoulHistoryParams 

type AgentSoulHistoryParams = apicontract.AgentSoulHistoryRequest

AgentSoulHistoryParams lists managed Soul authoring revisions.

type AgentSoulPutParams 

type AgentSoulPutParams = apicontract.AgentSoulPutRequest

AgentSoulPutParams creates or replaces SOUL.md through managed authoring.

type AgentSoulRollbackParams 

type AgentSoulRollbackParams = apicontract.AgentSoulRollbackRequest

AgentSoulRollbackParams restores a prior managed Soul revision.

type AgentSoulValidateParams 

type AgentSoulValidateParams = apicontract.AgentSoulValidateRequest

AgentSoulValidateParams validates current or proposed SOUL.md content.

type AutomationJobCreateParams 

type AutomationJobCreateParams = apicontract.CreateJobRequest

AutomationJobCreateParams starts a new dynamic automation job.

type AutomationJobRunsParams 

type AutomationJobRunsParams struct {
	ID     string                  `json:"id"`
	Status automationpkg.RunStatus `json:"status,omitempty"`
	Limit  int                     `json:"limit,omitempty"`
}

AutomationJobRunsParams filters run history for one automation job.

type AutomationJobTriggerParams 

type AutomationJobTriggerParams struct {
	ID      string         `json:"id"`
	Payload map[string]any `json:"payload,omitempty"`
}

AutomationJobTriggerParams forces one immediate automation job run.

type AutomationJobUpdateParams 

type AutomationJobUpdateParams struct {
	ID string `json:"id"`
	apicontract.UpdateJobRequest
}

AutomationJobUpdateParams patches one automation job definition by id.

type AutomationJobsParams 

type AutomationJobsParams struct {
	Scope       automationpkg.Scope `json:"scope,omitempty"`
	WorkspaceID string              `json:"workspace_id,omitempty"`
	Enabled     *bool               `json:"enabled,omitempty"`
}

AutomationJobsParams filters visible automation jobs.

type AutomationRunsParams 

type AutomationRunsParams struct {
	JobID     string                  `json:"job_id,omitempty"`
	TriggerID string                  `json:"trigger_id,omitempty"`
	Status    automationpkg.RunStatus `json:"status,omitempty"`
	Limit     int                     `json:"limit,omitempty"`
}

AutomationRunsParams filters visible automation runs.

type AutomationTargetParams 

type AutomationTargetParams struct {
	ID string `json:"id"`
}

AutomationTargetParams identifies one automation resource by id.

type AutomationTriggerCreateParams 

type AutomationTriggerCreateParams = apicontract.CreateTriggerRequest

AutomationTriggerCreateParams starts a new dynamic automation trigger.

type AutomationTriggerFireParams 

type AutomationTriggerFireParams struct {
	Event       string              `json:"event"`
	Scope       automationpkg.Scope `json:"scope"`
	WorkspaceID string              `json:"workspace_id,omitempty"`
	Payload     map[string]any      `json:"payload,omitempty"`
}

AutomationTriggerFireParams injects one extension-originated trigger event.

type AutomationTriggerRunsParams 

type AutomationTriggerRunsParams struct {
	ID     string                  `json:"id"`
	Status automationpkg.RunStatus `json:"status,omitempty"`
	Limit  int                     `json:"limit,omitempty"`
}

AutomationTriggerRunsParams filters run history for one automation trigger.

type AutomationTriggerUpdateParams 

type AutomationTriggerUpdateParams struct {
	ID string `json:"id"`
	apicontract.UpdateTriggerRequest
}

AutomationTriggerUpdateParams patches one automation trigger definition by id.

type AutomationTriggersParams 

type AutomationTriggersParams struct {
	Scope       automationpkg.Scope `json:"scope,omitempty"`
	WorkspaceID string              `json:"workspace_id,omitempty"`
	Event       string              `json:"event,omitempty"`
	Enabled     *bool               `json:"enabled,omitempty"`
}

AutomationTriggersParams filters visible automation triggers.

type BridgeInstanceTargetParams 

type BridgeInstanceTargetParams struct {
	BridgeInstanceID string `json:"bridge_instance_id"`
}

BridgeInstanceTargetParams identifies one provider-owned bridge instance.

type BridgesInstancesReportStateParams 

type BridgesInstancesReportStateParams struct {
	BridgeInstanceID string                       `json:"bridge_instance_id"`
	Status           bridgepkg.BridgeStatus       `json:"status"`
	Degradation      *bridgepkg.BridgeDegradation `json:"degradation,omitempty"`
	ClearDegradation bool                         `json:"clear_degradation,omitempty"`
}

BridgesInstancesReportStateParams reports one adapter-observed instance status update.

type BridgesMessagesIngestParams 

type BridgesMessagesIngestParams = bridgepkg.InboundMessageEnvelope

BridgesMessagesIngestParams carries one normalized inbound bridge message.

type BridgesMessagesIngestResult 

type BridgesMessagesIngestResult struct {
	SessionID    string               `json:"session_id"`
	RouteCreated bool                 `json:"route_created"`
	RoutingKey   bridgepkg.RoutingKey `json:"routing_key"`
}

BridgesMessagesIngestResult reports the resolved session association for one inbound message.

type EmptyResult 

type EmptyResult struct{}

EmptyResult is the empty JSON-RPC result for methods without payloads.

type HookContractSpec 

type HookContractSpec struct {
	Event   hooks.HookEvent
	Payload NamedType
	Patch   NamedType
}

HookContractSpec binds one hook event to its payload and patch contracts.

func BuildHookContracts 

func BuildHookContracts() ([]HookContractSpec, error)

BuildHookContracts returns the canonical hook payload/patch registry in event order.

func HookContracts 

func HookContracts() []HookContractSpec

HookContracts returns the canonical hook payload/patch registry in event order.

type HostAPIMethod 

type HostAPIMethod = extensionprotocol.HostAPIMethod

HostAPIMethod identifies one extension -> AGH Host API request.

type HostAPIMethodSpec 

type HostAPIMethodSpec struct {
	Method         HostAPIMethod
	Params         NamedType
	Result         NamedType
	OptionalParams bool
}

HostAPIMethodSpec describes one Host API request/response contract.

func HostAPIMethodSpecs 

func HostAPIMethodSpecs() []HostAPIMethodSpec

HostAPIMethodSpecs returns the canonical Host API method registry in wire order.

type ListLogsParams 

type ListLogsParams struct {
	WorkspaceID   string    `json:"workspace_id"`
	SessionID     string    `json:"session_id,omitempty"`
	AgentName     string    `json:"agent_name,omitempty"`
	Type          string    `json:"type,omitempty"`
	RunID         string    `json:"run,omitempty"`
	ActorKind     string    `json:"actor_kind,omitempty"`
	ActorID       string    `json:"actor_id,omitempty"`
	Provider      string    `json:"provider,omitempty"`
	Outcome       string    `json:"outcome,omitempty"`
	Component     string    `json:"component,omitempty"`
	ErrorOnly     bool      `json:"error_only,omitempty"`
	AfterSequence int64     `json:"after_seq,omitempty"`
	Since         time.Time `json:"since,omitzero"`
	Limit         int       `json:"limit,omitempty"`
}

ListLogsParams filters workspace runtime logs.

type MemoryForgetParams 

type MemoryForgetParams struct {
	Key       string            `json:"key"`
	Scope     memcontract.Scope `json:"scope,omitempty"`
	Workspace string            `json:"workspace,omitempty"`
}

MemoryForgetParams removes one stored memory document.

type MemoryRecallEntry 

type MemoryRecallEntry struct {
	Key     string  `json:"key"`
	Content string  `json:"content"`
	Score   float64 `json:"score"`
}

MemoryRecallEntry is one scored memory lookup hit.

type MemoryRecallParams 

type MemoryRecallParams struct {
	Query     string            `json:"query"`
	Limit     int               `json:"limit,omitempty"`
	Scope     memcontract.Scope `json:"scope,omitempty"`
	Workspace string            `json:"workspace,omitempty"`
}

MemoryRecallParams queries stored memory documents.

type MemoryStoreParams 

type MemoryStoreParams struct {
	Key       string            `json:"key"`
	Content   string            `json:"content"`
	Scope     memcontract.Scope `json:"scope,omitempty"`
	Workspace string            `json:"workspace,omitempty"`
	Tags      []string          `json:"tags,omitempty"`
}

MemoryStoreParams persists one memory document.

type ModelSourceListParams 

type ModelSourceListParams struct {
	ProviderID   string `json:"provider_id,omitempty"`
	Refresh      bool   `json:"refresh,omitempty"`
	IncludeStale bool   `json:"include_stale,omitempty"`
}

ModelSourceListParams is sent by AGH to extension model sources.

type ModelSourceListResponse 

type ModelSourceListResponse struct {
	Rows []ModelSourceRow `json:"rows"`
}

ModelSourceListResponse is returned by extension model sources.

type ModelSourceRow 

type ModelSourceRow struct {
	SourceID               string                               `json:"source_id"`
	ProviderID             string                               `json:"provider_id"`
	ModelID                string                               `json:"model_id"`
	DisplayName            string                               `json:"display_name,omitempty"`
	Priority               int                                  `json:"priority,omitempty"`
	Available              *bool                                `json:"available,omitempty"`
	Stale                  bool                                 `json:"stale,omitempty"`
	RefreshedAt            time.Time                            `json:"refreshed_at"`
	ExpiresAt              time.Time                            `json:"expires_at"`
	ContextWindow          *int64                               `json:"context_window,omitempty"`
	MaxInputTokens         *int64                               `json:"max_input_tokens,omitempty"`
	MaxOutputTokens        *int64                               `json:"max_output_tokens,omitempty"`
	SupportsTools          *bool                                `json:"supports_tools,omitempty"`
	SupportsReasoning      *bool                                `json:"supports_reasoning,omitempty"`
	ReasoningEfforts       []string                             `json:"reasoning_efforts,omitempty"`
	DefaultReasoningEffort *string                              `json:"default_reasoning_effort,omitempty"`
	Cost                   *apicontract.ModelCatalogCostPayload `json:"cost,omitempty"`
	LastError              string                               `json:"last_error,omitempty"`
}

ModelSourceRow is one extension-provided model catalog source row.

type ModelsListParams 

type ModelsListParams struct {
	ProviderID   string `json:"provider_id,omitempty"`
	SourceID     string `json:"source_id,omitempty"`
	Refresh      bool   `json:"refresh,omitempty"`
	IncludeStale bool   `json:"include_stale,omitempty"`
}

ModelsListParams filters daemon-owned model catalog projections.

type ModelsRefreshParams 

type ModelsRefreshParams struct {
	ProviderID string `json:"provider_id,omitempty"`
	SourceID   string `json:"source_id,omitempty"`
	Force      bool   `json:"force,omitempty"`
	RequestID  string `json:"request_id,omitempty"`
}

ModelsRefreshParams requests a daemon-owned model catalog refresh.

type ModelsStatusParams 

type ModelsStatusParams struct {
	ProviderID string `json:"provider_id,omitempty"`
}

ModelsStatusParams filters daemon-owned model catalog source status rows.

type NamedType 

type NamedType struct {
	Name  string
	Value any
}

NamedType links a generated TypeScript export name to a Go type.

func SDKRootTypes 

func SDKRootTypes() []NamedType

SDKRootTypes returns the canonical generated SDK contract roots.

type NetworkChannelsParams 

type NetworkChannelsParams struct {
	WorkspaceID string `json:"workspace_id"`
}

NetworkChannelsParams filters visible channels by workspace.

type NetworkDirectMessagesParams 

type NetworkDirectMessagesParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel"`
	DirectID    string `json:"direct_id"`
	Before      string `json:"before,omitempty"`
	After       string `json:"after,omitempty"`
	Kind        string `json:"kind,omitempty"`
	WorkID      string `json:"work_id,omitempty"`
	Limit       int    `json:"limit,omitempty"`
}

NetworkDirectMessagesParams filters messages inside one direct room.

type NetworkDirectResolveParams 

type NetworkDirectResolveParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel"`
	apicontract.NetworkDirectResolveRequest
}

NetworkDirectResolveParams creates or returns a deterministic direct room.

type NetworkDirectsParams 

type NetworkDirectsParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel"`
	PeerID      string `json:"peer_id,omitempty"`
	Limit       int    `json:"limit,omitempty"`
	After       string `json:"after,omitempty"`
}

NetworkDirectsParams filters direct-room summaries by channel.

type NetworkPeersParams 

type NetworkPeersParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel,omitempty"`
}

NetworkPeersParams filters visible peers by workspace and channel.

type NetworkSendParams 

type NetworkSendParams = apicontract.NetworkSendRequest

NetworkSendParams is the shared daemon network send request payload.

type NetworkThreadMessagesParams 

type NetworkThreadMessagesParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel"`
	ThreadID    string `json:"thread_id"`
	Before      string `json:"before,omitempty"`
	After       string `json:"after,omitempty"`
	Kind        string `json:"kind,omitempty"`
	WorkID      string `json:"work_id,omitempty"`
	Limit       int    `json:"limit,omitempty"`
}

NetworkThreadMessagesParams filters messages inside one public thread.

type NetworkThreadTargetParams 

type NetworkThreadTargetParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel"`
	ThreadID    string `json:"thread_id"`
}

NetworkThreadTargetParams identifies one public thread.

type NetworkThreadsParams 

type NetworkThreadsParams struct {
	WorkspaceID string `json:"workspace_id"`
	Channel     string `json:"channel"`
	Limit       int    `json:"limit,omitempty"`
	After       string `json:"after,omitempty"`
}

NetworkThreadsParams filters public-thread summaries by workspace and channel.

type NetworkWorkGetParams 

type NetworkWorkGetParams struct {
	WorkspaceID string `json:"workspace_id"`
	WorkID      string `json:"work_id"`
}

NetworkWorkGetParams identifies one network work row.

type ObserveHealth 

type ObserveHealth = observepkg.Health

ObserveHealth is the host-visible daemon health payload.

type ResourceGetParams 

type ResourceGetParams struct {
	Kind resources.ResourceKind `json:"kind"`
	ID   string                 `json:"id"`
}

ResourceGetParams identifies one canonical resource record by kind and id.

type ResourceRecord 

type ResourceRecord struct {
	Kind      resources.ResourceKind   `json:"kind"`
	ID        string                   `json:"id"`
	Version   int64                    `json:"version"`
	Scope     resources.ResourceScope  `json:"scope"`
	Owner     resources.ResourceOwner  `json:"owner"`
	Source    resources.ResourceSource `json:"source"`
	Spec      json.RawMessage          `json:"spec"`
	CreatedAt time.Time                `json:"created_at"`
	UpdatedAt time.Time                `json:"updated_at"`
}

ResourceRecord is the generic Host API desired-state shape exposed to extensions.

type ResourceSnapshotRecord 

type ResourceSnapshotRecord struct {
	Kind  resources.ResourceKind  `json:"kind"`
	ID    string                  `json:"id"`
	Scope resources.ResourceScope `json:"scope"`
	Spec  json.RawMessage         `json:"spec"`
}

ResourceSnapshotRecord carries one snapshot-authored resource definition.

type ResourcesListParams 

type ResourcesListParams struct {
	Kind  resources.ResourceKind   `json:"kind,omitempty"`
	Scope *resources.ResourceScope `json:"scope,omitempty"`
	Limit int                      `json:"limit,omitempty"`
}

ResourcesListParams filters same-source resource visibility for one extension actor.

type ResourcesSnapshotParams 

type ResourcesSnapshotParams struct {
	SourceVersion int64                    `json:"source_version"`
	Records       []ResourceSnapshotRecord `json:"records"`
}

ResourcesSnapshotParams replaces one extension source snapshot.

type SandboxExecParams 

type SandboxExecParams struct {
	WorkspaceID string `json:"workspace_id"`
	SessionID   string `json:"session_id"`
	Command     string `json:"command"`
	Timeout     int    `json:"timeout,omitempty"`
}

SandboxExecParams executes one command inside a session sandbox.

type SandboxExecResult 

type SandboxExecResult struct {
	ExitCode int    `json:"exit_code"`
	Stdout   string `json:"stdout,omitempty"`
	Stderr   string `json:"stderr,omitempty"`
}

SandboxExecResult returns command execution output.

type SandboxInfoParams 

type SandboxInfoParams struct {
	WorkspaceID string `json:"workspace_id"`
	SessionID   string `json:"session_id"`
}

SandboxInfoParams identifies one session sandbox.

type SandboxInfoResult 

type SandboxInfoResult struct {
	SandboxID     string    `json:"sandbox_id"`
	Backend       string    `json:"backend"`
	Profile       string    `json:"profile"`
	InstanceID    string    `json:"instance_id"`
	RuntimeRoot   string    `json:"runtime_root"`
	SyncState     string    `json:"sync_state"`
	CreatedAt     time.Time `json:"created_at"`
	LastSyncError string    `json:"last_sync_error"`
}

SandboxInfoResult returns detailed sandbox state for a session.

type SandboxListParams 

type SandboxListParams struct {
	Workspace string `json:"workspace,omitempty"`
}

SandboxListParams filters active sandboxes.

type SandboxListResult 

type SandboxListResult struct {
	Sandboxes []SandboxSummary `json:"sandboxes"`
}

SandboxListResult returns active sandbox instances.

type SandboxSummary 

type SandboxSummary struct {
	SessionID  string `json:"session_id"`
	SandboxID  string `json:"sandbox_id"`
	Backend    string `json:"backend"`
	Profile    string `json:"profile,omitempty"`
	InstanceID string `json:"instance_id,omitempty"`
	State      string `json:"state"`
	SyncState  string `json:"sync_state,omitempty"`
}

SandboxSummary is one active sandbox in the host-visible list response.

type SessionCreateResult 

type SessionCreateResult struct {
	SessionID string `json:"session_id"`
	Provider  string `json:"provider"`
}

SessionCreateResult returns the created session identifier.

type SessionEvent 

type SessionEvent struct {
	Type      string    `json:"type"`
	Timestamp time.Time `json:"timestamp"`
	Data      any       `json:"data,omitempty"`
}

SessionEvent is the host-visible session or observe event record.

type SessionEventsParams 

type SessionEventsParams struct {
	WorkspaceID string    `json:"workspace_id"`
	SessionID   string    `json:"session_id"`
	Type        string    `json:"type,omitempty"`
	AgentName   string    `json:"agent_name,omitempty"`
	TurnID      string    `json:"turn_id,omitempty"`
	Limit       int       `json:"limit,omitempty"`
	Offset      int64     `json:"offset,omitempty"`
	Since       time.Time `json:"since,omitzero"`
}

SessionEventsParams filters persisted session events.

type SessionHealthGetParams 

type SessionHealthGetParams = SessionTargetParams

SessionHealthGetParams identifies one session health row.

type SessionPromptResult 

type SessionPromptResult struct {
	TurnID string `json:"turn_id"`
}

SessionPromptResult returns the created turn identifier.

type SessionSoulRefreshParams 

type SessionSoulRefreshParams struct {
	WorkspaceID string `json:"workspace_id"`
	SessionID   string `json:"session_id"`
	apicontract.SessionSoulRefreshRequest
}

SessionSoulRefreshParams refreshes one session's Soul snapshot through managed CAS.

type SessionStatus 

type SessionStatus struct {
	SessionID    string           `json:"session_id"`
	Name         string           `json:"name,omitempty"`
	Agent        string           `json:"agent"`
	Provider     string           `json:"provider"`
	WorkspaceID  string           `json:"workspace_id,omitempty"`
	Workspace    string           `json:"workspace,omitempty"`
	State        session.State    `json:"state"`
	StopReason   store.StopReason `json:"stop_reason,omitempty"`
	StopDetail   string           `json:"stop_detail,omitempty"`
	ACPSessionID string           `json:"acp_session_id,omitempty"`
	CreatedAt    time.Time        `json:"created_at"`
	UpdatedAt    time.Time        `json:"updated_at"`
}

SessionStatus is the detailed host-visible session status shape.

type SessionStatusGetParams 

type SessionStatusGetParams = SessionTargetParams

SessionStatusGetParams identifies one authored-context session status row.

type SessionSummary 

type SessionSummary struct {
	ID        string        `json:"id"`
	Name      string        `json:"name,omitempty"`
	Agent     string        `json:"agent"`
	Provider  string        `json:"provider"`
	Workspace string        `json:"workspace,omitempty"`
	State     session.State `json:"state"`
	CreatedAt time.Time     `json:"created_at"`
}

SessionSummary is the lightweight host-visible session listing shape.

type SessionTargetParams 

type SessionTargetParams struct {
	WorkspaceID string `json:"workspace_id"`
	SessionID   string `json:"session_id"`
}

SessionTargetParams identifies an existing session.

type SessionsCreateParams 

type SessionsCreateParams struct {
	Agent           string `json:"agent"`
	Prompt          string `json:"prompt,omitempty"`
	Provider        string `json:"provider,omitempty"`
	Model           string `json:"model,omitempty"`
	ReasoningEffort string `json:"reasoning_effort,omitempty"`
	Workspace       string `json:"workspace,omitempty"`
}

SessionsCreateParams starts a new session.

type SessionsListParams 

type SessionsListParams struct {
	Workspace string `json:"workspace,omitempty"`
}

SessionsListParams filters visible sessions.

type SessionsPromptParams 

type SessionsPromptParams struct {
	WorkspaceID string `json:"workspace_id"`
	SessionID   string `json:"session_id"`
	Message     string `json:"message"`
}

SessionsPromptParams submits one prompt to an existing session.

type SkillSummary 

type SkillSummary struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Source      string `json:"source"`
}

SkillSummary is the lightweight host-visible skill listing shape.

type SkillsListParams 

type SkillsListParams struct {
	Workspace string `json:"workspace,omitempty"`
	ForAgent  string `json:"for_agent,omitempty"`
}

SkillsListParams filters skills by workspace scope.

type TaskCancelParams 

type TaskCancelParams struct {
	ID string `json:"id"`
	apicontract.CancelTaskRequest
}

TaskCancelParams requests cancellation for one task.

type TaskCreateParams 

type TaskCreateParams = apicontract.CreateTaskRequest

TaskCreateParams creates one task.

type TaskDashboardParams 

type TaskDashboardParams = apicontract.TaskDashboardQuery

TaskDashboardParams filters observer-backed task dashboard reads.

type TaskInboxParams 

type TaskInboxParams = apicontract.TaskInboxQuery

TaskInboxParams filters observer-backed task inbox reads.

type TaskRunAttachSessionParams 

type TaskRunAttachSessionParams struct {
	ID string `json:"id"`
	apicontract.AttachTaskRunSessionRequest
}

TaskRunAttachSessionParams attaches one existing session to a run.

type TaskRunCancelParams 

type TaskRunCancelParams struct {
	ID string `json:"id"`
	apicontract.CancelTaskRunRequest
}

TaskRunCancelParams cancels one run.

type TaskRunClaimParams 

type TaskRunClaimParams struct {
	ID string `json:"id"`
	apicontract.ClaimTaskRunRequest
}

TaskRunClaimParams claims one queued run.

type TaskRunCompleteParams 

type TaskRunCompleteParams struct {
	ID string `json:"id"`
	apicontract.CompleteTaskRunRequest
}

TaskRunCompleteParams completes one run.

type TaskRunEnqueueParams 

type TaskRunEnqueueParams struct {
	TaskID string `json:"task_id"`
	apicontract.EnqueueTaskRunRequest
}

TaskRunEnqueueParams enqueues one run for a task.

type TaskRunFailParams 

type TaskRunFailParams struct {
	ID string `json:"id"`
	apicontract.FailTaskRunRequest
}

TaskRunFailParams fails one run.

type TaskRunGetParams 

type TaskRunGetParams struct {
	ID string `json:"id"`
}

TaskRunGetParams identifies one task run by id for richer detail reads.

type TaskRunStartParams 

type TaskRunStartParams struct {
	ID string `json:"id"`
	apicontract.StartTaskRunRequest
}

TaskRunStartParams starts one claimed run.

type TaskRunsParams 

type TaskRunsParams struct {
	ID string `json:"id"`
	apicontract.TaskRunListQuery
}

TaskRunsParams filters runs for one task.

type TaskTargetParams 

type TaskTargetParams struct {
	ID string `json:"id"`
}

TaskTargetParams identifies one task by id.

type TaskTimelineParams 

type TaskTimelineParams struct {
	ID string `json:"id"`
	apicontract.TaskTimelineQuery
}

TaskTimelineParams queries one task timeline by task id.

type TaskTreeParams 

type TaskTreeParams = TaskTargetParams

TaskTreeParams queries one task tree by task id.

type TaskUpdateParams 

type TaskUpdateParams struct {
	ID string `json:"id"`
	apicontract.UpdateTaskRequest
}

TaskUpdateParams patches one task.

type TasksParams 

type TasksParams = apicontract.TaskListQuery

TasksParams filters visible tasks.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.