sdk

type ActivateSkillInput = api.ActivateSkillInput

type ActivateSkillOutput = api.ActivateSkillOutput

type ActiveFeedState = api.ActiveFeedState

type ApprovalCallback = api.ApprovalCallback

type ApprovalCallbackPayload = api.ApprovalCallbackPayload

type ApprovalCallbackResult = api.ApprovalCallbackResult

type ApprovalEditor = api.ApprovalEditor

type ApprovalForgeView = api.ApprovalForgeView

type ApprovalMeta = api.ApprovalMeta

type ApprovalOption = api.ApprovalOption

type AssistantBubble struct {
	MessageID string
	Content   string
	IsFinal   bool
}

type AssistantMessageState = api.AssistantMessageState

type AssistantState = api.AssistantState

type AsyncOperationState = api.AsyncOperationState

type AuthProvider struct {
	Name  string `json:"name"`
	Label string `json:"label"`
	Mode  string `json:"mode"`
}

type Backend interface {
	Client
}

type Client interface {
	Mode() Mode

	// Query sends a user message and returns the agent response (ReAct loop).
	Query(ctx context.Context, input *agentsvc.QueryInput) (*agentsvc.QueryOutput, error)

	// GetMessages returns a cursor-paginated page of messages for a conversation.
	GetMessages(ctx context.Context, input *GetMessagesInput) (*MessagePage, error)

	// StreamEvents subscribes to real-time streaming events for a conversation.
	StreamEvents(ctx context.Context, input *StreamEventsInput) (streaming.Subscription, error)

	// CreateConversation initialises a new conversation record.
	CreateConversation(ctx context.Context, input *CreateConversationInput) (*conversation.Conversation, error)

	// ListConversations returns a cursor-paginated list of conversations.
	ListConversations(ctx context.Context, input *ListConversationsInput) (*ConversationPage, error)
	// ListLinkedConversations returns child conversations for a given parent conversation/turn,
	// including status and latest assistant response.
	ListLinkedConversations(ctx context.Context, input *ListLinkedConversationsInput) (*LinkedConversationPage, error)

	// GetConversation retrieves a single conversation by ID.
	GetConversation(ctx context.Context, id string) (*conversation.Conversation, error)
	// UpdateConversation updates mutable conversation fields such as visibility and shareability.
	UpdateConversation(ctx context.Context, input *UpdateConversationInput) (*conversation.Conversation, error)
	// DeleteConversation deletes a conversation tree owned by the current user.
	DeleteConversation(ctx context.Context, id string) error

	// GetRun returns the current state of a run.
	GetRun(ctx context.Context, id string) (*agrun.RunRowsView, error)

	// CancelTurn aborts the active turn. Returns true if a running turn was found.
	CancelTurn(ctx context.Context, turnID string) (bool, error)
	// SteerTurn injects a user message into a currently running turn.
	SteerTurn(ctx context.Context, input *SteerTurnInput) (*SteerTurnOutput, error)
	// CancelQueuedTurn cancels a queued turn.
	CancelQueuedTurn(ctx context.Context, conversationID, turnID string) error
	// MoveQueuedTurn reorders a queued turn up/down in queue order.
	MoveQueuedTurn(ctx context.Context, input *MoveQueuedTurnInput) error
	// EditQueuedTurn updates queued turn starter message content.
	EditQueuedTurn(ctx context.Context, input *EditQueuedTurnInput) error
	// ForceSteerQueuedTurn cancels queued turn and injects its message into active turn.
	ForceSteerQueuedTurn(ctx context.Context, conversationID, turnID string) (*SteerTurnOutput, error)

	// ResolveElicitation delivers the user response for an elicitation prompt.
	ResolveElicitation(ctx context.Context, input *ResolveElicitationInput) error
	// ListPendingElicitations returns unresolved elicitation prompts for a conversation.
	ListPendingElicitations(ctx context.Context, input *ListPendingElicitationsInput) ([]*PendingElicitation, error)
	// ListPendingToolApprovals returns queued tool approvals for a user/conversation.
	ListPendingToolApprovals(ctx context.Context, input *ListPendingToolApprovalsInput) (*PendingToolApprovalPage, error)
	// DecideToolApproval resolves a queued tool request with approve/reject.
	DecideToolApproval(ctx context.Context, input *DecideToolApprovalInput) (*DecideToolApprovalOutput, error)

	// ExecuteTool invokes a registered tool by name and returns its textual result.
	ExecuteTool(ctx context.Context, name string, args map[string]interface{}) (string, error)

	// ExecuteMCPUIToolCall runs a host-mediated MCP UI guest tool call through
	// the canonical conversation-backed execution path. Bundle-derived
	// approval metadata is honored, so a tool configured for queue approval is
	// routed to the existing approval queue and the response status is
	// "queued" rather than "ok". This is the only path MCP UI guests use for
	// tools/call — direct /v1/tools/execute is intentionally bypassed.
	ExecuteMCPUIToolCall(ctx context.Context, input *MCPUIToolCallInput) (*MCPUIToolCallOutput, error)

	// ListTemplates returns output templates available to the current agent/workspace.
	ListTemplates(ctx context.Context, input *ListTemplatesInput) (*ListTemplatesOutput, error)

	// GetTemplate resolves one output template by name and can request document inclusion.
	GetTemplate(ctx context.Context, input *GetTemplateInput) (*GetTemplateOutput, error)

	// ListToolDefinitions returns the set of tool definitions available in the workspace.
	ListToolDefinitions(ctx context.Context) ([]ToolDefinitionInfo, error)
	// ListSkills returns visible skills for the conversation's current agent.
	ListSkills(ctx context.Context, input *ListSkillsInput) (*ListSkillsOutput, error)
	// ActivateSkill returns the SKILL.md body for a named skill in the conversation context.
	ActivateSkill(ctx context.Context, input *ActivateSkillInput) (*ActivateSkillOutput, error)
	// GetSkillDiagnostics returns load/shadow/validation diagnostics for the current skill registry.
	GetSkillDiagnostics(ctx context.Context) (*SkillDiagnosticsOutput, error)

	// UploadFile stores a file associated with a conversation.
	UploadFile(ctx context.Context, input *UploadFileInput) (*UploadFileOutput, error)

	// DownloadFile retrieves a previously uploaded file.
	DownloadFile(ctx context.Context, input *DownloadFileInput) (*DownloadFileOutput, error)

	// ListFiles returns all files associated with a conversation.
	ListFiles(ctx context.Context, input *ListFilesInput) (*ListFilesOutput, error)

	// ListResources returns resource names for a workspace kind.
	ListResources(ctx context.Context, input *ListResourcesInput) (*ListResourcesOutput, error)

	// GetResource retrieves a single workspace resource by kind and name.
	GetResource(ctx context.Context, input *ResourceRef) (*GetResourceOutput, error)

	// SaveResource creates or updates a workspace resource.
	SaveResource(ctx context.Context, input *SaveResourceInput) error

	// DeleteResource removes a workspace resource.
	DeleteResource(ctx context.Context, input *ResourceRef) error

	// ExportResources exports all resources of the given kinds.
	ExportResources(ctx context.Context, input *ExportResourcesInput) (*ExportResourcesOutput, error)

	// ImportResources imports resources in bulk.
	ImportResources(ctx context.Context, input *ImportResourcesInput) (*ImportResourcesOutput, error)

	// TerminateConversation cancels all active turns and marks the conversation as canceled.
	TerminateConversation(ctx context.Context, conversationID string) error

	// CompactConversation generates an LLM summary of conversation history, archiving old messages.
	CompactConversation(ctx context.Context, conversationID string) error

	// PruneConversation uses an LLM to select and remove low-value messages from conversation history.
	PruneConversation(ctx context.Context, conversationID string) error

	// GetTranscript returns the canonical conversation state for rendering.
	GetTranscript(ctx context.Context, input *GetTranscriptInput, options ...TranscriptOption) (*ConversationStateResponse, error)

	// GetLiveState returns the current canonical state snapshot with an EventCursor.
	// On SSE connect or reconnect the client should call GetLiveState first, then
	// consume the event stream starting at EventCursor to avoid replaying history
	// and to avoid missing events that arrived between page load and SSE connect.
	GetLiveState(ctx context.Context, conversationID string, options ...TranscriptOption) (*ConversationStateResponse, error)

	// GetPayloads returns a map of payload ID → payload for the given IDs.
	// Used for batch payload resolution in feed rendering, replacing per-step fetches.
	GetPayloads(ctx context.Context, ids []string) (map[string]*conversation.Payload, error)

	// GetA2AAgentCard returns the A2A agent card for the given agent.
	GetA2AAgentCard(ctx context.Context, agentID string) (*a2a.AgentCard, error)

	// SendA2AMessage sends a message to an A2A agent and returns the task envelope.
	SendA2AMessage(ctx context.Context, agentID string, req *a2a.SendMessageRequest) (*a2a.SendMessageResponse, error)

	// ListA2AAgents returns agent IDs that have A2A serving enabled.
	ListA2AAgents(ctx context.Context, agentIDs []string) ([]string, error)

	// GetSchedule returns a schedule by ID.
	GetSchedule(ctx context.Context, id string) (*scheduler.Schedule, error)

	// ListSchedules returns all schedules visible to the caller.
	ListSchedules(ctx context.Context) ([]*scheduler.Schedule, error)

	// UpsertSchedules creates or updates schedules in batch.
	UpsertSchedules(ctx context.Context, schedules []*scheduler.Schedule) error

	// RunScheduleNow triggers immediate execution of a schedule.
	RunScheduleNow(ctx context.Context, id string) error

	// FetchDatasource returns rows for a workspace-registered datasource.
	// Caller identity flows via ctx; the backend reads it when keying the
	// per-user cache and attaches any MCP auth token when the backend is
	// mcp_tool. Implementations that have not wired the datasource stack
	// should return a clear error rather than nil rows.
	FetchDatasource(ctx context.Context, in *api.FetchDatasourceInput) (*api.FetchDatasourceOutput, error)

	// InvalidateDatasourceCache drops cache entries for a datasource in the
	// caller's scope. When InputsHash is empty, the whole datasource range
	// is dropped.
	InvalidateDatasourceCache(ctx context.Context, in *api.InvalidateDatasourceCacheInput) error

	// ListLookupRegistry returns the set of named-token bindings available
	// for a given render context — composed server-side from loaded overlays
	// whose Named binding matches. Used by the web + mobile `/name` hotkey
	// component and by the authored-prompt renderer.
	ListLookupRegistry(ctx context.Context, in *api.ListLookupRegistryInput) (*api.ListLookupRegistryOutput, error)
}

type ConversationPage = api.ConversationPage

type ConversationState = api.ConversationState

type ConversationStateResponse = api.ConversationStateResponse

type ConversationStreamSnapshot struct {
	ConversationID     string             `json:"conversationId,omitempty"`
	State              *ConversationState `json:"state,omitempty"`
	ActiveTurnID       string             `json:"activeTurnId,omitempty"`
	Feeds              []*ActiveFeedState `json:"feeds,omitempty"`
	PendingElicitation *ElicitationState  `json:"pendingElicitation,omitempty"`
}

type ConversationStreamTracker struct {
	// contains filtered or unexported fields
}

type CreateConversationInput = api.CreateConversationInput

type CreateSessionRequest struct {
	Username     string `json:"username,omitempty"`
	AccessToken  string `json:"accessToken,omitempty"`
	IDToken      string `json:"idToken,omitempty"`
	RefreshToken string `json:"refreshToken,omitempty"`
	ExpiresAt    string `json:"expiresAt,omitempty"`
}

type DebugOption func(*debugOptions)

type DecideToolApprovalInput = api.DecideToolApprovalInput

type DecideToolApprovalOutput = api.DecideToolApprovalOutput

type Direction = api.Direction

type DownloadFileInput = api.DownloadFileInput

type DownloadFileOutput = api.DownloadFileOutput

type EditQueuedTurnInput = api.EditQueuedTurnInput

type ElicitationDialog struct {
	ElicitationID   string
	Status          ElicitationStatus
	Message         string
	RequestedSchema json.RawMessage
	CallbackURL     string
	ResponsePayload json.RawMessage
	// IsPending is true when the user needs to respond.
	IsPending bool
}

type ElicitationState = api.ElicitationState

type ElicitationStatus = api.ElicitationStatus

type ExecutionPageState = api.ExecutionPageState

type ExecutionState = api.ExecutionState

type ExportResourcesInput = api.ExportResourcesInput

type ExportResourcesOutput = api.ExportResourcesOutput

type FeedActivation = api.FeedActivation

type FeedMatch = api.FeedMatch

type FeedRegistry struct {
	// contains filtered or unexported fields
}

type FeedSpec = api.FeedSpec

type FeedState = api.FeedState

type FileEntry = api.FileEntry

type GetMessagesInput = api.GetMessagesInput

type GetResourceOutput = api.GetResourceOutput

type GetTemplateInput = api.GetTemplateInput

type GetTemplateOutput = api.GetTemplateOutput

type GetTranscriptInput = api.GetTranscriptInput

type HTTPClient struct {
	// contains filtered or unexported fields
}

type HTTPOption func(*HTTPClient)

type HandlerOption func(*handlerConfig)

type ImportResourcesInput = api.ImportResourcesInput

type ImportResourcesOutput = api.ImportResourcesOutput

type LinkedConversationEntry = api.LinkedConversationEntry

type LinkedConversationPage = api.LinkedConversationPage

type LinkedConversationState = api.LinkedConversationState

type ListConversationsInput = api.ListConversationsInput

type ListFilesInput = api.ListFilesInput

type ListFilesOutput = api.ListFilesOutput

type ListLinkedConversationsInput = api.ListLinkedConversationsInput

type ListPendingElicitationsInput = api.ListPendingElicitationsInput

type ListPendingToolApprovalsInput = api.ListPendingToolApprovalsInput

type ListResourcesInput = api.ListResourcesInput

type ListResourcesOutput = api.ListResourcesOutput

type ListSkillsInput = api.ListSkillsInput

type ListSkillsOutput = api.ListSkillsOutput

type ListTemplatesInput = api.ListTemplatesInput

type ListTemplatesOutput = api.ListTemplatesOutput

type LocalLoginRequest struct {
	Name string `json:"name"`
}

type LocalOOBSessionOptions struct {
	ConfigURL  string
	SecretsURL string
	Scopes     []string
}

type MCPUIResourceReadResponse struct {
	Uri      string                 `json:"uri"`
	MimeType string                 `json:"mimeType"`
	Text     string                 `json:"text"`
	Meta     map[string]interface{} `json:"_meta,omitempty"`
}

type MCPUIResourceReader func(ctx context.Context, uri string) (*mcpschema.ReadResourceResult, error)

type MCPUIToolCallInput = api.MCPUIToolCallInput

type MCPUIToolCallOutput = api.MCPUIToolCallOutput

type MCPUIToolCaller func(ctx context.Context, input *MCPUIToolCallInput) (*MCPUIToolCallOutput, error)

type MessagePage = api.MessagePage

type MetadataTargetContext struct {
	Platform     string
	FormFactor   string
	Surface      string
	Capabilities []string
}

type Mode string

type ModelStepState = api.ModelStepState

type MoveQueuedTurnInput = api.MoveQueuedTurnInput

type OAuthConfigResponse struct {
	ConfigURL string   `json:"configURL"`
	Scopes    []string `json:"scopes,omitempty"`
}

type OOBRequest struct {
	SecretsURL string   `json:"secretsURL"`
	Scopes     []string `json:"scopes,omitempty"`
}

type PageInput = api.PageInput

type PendingElicitation = api.PendingElicitation

type PendingToolApproval = api.PendingToolApproval

type PendingToolApprovalPage = api.PendingToolApprovalPage

type PlanFeedPayload = api.PlanFeedPayload

type PlanStep = api.PlanStep

type PlannerState = api.PlannerState

type QuerySelector = api.QuerySelector

type ResolveElicitationInput = api.ResolveElicitationInput

type Resource = api.Resource

type ResourceRef = api.ResourceRef

type SaveResourceInput = api.SaveResourceInput

type SchedulerOptions struct {
	EnableAPI      bool
	EnableRunNow   bool
	EnableWatchdog bool
}

type SessionDebugConfig struct {
	Enabled    bool
	Level      string
	Components []string
}

type SkillDiagnosticsOutput = api.SkillDiagnosticsOutput

type SkillItem = api.SkillItem

type StarterTask = api.StarterTask

type SteerTurnInput = api.SteerTurnInput

type SteerTurnOutput = api.SteerTurnOutput

type StreamEventsInput = api.StreamEventsInput

type TemplateListItem = api.TemplateListItem

type TokenProvider func(ctx context.Context) (string, error)

type ToolDefinitionInfo = api.ToolDefinitionInfo

type ToolStepState = api.ToolStepState

type TranscriptOption func(*transcriptOptions)

type TurnMessageState = api.TurnMessageState

type TurnState = api.TurnState

type TurnStatus = api.TurnStatus

type UpdateConversationInput = api.UpdateConversationInput

type UploadFileInput = api.UploadFileInput

type UploadFileOutput = api.UploadFileOutput

type UsageSummary = api.UsageSummary

type UserMessageState = api.UserMessageState

type WorkspaceAgentInfo = api.WorkspaceAgentInfo

type WorkspaceCapabilities = api.WorkspaceCapabilities

type WorkspaceDefaults = api.WorkspaceDefaults

type WorkspaceMetadata = api.WorkspaceMetadata

type WorkspaceModelInfo = api.WorkspaceModelInfo