Documentation
¶
Index ¶
- Constants
- func CommandFlagTypeValues() []string
- func IssueSeverityValues() []string
- func ModelSourceOptionKindValues() []string
- func PermissionMethods() []string
- type AgentHeartbeatDeleteParams
- type AgentHeartbeatGetParams
- type AgentHeartbeatHistoryParams
- type AgentHeartbeatPutParams
- type AgentHeartbeatRollbackParams
- type AgentHeartbeatStatusParams
- type AgentHeartbeatValidateParams
- type AgentHeartbeatWakeParams
- type AgentSoulDeleteParams
- type AgentSoulGetParams
- type AgentSoulHistoryParams
- type AgentSoulPutParams
- type AgentSoulRollbackParams
- type AgentSoulValidateParams
- type AutomationJobCreateParams
- type AutomationJobRunsParams
- type AutomationJobTriggerParams
- type AutomationJobUpdateParams
- type AutomationJobsParams
- type AutomationJobsResult
- type AutomationRunsParams
- type AutomationTargetParams
- type AutomationTriggerCreateParams
- type AutomationTriggerFireParams
- type AutomationTriggerRunsParams
- type AutomationTriggerUpdateParams
- type AutomationTriggersParams
- type AutomationTriggersResult
- type ClarifyAskParams
- type CmdPaletteAction
- type CmdPaletteArgument
- type CmdPaletteCommand
- type CmdPaletteConfig
- type CmdPaletteConfirmation
- type CmdPaletteExecutionPolicy
- type CmdPaletteView
- type CmdPaletteViewSource
- type CommandFlag
- type CommandFlagType
- type ConnectivityAdvertisedEndpoint
- type ConnectivityEstablishRequest
- type ConnectivityReachability
- type ConnectivityStatusRequest
- type ConnectivityTeardownRequest
- type ConnectivityTeardownResponse
- type ConsentArea
- type DescribeGatewayRequirement
- type DescribeHookEvent
- type DescribePayload
- type DescribeProfile
- type DescribeProfileCredential
- type DescribeProfileDefaults
- type DescribeResourcePath
- type DescribeResources
- type DescribeSDKInfo
- type DescribeSubprocess
- type EmptyResult
- type ExtensionCommandGroupSpec
- type ExtensionCommandSpec
- type ExtensionManifestSummary
- type ExtensionValidatePayload
- type ForgeCapabilitiesRequest
- type ForgeCapabilitiesResponse
- type ForgeChecks
- type ForgePRCandidate
- type ForgePRCreateRequest
- type ForgePRCreateResponse
- type ForgePRReadRequest
- type ForgePRSearchRequest
- type ForgePRSearchResponse
- type ForgeReview
- type ForgeReviewThread
- type ForgeReviews
- type ForgeStatusRequest
- type ForgeStatusResponse
- type HookContractSpec
- type HostAPIMethod
- type HostAPIMethodSpec
- type IssueSeverity
- type ListLogsParams
- type ModelSourceListParams
- type ModelSourceListResponse
- type ModelSourceOptionDescriptor
- type ModelSourceOptionKind
- type ModelSourceOptionSelection
- type ModelSourceOptionValue
- type ModelSourceRow
- type ModelSourceTransportBinding
- type ModelsListParams
- type ModelsRefreshParams
- type ModelsStatusParams
- type NamedType
- type ObserveHealth
- type PermissionContract
- type ProvideCapabilityContract
- type ResourceGetParams
- type ResourceRecord
- type ResourceSnapshotRecord
- type ResourcesListParams
- type ResourcesSnapshotParams
- type SDKEnumContract
- type SessionCreateResult
- type SessionEvent
- type SessionEventsParams
- type SessionHealthGetParams
- type SessionInput
- type SessionInputListResult
- type SessionInputPromoteParams
- type SessionInputReplaceParams
- type SessionInputResult
- type SessionInputTargetParams
- type SessionInputsListParams
- type SessionPromptResult
- type SessionRuntimeClearParams
- type SessionRuntimeSelectionPayload
- type SessionRuntimeSetParams
- type SessionSoulRefreshParams
- type SessionStatus
- type SessionStatusGetParams
- type SessionSummary
- type SessionTargetParams
- type SessionsCreateParams
- type SessionsListParams
- type SessionsPromptParams
- type SkillSummary
- type SkillsListParams
- type TaskCancelParams
- type TaskCreateParams
- type TaskDashboardParams
- type TaskInboxParams
- type TaskRunAttachSessionParams
- type TaskRunCancelParams
- type TaskRunCompleteParams
- type TaskRunEnqueueParams
- type TaskRunFailParams
- type TaskRunGetParams
- type TaskRunResultParams
- type TaskRunStartParams
- type TaskRunsParams
- type TaskTargetParams
- type TaskTimelineParams
- type TaskTreeParams
- type TaskUpdateParams
- type TasksParams
- type ValidationIssue
- type ViewFrame
Constants ¶
const ( // IssueSeverityError blocks extension-package use. IssueSeverityError = apicontract.IssueSeverityError // IssueSeverityWarning reports non-blocking authoring guidance. IssueSeverityWarning = apicontract.IssueSeverityWarning // IssueSeverityWarn reports one non-blocking portable-package skip. IssueSeverityWarn = apicontract.IssueSeverityWarn )
const ( // CommandFlagString projects a JSON string. CommandFlagString = toolspkg.CommandFlagString // CommandFlagBoolean projects a JSON boolean. CommandFlagBoolean = toolspkg.CommandFlagBoolean // CommandFlagInteger projects a JSON integer. CommandFlagInteger = toolspkg.CommandFlagInteger // CommandFlagNumber projects a JSON number. CommandFlagNumber = toolspkg.CommandFlagNumber )
const ( ForgeCauseRateLimited = "rate_limited" // #nosec G101 -- these are public error cause identifiers, not credentials. ForgeCauseCredentialExpired = "credential_expired" ForgeCauseUnsupportedRemote = "unsupported_remote" // #nosec G101 -- these are public error cause identifiers, not credentials. ForgeCauseCredentialAbsent = "credential_absent" )
const ( ForgeReviewApproved = "approved" ForgeReviewChangesRequested = "changes_requested" ForgeReviewCommented = "commented" ForgeReviewDismissed = "dismissed" )
Forge review states carried by ForgeReview.State.
const ( MaxForgeFailedNames = 64 MaxForgeReviews = 100 MaxForgeThreads = 100 )
Bounds on the facts one status response may carry.
const ( HostAPIMethodSessionsList = extensionprotocol.HostAPIMethodSessionsList HostAPIMethodSessionsCreate = extensionprotocol.HostAPIMethodSessionsCreate HostAPIMethodSessionsPrompt = extensionprotocol.HostAPIMethodSessionsPrompt HostAPIMethodSessionsRuntimeSet = extensionprotocol.HostAPIMethodSessionsRuntimeSet HostAPIMethodSessionsRuntimeClear = extensionprotocol.HostAPIMethodSessionsRuntimeClear HostAPIMethodSessionsInputsList = extensionprotocol.HostAPIMethodSessionsInputsList HostAPIMethodSessionsInputsReplace = extensionprotocol.HostAPIMethodSessionsInputsReplace HostAPIMethodSessionsInputsCancel = extensionprotocol.HostAPIMethodSessionsInputsCancel HostAPIMethodSessionsInputsPromote = extensionprotocol.HostAPIMethodSessionsInputsPromote HostAPIMethodSessionsStop = extensionprotocol.HostAPIMethodSessionsStop HostAPIMethodSessionsArchive = extensionprotocol.HostAPIMethodSessionsArchive HostAPIMethodSessionsUnarchive = extensionprotocol.HostAPIMethodSessionsUnarchive HostAPIMethodSessionsStatus = extensionprotocol.HostAPIMethodSessionsStatus HostAPIMethodSessionsEvents = extensionprotocol.HostAPIMethodSessionsEvents HostAPIMethodSessionsSoulRefresh = extensionprotocol.HostAPIMethodSessionsSoulRefresh HostAPIMethodSessionsHealthGet = extensionprotocol.HostAPIMethodSessionsHealthGet HostAPIMethodSessionsStatusGet = extensionprotocol.HostAPIMethodSessionsStatusGet 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 HostAPIMethodViewPatch = extensionprotocol.HostAPIMethodViewPatch 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 HostAPIMethodTasksRunsResult = extensionprotocol.HostAPIMethodTasksRunsResult HostAPIMethodTasksRunsEnqueue = extensionprotocol.HostAPIMethodTasksRunsEnqueue HostAPIMethodTasksRunsStart = extensionprotocol.HostAPIMethodTasksRunsStart HostAPIMethodTasksRunsAttachSession = extensionprotocol.HostAPIMethodTasksRunsAttachSession HostAPIMethodTasksRunsComplete = extensionprotocol.HostAPIMethodTasksRunsComplete HostAPIMethodTasksRunsFail = extensionprotocol.HostAPIMethodTasksRunsFail HostAPIMethodTasksRunsCancel = extensionprotocol.HostAPIMethodTasksRunsCancel HostAPIMethodResourcesList = extensionprotocol.HostAPIMethodResourcesList HostAPIMethodResourcesGet = extensionprotocol.HostAPIMethodResourcesGet HostAPIMethodResourcesSnapshot = extensionprotocol.HostAPIMethodResourcesSnapshot HostAPIMethodClarifyAsk = extensionprotocol.HostAPIMethodClarifyAsk )
Variables ¶
This section is empty.
Functions ¶
func CommandFlagTypeValues ¶
func CommandFlagTypeValues() []string
CommandFlagTypeValues returns the complete generated-contract enum domain.
func IssueSeverityValues ¶
func IssueSeverityValues() []string
IssueSeverityValues returns the closed validation-severity set.
func ModelSourceOptionKindValues ¶
func ModelSourceOptionKindValues() []string
ModelSourceOptionKindValues returns the closed extension option-kind vocabulary.
func PermissionMethods ¶
func PermissionMethods() []string
PermissionMethods returns the closed Host API permission set in stable order.
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"`
Query string `json:"q,omitempty"`
Cursor string `json:"cursor,omitempty"`
Limit int `json:"limit,omitempty"`
}
AutomationJobsParams filters visible automation jobs.
type AutomationJobsResult ¶
type AutomationJobsResult struct {
Jobs []automationpkg.Job `json:"jobs"`
Page apicontract.CountedCursorPagePayload `json:"page"`
}
AutomationJobsResult is one bounded page of extension-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"`
Query string `json:"q,omitempty"`
Cursor string `json:"cursor,omitempty"`
Limit int `json:"limit,omitempty"`
}
AutomationTriggersParams filters visible automation triggers.
type AutomationTriggersResult ¶
type AutomationTriggersResult struct {
Triggers []apicontract.TriggerPayload `json:"triggers"`
Page apicontract.CountedCursorPagePayload `json:"page"`
}
AutomationTriggersResult is one bounded page of redacted extension-visible automation triggers.
type ClarifyAskParams ¶
type ClarifyAskParams struct {
InvocationID string `json:"invocation_id"`
Question string `json:"question"`
Choices []string `json:"choices,omitempty"`
}
ClarifyAskParams carries daemon-issued invocation authority and extension-authored question data.
type CmdPaletteAction ¶
type CmdPaletteAction struct {
Kind string `toml:"kind" json:"kind"`
Tool string `toml:"tool,omitempty" json:"tool,omitempty"`
View string `toml:"view,omitempty" json:"view,omitempty"`
App string `toml:"app,omitempty" json:"app,omitempty"`
URL string `toml:"url,omitempty" json:"url,omitempty"`
Args map[string]any `toml:"args,omitempty" json:"args,omitempty"`
}
CmdPaletteAction is the closed extension action union.
type CmdPaletteArgument ¶
type CmdPaletteArgument struct {
Name string `toml:"name" json:"name"`
Type string `toml:"type" json:"type"`
Placeholder string `toml:"placeholder,omitempty" json:"placeholder,omitempty"`
Required bool `toml:"required,omitempty" json:"required,omitempty"`
Options []string `toml:"options,omitempty" json:"options,omitempty"`
}
CmdPaletteArgument describes one inline command argument.
type CmdPaletteCommand ¶
type CmdPaletteCommand struct {
ID string `toml:"id" json:"id"`
Title string `toml:"title" json:"title"`
Section string `toml:"section,omitempty" json:"section,omitempty"`
Icon string `toml:"icon" json:"icon"`
Profile string `toml:"profile,omitempty" json:"profile,omitempty"`
Keywords []string `toml:"keywords,omitempty" json:"keywords,omitempty"`
Arguments []CmdPaletteArgument `toml:"arguments,omitempty" json:"arguments,omitempty"`
Action CmdPaletteAction `toml:"action" json:"action"`
Destructive bool `toml:"destructive,omitempty" json:"destructive,omitempty"`
Confirmation *CmdPaletteConfirmation `toml:"confirmation,omitempty" json:"confirmation,omitempty"`
DefaultShortcut string `toml:"default_shortcut,omitempty" json:"default_shortcut,omitempty"`
Execution *CmdPaletteExecutionPolicy `toml:"execution,omitempty" json:"execution,omitempty"`
}
CmdPaletteCommand is one manifest-authored command before extension namespacing.
type CmdPaletteConfig ¶
type CmdPaletteConfig struct {
Commands []CmdPaletteCommand `toml:"commands,omitempty" json:"commands,omitempty"`
Views []CmdPaletteView `toml:"views,omitempty" json:"views,omitempty"`
}
CmdPaletteConfig declares commands and views contributed by an extension.
type CmdPaletteConfirmation ¶
type CmdPaletteConfirmation struct {
Title string `toml:"title" json:"title"`
Body string `toml:"body,omitempty" json:"body,omitempty"`
Confirm string `toml:"confirm" json:"confirm"`
}
CmdPaletteConfirmation is required for destructive commands.
type CmdPaletteExecutionPolicy ¶
type CmdPaletteExecutionPolicy struct {
SingleFlight *bool `toml:"single_flight,omitempty" json:"single_flight,omitempty"`
RetrySafe *bool `toml:"retry_safe,omitempty" json:"retry_safe,omitempty"`
}
CmdPaletteExecutionPolicy allows an author to override action-kind defaults.
type CmdPaletteView ¶
type CmdPaletteView struct {
ID string `toml:"id" json:"id"`
Title string `toml:"title" json:"title"`
Kind string `toml:"kind" json:"kind"`
Profile string `toml:"profile,omitempty" json:"profile,omitempty"`
Source *CmdPaletteViewSource `toml:"source,omitempty" json:"source,omitempty"`
Program bool `toml:"program,omitempty" json:"program,omitempty"`
}
CmdPaletteView declares one declarative or programmable palette view.
type CmdPaletteViewSource ¶
type CmdPaletteViewSource struct {
Tool string `toml:"tool" json:"tool"`
}
CmdPaletteViewSource binds a declarative view to one extension-owned tool.
type CommandFlag ¶
type CommandFlag = toolspkg.CommandFlag
CommandFlag is the schema-derived CLI projection for one top-level input field.
type CommandFlagType ¶
type CommandFlagType = toolspkg.CommandFlagType
CommandFlagType is the closed scalar type accepted by projected command flags.
type ConnectivityAdvertisedEndpoint ¶
type ConnectivityAdvertisedEndpoint struct {
URL string `json:"url"`
Scheme string `json:"scheme"`
SchemePolicy string `json:"scheme_policy,omitempty"`
Stability string `json:"stability"`
VerificationAddress string `json:"verification_address,omitempty"`
}
ConnectivityAdvertisedEndpoint is one provider-owned external address.
type ConnectivityEstablishRequest ¶
type ConnectivityEstablishRequest struct {
Tier string `json:"tier"`
ForwardTarget string `json:"forward_target"`
ChallengePath string `json:"challenge_path"`
Deadline time.Time `json:"deadline"`
}
ConnectivityEstablishRequest asks a provider to forward one tier to the daemon listener.
type ConnectivityReachability ¶
type ConnectivityReachability struct {
Tier string `json:"tier"`
Endpoints []ConnectivityAdvertisedEndpoint `json:"endpoints"`
Health string `json:"health"`
Reason string `json:"reason,omitempty"`
}
ConnectivityReachability is the untrusted provider response verified by the daemon.
type ConnectivityStatusRequest ¶
type ConnectivityStatusRequest struct {
Tier string `json:"tier"`
}
ConnectivityStatusRequest selects one tier whose reachability must be reported.
type ConnectivityTeardownRequest ¶
type ConnectivityTeardownRequest struct {
Tier string `json:"tier"`
Deadline time.Time `json:"deadline"`
}
ConnectivityTeardownRequest asks a provider to stop forwarding one tier.
type ConnectivityTeardownResponse ¶
type ConnectivityTeardownResponse struct {
Stopped bool `json:"stopped"`
}
ConnectivityTeardownResponse acknowledges that the tier stopped forwarding.
type ConsentArea ¶
type ConsentArea = apicontract.ConsentArea
ConsentArea is one operator-facing permission summary derived from Host API methods.
type DescribeGatewayRequirement ¶
type DescribeGatewayRequirement struct {
Permissions []string `json:"permissions"`
}
DescribeGatewayRequirement declares the reachability control included in consent digests.
type DescribeHookEvent ¶
type DescribeHookEvent struct {
Event hookspkg.HookEvent `json:"event"`
Profile string `json:"profile,omitempty"`
}
DescribeHookEvent binds one supported hook event to every profile or one named profile.
type DescribePayload ¶
type DescribePayload struct {
Name string `json:"name"`
Version string `json:"version"`
Description string `json:"description,omitempty"`
Provides []string `json:"provides"`
Permissions []string `json:"permissions"`
RequiresEnv []string `json:"requires_env,omitempty"`
Profiles []DescribeProfile `json:"profiles,omitempty"`
Resources DescribeResources `json:"resources"`
Subprocess DescribeSubprocess `json:"subprocess"`
Gateway *DescribeGatewayRequirement `json:"gateway,omitempty"`
Tools []toolspkg.ExtensionToolRuntimeDescriptor `json:"tools,omitempty"`
HookEvents []DescribeHookEvent `json:"hook_events,omitempty"`
WatchSourceKinds []string `json:"watch_source_kinds,omitempty"`
CmdPaletteViews []string `json:"cmd_palette_views,omitempty"`
CommandGroups []ExtensionCommandGroupSpec `json:"command_groups,omitempty"`
SDK DescribeSDKInfo `json:"sdk"`
}
DescribePayload is the build-time contract emitted by an SDK describe process.
type DescribeProfile ¶
type DescribeProfile struct {
Name string `json:"name"`
Color string `json:"color,omitempty"`
Icon string `json:"icon,omitempty"`
Emoji string `json:"emoji,omitempty"`
Defaults DescribeProfileDefaults `json:"defaults,omitzero"`
Credentials []DescribeProfileCredential `json:"credentials,omitempty"`
}
DescribeProfile declares one profile seeded when an SDK-built extension is installed.
type DescribeProfileCredential ¶
type DescribeProfileCredential struct {
Provider string `json:"provider"`
Slot string `json:"slot"`
}
DescribeProfileCredential declares one vault-backed setup requirement.
type DescribeProfileDefaults ¶
type DescribeProfileDefaults struct {
Agent string `json:"agent,omitempty"`
Provider string `json:"provider,omitempty"`
}
DescribeProfileDefaults declares profile defaults seeded at creation time.
type DescribeResourcePath ¶
type DescribeResourcePath struct {
Path string `json:"path"`
Profile string `json:"profile,omitempty"`
}
DescribeResourcePath binds one static resource path to every profile or one named profile.
type DescribeResources ¶
type DescribeResources struct {
Skills []DescribeResourcePath `json:"skills,omitempty"`
Loops []DescribeResourcePath `json:"loops,omitempty"`
Agents []DescribeResourcePath `json:"agents,omitempty"`
Automation []DescribeResourcePath `json:"automation,omitempty"`
Layouts []DescribeResourcePath `json:"layouts,omitempty"`
CmdPalette CmdPaletteConfig `json:"cmd_palette,omitzero"`
}
DescribeResources declares source-relative static resource paths copied into a generation.
type DescribeSDKInfo ¶
type DescribeSDKInfo struct {
Name string `json:"name"`
Version string `json:"version"`
ProtocolVersion string `json:"protocol_version"`
MinCompozyVersion string `json:"min_compozy_version"`
}
DescribeSDKInfo identifies the SDK and compatibility floor that authored the payload.
type DescribeSubprocess ¶
type DescribeSubprocess struct {
Command string `json:"command"`
Args []string `json:"args,omitempty"`
Env map[string]string `json:"env,omitempty"`
}
DescribeSubprocess declares the generated manifest's extension process entrypoint.
type EmptyResult ¶
type EmptyResult struct{}
EmptyResult is the empty JSON-RPC result for methods without payloads.
type ExtensionCommandGroupSpec ¶
type ExtensionCommandGroupSpec struct {
Path string `toml:"path" json:"path"`
Summary string `toml:"summary" json:"summary"`
Profile string `toml:"profile,omitempty" json:"profile,omitempty"`
}
ExtensionCommandGroupSpec declares a presentation-only command group.
type ExtensionCommandSpec ¶
type ExtensionCommandSpec = toolspkg.ExtensionCommandSpec
ExtensionCommandSpec presents an extension tool as an operator-facing command.
type ExtensionManifestSummary ¶
type ExtensionManifestSummary = apicontract.ExtensionManifestSummary
ExtensionManifestSummary is the authoring-facing subset of a validated manifest.
type ExtensionValidatePayload ¶
type ExtensionValidatePayload = apicontract.ExtensionValidatePayload
ExtensionValidatePayload is the shared result for extension-package validation surfaces.
type ForgeCapabilitiesRequest ¶
type ForgeCapabilitiesRequest struct {
RemoteURLs []string `json:"remote_urls"`
}
type ForgeCapabilitiesResponse ¶
type ForgeCapabilitiesResponse struct {
SupportsPRDiscovery bool `json:"supports_pr_discovery,omitempty"`
Served bool `json:"served"`
Available bool `json:"available"`
Winner string `json:"winner,omitempty"`
Provider string `json:"provider,omitempty"`
ServedRemote string `json:"served_remote,omitempty"`
RequestNoun string `json:"request_noun,omitempty"`
OpenActionLabel string `json:"open_action_label,omitempty"`
ViewActionLabel string `json:"view_action_label,omitempty"`
SupportsDraft bool `json:"supports_draft,omitempty"`
CompareURLTemplate string `json:"compare_url_template,omitempty"`
TemplatePaths []string `json:"template_paths,omitempty"`
CredentialSource string `json:"credential_source,omitempty"`
DefaultBranch string `json:"default_branch,omitempty"`
Cause string `json:"cause,omitempty"`
}
type ForgeChecks ¶
type ForgePRCandidate ¶
type ForgePRCreateRequest ¶
type ForgePRCreateResponse ¶
type ForgePRReadRequest ¶
type ForgePRSearchRequest ¶
type ForgePRSearchRequest struct {
RemoteURLs []string `json:"remote_urls"`
Query string `json:"query,omitempty"`
Page int `json:"page,omitempty"`
Limit int `json:"limit,omitempty"`
}
ForgePRSearchRequest is an optional paged discovery operation. Providers scope every result to the repository selected by RemoteURLs.
type ForgePRSearchResponse ¶
type ForgePRSearchResponse struct {
Items []ForgePRCandidate `json:"items"`
HasMore bool `json:"has_more"`
}
type ForgeReview ¶
type ForgeReview struct {
ID string `json:"id"`
Author string `json:"author,omitempty"`
IsBot bool `json:"is_bot,omitempty"`
State string `json:"state"`
SubmittedAt *time.Time `json:"submitted_at,omitempty"`
Commit string `json:"commit,omitempty"`
}
ForgeReview is one submitted review. It never carries the review body.
type ForgeReviewThread ¶
ForgeReviewThread is one unresolved review thread. Commit is the commit the thread was opened on, which stays fixed when the head moves; empty means the provider cannot tell.
type ForgeReviews ¶
type ForgeReviews struct {
Items []ForgeReview `json:"items"`
// Threads lists unresolved threads, newest last. UnresolvedThreads is their total, which may exceed
// this list only when Truncated is set.
Threads []ForgeReviewThread `json:"threads,omitempty"`
UnresolvedThreads int `json:"unresolved_threads"`
// Truncated reports that the provider stopped before reading every review or thread.
Truncated bool `json:"truncated,omitempty"`
}
ForgeReviews is optional review activity. A provider that omits it still serves checks; consumers report reviews as not observable.
type ForgeStatusRequest ¶
type ForgeStatusResponse ¶
type ForgeStatusResponse struct {
Title string `json:"title,omitempty"`
Checks *ForgeChecks `json:"checks,omitempty"`
Reviews *ForgeReviews `json:"reviews,omitempty"`
// ReviewsUnavailable reports a provider that serves reviews but failed to read them this time. It is
// distinct from omitting Reviews, which means the provider cannot observe them at all.
ReviewDecision string `json:"review_decision,omitempty"`
Mergeable string `json:"mergeable,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
Selection string `json:"selection,omitempty"`
RetryAfter *time.Time `json:"retry_after,omitempty"`
Provider string `json:"provider"`
PRNumber *int `json:"pr_number,omitempty"`
PRState *string `json:"pr_state,omitempty"`
PRURL string `json:"pr_url,omitempty"`
Head string `json:"head,omitempty"`
Base string `json:"base,omitempty"`
HeadSHA string `json:"head_sha,omitempty"`
Draft *bool `json:"draft,omitempty"`
Merged *bool `json:"merged,omitempty"`
FetchedAt time.Time `json:"fetched_at"`
Cause string `json:"cause,omitempty"`
}
type HookContractSpec ¶
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.
type HostAPIMethod ¶
type HostAPIMethod = extensionprotocol.HostAPIMethod
HostAPIMethod identifies one extension -> Compozy 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 IssueSeverity ¶
type IssueSeverity = apicontract.IssueSeverity
IssueSeverity classifies one extension-package validation issue.
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 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 Compozy to extension model sources.
type ModelSourceListResponse ¶
type ModelSourceListResponse struct {
Rows []ModelSourceRow `json:"rows"`
}
ModelSourceListResponse is returned by extension model sources.
type ModelSourceOptionDescriptor ¶
type ModelSourceOptionDescriptor struct {
ID string `json:"id"`
Label string `json:"label,omitempty"`
Description string `json:"description,omitempty"`
Category string `json:"category,omitempty"`
Kind ModelSourceOptionKind `json:"kind"`
CurrentValueID string `json:"current_value_id,omitempty"`
CurrentBool *bool `json:"current_bool,omitempty"`
Values []ModelSourceOptionValue `json:"values,omitempty"`
}
ModelSourceOptionDescriptor describes one option supported by a logical model.
type ModelSourceOptionKind ¶
type ModelSourceOptionKind string
ModelSourceOptionKind identifies the value shape of an extension-provided model option.
const ( ModelSourceOptionKindSelect ModelSourceOptionKind = "select" ModelSourceOptionKindBoolean ModelSourceOptionKind = "boolean" )
type ModelSourceOptionSelection ¶
type ModelSourceOptionSelection struct {
ID string `json:"id"`
ValueID string `json:"value_id,omitempty"`
BoolValue *bool `json:"bool_value,omitempty"`
}
ModelSourceOptionSelection selects one typed option value for a transport binding.
type ModelSourceOptionValue ¶
type ModelSourceOptionValue struct {
ValueID string `json:"value_id"`
Label string `json:"label,omitempty"`
Description string `json:"description,omitempty"`
GroupID string `json:"group_id,omitempty"`
GroupLabel string `json:"group_label,omitempty"`
Order int `json:"order,omitempty"`
}
ModelSourceOptionValue is one grouped value of a select option.
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 []apicontract.ReasoningEffort `json:"reasoning_efforts,omitempty"`
DefaultReasoningEffort *apicontract.ReasoningEffort `json:"default_reasoning_effort,omitempty"`
// ConfigOptions declares provider-visible select and boolean controls for this logical model.
ConfigOptions []ModelSourceOptionDescriptor `json:"config_options,omitempty"`
// TransportBindings maps supported option combinations to private provider transport IDs.
TransportBindings []ModelSourceTransportBinding `json:"transport_bindings,omitempty"`
Cost *apicontract.ModelCatalogCostPayload `json:"cost,omitempty"`
Deprecated *bool `json:"deprecated,omitempty"`
Hidden *bool `json:"hidden,omitempty"`
Featured *bool `json:"featured,omitempty"`
ReleaseDate *string `json:"release_date,omitempty"`
LastError string `json:"last_error,omitempty"`
}
ModelSourceRow is one extension-provided model catalog source row.
type ModelSourceTransportBinding ¶
type ModelSourceTransportBinding struct {
TransportModelID string `json:"transport_model_id"`
Label string `json:"label,omitempty"`
ReasoningEffort *apicontract.ReasoningEffort `json:"reasoning_effort,omitempty"`
Fast *bool `json:"fast,omitempty"`
Thinking *bool `json:"thinking,omitempty"`
OptionSelections []ModelSourceOptionSelection `json:"option_selections,omitempty"`
}
ModelSourceTransportBinding maps a logical model configuration to a provider transport identifier.
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 ¶
NamedType links a generated TypeScript export name to a Go type.
func SDKRootTypes ¶
func SDKRootTypes() []NamedType
SDKRootTypes returns a defensive copy of every canonical generated SDK contract root.
type ObserveHealth ¶
type ObserveHealth = observepkg.Health
ObserveHealth is the host-visible daemon health payload.
type PermissionContract ¶
PermissionContract binds one Host API method to its operator-facing consent area.
func PermissionContractForMethod ¶
func PermissionContractForMethod(method string) (PermissionContract, bool)
PermissionContractForMethod resolves one closed-set Host API permission.
func PermissionContracts ¶
func PermissionContracts() []PermissionContract
PermissionContracts returns every Host API permission in protocol order.
type ProvideCapabilityContract ¶
ProvideCapabilityContract binds a daemon-recognized provide surface to its service methods.
func ProvideCapabilityContracts ¶
func ProvideCapabilityContracts() []ProvideCapabilityContract
ProvideCapabilityContracts returns the daemon capability registry in stable order.
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 SDKEnumContract ¶
SDKEnumContract binds one daemon enum type to its closed public wire vocabulary.
func SDKEnumContracts ¶
func SDKEnumContracts() []SDKEnumContract
SDKEnumContracts returns the enums whose Go SDK declarations require generated constants.
type SessionCreateResult ¶
type SessionCreateResult struct {
SessionID string `json:"session_id"`
}
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 SessionInput ¶
type SessionInput struct {
SteerDelivery store.SteerDeliveryMode `json:"steer_delivery,omitempty"`
ID string `json:"id"`
SessionID string `json:"session_id"`
MessageID string `json:"message_id,omitempty"`
IdempotencyKey string `json:"idempotency_key,omitempty"`
TargetTurnID string `json:"target_turn_id,omitempty"`
Status string `json:"status"`
Mode apicontract.PromptMode `json:"mode"`
Delivery apicontract.PromptDelivery `json:"delivery"`
Text string `json:"text"`
QueueGeneration int64 `json:"queue_generation"`
EnqueuedAt time.Time `json:"enqueued_at"`
Runtime *apicontract.PromptRuntimeSelectionPayload `json:"runtime,omitempty"`
}
SessionInput is one durable operator input waiting for session dispatch.
type SessionInputListResult ¶
type SessionInputListResult struct {
Inputs []SessionInput `json:"inputs"`
}
SessionInputListResult returns pending input in daemon dispatch order.
type SessionInputPromoteParams ¶
type SessionInputPromoteParams struct {
WorkspaceID string `json:"workspace_id"`
SessionID string `json:"session_id"`
QueueEntryID string `json:"queue_entry_id"`
Text string `json:"text"`
MessageID string `json:"message_id"`
IdempotencyKey string `json:"idempotency_key"`
ExpectedTurnID string `json:"expected_turn_id"`
}
SessionInputPromoteParams atomically promotes one queued input to fenced steering.
type SessionInputReplaceParams ¶
type SessionInputReplaceParams struct {
WorkspaceID string `json:"workspace_id"`
SessionID string `json:"session_id"`
QueueEntryID string `json:"queue_entry_id"`
Text string `json:"text"`
MessageID string `json:"message_id"`
IdempotencyKey string `json:"idempotency_key"`
}
SessionInputReplaceParams atomically replaces one queued input and its durable identity.
type SessionInputResult ¶
type SessionInputResult struct {
Input SessionInput `json:"input"`
}
SessionInputResult returns one durable pending input.
type SessionInputTargetParams ¶
type SessionInputTargetParams struct {
WorkspaceID string `json:"workspace_id"`
SessionID string `json:"session_id"`
QueueEntryID string `json:"queue_entry_id"`
}
SessionInputTargetParams identifies one durable pending input.
type SessionInputsListParams ¶
type SessionInputsListParams = SessionTargetParams
SessionInputsListParams identifies the pending inputs for one session.
type SessionPromptResult ¶
type SessionPromptResult struct {
Disposition session.Disposition `json:"disposition,omitempty"`
SteerDelivery store.SteerDeliveryMode `json:"steer_delivery,omitempty"`
EntryID string `json:"entry_id,omitempty"`
Status string `json:"status"`
Mode apicontract.PromptMode `json:"mode,omitempty"`
Delivery apicontract.PromptDelivery `json:"delivery"`
MessageID string `json:"message_id"`
IdempotencyKey string `json:"idempotency_key"`
Replayed bool `json:"replayed"`
TurnID string `json:"turn_id,omitempty"`
QueueEntryID string `json:"queue_entry_id,omitempty"`
QueuePosition int `json:"queue_position,omitempty"`
QueueGeneration int64 `json:"queue_generation,omitempty"`
EstimatedSendAt *time.Time `json:"estimated_send_at,omitempty"`
PreviousTurnID string `json:"previous_turn_id,omitempty"`
CanceledQueuedEntries int `json:"canceled_queued_entries,omitempty"`
}
SessionPromptResult reports an immediate or deferred prompt admission.
type SessionRuntimeClearParams ¶
type SessionRuntimeClearParams struct {
WorkspaceID string `json:"workspace_id"`
SessionID string `json:"session_id"`
ExpectedRevision *int64 `json:"expected_revision"`
}
SessionRuntimeClearParams clears the durable runtime selection.
type SessionRuntimeSelectionPayload ¶
type SessionRuntimeSelectionPayload struct {
Provider string `json:"provider"`
Model string `json:"model,omitempty"`
ReasoningEffort modelcatalog.ReasoningEffort `json:"reasoning_effort,omitempty"`
Speed speedpkg.Speed `json:"speed,omitempty"`
ACPOptions []apicontract.AgentACPOptionSelection `json:"acp_options,omitempty"`
}
SessionRuntimeSelectionPayload is the extension-owned wire shape for a durable runtime choice.
type SessionRuntimeSetParams ¶
type SessionRuntimeSetParams struct {
WorkspaceID string `json:"workspace_id"`
SessionID string `json:"session_id"`
Runtime SessionRuntimeSelectionPayload `json:"runtime"`
ExpectedRevision *int64 `json:"expected_revision"`
}
SessionRuntimeSetParams durably selects the default runtime for future prompts.
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"`
Runtime apicontract.SessionRuntimePayload `json:"runtime"`
WorkspaceID string `json:"workspace_id,omitempty"`
Workspace string `json:"workspace,omitempty"`
State session.State `json:"state"`
ArchivedAt *time.Time `json:"archived_at"`
StopReason store.StopReason `json:"stop_reason,omitempty"`
StopDetail string `json:"stop_detail,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"`
Runtime apicontract.SessionRuntimePayload `json:"runtime"`
Workspace string `json:"workspace,omitempty"`
State session.State `json:"state"`
ArchivedAt *time.Time `json:"archived_at"`
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"`
Workspace string `json:"workspace,omitempty"`
}
SessionsCreateParams starts a new session.
type SessionsListParams ¶
type SessionsListParams struct {
Workspace string `json:"workspace,omitempty"`
Archive string `json:"archive,omitempty"`
}
SessionsListParams filters visible sessions.
type SessionsPromptParams ¶
type SessionsPromptParams struct {
WorkspaceID string `json:"workspace_id"`
SessionID string `json:"session_id"`
Message string `json:"message"`
MessageID string `json:"message_id"`
IdempotencyKey string `json:"idempotency_key"`
Mode apicontract.PromptMode `json:"mode,omitempty"`
ExpectedTurnID string `json:"expected_turn_id,omitempty"`
Runtime *apicontract.PromptRuntimeSelectionPayload `json:"runtime,omitempty"`
}
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"`
Origin string `json:"origin"`
Enabled bool `json:"enabled"`
Activation apicontract.SkillActivationPayload `json:"activation"`
}
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 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 TaskRunResultParams ¶
type TaskRunResultParams struct {
ID string `json:"id"`
Offset int64 `json:"offset,omitempty"`
Limit int64 `json:"limit,omitempty"`
}
TaskRunResultParams reads one exact byte page from a task-run result.
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 ValidationIssue ¶
type ValidationIssue = apicontract.ValidationIssue
ValidationIssue is one positioned extension-package validation diagnostic.
type ViewFrame ¶
type ViewFrame = cmdpalette.ViewFrame
ViewFrame is the canonical programmable-view frame shared with SDK codegen.
Source Files
¶
- authoring.go
- capabilities.go
- cmd_palette.go
- command.go
- describe.go
- forge.go
- gateway_source.go
- host_api.go
- host_api_automation_params.go
- host_api_clarify.go
- host_api_method_aliases_gen.go
- host_api_method_registry_automation_gen.go
- host_api_method_registry_clarify_gen.go
- host_api_method_registry_core_gen.go
- host_api_method_registry_gen.go
- host_api_method_registry_resources_gen.go
- host_api_method_registry_tasks_gen.go
- host_api_resource.go
- host_api_results.go
- host_api_task_resource_params.go
- model_source.go
- permissions.go
- sdk.go
- sdk_contract_builder.go
- sdk_enums.go
- sdk_host_control.go
- sdk_named_types.go
- sdk_named_types_terminal.go
- sdk_window_manager_hooks.go
- skills.go