protocol

package
v0.145.0 Latest Latest
Warning

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

Go to latest
Published: Jul 21, 2026 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Index

Constants

View Source
const GeneratedCodexCommit = "5d1fbf26c43abc65a203928b2e31561cb039e06d"

GeneratedCodexCommit is the Codex source commit used to generate this protocol package.

View Source
const GeneratedCodexVersion = "0.144.6"

GeneratedCodexVersion is the Codex package version used to generate this protocol package.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbsolutePathBuf

type AbsolutePathBuf string

A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).

IMPORTANT: When deserializing an `AbsolutePathBuf`, a base path must be set using [AbsolutePathBufGuard::new]. If no base path is set, the deserialization will fail unless the path being deserialized is already absolute.

type Account

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

Account preserves the complete JSON payload for a discriminated union.

func NewAccount added in v0.145.0

func NewAccount(value any) (Account, error)

NewAccount validates the discriminator and wraps a JSON-marshalable Account value.

func (Account) IsKnown added in v0.145.0

func (value Account) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (Account) Kind added in v0.145.0

func (value Account) Kind() AccountKind

Kind returns the payload discriminator, including unknown future values.

func (Account) MarshalJSON added in v0.145.0

func (value Account) MarshalJSON() ([]byte, error)

func (Account) RawJSON added in v0.145.0

func (value Account) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*Account) UnmarshalJSON added in v0.145.0

func (value *Account) UnmarshalJSON(data []byte) error

type AccountKind added in v0.145.0

type AccountKind string

AccountKind identifies a known Account variant.

const (
	AccountKindAmazonBedrock AccountKind = "amazonBedrock"
	AccountKindApiKey        AccountKind = "apiKey"
	AccountKindChatgpt       AccountKind = "chatgpt"
)

type AccountLoginCompletedNotification

type AccountLoginCompletedNotification = SanitizedAccountLoginCompletedNotificationJSON

Fallback types for schemas that failed to generate.

type AccountTokenUsageDailyBucket

type AccountTokenUsageDailyBucket struct {
	// StartDate corresponds to the JSON schema field "startDate".
	StartDate string `json:"startDate"`

	// Tokens corresponds to the JSON schema field "tokens".
	Tokens int `json:"tokens"`
}

type AccountTokenUsageSummary

type AccountTokenUsageSummary struct {
	// CurrentStreakDays corresponds to the JSON schema field "currentStreakDays".
	CurrentStreakDays AccountTokenUsageSummaryCurrentStreakDays `json:"currentStreakDays,omitempty,omitzero"`

	// LifetimeTokens corresponds to the JSON schema field "lifetimeTokens".
	LifetimeTokens AccountTokenUsageSummaryLifetimeTokens `json:"lifetimeTokens,omitempty,omitzero"`

	// LongestRunningTurnSec corresponds to the JSON schema field
	// "longestRunningTurnSec".
	LongestRunningTurnSec AccountTokenUsageSummaryLongestRunningTurnSec `json:"longestRunningTurnSec,omitempty,omitzero"`

	// LongestStreakDays corresponds to the JSON schema field "longestStreakDays".
	LongestStreakDays AccountTokenUsageSummaryLongestStreakDays `json:"longestStreakDays,omitempty,omitzero"`

	// PeakDailyTokens corresponds to the JSON schema field "peakDailyTokens".
	PeakDailyTokens AccountTokenUsageSummaryPeakDailyTokens `json:"peakDailyTokens,omitempty,omitzero"`
}

type AccountTokenUsageSummaryCurrentStreakDays added in v0.144.0

type AccountTokenUsageSummaryCurrentStreakDays *int

type AccountTokenUsageSummaryLifetimeTokens added in v0.144.0

type AccountTokenUsageSummaryLifetimeTokens *int

type AccountTokenUsageSummaryLongestRunningTurnSec added in v0.144.0

type AccountTokenUsageSummaryLongestRunningTurnSec *int

type AccountTokenUsageSummaryLongestStreakDays added in v0.144.0

type AccountTokenUsageSummaryLongestStreakDays *int

type AccountTokenUsageSummaryPeakDailyTokens added in v0.144.0

type AccountTokenUsageSummaryPeakDailyTokens *int

type AddCreditsNudgeCreditType

type AddCreditsNudgeCreditType string
const AddCreditsNudgeCreditTypeCredits AddCreditsNudgeCreditType = "credits"
const AddCreditsNudgeCreditTypeUsageLimit AddCreditsNudgeCreditType = "usage_limit"

type AddCreditsNudgeEmailStatus

type AddCreditsNudgeEmailStatus string
const AddCreditsNudgeEmailStatusCooldownActive AddCreditsNudgeEmailStatus = "cooldown_active"
const AddCreditsNudgeEmailStatusSent AddCreditsNudgeEmailStatus = "sent"

type AdditionalContextEntry

type AdditionalContextEntry struct {
	// Kind corresponds to the JSON schema field "kind".
	Kind AdditionalContextKind `json:"kind"`

	// Value corresponds to the JSON schema field "value".
	Value string `json:"value"`
}

type AdditionalContextKind

type AdditionalContextKind string
const AdditionalContextKindApplication AdditionalContextKind = "application"
const AdditionalContextKindUntrusted AdditionalContextKind = "untrusted"

type AdditionalFileSystemPermissions

type AdditionalFileSystemPermissions struct {
	// Entries corresponds to the JSON schema field "entries".
	Entries *AdditionalFileSystemPermissionsEntries `json:"entries,omitempty,omitzero"`

	// GlobScanMaxDepth corresponds to the JSON schema field "globScanMaxDepth".
	GlobScanMaxDepth AdditionalFileSystemPermissionsGlobScanMaxDepth `json:"globScanMaxDepth,omitempty,omitzero"`

	// This will be removed in favor of `entries`.
	Read *AdditionalFileSystemPermissionsRead `json:"read,omitempty,omitzero"`

	// This will be removed in favor of `entries`.
	Write *AdditionalFileSystemPermissionsWrite `json:"write,omitempty,omitzero"`
}

type AdditionalFileSystemPermissionsEntries added in v0.144.0

type AdditionalFileSystemPermissionsEntries []FileSystemSandboxEntry

type AdditionalFileSystemPermissionsGlobScanMaxDepth added in v0.144.0

type AdditionalFileSystemPermissionsGlobScanMaxDepth *int

type AdditionalFileSystemPermissionsRead added in v0.144.0

type AdditionalFileSystemPermissionsRead []LegacyAppPathString

This will be removed in favor of `entries`.

type AdditionalFileSystemPermissionsWrite added in v0.144.0

type AdditionalFileSystemPermissionsWrite []LegacyAppPathString

This will be removed in favor of `entries`.

type AdditionalNetworkPermissions

type AdditionalNetworkPermissions struct {
	// Enabled corresponds to the JSON schema field "enabled".
	Enabled AdditionalNetworkPermissionsEnabled `json:"enabled,omitempty,omitzero"`
}

type AdditionalNetworkPermissionsEnabled added in v0.144.0

type AdditionalNetworkPermissionsEnabled *bool

type AgentMessageInputContent

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

AgentMessageInputContent preserves the complete JSON payload for a discriminated union.

func NewAgentMessageInputContent added in v0.145.0

func NewAgentMessageInputContent(value any) (AgentMessageInputContent, error)

NewAgentMessageInputContent validates the discriminator and wraps a JSON-marshalable AgentMessageInputContent value.

func (AgentMessageInputContent) IsKnown added in v0.145.0

func (value AgentMessageInputContent) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (AgentMessageInputContent) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (AgentMessageInputContent) MarshalJSON added in v0.145.0

func (value AgentMessageInputContent) MarshalJSON() ([]byte, error)

func (AgentMessageInputContent) RawJSON added in v0.145.0

func (value AgentMessageInputContent) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*AgentMessageInputContent) UnmarshalJSON added in v0.145.0

func (value *AgentMessageInputContent) UnmarshalJSON(data []byte) error

type AgentMessageInputContentKind added in v0.145.0

type AgentMessageInputContentKind string

AgentMessageInputContentKind identifies a known AgentMessageInputContent variant.

const (
	AgentMessageInputContentKindEncryptedContent AgentMessageInputContentKind = "encrypted_content"
	AgentMessageInputContentKindInputText        AgentMessageInputContentKind = "input_text"
)

type AmazonBedrockCredentialSource

type AmazonBedrockCredentialSource string
const AmazonBedrockCredentialSourceAwsManaged AmazonBedrockCredentialSource = "awsManaged"
const AmazonBedrockCredentialSourceCodexManaged AmazonBedrockCredentialSource = "codexManaged"

type AppBranding

type AppBranding struct {
	// Category corresponds to the JSON schema field "category".
	Category AppBrandingCategory `json:"category,omitempty,omitzero"`

	// Developer corresponds to the JSON schema field "developer".
	Developer AppBrandingDeveloper `json:"developer,omitempty,omitzero"`

	// IsDiscoverableApp corresponds to the JSON schema field "isDiscoverableApp".
	IsDiscoverableApp bool `json:"isDiscoverableApp"`

	// PrivacyPolicy corresponds to the JSON schema field "privacyPolicy".
	PrivacyPolicy AppBrandingPrivacyPolicy `json:"privacyPolicy,omitempty,omitzero"`

	// TermsOfService corresponds to the JSON schema field "termsOfService".
	TermsOfService AppBrandingTermsOfService `json:"termsOfService,omitempty,omitzero"`

	// Website corresponds to the JSON schema field "website".
	Website AppBrandingWebsite `json:"website,omitempty,omitzero"`
}

EXPERIMENTAL - app metadata returned by app-list APIs.

type AppBrandingCategory added in v0.144.0

type AppBrandingCategory *string

type AppBrandingDeveloper added in v0.144.0

type AppBrandingDeveloper *string

type AppBrandingPrivacyPolicy added in v0.144.0

type AppBrandingPrivacyPolicy *string

type AppBrandingTermsOfService added in v0.144.0

type AppBrandingTermsOfService *string

type AppBrandingWebsite added in v0.144.0

type AppBrandingWebsite *string

type AppInfo

type AppInfo struct {
	// AppMetadata corresponds to the JSON schema field "appMetadata".
	AppMetadata interface{} `json:"appMetadata,omitempty,omitzero"`

	// Branding corresponds to the JSON schema field "branding".
	Branding interface{} `json:"branding,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description AppInfoDescription `json:"description,omitempty,omitzero"`

	// DistributionChannel corresponds to the JSON schema field "distributionChannel".
	DistributionChannel AppInfoDistributionChannel `json:"distributionChannel,omitempty,omitzero"`

	// IconAssets corresponds to the JSON schema field "iconAssets".
	IconAssets *AppInfoIconAssets `json:"iconAssets,omitempty,omitzero"`

	// IconDarkAssets corresponds to the JSON schema field "iconDarkAssets".
	IconDarkAssets *AppInfoIconDarkAssets `json:"iconDarkAssets,omitempty,omitzero"`

	// ID corresponds to the JSON schema field "id".
	ID string `json:"id"`

	// InstallURL corresponds to the JSON schema field "installUrl".
	InstallURL AppInfoInstallURL `json:"installUrl,omitempty,omitzero"`

	// IsAccessible corresponds to the JSON schema field "isAccessible".
	IsAccessible bool `json:"isAccessible,omitempty,omitzero"`

	// Whether this app is enabled in config.toml. Example: “`toml [apps.bad_app]
	// enabled = false “`
	IsEnabled bool `json:"isEnabled,omitempty,omitzero"`

	// Labels corresponds to the JSON schema field "labels".
	Labels *AppInfoLabels `json:"labels,omitempty,omitzero"`

	// LogoURL corresponds to the JSON schema field "logoUrl".
	LogoURL AppInfoLogoURL `json:"logoUrl,omitempty,omitzero"`

	// LogoURLDark corresponds to the JSON schema field "logoUrlDark".
	LogoURLDark AppInfoLogoURLDark `json:"logoUrlDark,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// PluginDisplayNames corresponds to the JSON schema field "pluginDisplayNames".
	PluginDisplayNames []string `json:"pluginDisplayNames,omitempty,omitzero"`
}

EXPERIMENTAL - app metadata returned by app-list APIs.

type AppInfoDescription added in v0.144.0

type AppInfoDescription *string

type AppInfoDistributionChannel added in v0.144.0

type AppInfoDistributionChannel *string

type AppInfoIconAssets added in v0.144.0

type AppInfoIconAssets map[string]string

type AppInfoIconDarkAssets added in v0.144.0

type AppInfoIconDarkAssets map[string]string

type AppInfoInstallURL added in v0.144.0

type AppInfoInstallURL *string

type AppInfoLabels added in v0.144.0

type AppInfoLabels map[string]string

type AppInfoLogoURL added in v0.144.0

type AppInfoLogoURL *string

type AppInfoLogoURLDark added in v0.144.0

type AppInfoLogoURLDark *string

type AppMetadata

type AppMetadata struct {
	// Categories corresponds to the JSON schema field "categories".
	Categories *AppMetadataCategories `json:"categories,omitempty,omitzero"`

	// Developer corresponds to the JSON schema field "developer".
	Developer AppMetadataDeveloper `json:"developer,omitempty,omitzero"`

	// FirstPartyRequiresInstall corresponds to the JSON schema field
	// "firstPartyRequiresInstall".
	FirstPartyRequiresInstall AppMetadataFirstPartyRequiresInstall `json:"firstPartyRequiresInstall,omitempty,omitzero"`

	// FirstPartyType corresponds to the JSON schema field "firstPartyType".
	FirstPartyType AppMetadataFirstPartyType `json:"firstPartyType,omitempty,omitzero"`

	// Review corresponds to the JSON schema field "review".
	Review interface{} `json:"review,omitempty,omitzero"`

	// Screenshots corresponds to the JSON schema field "screenshots".
	Screenshots *AppMetadataScreenshots `json:"screenshots,omitempty,omitzero"`

	// SeoDescription corresponds to the JSON schema field "seoDescription".
	SeoDescription AppMetadataSeoDescription `json:"seoDescription,omitempty,omitzero"`

	// ShowInComposerWhenUnlinked corresponds to the JSON schema field
	// "showInComposerWhenUnlinked".
	ShowInComposerWhenUnlinked AppMetadataShowInComposerWhenUnlinked `json:"showInComposerWhenUnlinked,omitempty,omitzero"`

	// SubCategories corresponds to the JSON schema field "subCategories".
	SubCategories *AppMetadataSubCategories `json:"subCategories,omitempty,omitzero"`

	// Version corresponds to the JSON schema field "version".
	Version AppMetadataVersion `json:"version,omitempty,omitzero"`

	// VersionID corresponds to the JSON schema field "versionId".
	VersionID AppMetadataVersionID `json:"versionId,omitempty,omitzero"`

	// VersionNotes corresponds to the JSON schema field "versionNotes".
	VersionNotes AppMetadataVersionNotes `json:"versionNotes,omitempty,omitzero"`
}

type AppMetadataCategories added in v0.144.0

type AppMetadataCategories []string

type AppMetadataDeveloper added in v0.144.0

type AppMetadataDeveloper *string

type AppMetadataFirstPartyRequiresInstall added in v0.144.0

type AppMetadataFirstPartyRequiresInstall *bool

type AppMetadataFirstPartyType added in v0.144.0

type AppMetadataFirstPartyType *string

type AppMetadataScreenshots added in v0.144.0

type AppMetadataScreenshots []AppScreenshot

type AppMetadataSeoDescription added in v0.144.0

type AppMetadataSeoDescription *string

type AppMetadataShowInComposerWhenUnlinked added in v0.144.0

type AppMetadataShowInComposerWhenUnlinked *bool

type AppMetadataSubCategories added in v0.144.0

type AppMetadataSubCategories []string

type AppMetadataVersion added in v0.144.0

type AppMetadataVersion *string

type AppMetadataVersionID added in v0.144.0

type AppMetadataVersionID *string

type AppMetadataVersionNotes added in v0.144.0

type AppMetadataVersionNotes *string

type AppReview

type AppReview struct {
	// Status corresponds to the JSON schema field "status".
	Status string `json:"status"`
}

type AppScreenshot

type AppScreenshot struct {
	// FileID corresponds to the JSON schema field "fileId".
	FileID AppScreenshotFileID `json:"fileId,omitempty,omitzero"`

	// URL corresponds to the JSON schema field "url".
	URL AppScreenshotURL `json:"url,omitempty,omitzero"`

	// UserPrompt corresponds to the JSON schema field "userPrompt".
	UserPrompt string `json:"userPrompt"`
}

type AppScreenshotFileID added in v0.144.0

type AppScreenshotFileID *string

type AppScreenshotURL added in v0.144.0

type AppScreenshotURL *string

type AppSummary

type AppSummary struct {
	// Category corresponds to the JSON schema field "category".
	Category AppSummaryCategory `json:"category,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description AppSummaryDescription `json:"description,omitempty,omitzero"`

	// ID corresponds to the JSON schema field "id".
	ID string `json:"id"`

	// InstallURL corresponds to the JSON schema field "installUrl".
	InstallURL AppSummaryInstallURL `json:"installUrl,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

EXPERIMENTAL - app metadata summary for plugin responses.

type AppSummaryCategory added in v0.144.0

type AppSummaryCategory *string

type AppSummaryDescription added in v0.144.0

type AppSummaryDescription *string

type AppSummaryInstallURL added in v0.144.0

type AppSummaryInstallURL *string

type ApplyPatchApprovalParams

type ApplyPatchApprovalParams struct {
	CallID         string         `json:"callId"`
	ConversationID string         `json:"conversationId"`
	FileChanges    map[string]any `json:"fileChanges"`
	GrantRoot      *string        `json:"grantRoot,omitempty"`
	Reason         *string        `json:"reason,omitempty"`
}

ApplyPatchApprovalParams is maintained manually to keep FileChanges source compatible with older untyped callers.

type ApplyPatchApprovalResponse

type ApplyPatchApprovalResponse = SanitizedApplyPatchApprovalResponse

ApplyPatchApprovalResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type ApprovalsReviewer

type ApprovalsReviewer string
const ApprovalsReviewerAutoReview ApprovalsReviewer = "auto_review"
const ApprovalsReviewerGuardianSubagent ApprovalsReviewer = "guardian_subagent"
const ApprovalsReviewerUser ApprovalsReviewer = "user"

type AppsListParams

type AppsListParams struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor AppsListParamsCursor `json:"cursor,omitempty,omitzero"`

	// When true, bypass app caches and fetch the latest data from sources.
	ForceRefetch *bool `json:"forceRefetch,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit AppsListParamsLimit `json:"limit,omitempty,omitzero"`

	// Optional thread id used to evaluate app feature gating from that thread's
	// config.
	ThreadID AppsListParamsThreadID `json:"threadId,omitempty,omitzero"`
}

EXPERIMENTAL - list available apps/connectors.

type AppsListParamsCursor added in v0.144.0

type AppsListParamsCursor *string

Opaque pagination cursor returned by a previous call.

type AppsListParamsLimit added in v0.144.0

type AppsListParamsLimit *int

Optional page size; defaults to a reasonable server-side value.

type AppsListParamsThreadID added in v0.144.0

type AppsListParamsThreadID *string

Optional thread id used to evaluate app feature gating from that thread's config.

type AppsListResponse

type AppsListResponse = SanitizedAppsListResponseJSON

type AskForApproval

type AskForApproval interface{}

type AuthMode

type AuthMode interface{}

Authentication mode for OpenAI-backed providers.

type ByteRange

type ByteRange struct {
	// End corresponds to the JSON schema field "end".
	End int `json:"end"`

	// Start corresponds to the JSON schema field "start".
	Start int `json:"start"`
}

type CancelLoginAccountParams

type CancelLoginAccountParams struct {
	// LoginID corresponds to the JSON schema field "loginId".
	LoginID string `json:"loginId"`
}

type CancelLoginAccountStatus

type CancelLoginAccountStatus string
const CancelLoginAccountStatusCanceled CancelLoginAccountStatus = "canceled"
const CancelLoginAccountStatusNotFound CancelLoginAccountStatus = "notFound"

type CapabilityRootLocation

type CapabilityRootLocation interface{}

Location used to resolve a selected capability root.

type ChatgptAuthTokensRefreshReason

type ChatgptAuthTokensRefreshReason interface{}

type ClientInfo

type ClientInfo struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Title corresponds to the JSON schema field "title".
	Title ClientInfoTitle `json:"title,omitempty,omitzero"`

	// Version corresponds to the JSON schema field "version".
	Version string `json:"version"`
}

type ClientInfoTitle added in v0.144.0

type ClientInfoTitle *string

type ClientNotification

type ClientNotification interface{}

type ClientRequest

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

ClientRequest preserves the complete JSON payload for a discriminated union.

func NewClientRequest added in v0.145.0

func NewClientRequest(value any) (ClientRequest, error)

NewClientRequest validates the discriminator and wraps a JSON-marshalable ClientRequest value.

func (ClientRequest) IsKnown added in v0.145.0

func (value ClientRequest) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ClientRequest) Kind added in v0.145.0

func (value ClientRequest) Kind() ClientRequestKind

Kind returns the payload discriminator, including unknown future values.

func (ClientRequest) MarshalJSON added in v0.145.0

func (value ClientRequest) MarshalJSON() ([]byte, error)

func (ClientRequest) RawJSON added in v0.145.0

func (value ClientRequest) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ClientRequest) UnmarshalJSON added in v0.145.0

func (value *ClientRequest) UnmarshalJSON(data []byte) error

type ClientRequestKind added in v0.145.0

type ClientRequestKind string

ClientRequestKind identifies a known ClientRequest variant.

const (
	ClientRequestKindAccountLoginCancel                     ClientRequestKind = "account/login/cancel"
	ClientRequestKindAccountLoginStart                      ClientRequestKind = "account/login/start"
	ClientRequestKindAccountLogout                          ClientRequestKind = "account/logout"
	ClientRequestKindAccountRateLimitResetCreditConsume     ClientRequestKind = "account/rateLimitResetCredit/consume"
	ClientRequestKindAccountRateLimitsRead                  ClientRequestKind = "account/rateLimits/read"
	ClientRequestKindAccountRead                            ClientRequestKind = "account/read"
	ClientRequestKindAccountSendAddCreditsNudgeEmail        ClientRequestKind = "account/sendAddCreditsNudgeEmail"
	ClientRequestKindAccountUsageRead                       ClientRequestKind = "account/usage/read"
	ClientRequestKindAccountWorkspaceMessagesRead           ClientRequestKind = "account/workspaceMessages/read"
	ClientRequestKindAppList                                ClientRequestKind = "app/list"
	ClientRequestKindCommandExec                            ClientRequestKind = "command/exec"
	ClientRequestKindCommandExecResize                      ClientRequestKind = "command/exec/resize"
	ClientRequestKindCommandExecTerminate                   ClientRequestKind = "command/exec/terminate"
	ClientRequestKindCommandExecWrite                       ClientRequestKind = "command/exec/write"
	ClientRequestKindConfigBatchWrite                       ClientRequestKind = "config/batchWrite"
	ClientRequestKindConfigMcpServerReload                  ClientRequestKind = "config/mcpServer/reload"
	ClientRequestKindConfigRead                             ClientRequestKind = "config/read"
	ClientRequestKindConfigValueWrite                       ClientRequestKind = "config/value/write"
	ClientRequestKindConfigRequirementsRead                 ClientRequestKind = "configRequirements/read"
	ClientRequestKindExperimentalFeatureEnablementSet       ClientRequestKind = "experimentalFeature/enablement/set"
	ClientRequestKindExperimentalFeatureList                ClientRequestKind = "experimentalFeature/list"
	ClientRequestKindExternalAgentConfigDetect              ClientRequestKind = "externalAgentConfig/detect"
	ClientRequestKindExternalAgentConfigImport              ClientRequestKind = "externalAgentConfig/import"
	ClientRequestKindExternalAgentConfigImportReadHistories ClientRequestKind = "externalAgentConfig/import/readHistories"
	ClientRequestKindFeedbackUpload                         ClientRequestKind = "feedback/upload"
	ClientRequestKindFsCopy                                 ClientRequestKind = "fs/copy"
	ClientRequestKindFsCreateDirectory                      ClientRequestKind = "fs/createDirectory"
	ClientRequestKindFsGetMetadata                          ClientRequestKind = "fs/getMetadata"
	ClientRequestKindFsReadDirectory                        ClientRequestKind = "fs/readDirectory"
	ClientRequestKindFsReadFile                             ClientRequestKind = "fs/readFile"
	ClientRequestKindFsRemove                               ClientRequestKind = "fs/remove"
	ClientRequestKindFsUnwatch                              ClientRequestKind = "fs/unwatch"
	ClientRequestKindFsWatch                                ClientRequestKind = "fs/watch"
	ClientRequestKindFsWriteFile                            ClientRequestKind = "fs/writeFile"
	ClientRequestKindFuzzyFileSearch                        ClientRequestKind = "fuzzyFileSearch"
	ClientRequestKindHooksList                              ClientRequestKind = "hooks/list"
	ClientRequestKindInitialize                             ClientRequestKind = "initialize"
	ClientRequestKindMarketplaceAdd                         ClientRequestKind = "marketplace/add"
	ClientRequestKindMarketplaceRemove                      ClientRequestKind = "marketplace/remove"
	ClientRequestKindMarketplaceUpgrade                     ClientRequestKind = "marketplace/upgrade"
	ClientRequestKindMcpServerOauthLogin                    ClientRequestKind = "mcpServer/oauth/login"
	ClientRequestKindMcpServerResourceRead                  ClientRequestKind = "mcpServer/resource/read"
	ClientRequestKindMcpServerToolCall                      ClientRequestKind = "mcpServer/tool/call"
	ClientRequestKindMcpServerStatusList                    ClientRequestKind = "mcpServerStatus/list"
	ClientRequestKindModelList                              ClientRequestKind = "model/list"
	ClientRequestKindModelProviderCapabilitiesRead          ClientRequestKind = "modelProvider/capabilities/read"
	ClientRequestKindPermissionProfileList                  ClientRequestKind = "permissionProfile/list"
	ClientRequestKindPluginInstall                          ClientRequestKind = "plugin/install"
	ClientRequestKindPluginInstalled                        ClientRequestKind = "plugin/installed"
	ClientRequestKindPluginList                             ClientRequestKind = "plugin/list"
	ClientRequestKindPluginRead                             ClientRequestKind = "plugin/read"
	ClientRequestKindPluginShareCheckout                    ClientRequestKind = "plugin/share/checkout"
	ClientRequestKindPluginShareDelete                      ClientRequestKind = "plugin/share/delete"
	ClientRequestKindPluginShareList                        ClientRequestKind = "plugin/share/list"
	ClientRequestKindPluginShareSave                        ClientRequestKind = "plugin/share/save"
	ClientRequestKindPluginShareUpdateTargets               ClientRequestKind = "plugin/share/updateTargets"
	ClientRequestKindPluginSkillRead                        ClientRequestKind = "plugin/skill/read"
	ClientRequestKindPluginUninstall                        ClientRequestKind = "plugin/uninstall"
	ClientRequestKindReviewStart                            ClientRequestKind = "review/start"
	ClientRequestKindSkillsConfigWrite                      ClientRequestKind = "skills/config/write"
	ClientRequestKindSkillsExtraRootsSet                    ClientRequestKind = "skills/extraRoots/set"
	ClientRequestKindSkillsList                             ClientRequestKind = "skills/list"
	ClientRequestKindThreadApproveGuardianDeniedAction      ClientRequestKind = "thread/approveGuardianDeniedAction"
	ClientRequestKindThreadArchive                          ClientRequestKind = "thread/archive"
	ClientRequestKindThreadCompactStart                     ClientRequestKind = "thread/compact/start"
	ClientRequestKindThreadDelete                           ClientRequestKind = "thread/delete"
	ClientRequestKindThreadFork                             ClientRequestKind = "thread/fork"
	ClientRequestKindThreadGoalClear                        ClientRequestKind = "thread/goal/clear"
	ClientRequestKindThreadGoalGet                          ClientRequestKind = "thread/goal/get"
	ClientRequestKindThreadGoalSet                          ClientRequestKind = "thread/goal/set"
	ClientRequestKindThreadInjectItems                      ClientRequestKind = "thread/inject_items"
	ClientRequestKindThreadList                             ClientRequestKind = "thread/list"
	ClientRequestKindThreadLoadedList                       ClientRequestKind = "thread/loaded/list"
	ClientRequestKindThreadMetadataUpdate                   ClientRequestKind = "thread/metadata/update"
	ClientRequestKindThreadNameSet                          ClientRequestKind = "thread/name/set"
	ClientRequestKindThreadRead                             ClientRequestKind = "thread/read"
	ClientRequestKindThreadResume                           ClientRequestKind = "thread/resume"
	ClientRequestKindThreadRollback                         ClientRequestKind = "thread/rollback"
	ClientRequestKindThreadShellCommand                     ClientRequestKind = "thread/shellCommand"
	ClientRequestKindThreadStart                            ClientRequestKind = "thread/start"
	ClientRequestKindThreadUnarchive                        ClientRequestKind = "thread/unarchive"
	ClientRequestKindThreadUnsubscribe                      ClientRequestKind = "thread/unsubscribe"
	ClientRequestKindTurnInterrupt                          ClientRequestKind = "turn/interrupt"
	ClientRequestKindTurnStart                              ClientRequestKind = "turn/start"
	ClientRequestKindTurnSteer                              ClientRequestKind = "turn/steer"
	ClientRequestKindWindowsSandboxReadiness                ClientRequestKind = "windowsSandbox/readiness"
	ClientRequestKindWindowsSandboxSetupStart               ClientRequestKind = "windowsSandbox/setupStart"
)

type CodexAppServerProtocolV2

type CodexAppServerProtocolV2 interface{}

type CodexErrorInfo

type CodexErrorInfo interface{}

This translation layer make sure that we expose codex error code in camel case.

When an upstream HTTP status is available (for example, from the Responses API or a provider), it is forwarded in `httpStatusCode` on the relevant `codexErrorInfo` variant.

type CollaborationMode

type CollaborationMode struct {
	// Mode corresponds to the JSON schema field "mode".
	Mode ModeKind `json:"mode"`

	// Settings corresponds to the JSON schema field "settings".
	Settings Settings `json:"settings"`
}

Collaboration mode for a Codex session.

type CommandAction added in v0.145.0

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

CommandAction preserves the complete JSON payload for a discriminated union.

func NewCommandAction added in v0.145.0

func NewCommandAction(value any) (CommandAction, error)

NewCommandAction validates the discriminator and wraps a JSON-marshalable CommandAction value.

func (CommandAction) IsKnown added in v0.145.0

func (value CommandAction) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (CommandAction) Kind added in v0.145.0

func (value CommandAction) Kind() CommandActionKind

Kind returns the payload discriminator, including unknown future values.

func (CommandAction) MarshalJSON added in v0.145.0

func (value CommandAction) MarshalJSON() ([]byte, error)

func (CommandAction) RawJSON added in v0.145.0

func (value CommandAction) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*CommandAction) UnmarshalJSON added in v0.145.0

func (value *CommandAction) UnmarshalJSON(data []byte) error

type CommandActionKind added in v0.145.0

type CommandActionKind string

CommandActionKind identifies a known CommandAction variant.

const (
	CommandActionKindListFiles CommandActionKind = "listFiles"
	CommandActionKindRead      CommandActionKind = "read"
	CommandActionKindSearch    CommandActionKind = "search"
	CommandActionKindUnknown   CommandActionKind = "unknown"
)

type CommandExecOutputStream

type CommandExecOutputStream interface{}

Stream label for `command/exec/outputDelta` notifications.

type CommandExecParams

type CommandExecParams struct {
	// Command argv vector. Empty arrays are rejected.
	Command []string `json:"command"`

	// Optional working directory. Defaults to the server cwd.
	Cwd CommandExecParamsCwd `json:"cwd,omitempty,omitzero"`

	// Disable stdout/stderr capture truncation for this request.
	//
	// Cannot be combined with `outputBytesCap`.
	DisableOutputCap *bool `json:"disableOutputCap,omitempty,omitzero"`

	// Disable the timeout entirely for this request.
	//
	// Cannot be combined with `timeoutMs`.
	DisableTimeout *bool `json:"disableTimeout,omitempty,omitzero"`

	// Optional environment overrides merged into the server-computed environment.
	//
	// Matching names override inherited values. Set a key to `null` to unset an
	// inherited variable.
	Env *CommandExecParamsEnv `json:"env,omitempty,omitzero"`

	// Optional per-stream stdout/stderr capture cap in bytes.
	//
	// When omitted, the server default applies. Cannot be combined with
	// `disableOutputCap`.
	OutputBytesCap CommandExecParamsOutputBytesCap `json:"outputBytesCap,omitempty,omitzero"`

	// Optional client-supplied, connection-scoped process id.
	//
	// Required for `tty`, `streamStdin`, `streamStdoutStderr`, and follow-up
	// `command/exec/write`, `command/exec/resize`, and `command/exec/terminate`
	// calls. When omitted, buffered execution gets an internal id that is not exposed
	// to the client.
	ProcessID CommandExecParamsProcessID `json:"processId,omitempty,omitzero"`

	// Optional sandbox policy for this command.
	//
	// Uses the same shape as thread/turn execution sandbox configuration and defaults
	// to the user's configured policy when omitted. Cannot be combined with
	// `permissionProfile`.
	SandboxPolicy interface{} `json:"sandboxPolicy,omitempty,omitzero"`

	// Optional initial PTY size in character cells. Only valid when `tty` is true.
	Size interface{} `json:"size,omitempty,omitzero"`

	// Allow follow-up `command/exec/write` requests to write stdin bytes.
	//
	// Requires a client-supplied `processId`.
	StreamStdin *bool `json:"streamStdin,omitempty,omitzero"`

	// Stream stdout/stderr via `command/exec/outputDelta` notifications.
	//
	// Streamed bytes are not duplicated into the final response and require a
	// client-supplied `processId`.
	StreamStdoutStderr *bool `json:"streamStdoutStderr,omitempty,omitzero"`

	// Optional timeout in milliseconds.
	//
	// When omitted, the server default applies. Cannot be combined with
	// `disableTimeout`.
	TimeoutMs CommandExecParamsTimeoutMs `json:"timeoutMs,omitempty,omitzero"`

	// Enable PTY mode.
	//
	// This implies `streamStdin` and `streamStdoutStderr`.
	Tty *bool `json:"tty,omitempty,omitzero"`
}

Run a standalone command (argv vector) in the server sandbox without creating a thread or turn.

The final `command/exec` response is deferred until the process exits and is sent only after all `command/exec/outputDelta` notifications for that connection have been emitted.

type CommandExecParamsCwd added in v0.144.0

type CommandExecParamsCwd *string

Optional working directory. Defaults to the server cwd.

type CommandExecParamsEnv added in v0.144.0

type CommandExecParamsEnv map[string]*string

Optional environment overrides merged into the server-computed environment.

Matching names override inherited values. Set a key to `null` to unset an inherited variable.

type CommandExecParamsOutputBytesCap added in v0.144.0

type CommandExecParamsOutputBytesCap *int

Optional per-stream stdout/stderr capture cap in bytes.

When omitted, the server default applies. Cannot be combined with `disableOutputCap`.

type CommandExecParamsProcessID added in v0.144.0

type CommandExecParamsProcessID *string

Optional client-supplied, connection-scoped process id.

Required for `tty`, `streamStdin`, `streamStdoutStderr`, and follow-up `command/exec/write`, `command/exec/resize`, and `command/exec/terminate` calls. When omitted, buffered execution gets an internal id that is not exposed to the client.

type CommandExecParamsTimeoutMs added in v0.144.0

type CommandExecParamsTimeoutMs *int

Optional timeout in milliseconds.

When omitted, the server default applies. Cannot be combined with `disableTimeout`.

type CommandExecResizeParams

type CommandExecResizeParams struct {
	// Client-supplied, connection-scoped `processId` from the original `command/exec`
	// request.
	ProcessID string `json:"processId"`

	// New PTY size in character cells.
	Size CommandExecResizeParamsSize `json:"size"`
}

Resize a running PTY-backed `command/exec` session.

type CommandExecResizeParamsSize

type CommandExecResizeParamsSize struct {
	// Terminal width in character cells.
	Cols int `json:"cols"`

	// Terminal height in character cells.
	Rows int `json:"rows"`
}

New PTY size in character cells.

type CommandExecResponse

type CommandExecResponse = SanitizedCommandExecResponseJSON

type CommandExecTerminalSize

type CommandExecTerminalSize struct {
	// Terminal width in character cells.
	Cols int `json:"cols"`

	// Terminal height in character cells.
	Rows int `json:"rows"`
}

PTY size in character cells for `command/exec` PTY sessions.

type CommandExecTerminateParams

type CommandExecTerminateParams struct {
	// Client-supplied, connection-scoped `processId` from the original `command/exec`
	// request.
	ProcessID string `json:"processId"`
}

Terminate a running `command/exec` session.

type CommandExecWriteParams

type CommandExecWriteParams struct {
	// Close stdin after writing `deltaBase64`, if present.
	CloseStdin *bool `json:"closeStdin,omitempty,omitzero"`

	// Optional base64-encoded stdin bytes to write.
	DeltaBase64 CommandExecWriteParamsDeltaBase64 `json:"deltaBase64,omitempty,omitzero"`

	// Client-supplied, connection-scoped `processId` from the original `command/exec`
	// request.
	ProcessID string `json:"processId"`
}

Write stdin bytes to a running `command/exec` session, close stdin, or both.

type CommandExecWriteParamsDeltaBase64 added in v0.144.0

type CommandExecWriteParamsDeltaBase64 *string

Optional base64-encoded stdin bytes to write.

type CommandExecutionApprovalDecision

type CommandExecutionApprovalDecision interface{}

type CommandExecutionRequestApprovalParams

type CommandExecutionRequestApprovalParams struct {
	ThreadID string `json:"threadId"`
	TurnID   string `json:"turnId"`
	ItemID   string `json:"itemId"`

	ApprovalID *string `json:"approvalId,omitempty"`
	Reason     *string `json:"reason,omitempty"`

	NetworkApprovalContext          interface{}                        `json:"networkApprovalContext,omitempty"`
	Command                         *string                            `json:"command,omitempty"`
	Cwd                             *string                            `json:"cwd,omitempty"`
	CommandActions                  []interface{}                      `json:"commandActions,omitempty"`
	AdditionalPermissions           interface{}                        `json:"additionalPermissions,omitempty"`
	ProposedExecpolicyAmendment     []string                           `json:"proposedExecpolicyAmendment,omitempty"`
	ProposedNetworkPolicyAmendments []NetworkPolicyAmendment           `json:"proposedNetworkPolicyAmendments,omitempty"`
	AvailableDecisions              []CommandExecutionApprovalDecision `json:"availableDecisions,omitempty"`
}

CommandExecutionRequestApprovalParams is maintained manually because the raw schema uses nested unions that the generator does not currently emit.

type CommandExecutionRequestApprovalResponse

type CommandExecutionRequestApprovalResponse struct {
	Decision CommandExecutionApprovalDecision `json:"decision"`
}

CommandExecutionRequestApprovalResponse is maintained manually because the raw schema uses nested unions that the generator does not currently emit.

type CommandMigration

type CommandMigration struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

type ComputerUseRequirements

type ComputerUseRequirements struct {
	// AllowLockedComputerUse corresponds to the JSON schema field
	// "allowLockedComputerUse".
	AllowLockedComputerUse ComputerUseRequirementsAllowLockedComputerUse `json:"allowLockedComputerUse,omitempty,omitzero"`
}

type ComputerUseRequirementsAllowLockedComputerUse added in v0.144.0

type ComputerUseRequirementsAllowLockedComputerUse *bool

type ConfigBatchWriteParams

type ConfigBatchWriteParams struct {
	// Edits corresponds to the JSON schema field "edits".
	Edits []ConfigEdit `json:"edits"`

	// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
	ExpectedVersion ConfigBatchWriteParamsExpectedVersion `json:"expectedVersion,omitempty,omitzero"`

	// Path to the config file to write; defaults to the user's `config.toml` when
	// omitted.
	FilePath ConfigBatchWriteParamsFilePath `json:"filePath,omitempty,omitzero"`

	// When true, hot-reload the updated user config into all loaded threads after
	// writing.
	ReloadUserConfig *bool `json:"reloadUserConfig,omitempty,omitzero"`
}

type ConfigBatchWriteParamsExpectedVersion added in v0.144.0

type ConfigBatchWriteParamsExpectedVersion *string

type ConfigBatchWriteParamsFilePath added in v0.144.0

type ConfigBatchWriteParamsFilePath *string

Path to the config file to write; defaults to the user's `config.toml` when omitted.

type ConfigEdit

type ConfigEdit struct {
	// KeyPath corresponds to the JSON schema field "keyPath".
	KeyPath string `json:"keyPath"`

	// MergeStrategy corresponds to the JSON schema field "mergeStrategy".
	MergeStrategy MergeStrategy `json:"mergeStrategy"`

	// Value corresponds to the JSON schema field "value".
	Value interface{} `json:"value"`
}

type ConfigLayerSource added in v0.145.0

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

ConfigLayerSource preserves the complete JSON payload for a discriminated union.

func NewConfigLayerSource added in v0.145.0

func NewConfigLayerSource(value any) (ConfigLayerSource, error)

NewConfigLayerSource validates the discriminator and wraps a JSON-marshalable ConfigLayerSource value.

func (ConfigLayerSource) IsKnown added in v0.145.0

func (value ConfigLayerSource) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ConfigLayerSource) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (ConfigLayerSource) MarshalJSON added in v0.145.0

func (value ConfigLayerSource) MarshalJSON() ([]byte, error)

func (ConfigLayerSource) RawJSON added in v0.145.0

func (value ConfigLayerSource) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ConfigLayerSource) UnmarshalJSON added in v0.145.0

func (value *ConfigLayerSource) UnmarshalJSON(data []byte) error

type ConfigLayerSourceKind added in v0.145.0

type ConfigLayerSourceKind string

ConfigLayerSourceKind identifies a known ConfigLayerSource variant.

const (
	ConfigLayerSourceKindEnterpriseManaged               ConfigLayerSourceKind = "enterpriseManaged"
	ConfigLayerSourceKindLegacyManagedConfigTomlFromFile ConfigLayerSourceKind = "legacyManagedConfigTomlFromFile"
	ConfigLayerSourceKindLegacyManagedConfigTomlFromMdm  ConfigLayerSourceKind = "legacyManagedConfigTomlFromMdm"
	ConfigLayerSourceKindMdm                             ConfigLayerSourceKind = "mdm"
	ConfigLayerSourceKindProject                         ConfigLayerSourceKind = "project"
	ConfigLayerSourceKindSessionFlags                    ConfigLayerSourceKind = "sessionFlags"
	ConfigLayerSourceKindSystem                          ConfigLayerSourceKind = "system"
	ConfigLayerSourceKindUser                            ConfigLayerSourceKind = "user"
)

type ConfigReadParams

type ConfigReadParams struct {
	// Optional working directory to resolve project config layers. If specified,
	// return the effective config as seen from that directory (i.e., including any
	// project layers between `cwd` and the project/repo root).
	Cwd ConfigReadParamsCwd `json:"cwd,omitempty,omitzero"`

	// IncludeLayers corresponds to the JSON schema field "includeLayers".
	IncludeLayers *bool `json:"includeLayers,omitempty,omitzero"`
}

type ConfigReadParamsCwd added in v0.144.0

type ConfigReadParamsCwd *string

Optional working directory to resolve project config layers. If specified, return the effective config as seen from that directory (i.e., including any project layers between `cwd` and the project/repo root).

type ConfigReadResponse

type ConfigReadResponse interface{}

type ConfigRequirements

type ConfigRequirements struct {
	// AllowAppshots corresponds to the JSON schema field "allowAppshots".
	AllowAppshots ConfigRequirementsAllowAppshots `json:"allowAppshots,omitempty,omitzero"`

	// AllowManagedHooksOnly corresponds to the JSON schema field
	// "allowManagedHooksOnly".
	AllowManagedHooksOnly ConfigRequirementsAllowManagedHooksOnly `json:"allowManagedHooksOnly,omitempty,omitzero"`

	// AllowRemoteControl corresponds to the JSON schema field "allowRemoteControl".
	AllowRemoteControl ConfigRequirementsAllowRemoteControl `json:"allowRemoteControl,omitempty,omitzero"`

	// AllowedApprovalPolicies corresponds to the JSON schema field
	// "allowedApprovalPolicies".
	AllowedApprovalPolicies *ConfigRequirementsAllowedApprovalPolicies `json:"allowedApprovalPolicies,omitempty,omitzero"`

	// AllowedPermissionProfiles corresponds to the JSON schema field
	// "allowedPermissionProfiles".
	AllowedPermissionProfiles *ConfigRequirementsAllowedPermissionProfiles `json:"allowedPermissionProfiles,omitempty,omitzero"`

	// AllowedSandboxModes corresponds to the JSON schema field "allowedSandboxModes".
	AllowedSandboxModes *ConfigRequirementsAllowedSandboxModes `json:"allowedSandboxModes,omitempty,omitzero"`

	// AllowedWebSearchModes corresponds to the JSON schema field
	// "allowedWebSearchModes".
	AllowedWebSearchModes *ConfigRequirementsAllowedWebSearchModes `json:"allowedWebSearchModes,omitempty,omitzero"`

	// AllowedWindowsSandboxImplementations corresponds to the JSON schema field
	// "allowedWindowsSandboxImplementations".
	AllowedWindowsSandboxImplementations *ConfigRequirementsAllowedWindowsSandboxImplementations `json:"allowedWindowsSandboxImplementations,omitempty,omitzero"`

	// ComputerUse corresponds to the JSON schema field "computerUse".
	ComputerUse interface{} `json:"computerUse,omitempty,omitzero"`

	// DefaultPermissions corresponds to the JSON schema field "defaultPermissions".
	DefaultPermissions ConfigRequirementsDefaultPermissions `json:"defaultPermissions,omitempty,omitzero"`

	// EnforceResidency corresponds to the JSON schema field "enforceResidency".
	EnforceResidency interface{} `json:"enforceResidency,omitempty,omitzero"`

	// FeatureRequirements corresponds to the JSON schema field "featureRequirements".
	FeatureRequirements *ConfigRequirementsFeatureRequirements `json:"featureRequirements,omitempty,omitzero"`

	// Models corresponds to the JSON schema field "models".
	Models interface{} `json:"models,omitempty,omitzero"`
}

type ConfigRequirementsAllowAppshots added in v0.144.0

type ConfigRequirementsAllowAppshots *bool

type ConfigRequirementsAllowManagedHooksOnly added in v0.144.0

type ConfigRequirementsAllowManagedHooksOnly *bool

type ConfigRequirementsAllowRemoteControl added in v0.144.0

type ConfigRequirementsAllowRemoteControl *bool

type ConfigRequirementsAllowedApprovalPolicies added in v0.144.0

type ConfigRequirementsAllowedApprovalPolicies []AskForApproval

type ConfigRequirementsAllowedPermissionProfiles added in v0.144.0

type ConfigRequirementsAllowedPermissionProfiles map[string]bool

type ConfigRequirementsAllowedSandboxModes added in v0.144.0

type ConfigRequirementsAllowedSandboxModes []SandboxMode

type ConfigRequirementsAllowedWebSearchModes added in v0.144.0

type ConfigRequirementsAllowedWebSearchModes []WebSearchMode

type ConfigRequirementsAllowedWindowsSandboxImplementations added in v0.144.0

type ConfigRequirementsAllowedWindowsSandboxImplementations []WindowsSandboxSetupMode

type ConfigRequirementsDefaultPermissions added in v0.144.0

type ConfigRequirementsDefaultPermissions *string

type ConfigRequirementsFeatureRequirements added in v0.144.0

type ConfigRequirementsFeatureRequirements map[string]bool

type ConfigValueWriteParams

type ConfigValueWriteParams struct {
	// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
	ExpectedVersion ConfigValueWriteParamsExpectedVersion `json:"expectedVersion,omitempty,omitzero"`

	// Path to the config file to write; defaults to the user's `config.toml` when
	// omitted.
	FilePath ConfigValueWriteParamsFilePath `json:"filePath,omitempty,omitzero"`

	// KeyPath corresponds to the JSON schema field "keyPath".
	KeyPath string `json:"keyPath"`

	// MergeStrategy corresponds to the JSON schema field "mergeStrategy".
	MergeStrategy MergeStrategy `json:"mergeStrategy"`

	// Value corresponds to the JSON schema field "value".
	Value interface{} `json:"value"`
}

type ConfigValueWriteParamsExpectedVersion added in v0.144.0

type ConfigValueWriteParamsExpectedVersion *string

type ConfigValueWriteParamsFilePath added in v0.144.0

type ConfigValueWriteParamsFilePath *string

Path to the config file to write; defaults to the user's `config.toml` when omitted.

type ConfigWriteResponse

type ConfigWriteResponse interface{}

type ConfiguredHookHandler

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

ConfiguredHookHandler preserves the complete JSON payload for a discriminated union.

func NewConfiguredHookHandler added in v0.145.0

func NewConfiguredHookHandler(value any) (ConfiguredHookHandler, error)

NewConfiguredHookHandler validates the discriminator and wraps a JSON-marshalable ConfiguredHookHandler value.

func (ConfiguredHookHandler) IsKnown added in v0.145.0

func (value ConfiguredHookHandler) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ConfiguredHookHandler) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (ConfiguredHookHandler) MarshalJSON added in v0.145.0

func (value ConfiguredHookHandler) MarshalJSON() ([]byte, error)

func (ConfiguredHookHandler) RawJSON added in v0.145.0

func (value ConfiguredHookHandler) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ConfiguredHookHandler) UnmarshalJSON added in v0.145.0

func (value *ConfiguredHookHandler) UnmarshalJSON(data []byte) error

type ConfiguredHookHandlerKind added in v0.145.0

type ConfiguredHookHandlerKind string

ConfiguredHookHandlerKind identifies a known ConfiguredHookHandler variant.

const (
	ConfiguredHookHandlerKindAgent   ConfiguredHookHandlerKind = "agent"
	ConfiguredHookHandlerKindCommand ConfiguredHookHandlerKind = "command"
	ConfiguredHookHandlerKindPrompt  ConfiguredHookHandlerKind = "prompt"
)

type ConfiguredHookMatcherGroup

type ConfiguredHookMatcherGroup struct {
	// Hooks corresponds to the JSON schema field "hooks".
	Hooks []ConfiguredHookHandler `json:"hooks"`

	// Matcher corresponds to the JSON schema field "matcher".
	Matcher ConfiguredHookMatcherGroupMatcher `json:"matcher,omitempty,omitzero"`
}

type ConfiguredHookMatcherGroupMatcher added in v0.144.0

type ConfiguredHookMatcherGroupMatcher *string

type ConsumeAccountRateLimitResetCreditOutcome

type ConsumeAccountRateLimitResetCreditOutcome interface{}

type ConsumeAccountRateLimitResetCreditParams

type ConsumeAccountRateLimitResetCreditParams struct {
	// Opaque reset-credit identifier to redeem. When omitted, the backend selects the
	// next available credit.
	CreditID ConsumeAccountRateLimitResetCreditParamsCreditID `json:"creditId,omitempty,omitzero"`

	// Identifies one logical reset attempt. A UUID is recommended; reuse the same
	// value when retrying that attempt.
	IdempotencyKey string `json:"idempotencyKey"`
}

type ConsumeAccountRateLimitResetCreditParamsCreditID added in v0.144.0

type ConsumeAccountRateLimitResetCreditParamsCreditID *string

Opaque reset-credit identifier to redeem. When omitted, the backend selects the next available credit.

type ContentItem

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

ContentItem preserves the complete JSON payload for a discriminated union.

func NewContentItem added in v0.145.0

func NewContentItem(value any) (ContentItem, error)

NewContentItem validates the discriminator and wraps a JSON-marshalable ContentItem value.

func (ContentItem) IsKnown added in v0.145.0

func (value ContentItem) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ContentItem) Kind added in v0.145.0

func (value ContentItem) Kind() ContentItemKind

Kind returns the payload discriminator, including unknown future values.

func (ContentItem) MarshalJSON added in v0.145.0

func (value ContentItem) MarshalJSON() ([]byte, error)

func (ContentItem) RawJSON added in v0.145.0

func (value ContentItem) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ContentItem) UnmarshalJSON added in v0.145.0

func (value *ContentItem) UnmarshalJSON(data []byte) error

type ContentItemKind added in v0.145.0

type ContentItemKind string

ContentItemKind identifies a known ContentItem variant.

const (
	ContentItemKindInputImage ContentItemKind = "input_image"
	ContentItemKindInputText  ContentItemKind = "input_text"
	ContentItemKindOutputText ContentItemKind = "output_text"
)

type ConversationTextRole

type ConversationTextRole string
const ConversationTextRoleAssistant ConversationTextRole = "assistant"
const ConversationTextRoleDeveloper ConversationTextRole = "developer"
const ConversationTextRoleUser ConversationTextRole = "user"

type CreditsSnapshot

type CreditsSnapshot struct {
	// Balance corresponds to the JSON schema field "balance".
	Balance CreditsSnapshotBalance `json:"balance,omitempty,omitzero"`

	// HasCredits corresponds to the JSON schema field "hasCredits".
	HasCredits bool `json:"hasCredits"`

	// Unlimited corresponds to the JSON schema field "unlimited".
	Unlimited bool `json:"unlimited"`
}

type CreditsSnapshotBalance added in v0.144.0

type CreditsSnapshotBalance *string

type DynamicToolCallOutputContentItem

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

DynamicToolCallOutputContentItem preserves the complete JSON payload for a discriminated union.

func NewDynamicToolCallOutputContentItem added in v0.145.0

func NewDynamicToolCallOutputContentItem(value any) (DynamicToolCallOutputContentItem, error)

NewDynamicToolCallOutputContentItem validates the discriminator and wraps a JSON-marshalable DynamicToolCallOutputContentItem value.

func (DynamicToolCallOutputContentItem) IsKnown added in v0.145.0

func (value DynamicToolCallOutputContentItem) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (DynamicToolCallOutputContentItem) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (DynamicToolCallOutputContentItem) MarshalJSON added in v0.145.0

func (value DynamicToolCallOutputContentItem) MarshalJSON() ([]byte, error)

func (DynamicToolCallOutputContentItem) RawJSON added in v0.145.0

RawJSON returns a copy of the complete union payload.

func (*DynamicToolCallOutputContentItem) UnmarshalJSON added in v0.145.0

func (value *DynamicToolCallOutputContentItem) UnmarshalJSON(data []byte) error

type DynamicToolCallOutputContentItemKind added in v0.145.0

type DynamicToolCallOutputContentItemKind string

DynamicToolCallOutputContentItemKind identifies a known DynamicToolCallOutputContentItem variant.

const (
	DynamicToolCallOutputContentItemKindInputImage DynamicToolCallOutputContentItemKind = "inputImage"
	DynamicToolCallOutputContentItemKindInputText  DynamicToolCallOutputContentItemKind = "inputText"
)

type DynamicToolCallParams

type DynamicToolCallParams = SanitizedDynamicToolCallParamsJSON

type DynamicToolNamespaceTool

type DynamicToolNamespaceTool interface{}

type DynamicToolSpec

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

DynamicToolSpec preserves the complete JSON payload for a discriminated union.

func NewDynamicToolSpec added in v0.145.0

func NewDynamicToolSpec(value any) (DynamicToolSpec, error)

NewDynamicToolSpec validates the discriminator and wraps a JSON-marshalable DynamicToolSpec value.

func (DynamicToolSpec) IsKnown added in v0.145.0

func (value DynamicToolSpec) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (DynamicToolSpec) Kind added in v0.145.0

func (value DynamicToolSpec) Kind() DynamicToolSpecKind

Kind returns the payload discriminator, including unknown future values.

func (DynamicToolSpec) MarshalJSON added in v0.145.0

func (value DynamicToolSpec) MarshalJSON() ([]byte, error)

func (DynamicToolSpec) RawJSON added in v0.145.0

func (value DynamicToolSpec) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*DynamicToolSpec) UnmarshalJSON added in v0.145.0

func (value *DynamicToolSpec) UnmarshalJSON(data []byte) error

type DynamicToolSpecKind added in v0.145.0

type DynamicToolSpecKind string

DynamicToolSpecKind identifies a known DynamicToolSpec variant.

const (
	DynamicToolSpecKindFunction  DynamicToolSpecKind = "function"
	DynamicToolSpecKindNamespace DynamicToolSpecKind = "namespace"
)

type ErrorNotification

type ErrorNotification struct {
	ThreadID  string                 `json:"threadId,omitempty"`
	WillRetry *bool                  `json:"willRetry,omitempty"`
	Error     *TurnNotificationError `json:"error,omitempty"`
}

ErrorNotification is the payload for error notifications.

type ExecCommandApprovalParams

type ExecCommandApprovalParams = SanitizedExecCommandApprovalParams

ExecCommandApprovalParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type ExecCommandApprovalResponse

type ExecCommandApprovalResponse = SanitizedExecCommandApprovalResponse

ExecCommandApprovalResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type ExperimentalFeature added in v0.144.0

type ExperimentalFeature struct {
	// Announcement copy shown to users when the feature is introduced. Null when this
	// feature is not in beta.
	Announcement ExperimentalFeatureAnnouncement `json:"announcement,omitempty,omitzero"`

	// Whether this feature is enabled by default.
	DefaultEnabled bool `json:"defaultEnabled"`

	// Short summary describing what the feature does. Null when this feature is not
	// in beta.
	Description ExperimentalFeatureDescription `json:"description,omitempty,omitzero"`

	// User-facing display name shown in the experimental features UI. Null when this
	// feature is not in beta.
	DisplayName ExperimentalFeatureDisplayName `json:"displayName,omitempty,omitzero"`

	// Whether this feature is currently enabled in the loaded config.
	Enabled bool `json:"enabled"`

	// Stable key used in config.toml and CLI flag toggles.
	Name string `json:"name"`

	// Lifecycle stage of this feature flag.
	Stage interface{} `json:"stage"`
}

type ExperimentalFeatureAnnouncement added in v0.144.0

type ExperimentalFeatureAnnouncement *string

Announcement copy shown to users when the feature is introduced. Null when this feature is not in beta.

type ExperimentalFeatureDescription added in v0.144.0

type ExperimentalFeatureDescription *string

Short summary describing what the feature does. Null when this feature is not in beta.

type ExperimentalFeatureDisplayName added in v0.144.0

type ExperimentalFeatureDisplayName *string

User-facing display name shown in the experimental features UI. Null when this feature is not in beta.

type ExperimentalFeatureEnablementSetParams

type ExperimentalFeatureEnablementSetParams struct {
	// Process-wide runtime feature enablement keyed by canonical feature name.
	//
	// Only named features are updated. Omitted features are left unchanged. Send an
	// empty map for a no-op.
	Enablement ExperimentalFeatureEnablementSetParamsEnablement `json:"enablement"`
}

type ExperimentalFeatureEnablementSetParamsEnablement added in v0.144.0

type ExperimentalFeatureEnablementSetParamsEnablement map[string]bool

Process-wide runtime feature enablement keyed by canonical feature name.

Only named features are updated. Omitted features are left unchanged. Send an empty map for a no-op.

type ExperimentalFeatureListParams

type ExperimentalFeatureListParams struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor ExperimentalFeatureListParamsCursor `json:"cursor,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit ExperimentalFeatureListParamsLimit `json:"limit,omitempty,omitzero"`

	// Optional loaded thread id. Pass this when showing feature state for an existing
	// thread so enablement is computed from that thread's refreshed config, including
	// project-local config for the thread's cwd.
	ThreadID ExperimentalFeatureListParamsThreadID `json:"threadId,omitempty,omitzero"`
}

type ExperimentalFeatureListParamsCursor added in v0.144.0

type ExperimentalFeatureListParamsCursor *string

Opaque pagination cursor returned by a previous call.

type ExperimentalFeatureListParamsLimit added in v0.144.0

type ExperimentalFeatureListParamsLimit *int

Optional page size; defaults to a reasonable server-side value.

type ExperimentalFeatureListParamsThreadID added in v0.144.0

type ExperimentalFeatureListParamsThreadID *string

Optional loaded thread id. Pass this when showing feature state for an existing thread so enablement is computed from that thread's refreshed config, including project-local config for the thread's cwd.

type ExperimentalFeatureStage added in v0.144.0

type ExperimentalFeatureStage interface{}

type ExternalAgentConfigDetectParams

type ExternalAgentConfigDetectParams struct {
	// Zero or more working directories to include for repo-scoped detection.
	Cwds *ExternalAgentConfigDetectParamsCwds `json:"cwds,omitempty,omitzero"`

	// If true, include detection under the user's home directory.
	IncludeHome *bool `json:"includeHome,omitempty,omitzero"`
}

type ExternalAgentConfigDetectParamsCwds added in v0.144.0

type ExternalAgentConfigDetectParamsCwds []string

Zero or more working directories to include for repo-scoped detection.

type ExternalAgentConfigImportHistory

type ExternalAgentConfigImportHistory struct {
	// CompletedAtMs corresponds to the JSON schema field "completedAtMs".
	CompletedAtMs int `json:"completedAtMs"`

	// Failures corresponds to the JSON schema field "failures".
	Failures []ExternalAgentConfigImportItemTypeFailure `json:"failures"`

	// ImportID corresponds to the JSON schema field "importId".
	ImportID string `json:"importId"`

	// Successes corresponds to the JSON schema field "successes".
	Successes []ExternalAgentConfigImportItemTypeSuccess `json:"successes"`
}

type ExternalAgentConfigImportItemTypeFailure

type ExternalAgentConfigImportItemTypeFailure struct {
	// Cwd corresponds to the JSON schema field "cwd".
	Cwd ExternalAgentConfigImportItemTypeFailureCwd `json:"cwd,omitempty,omitzero"`

	// ErrorType corresponds to the JSON schema field "errorType".
	ErrorType ExternalAgentConfigImportItemTypeFailureErrorType `json:"errorType,omitempty,omitzero"`

	// FailureStage corresponds to the JSON schema field "failureStage".
	FailureStage string `json:"failureStage"`

	// ItemType corresponds to the JSON schema field "itemType".
	ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`

	// Message corresponds to the JSON schema field "message".
	Message string `json:"message"`

	// Source corresponds to the JSON schema field "source".
	Source ExternalAgentConfigImportItemTypeFailureSource `json:"source,omitempty,omitzero"`
}

type ExternalAgentConfigImportItemTypeFailureCwd added in v0.144.0

type ExternalAgentConfigImportItemTypeFailureCwd *string

type ExternalAgentConfigImportItemTypeFailureErrorType added in v0.144.0

type ExternalAgentConfigImportItemTypeFailureErrorType *string

type ExternalAgentConfigImportItemTypeFailureSource added in v0.144.0

type ExternalAgentConfigImportItemTypeFailureSource *string

type ExternalAgentConfigImportItemTypeSuccess

type ExternalAgentConfigImportItemTypeSuccess struct {
	// Cwd corresponds to the JSON schema field "cwd".
	Cwd ExternalAgentConfigImportItemTypeSuccessCwd `json:"cwd,omitempty,omitzero"`

	// ItemType corresponds to the JSON schema field "itemType".
	ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`

	// Source corresponds to the JSON schema field "source".
	Source ExternalAgentConfigImportItemTypeSuccessSource `json:"source,omitempty,omitzero"`

	// Target corresponds to the JSON schema field "target".
	Target ExternalAgentConfigImportItemTypeSuccessTarget `json:"target,omitempty,omitzero"`
}

type ExternalAgentConfigImportItemTypeSuccessCwd added in v0.144.0

type ExternalAgentConfigImportItemTypeSuccessCwd *string

type ExternalAgentConfigImportItemTypeSuccessSource added in v0.144.0

type ExternalAgentConfigImportItemTypeSuccessSource *string

type ExternalAgentConfigImportItemTypeSuccessTarget added in v0.144.0

type ExternalAgentConfigImportItemTypeSuccessTarget *string

type ExternalAgentConfigImportParams

type ExternalAgentConfigImportParams struct {
	// MigrationItems corresponds to the JSON schema field "migrationItems".
	MigrationItems []ExternalAgentConfigMigrationItem `json:"migrationItems"`

	// Source product that produced the migration items. Missing means unspecified.
	Source ExternalAgentConfigImportParamsSource `json:"source,omitempty,omitzero"`
}

type ExternalAgentConfigImportParamsSource added in v0.144.0

type ExternalAgentConfigImportParamsSource *string

Source product that produced the migration items. Missing means unspecified.

type ExternalAgentConfigImportTypeResult

type ExternalAgentConfigImportTypeResult struct {
	// Failures corresponds to the JSON schema field "failures".
	Failures []ExternalAgentConfigImportItemTypeFailure `json:"failures"`

	// ItemType corresponds to the JSON schema field "itemType".
	ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`

	// Successes corresponds to the JSON schema field "successes".
	Successes []ExternalAgentConfigImportItemTypeSuccess `json:"successes"`
}

type ExternalAgentConfigMigrationItem

type ExternalAgentConfigMigrationItem struct {
	// Null or empty means home-scoped migration; non-empty means repo-scoped
	// migration.
	Cwd ExternalAgentConfigMigrationItemCwd `json:"cwd,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description string `json:"description"`

	// Details corresponds to the JSON schema field "details".
	Details interface{} `json:"details,omitempty,omitzero"`

	// ItemType corresponds to the JSON schema field "itemType".
	ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`
}

type ExternalAgentConfigMigrationItemCwd added in v0.144.0

type ExternalAgentConfigMigrationItemCwd *string

Null or empty means home-scoped migration; non-empty means repo-scoped migration.

type ExternalAgentConfigMigrationItemType

type ExternalAgentConfigMigrationItemType string
const ExternalAgentConfigMigrationItemTypeAGENTSMD ExternalAgentConfigMigrationItemType = "AGENTS_MD"
const ExternalAgentConfigMigrationItemTypeCOMMANDS ExternalAgentConfigMigrationItemType = "COMMANDS"
const ExternalAgentConfigMigrationItemTypeCONFIG ExternalAgentConfigMigrationItemType = "CONFIG"
const ExternalAgentConfigMigrationItemTypeHOOKS ExternalAgentConfigMigrationItemType = "HOOKS"
const ExternalAgentConfigMigrationItemTypeMCPSERVERCONFIG ExternalAgentConfigMigrationItemType = "MCP_SERVER_CONFIG"
const ExternalAgentConfigMigrationItemTypePLUGINS ExternalAgentConfigMigrationItemType = "PLUGINS"
const ExternalAgentConfigMigrationItemTypeSESSIONS ExternalAgentConfigMigrationItemType = "SESSIONS"
const ExternalAgentConfigMigrationItemTypeSKILLS ExternalAgentConfigMigrationItemType = "SKILLS"
const ExternalAgentConfigMigrationItemTypeSUBAGENTS ExternalAgentConfigMigrationItemType = "SUBAGENTS"

type FeedbackUploadParams

type FeedbackUploadParams struct {
	// Classification corresponds to the JSON schema field "classification".
	Classification string `json:"classification"`

	// ExtraLogFiles corresponds to the JSON schema field "extraLogFiles".
	ExtraLogFiles *FeedbackUploadParamsExtraLogFiles `json:"extraLogFiles,omitempty,omitzero"`

	// IncludeLogs corresponds to the JSON schema field "includeLogs".
	IncludeLogs *bool `json:"includeLogs,omitempty,omitzero"`

	// Reason corresponds to the JSON schema field "reason".
	Reason FeedbackUploadParamsReason `json:"reason,omitempty,omitzero"`

	// Tags corresponds to the JSON schema field "tags".
	Tags *FeedbackUploadParamsTags `json:"tags,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID FeedbackUploadParamsThreadID `json:"threadId,omitempty,omitzero"`
}

type FeedbackUploadParamsExtraLogFiles added in v0.144.0

type FeedbackUploadParamsExtraLogFiles []string

type FeedbackUploadParamsReason added in v0.144.0

type FeedbackUploadParamsReason *string

type FeedbackUploadParamsTags added in v0.144.0

type FeedbackUploadParamsTags map[string]string

type FeedbackUploadParamsThreadID added in v0.144.0

type FeedbackUploadParamsThreadID *string

type FileChange

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

FileChange preserves the complete JSON payload for a discriminated union.

func NewFileChange added in v0.145.0

func NewFileChange(value any) (FileChange, error)

NewFileChange validates the discriminator and wraps a JSON-marshalable FileChange value.

func (FileChange) IsKnown added in v0.145.0

func (value FileChange) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (FileChange) Kind added in v0.145.0

func (value FileChange) Kind() FileChangeKind

Kind returns the payload discriminator, including unknown future values.

func (FileChange) MarshalJSON added in v0.145.0

func (value FileChange) MarshalJSON() ([]byte, error)

func (FileChange) RawJSON added in v0.145.0

func (value FileChange) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*FileChange) UnmarshalJSON added in v0.145.0

func (value *FileChange) UnmarshalJSON(data []byte) error

type FileChangeApprovalDecision

type FileChangeApprovalDecision interface{}

type FileChangeKind added in v0.145.0

type FileChangeKind string

FileChangeKind identifies a known FileChange variant.

const (
	FileChangeKindAdd    FileChangeKind = "add"
	FileChangeKindDelete FileChangeKind = "delete"
	FileChangeKindUpdate FileChangeKind = "update"
)

type FileChangeRequestApprovalParams

type FileChangeRequestApprovalParams = SanitizedFileChangeRequestApprovalParams

FileChangeRequestApprovalParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type FileChangeRequestApprovalResponse

type FileChangeRequestApprovalResponse = SanitizedFileChangeRequestApprovalResponse

FileChangeRequestApprovalResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type FileSystemAccessMode

type FileSystemAccessMode string
const FileSystemAccessModeDeny FileSystemAccessMode = "deny"
const FileSystemAccessModeRead FileSystemAccessMode = "read"
const FileSystemAccessModeWrite FileSystemAccessMode = "write"

type FileSystemPath

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

FileSystemPath preserves the complete JSON payload for a discriminated union.

func NewFileSystemPath added in v0.145.0

func NewFileSystemPath(value any) (FileSystemPath, error)

NewFileSystemPath validates the discriminator and wraps a JSON-marshalable FileSystemPath value.

func (FileSystemPath) IsKnown added in v0.145.0

func (value FileSystemPath) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (FileSystemPath) Kind added in v0.145.0

func (value FileSystemPath) Kind() FileSystemPathKind

Kind returns the payload discriminator, including unknown future values.

func (FileSystemPath) MarshalJSON added in v0.145.0

func (value FileSystemPath) MarshalJSON() ([]byte, error)

func (FileSystemPath) RawJSON added in v0.145.0

func (value FileSystemPath) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*FileSystemPath) UnmarshalJSON added in v0.145.0

func (value *FileSystemPath) UnmarshalJSON(data []byte) error

type FileSystemPathKind added in v0.145.0

type FileSystemPathKind string

FileSystemPathKind identifies a known FileSystemPath variant.

const (
	FileSystemPathKindGlobPattern FileSystemPathKind = "glob_pattern"
	FileSystemPathKindPath        FileSystemPathKind = "path"
	FileSystemPathKindSpecial     FileSystemPathKind = "special"
)

type FileSystemSandboxEntry

type FileSystemSandboxEntry struct {
	// Access corresponds to the JSON schema field "access".
	Access FileSystemAccessMode `json:"access"`

	// Path corresponds to the JSON schema field "path".
	Path FileSystemPath `json:"path"`
}

type FileSystemSpecialPath

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

FileSystemSpecialPath preserves the complete JSON payload for a discriminated union.

func NewFileSystemSpecialPath added in v0.145.0

func NewFileSystemSpecialPath(value any) (FileSystemSpecialPath, error)

NewFileSystemSpecialPath validates the discriminator and wraps a JSON-marshalable FileSystemSpecialPath value.

func (FileSystemSpecialPath) IsKnown added in v0.145.0

func (value FileSystemSpecialPath) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (FileSystemSpecialPath) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (FileSystemSpecialPath) MarshalJSON added in v0.145.0

func (value FileSystemSpecialPath) MarshalJSON() ([]byte, error)

func (FileSystemSpecialPath) RawJSON added in v0.145.0

func (value FileSystemSpecialPath) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*FileSystemSpecialPath) UnmarshalJSON added in v0.145.0

func (value *FileSystemSpecialPath) UnmarshalJSON(data []byte) error

type FileSystemSpecialPathKind added in v0.145.0

type FileSystemSpecialPathKind string

FileSystemSpecialPathKind identifies a known FileSystemSpecialPath variant.

const (
	FileSystemSpecialPathKindMinimal      FileSystemSpecialPathKind = "minimal"
	FileSystemSpecialPathKindProjectRoots FileSystemSpecialPathKind = "project_roots"
	FileSystemSpecialPathKindRoot         FileSystemSpecialPathKind = "root"
	FileSystemSpecialPathKindSlashTmp     FileSystemSpecialPathKind = "slash_tmp"
	FileSystemSpecialPathKindTmpdir       FileSystemSpecialPathKind = "tmpdir"
	FileSystemSpecialPathKindUnknown      FileSystemSpecialPathKind = "unknown"
)

type FileUpdateChange

type FileUpdateChange struct {
	// Diff corresponds to the JSON schema field "diff".
	Diff string `json:"diff"`

	// Kind corresponds to the JSON schema field "kind".
	Kind PatchChangeKind `json:"kind"`

	// Path corresponds to the JSON schema field "path".
	Path string `json:"path"`
}

type FsChangedNotification

type FsChangedNotification interface{}

type FsCopyParams

type FsCopyParams struct {
	// Absolute destination path.
	DestinationPath interface{} `json:"destinationPath"`

	// Required for directory copies; ignored for file copies.
	Recursive *bool `json:"recursive,omitempty,omitzero"`

	// Absolute source path.
	SourcePath interface{} `json:"sourcePath"`
}

Copy a file or directory tree on the host filesystem.

type FsCopyResponse

type FsCopyResponse = SanitizedFsCopyResponseJSON

type FsCreateDirectoryParams

type FsCreateDirectoryParams struct {
	// Absolute directory path to create.
	Path interface{} `json:"path"`

	// Whether parent directories should also be created. Defaults to `true`.
	Recursive FsCreateDirectoryParamsRecursive `json:"recursive,omitempty,omitzero"`
}

Create a directory on the host filesystem.

type FsCreateDirectoryParamsRecursive added in v0.144.0

type FsCreateDirectoryParamsRecursive *bool

Whether parent directories should also be created. Defaults to `true`.

type FsGetMetadataParams

type FsGetMetadataParams struct {
	// Absolute path to inspect.
	Path interface{} `json:"path"`
}

Request metadata for an absolute path.

type FsGetMetadataResponse

type FsGetMetadataResponse = SanitizedFsGetMetadataResponseJSON

type FsReadDirectoryEntry

type FsReadDirectoryEntry struct {
	// Direct child entry name only, not an absolute or relative path.
	FileName string `json:"fileName"`

	// Whether this entry resolves to a directory.
	IsDirectory bool `json:"isDirectory"`

	// Whether this entry resolves to a regular file.
	IsFile bool `json:"isFile"`
}

A directory entry returned by `fs/readDirectory`.

type FsReadDirectoryParams

type FsReadDirectoryParams struct {
	// Absolute directory path to read.
	Path interface{} `json:"path"`
}

List direct child names for a directory.

type FsReadFileParams

type FsReadFileParams struct {
	// Absolute path to read.
	Path interface{} `json:"path"`
}

Read a file from the host filesystem.

type FsReadFileResponse

type FsReadFileResponse = SanitizedFsReadFileResponseJSON

type FsRemoveParams

type FsRemoveParams struct {
	// Whether missing paths should be ignored. Defaults to `true`.
	Force FsRemoveParamsForce `json:"force,omitempty,omitzero"`

	// Absolute path to remove.
	Path interface{} `json:"path"`

	// Whether directory removal should recurse. Defaults to `true`.
	Recursive FsRemoveParamsRecursive `json:"recursive,omitempty,omitzero"`
}

Remove a file or directory tree from the host filesystem.

type FsRemoveParamsForce added in v0.144.0

type FsRemoveParamsForce *bool

Whether missing paths should be ignored. Defaults to `true`.

type FsRemoveParamsRecursive added in v0.144.0

type FsRemoveParamsRecursive *bool

Whether directory removal should recurse. Defaults to `true`.

type FsRemoveResponse

type FsRemoveResponse = SanitizedFsRemoveResponseJSON

type FsUnwatchParams

type FsUnwatchParams struct {
	// Watch identifier previously provided to `fs/watch`.
	WatchID string `json:"watchId"`
}

Stop filesystem watch notifications for a prior `fs/watch`.

type FsUnwatchResponse

type FsUnwatchResponse = SanitizedFsUnwatchResponseJSON

type FsWatchParams

type FsWatchParams struct {
	// Absolute file or directory path to watch.
	Path interface{} `json:"path"`

	// Connection-scoped watch identifier used for `fs/unwatch` and `fs/changed`.
	WatchID string `json:"watchId"`
}

Start filesystem watch notifications for an absolute path.

type FsWatchResponse

type FsWatchResponse interface{}

type FsWriteFileParams

type FsWriteFileParams struct {
	// File contents encoded as base64.
	DataBase64 string `json:"dataBase64"`

	// Absolute path to write.
	Path interface{} `json:"path"`
}

Write a file on the host filesystem.

type FsWriteFileResponse

type FsWriteFileResponse = SanitizedFsWriteFileResponseJSON

type FunctionCallOutputBody

type FunctionCallOutputBody interface{}

type FunctionCallOutputContentItem

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

FunctionCallOutputContentItem preserves the complete JSON payload for a discriminated union.

func NewFunctionCallOutputContentItem added in v0.145.0

func NewFunctionCallOutputContentItem(value any) (FunctionCallOutputContentItem, error)

NewFunctionCallOutputContentItem validates the discriminator and wraps a JSON-marshalable FunctionCallOutputContentItem value.

func (FunctionCallOutputContentItem) IsKnown added in v0.145.0

func (value FunctionCallOutputContentItem) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (FunctionCallOutputContentItem) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (FunctionCallOutputContentItem) MarshalJSON added in v0.145.0

func (value FunctionCallOutputContentItem) MarshalJSON() ([]byte, error)

func (FunctionCallOutputContentItem) RawJSON added in v0.145.0

RawJSON returns a copy of the complete union payload.

func (*FunctionCallOutputContentItem) UnmarshalJSON added in v0.145.0

func (value *FunctionCallOutputContentItem) UnmarshalJSON(data []byte) error

type FunctionCallOutputContentItemKind added in v0.145.0

type FunctionCallOutputContentItemKind string

FunctionCallOutputContentItemKind identifies a known FunctionCallOutputContentItem variant.

const (
	FunctionCallOutputContentItemKindEncryptedContent FunctionCallOutputContentItemKind = "encrypted_content"
	FunctionCallOutputContentItemKindInputImage       FunctionCallOutputContentItemKind = "input_image"
	FunctionCallOutputContentItemKindInputText        FunctionCallOutputContentItemKind = "input_text"
)

type FuzzyFileSearchMatchType

type FuzzyFileSearchMatchType string
const FuzzyFileSearchMatchTypeDirectory FuzzyFileSearchMatchType = "directory"
const FuzzyFileSearchMatchTypeFile FuzzyFileSearchMatchType = "file"

type FuzzyFileSearchParams

type FuzzyFileSearchParams struct {
	// CancellationToken corresponds to the JSON schema field "cancellationToken".
	CancellationToken FuzzyFileSearchParamsCancellationToken `json:"cancellationToken,omitempty,omitzero"`

	// Query corresponds to the JSON schema field "query".
	Query string `json:"query"`

	// Roots corresponds to the JSON schema field "roots".
	Roots []string `json:"roots"`
}

type FuzzyFileSearchParamsCancellationToken added in v0.144.0

type FuzzyFileSearchParamsCancellationToken *string

type FuzzyFileSearchResult

type FuzzyFileSearchResult struct {
	// FileName corresponds to the JSON schema field "file_name".
	FileName string `json:"file_name"`

	// Indices corresponds to the JSON schema field "indices".
	Indices *FuzzyFileSearchResultIndices `json:"indices,omitempty,omitzero"`

	// MatchType corresponds to the JSON schema field "match_type".
	MatchType FuzzyFileSearchMatchType `json:"match_type"`

	// Path corresponds to the JSON schema field "path".
	Path string `json:"path"`

	// Root corresponds to the JSON schema field "root".
	Root string `json:"root"`

	// Score corresponds to the JSON schema field "score".
	Score int `json:"score"`
}

Superset of [`codex_file_search::FileMatch`]

type FuzzyFileSearchResultIndices added in v0.144.0

type FuzzyFileSearchResultIndices []int

type GetAccountParams

type GetAccountParams struct {
	// When `true`, requests a proactive token refresh before returning.
	//
	// In managed auth mode this triggers the normal refresh-token flow. In external
	// auth mode this flag is ignored. Clients should refresh tokens themselves and
	// call `account/login/start` with `chatgptAuthTokens`.
	RefreshToken *bool `json:"refreshToken,omitempty,omitzero"`
}

type GetAccountResponse

type GetAccountResponse = SanitizedGetAccountResponseJSON

type GrantedPermissionProfile

type GrantedPermissionProfile struct {
	// FileSystem corresponds to the JSON schema field "fileSystem".
	FileSystem interface{} `json:"fileSystem,omitempty,omitzero"`

	// Network corresponds to the JSON schema field "network".
	Network interface{} `json:"network,omitempty,omitzero"`
}

type GuardianApprovalReviewAction added in v0.145.0

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

GuardianApprovalReviewAction preserves the complete JSON payload for a discriminated union.

func NewGuardianApprovalReviewAction added in v0.145.0

func NewGuardianApprovalReviewAction(value any) (GuardianApprovalReviewAction, error)

NewGuardianApprovalReviewAction validates the discriminator and wraps a JSON-marshalable GuardianApprovalReviewAction value.

func (GuardianApprovalReviewAction) IsKnown added in v0.145.0

func (value GuardianApprovalReviewAction) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (GuardianApprovalReviewAction) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (GuardianApprovalReviewAction) MarshalJSON added in v0.145.0

func (value GuardianApprovalReviewAction) MarshalJSON() ([]byte, error)

func (GuardianApprovalReviewAction) RawJSON added in v0.145.0

RawJSON returns a copy of the complete union payload.

func (*GuardianApprovalReviewAction) UnmarshalJSON added in v0.145.0

func (value *GuardianApprovalReviewAction) UnmarshalJSON(data []byte) error

type GuardianApprovalReviewActionKind added in v0.145.0

type GuardianApprovalReviewActionKind string

GuardianApprovalReviewActionKind identifies a known GuardianApprovalReviewAction variant.

const (
	GuardianApprovalReviewActionKindApplyPatch         GuardianApprovalReviewActionKind = "applyPatch"
	GuardianApprovalReviewActionKindCommand            GuardianApprovalReviewActionKind = "command"
	GuardianApprovalReviewActionKindExecve             GuardianApprovalReviewActionKind = "execve"
	GuardianApprovalReviewActionKindMcpToolCall        GuardianApprovalReviewActionKind = "mcpToolCall"
	GuardianApprovalReviewActionKindNetworkAccess      GuardianApprovalReviewActionKind = "networkAccess"
	GuardianApprovalReviewActionKindRequestPermissions GuardianApprovalReviewActionKind = "requestPermissions"
)

type HookCompletedNotification

type HookCompletedNotification interface{}

type HookMigration

type HookMigration struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

type HookStartedNotification

type HookStartedNotification interface{}

type HooksListParams

type HooksListParams struct {
	// When empty, defaults to the current session working directory.
	Cwds []string `json:"cwds,omitempty,omitzero"`
}

type HooksListResponse

type HooksListResponse interface{}

type ImageDetail

type ImageDetail string
const ImageDetailAuto ImageDetail = "auto"
const ImageDetailHigh ImageDetail = "high"
const ImageDetailLow ImageDetail = "low"
const ImageDetailOriginal ImageDetail = "original"

type InitializeCapabilities

type InitializeCapabilities struct {
	// Opt into receiving experimental API methods and fields.
	ExperimentalApi bool `json:"experimentalApi,omitempty,omitzero"`

	// Allow downstream MCP servers to request OpenAI extended form elicitations.
	MCPServerOpenaiFormElicitation *bool `json:"mcpServerOpenaiFormElicitation,omitempty,omitzero"`

	// Exact notification method names that should be suppressed for this connection
	// (for example `thread/started`).
	OptOutNotificationMethods *InitializeCapabilitiesOptOutNotificationMethods `json:"optOutNotificationMethods,omitempty,omitzero"`

	// Opt into `attestation/generate` requests for upstream `x-oai-attestation`.
	RequestAttestation bool `json:"requestAttestation,omitempty,omitzero"`
}

Client-declared capabilities negotiated during initialize.

type InitializeCapabilitiesOptOutNotificationMethods added in v0.144.0

type InitializeCapabilitiesOptOutNotificationMethods []string

Exact notification method names that should be suppressed for this connection (for example `thread/started`).

type InitializeParams

type InitializeParams struct {
	// Capabilities corresponds to the JSON schema field "capabilities".
	Capabilities interface{} `json:"capabilities,omitempty,omitzero"`

	// ClientInfo corresponds to the JSON schema field "clientInfo".
	ClientInfo ClientInfo `json:"clientInfo"`
}

type InitializeResponse

type InitializeResponse interface{}

type InputModality

type InputModality interface{}

Canonical user-input modality tags advertised by a model.

type InternalChatMessageMetadataPassthrough

type InternalChatMessageMetadataPassthrough struct {
	// TurnID corresponds to the JSON schema field "turn_id".
	TurnID InternalChatMessageMetadataPassthroughTurnID `json:"turn_id,omitempty,omitzero"`
}

Internal Responses API passthrough metadata copied into underlying chat messages.

Responses API strongly types this payload. Do not modify it without first getting API approval and making the corresponding Responses API change.

type InternalChatMessageMetadataPassthroughTurnID added in v0.144.0

type InternalChatMessageMetadataPassthroughTurnID *string

type ItemCompletedNotification

type ItemCompletedNotification struct {
	ThreadID string          `json:"threadId,omitempty"`
	Item     json.RawMessage `json:"item,omitempty"`
}

ItemCompletedNotification is the payload for item/completed.

type ItemGuardianApprovalReviewCompletedNotification

type ItemGuardianApprovalReviewCompletedNotification interface{}

type ItemGuardianApprovalReviewStartedNotification

type ItemGuardianApprovalReviewStartedNotification interface{}

type ItemStartedNotification

type ItemStartedNotification interface{}

type LegacyAppPathString

type LegacyAppPathString string

type ListMCPServerStatusParams

type ListMCPServerStatusParams struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor ListMCPServerStatusParamsCursor `json:"cursor,omitempty,omitzero"`

	// Controls how much MCP inventory data to fetch for each server. Defaults to
	// `Full` when omitted.
	Detail interface{} `json:"detail,omitempty,omitzero"`

	// Optional page size; defaults to a server-defined value.
	Limit ListMCPServerStatusParamsLimit `json:"limit,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID ListMCPServerStatusParamsThreadID `json:"threadId,omitempty,omitzero"`
}

type ListMCPServerStatusParamsCursor added in v0.144.0

type ListMCPServerStatusParamsCursor *string

Opaque pagination cursor returned by a previous call.

type ListMCPServerStatusParamsLimit added in v0.144.0

type ListMCPServerStatusParamsLimit *int

Optional page size; defaults to a server-defined value.

type ListMCPServerStatusParamsThreadID added in v0.144.0

type ListMCPServerStatusParamsThreadID *string

type ListMcpServerStatusParams

type ListMcpServerStatusParams interface{}

type ListMcpServerStatusResponse

type ListMcpServerStatusResponse interface{}

type LocalShellAction

type LocalShellAction interface{}

type LocalShellStatus

type LocalShellStatus string
const LocalShellStatusCompleted LocalShellStatus = "completed"
const LocalShellStatusInProgress LocalShellStatus = "in_progress"
const LocalShellStatusIncomplete LocalShellStatus = "incomplete"

type LoginAccountParams

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

LoginAccountParams preserves the complete JSON payload for a discriminated union.

func NewLoginAccountParams added in v0.145.0

func NewLoginAccountParams(value any) (LoginAccountParams, error)

NewLoginAccountParams validates the discriminator and wraps a JSON-marshalable LoginAccountParams value.

func (LoginAccountParams) IsKnown added in v0.145.0

func (value LoginAccountParams) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (LoginAccountParams) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (LoginAccountParams) MarshalJSON added in v0.145.0

func (value LoginAccountParams) MarshalJSON() ([]byte, error)

func (LoginAccountParams) RawJSON added in v0.145.0

func (value LoginAccountParams) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*LoginAccountParams) UnmarshalJSON added in v0.145.0

func (value *LoginAccountParams) UnmarshalJSON(data []byte) error

type LoginAccountParamsKind added in v0.145.0

type LoginAccountParamsKind string

LoginAccountParamsKind identifies a known LoginAccountParams variant.

const (
	LoginAccountParamsKindApiKey            LoginAccountParamsKind = "apiKey"
	LoginAccountParamsKindChatgpt           LoginAccountParamsKind = "chatgpt"
	LoginAccountParamsKindChatgptAuthTokens LoginAccountParamsKind = "chatgptAuthTokens"
	LoginAccountParamsKindChatgptDeviceCode LoginAccountParamsKind = "chatgptDeviceCode"
)

type LoginAccountResponse

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

LoginAccountResponse preserves the complete JSON payload for a discriminated union.

func NewLoginAccountResponse added in v0.145.0

func NewLoginAccountResponse(value any) (LoginAccountResponse, error)

NewLoginAccountResponse validates the discriminator and wraps a JSON-marshalable LoginAccountResponse value.

func (LoginAccountResponse) IsKnown added in v0.145.0

func (value LoginAccountResponse) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (LoginAccountResponse) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (LoginAccountResponse) MarshalJSON added in v0.145.0

func (value LoginAccountResponse) MarshalJSON() ([]byte, error)

func (LoginAccountResponse) RawJSON added in v0.145.0

func (value LoginAccountResponse) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*LoginAccountResponse) UnmarshalJSON added in v0.145.0

func (value *LoginAccountResponse) UnmarshalJSON(data []byte) error

type LoginAccountResponseKind added in v0.145.0

type LoginAccountResponseKind string

LoginAccountResponseKind identifies a known LoginAccountResponse variant.

const (
	LoginAccountResponseKindApiKey            LoginAccountResponseKind = "apiKey"
	LoginAccountResponseKindChatgpt           LoginAccountResponseKind = "chatgpt"
	LoginAccountResponseKindChatgptAuthTokens LoginAccountResponseKind = "chatgptAuthTokens"
	LoginAccountResponseKindChatgptDeviceCode LoginAccountResponseKind = "chatgptDeviceCode"
)

type LoginAppBrand added in v0.144.0

type LoginAppBrand string
const LoginAppBrandChatgpt LoginAppBrand = "chatgpt"
const LoginAppBrandCodex LoginAppBrand = "codex"

type LogoutAccountResponse

type LogoutAccountResponse = SanitizedLogoutAccountResponseJSON

type MCPAuthStatus

type MCPAuthStatus string
const MCPAuthStatusBearerToken MCPAuthStatus = "bearerToken"
const MCPAuthStatusNotLoggedIn MCPAuthStatus = "notLoggedIn"
const MCPAuthStatusOAuth MCPAuthStatus = "oAuth"
const MCPAuthStatusUnsupported MCPAuthStatus = "unsupported"

type MCPElicitationArrayType

type MCPElicitationArrayType string
const MCPElicitationArrayTypeArray MCPElicitationArrayType = "array"

type MCPElicitationBooleanSchema

type MCPElicitationBooleanSchema struct {
	// Default corresponds to the JSON schema field "default".
	Default MCPElicitationBooleanSchemaDefault `json:"default,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description MCPElicitationBooleanSchemaDescription `json:"description,omitempty,omitzero"`

	// Title corresponds to the JSON schema field "title".
	Title MCPElicitationBooleanSchemaTitle `json:"title,omitempty,omitzero"`

	// Type corresponds to the JSON schema field "type".
	Type MCPElicitationBooleanType `json:"type"`
}

type MCPElicitationBooleanSchemaDefault added in v0.144.0

type MCPElicitationBooleanSchemaDefault *bool

type MCPElicitationBooleanSchemaDescription added in v0.144.0

type MCPElicitationBooleanSchemaDescription *string

type MCPElicitationBooleanSchemaTitle added in v0.144.0

type MCPElicitationBooleanSchemaTitle *string

type MCPElicitationBooleanType

type MCPElicitationBooleanType string
const MCPElicitationBooleanTypeBoolean MCPElicitationBooleanType = "boolean"

type MCPElicitationConstOption

type MCPElicitationConstOption struct {
	// Const corresponds to the JSON schema field "const".
	Const string `json:"const"`

	// Title corresponds to the JSON schema field "title".
	Title string `json:"title"`
}

type MCPElicitationEnumSchema

type MCPElicitationEnumSchema interface{}

type MCPElicitationLegacyTitledEnumSchema

type MCPElicitationLegacyTitledEnumSchema struct {
	// Default corresponds to the JSON schema field "default".
	Default MCPElicitationLegacyTitledEnumSchemaDefault `json:"default,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description MCPElicitationLegacyTitledEnumSchemaDescription `json:"description,omitempty,omitzero"`

	// Enum corresponds to the JSON schema field "enum".
	Enum []string `json:"enum"`

	// EnumNames corresponds to the JSON schema field "enumNames".
	EnumNames *MCPElicitationLegacyTitledEnumSchemaEnumNames `json:"enumNames,omitempty,omitzero"`

	// Title corresponds to the JSON schema field "title".
	Title MCPElicitationLegacyTitledEnumSchemaTitle `json:"title,omitempty,omitzero"`

	// Type corresponds to the JSON schema field "type".
	Type MCPElicitationStringType `json:"type"`
}

type MCPElicitationLegacyTitledEnumSchemaDefault added in v0.144.0

type MCPElicitationLegacyTitledEnumSchemaDefault *string

type MCPElicitationLegacyTitledEnumSchemaDescription added in v0.144.0

type MCPElicitationLegacyTitledEnumSchemaDescription *string

type MCPElicitationLegacyTitledEnumSchemaEnumNames added in v0.144.0

type MCPElicitationLegacyTitledEnumSchemaEnumNames []string

type MCPElicitationLegacyTitledEnumSchemaTitle added in v0.144.0

type MCPElicitationLegacyTitledEnumSchemaTitle *string

type MCPElicitationMultiSelectEnumSchema

type MCPElicitationMultiSelectEnumSchema interface{}

type MCPElicitationNumberSchema

type MCPElicitationNumberSchema struct {
	// Default corresponds to the JSON schema field "default".
	Default MCPElicitationNumberSchemaDefault `json:"default,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description MCPElicitationNumberSchemaDescription `json:"description,omitempty,omitzero"`

	// Maximum corresponds to the JSON schema field "maximum".
	Maximum MCPElicitationNumberSchemaMaximum `json:"maximum,omitempty,omitzero"`

	// Minimum corresponds to the JSON schema field "minimum".
	Minimum MCPElicitationNumberSchemaMinimum `json:"minimum,omitempty,omitzero"`

	// Title corresponds to the JSON schema field "title".
	Title MCPElicitationNumberSchemaTitle `json:"title,omitempty,omitzero"`

	// Type corresponds to the JSON schema field "type".
	Type MCPElicitationNumberType `json:"type"`
}

type MCPElicitationNumberSchemaDefault added in v0.144.0

type MCPElicitationNumberSchemaDefault *float64

type MCPElicitationNumberSchemaDescription added in v0.144.0

type MCPElicitationNumberSchemaDescription *string

type MCPElicitationNumberSchemaMaximum added in v0.144.0

type MCPElicitationNumberSchemaMaximum *float64

type MCPElicitationNumberSchemaMinimum added in v0.144.0

type MCPElicitationNumberSchemaMinimum *float64

type MCPElicitationNumberSchemaTitle added in v0.144.0

type MCPElicitationNumberSchemaTitle *string

type MCPElicitationNumberType

type MCPElicitationNumberType string
const MCPElicitationNumberTypeInteger MCPElicitationNumberType = "integer"
const MCPElicitationNumberTypeNumber MCPElicitationNumberType = "number"

type MCPElicitationObjectType

type MCPElicitationObjectType string
const MCPElicitationObjectTypeObject MCPElicitationObjectType = "object"

type MCPElicitationPrimitiveSchema

type MCPElicitationPrimitiveSchema interface{}

type MCPElicitationSchema

type MCPElicitationSchema struct {
	// Schema corresponds to the JSON schema field "$schema".
	Schema MCPElicitationSchemaSchema `json:"$schema,omitempty,omitzero"`

	// Properties corresponds to the JSON schema field "properties".
	Properties MCPElicitationSchemaProperties `json:"properties"`

	// Required corresponds to the JSON schema field "required".
	Required *MCPElicitationSchemaRequired `json:"required,omitempty,omitzero"`

	// Type corresponds to the JSON schema field "type".
	Type MCPElicitationObjectType `json:"type"`
}

Typed form schema for MCP `elicitation/create` requests.

This matches the `requestedSchema` shape from the MCP 2025-11-25 `ElicitRequestFormParams` schema.

type MCPElicitationSchemaProperties added in v0.144.0

type MCPElicitationSchemaProperties map[string]MCPElicitationPrimitiveSchema

type MCPElicitationSchemaRequired added in v0.144.0

type MCPElicitationSchemaRequired []string

type MCPElicitationSchemaSchema added in v0.144.0

type MCPElicitationSchemaSchema *string

type MCPElicitationSingleSelectEnumSchema

type MCPElicitationSingleSelectEnumSchema interface{}

type MCPElicitationStringFormat

type MCPElicitationStringFormat string
const MCPElicitationStringFormatDate MCPElicitationStringFormat = "date"
const MCPElicitationStringFormatDateTime MCPElicitationStringFormat = "date-time"
const MCPElicitationStringFormatEmail MCPElicitationStringFormat = "email"
const MCPElicitationStringFormatUri MCPElicitationStringFormat = "uri"

type MCPElicitationStringSchema

type MCPElicitationStringSchema struct {
	// Default corresponds to the JSON schema field "default".
	Default MCPElicitationStringSchemaDefault `json:"default,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description MCPElicitationStringSchemaDescription `json:"description,omitempty,omitzero"`

	// Format corresponds to the JSON schema field "format".
	Format interface{} `json:"format,omitempty,omitzero"`

	// MaxLength corresponds to the JSON schema field "maxLength".
	MaxLength MCPElicitationStringSchemaMaxLength `json:"maxLength,omitempty,omitzero"`

	// MinLength corresponds to the JSON schema field "minLength".
	MinLength MCPElicitationStringSchemaMinLength `json:"minLength,omitempty,omitzero"`

	// Title corresponds to the JSON schema field "title".
	Title MCPElicitationStringSchemaTitle `json:"title,omitempty,omitzero"`

	// Type corresponds to the JSON schema field "type".
	Type MCPElicitationStringType `json:"type"`
}

type MCPElicitationStringSchemaDefault added in v0.144.0

type MCPElicitationStringSchemaDefault *string

type MCPElicitationStringSchemaDescription added in v0.144.0

type MCPElicitationStringSchemaDescription *string

type MCPElicitationStringSchemaMaxLength added in v0.144.0

type MCPElicitationStringSchemaMaxLength *int

type MCPElicitationStringSchemaMinLength added in v0.144.0

type MCPElicitationStringSchemaMinLength *int

type MCPElicitationStringSchemaTitle added in v0.144.0

type MCPElicitationStringSchemaTitle *string

type MCPElicitationStringType

type MCPElicitationStringType string
const MCPElicitationStringTypeString MCPElicitationStringType = "string"

type MCPResourceReadParams

type MCPResourceReadParams struct {
	// Server corresponds to the JSON schema field "server".
	Server string `json:"server"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID MCPResourceReadParamsThreadID `json:"threadId,omitempty,omitzero"`

	// Uri corresponds to the JSON schema field "uri".
	Uri string `json:"uri"`
}

type MCPResourceReadParamsThreadID added in v0.144.0

type MCPResourceReadParamsThreadID *string

type MCPServerElicitationAction

type MCPServerElicitationAction string
const MCPServerElicitationActionAccept MCPServerElicitationAction = "accept"
const MCPServerElicitationActionCancel MCPServerElicitationAction = "cancel"
const MCPServerElicitationActionDecline MCPServerElicitationAction = "decline"

type MCPServerInfo

type MCPServerInfo struct {
	// Description corresponds to the JSON schema field "description".
	Description MCPServerInfoDescription `json:"description,omitempty,omitzero"`

	// Icons corresponds to the JSON schema field "icons".
	Icons *MCPServerInfoIcons `json:"icons,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Title corresponds to the JSON schema field "title".
	Title MCPServerInfoTitle `json:"title,omitempty,omitzero"`

	// Version corresponds to the JSON schema field "version".
	Version string `json:"version"`

	// WebsiteURL corresponds to the JSON schema field "websiteUrl".
	WebsiteURL MCPServerInfoWebsiteURL `json:"websiteUrl,omitempty,omitzero"`
}

Presentation metadata advertised by an initialized MCP server.

type MCPServerInfoDescription added in v0.144.0

type MCPServerInfoDescription *string

type MCPServerInfoIcons added in v0.144.0

type MCPServerInfoIcons []interface{}

type MCPServerInfoTitle added in v0.144.0

type MCPServerInfoTitle *string

type MCPServerInfoWebsiteURL added in v0.144.0

type MCPServerInfoWebsiteURL *string

type MCPServerMigration

type MCPServerMigration struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

type MCPServerOauthLoginParams

type MCPServerOauthLoginParams struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Scopes corresponds to the JSON schema field "scopes".
	Scopes *MCPServerOauthLoginParamsScopes `json:"scopes,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID MCPServerOauthLoginParamsThreadID `json:"threadId,omitempty,omitzero"`

	// TimeoutSecs corresponds to the JSON schema field "timeoutSecs".
	TimeoutSecs MCPServerOauthLoginParamsTimeoutSecs `json:"timeoutSecs,omitempty,omitzero"`
}

type MCPServerOauthLoginParamsScopes added in v0.144.0

type MCPServerOauthLoginParamsScopes []string

type MCPServerOauthLoginParamsThreadID added in v0.144.0

type MCPServerOauthLoginParamsThreadID *string

type MCPServerOauthLoginParamsTimeoutSecs added in v0.144.0

type MCPServerOauthLoginParamsTimeoutSecs *int

type MCPServerStartupFailureReason

type MCPServerStartupFailureReason string
const MCPServerStartupFailureReasonReauthenticationRequired MCPServerStartupFailureReason = "reauthenticationRequired"

type MCPServerStartupState

type MCPServerStartupState string
const MCPServerStartupStateCancelled MCPServerStartupState = "cancelled"
const MCPServerStartupStateFailed MCPServerStartupState = "failed"
const MCPServerStartupStateReady MCPServerStartupState = "ready"
const MCPServerStartupStateStarting MCPServerStartupState = "starting"

type MCPServerStatus

type MCPServerStatus struct {
	// AuthStatus corresponds to the JSON schema field "authStatus".
	AuthStatus MCPAuthStatus `json:"authStatus"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// ResourceTemplates corresponds to the JSON schema field "resourceTemplates".
	ResourceTemplates []ResourceTemplate `json:"resourceTemplates"`

	// Resources corresponds to the JSON schema field "resources".
	Resources []Resource `json:"resources"`

	// ServerInfo corresponds to the JSON schema field "serverInfo".
	ServerInfo interface{} `json:"serverInfo,omitempty,omitzero"`

	// Tools corresponds to the JSON schema field "tools".
	Tools MCPServerStatusTools `json:"tools"`
}

type MCPServerStatusDetail

type MCPServerStatusDetail string
const MCPServerStatusDetailFull MCPServerStatusDetail = "full"
const MCPServerStatusDetailToolsAndAuthOnly MCPServerStatusDetail = "toolsAndAuthOnly"

type MCPServerStatusTools added in v0.144.0

type MCPServerStatusTools map[string]Tool

type MCPServerToolCallParams

type MCPServerToolCallParams struct {
	// Meta corresponds to the JSON schema field "_meta".
	Meta interface{} `json:"_meta,omitempty,omitzero"`

	// Arguments corresponds to the JSON schema field "arguments".
	Arguments interface{} `json:"arguments,omitempty,omitzero"`

	// Server corresponds to the JSON schema field "server".
	Server string `json:"server"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// Tool corresponds to the JSON schema field "tool".
	Tool string `json:"tool"`
}

type ManagedHooksRequirements

type ManagedHooksRequirements struct {
	// PermissionRequest corresponds to the JSON schema field "PermissionRequest".
	PermissionRequest []ConfiguredHookMatcherGroup `json:"PermissionRequest"`

	// PostCompact corresponds to the JSON schema field "PostCompact".
	PostCompact []ConfiguredHookMatcherGroup `json:"PostCompact"`

	// PostToolUse corresponds to the JSON schema field "PostToolUse".
	PostToolUse []ConfiguredHookMatcherGroup `json:"PostToolUse"`

	// PreCompact corresponds to the JSON schema field "PreCompact".
	PreCompact []ConfiguredHookMatcherGroup `json:"PreCompact"`

	// PreToolUse corresponds to the JSON schema field "PreToolUse".
	PreToolUse []ConfiguredHookMatcherGroup `json:"PreToolUse"`

	// SessionStart corresponds to the JSON schema field "SessionStart".
	SessionStart []ConfiguredHookMatcherGroup `json:"SessionStart"`

	// Stop corresponds to the JSON schema field "Stop".
	Stop []ConfiguredHookMatcherGroup `json:"Stop"`

	// SubagentStart corresponds to the JSON schema field "SubagentStart".
	SubagentStart []ConfiguredHookMatcherGroup `json:"SubagentStart"`

	// SubagentStop corresponds to the JSON schema field "SubagentStop".
	SubagentStop []ConfiguredHookMatcherGroup `json:"SubagentStop"`

	// UserPromptSubmit corresponds to the JSON schema field "UserPromptSubmit".
	UserPromptSubmit []ConfiguredHookMatcherGroup `json:"UserPromptSubmit"`

	// ManagedDir corresponds to the JSON schema field "managedDir".
	ManagedDir ManagedHooksRequirementsManagedDir `json:"managedDir,omitempty,omitzero"`

	// WindowsManagedDir corresponds to the JSON schema field "windowsManagedDir".
	WindowsManagedDir ManagedHooksRequirementsWindowsManagedDir `json:"windowsManagedDir,omitempty,omitzero"`
}

type ManagedHooksRequirementsManagedDir added in v0.144.0

type ManagedHooksRequirementsManagedDir *string

type ManagedHooksRequirementsWindowsManagedDir added in v0.144.0

type ManagedHooksRequirementsWindowsManagedDir *string

type MarketplaceAddParams

type MarketplaceAddParams struct {
	// RefName corresponds to the JSON schema field "refName".
	RefName MarketplaceAddParamsRefName `json:"refName,omitempty,omitzero"`

	// Source corresponds to the JSON schema field "source".
	Source string `json:"source"`

	// SparsePaths corresponds to the JSON schema field "sparsePaths".
	SparsePaths *MarketplaceAddParamsSparsePaths `json:"sparsePaths,omitempty,omitzero"`
}

type MarketplaceAddParamsRefName added in v0.144.0

type MarketplaceAddParamsRefName *string

type MarketplaceAddParamsSparsePaths added in v0.144.0

type MarketplaceAddParamsSparsePaths []string

type MarketplaceAddResponse

type MarketplaceAddResponse interface{}

type MarketplaceRemoveParams

type MarketplaceRemoveParams struct {
	// MarketplaceName corresponds to the JSON schema field "marketplaceName".
	MarketplaceName string `json:"marketplaceName"`
}

type MarketplaceRemoveResponse

type MarketplaceRemoveResponse interface{}

type MarketplaceUpgradeParams

type MarketplaceUpgradeParams struct {
	// MarketplaceName corresponds to the JSON schema field "marketplaceName".
	MarketplaceName MarketplaceUpgradeParamsMarketplaceName `json:"marketplaceName,omitempty,omitzero"`
}

type MarketplaceUpgradeParamsMarketplaceName added in v0.144.0

type MarketplaceUpgradeParamsMarketplaceName *string

type MarketplaceUpgradeResponse

type MarketplaceUpgradeResponse interface{}

type McpResourceReadParams

type McpResourceReadParams interface{}

type McpResourceReadResponse

type McpResourceReadResponse interface{}

type McpServerElicitationRequestParams

type McpServerElicitationRequestParams interface{}

type McpServerElicitationRequestResponse

type McpServerElicitationRequestResponse interface{}

type McpServerOauthLoginCompletedNotification

type McpServerOauthLoginCompletedNotification interface{}

type McpServerOauthLoginParams

type McpServerOauthLoginParams interface{}

type McpServerOauthLoginResponse

type McpServerOauthLoginResponse interface{}

type McpServerRefreshResponse

type McpServerRefreshResponse interface{}

type McpServerStatusUpdatedNotification

type McpServerStatusUpdatedNotification interface{}

type McpServerToolCallParams

type McpServerToolCallParams interface{}

type McpServerToolCallResponse

type McpServerToolCallResponse interface{}

type McpToolCallProgressNotification

type McpToolCallProgressNotification interface{}

type MergeStrategy

type MergeStrategy string
const MergeStrategyReplace MergeStrategy = "replace"
const MergeStrategyUpsert MergeStrategy = "upsert"

type MessagePhase

type MessagePhase interface{}

Classifies an assistant message as interim commentary or final answer text.

Providers do not emit this consistently, so callers must treat `None` as "phase unknown" and keep compatibility behavior for legacy models.

type MigrationDetails

type MigrationDetails struct {
	// Commands corresponds to the JSON schema field "commands".
	Commands []CommandMigration `json:"commands,omitempty,omitzero"`

	// Hooks corresponds to the JSON schema field "hooks".
	Hooks []HookMigration `json:"hooks,omitempty,omitzero"`

	// MCPServers corresponds to the JSON schema field "mcpServers".
	MCPServers []MCPServerMigration `json:"mcpServers,omitempty,omitzero"`

	// Plugins corresponds to the JSON schema field "plugins".
	Plugins []PluginsMigration `json:"plugins,omitempty,omitzero"`

	// Sessions corresponds to the JSON schema field "sessions".
	Sessions []SessionMigration `json:"sessions,omitempty,omitzero"`

	// Skills corresponds to the JSON schema field "skills".
	Skills []SkillMigration `json:"skills,omitempty,omitzero"`

	// Subagents corresponds to the JSON schema field "subagents".
	Subagents []SubagentMigration `json:"subagents,omitempty,omitzero"`
}

type ModeKind

type ModeKind string
const ModeKindDefault ModeKind = "default"
const ModeKindPlan ModeKind = "plan"

type Model

type Model struct {
	// Deprecated: use `serviceTiers` instead.
	AdditionalSpeedTiers []string `json:"additionalSpeedTiers,omitempty,omitzero"`

	// AvailabilityNux corresponds to the JSON schema field "availabilityNux".
	AvailabilityNux interface{} `json:"availabilityNux,omitempty,omitzero"`

	// DefaultReasoningEffort corresponds to the JSON schema field
	// "defaultReasoningEffort".
	DefaultReasoningEffort ReasoningEffort `json:"defaultReasoningEffort"`

	// Catalog default service tier id for this model, when one is configured.
	DefaultServiceTier ModelDefaultServiceTier `json:"defaultServiceTier,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description string `json:"description"`

	// DisplayName corresponds to the JSON schema field "displayName".
	DisplayName string `json:"displayName"`

	// Hidden corresponds to the JSON schema field "hidden".
	Hidden bool `json:"hidden"`

	// ID corresponds to the JSON schema field "id".
	ID string `json:"id"`

	// InputModalities corresponds to the JSON schema field "inputModalities".
	InputModalities []InputModality `json:"inputModalities,omitempty,omitzero"`

	// IsDefault corresponds to the JSON schema field "isDefault".
	IsDefault bool `json:"isDefault"`

	// Model corresponds to the JSON schema field "model".
	Model string `json:"model"`

	// ServiceTiers corresponds to the JSON schema field "serviceTiers".
	ServiceTiers []ModelServiceTier `json:"serviceTiers,omitempty,omitzero"`

	// SupportedReasoningEfforts corresponds to the JSON schema field
	// "supportedReasoningEfforts".
	SupportedReasoningEfforts []ReasoningEffortOption `json:"supportedReasoningEfforts"`

	// SupportsPersonality corresponds to the JSON schema field "supportsPersonality".
	SupportsPersonality bool `json:"supportsPersonality,omitempty,omitzero"`

	// Upgrade corresponds to the JSON schema field "upgrade".
	Upgrade ModelUpgrade `json:"upgrade,omitempty,omitzero"`

	// UpgradeInfo corresponds to the JSON schema field "upgradeInfo".
	UpgradeInfo interface{} `json:"upgradeInfo,omitempty,omitzero"`
}

type ModelAvailabilityNux

type ModelAvailabilityNux struct {
	// Message corresponds to the JSON schema field "message".
	Message string `json:"message"`
}

type ModelDefaultServiceTier added in v0.144.0

type ModelDefaultServiceTier *string

Catalog default service tier id for this model, when one is configured.

type ModelListParams

type ModelListParams struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor ModelListParamsCursor `json:"cursor,omitempty,omitzero"`

	// When true, include models that are hidden from the default picker list.
	IncludeHidden ModelListParamsIncludeHidden `json:"includeHidden,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit ModelListParamsLimit `json:"limit,omitempty,omitzero"`
}

type ModelListParamsCursor added in v0.144.0

type ModelListParamsCursor *string

Opaque pagination cursor returned by a previous call.

type ModelListParamsIncludeHidden added in v0.144.0

type ModelListParamsIncludeHidden *bool

When true, include models that are hidden from the default picker list.

type ModelListParamsLimit added in v0.144.0

type ModelListParamsLimit *int

Optional page size; defaults to a reasonable server-side value.

type ModelListResponse

type ModelListResponse = SanitizedModelListResponseJSON

type ModelProviderCapabilitiesReadParams

type ModelProviderCapabilitiesReadParams map[string]interface{}

type ModelRerouteReason

type ModelRerouteReason string
const ModelRerouteReasonHighRiskCyberActivity ModelRerouteReason = "highRiskCyberActivity"

type ModelServiceTier

type ModelServiceTier struct {
	// Description corresponds to the JSON schema field "description".
	Description string `json:"description"`

	// ID corresponds to the JSON schema field "id".
	ID string `json:"id"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

type ModelUpgrade added in v0.144.0

type ModelUpgrade *string

type ModelUpgradeInfo

type ModelUpgradeInfo struct {
	// MigrationMarkdown corresponds to the JSON schema field "migrationMarkdown".
	MigrationMarkdown ModelUpgradeInfoMigrationMarkdown `json:"migrationMarkdown,omitempty,omitzero"`

	// Model corresponds to the JSON schema field "model".
	Model string `json:"model"`

	// ModelLink corresponds to the JSON schema field "modelLink".
	ModelLink ModelUpgradeInfoModelLink `json:"modelLink,omitempty,omitzero"`

	// UpgradeCopy corresponds to the JSON schema field "upgradeCopy".
	UpgradeCopy ModelUpgradeInfoUpgradeCopy `json:"upgradeCopy,omitempty,omitzero"`
}

type ModelUpgradeInfoMigrationMarkdown added in v0.144.0

type ModelUpgradeInfoMigrationMarkdown *string
type ModelUpgradeInfoModelLink *string

type ModelUpgradeInfoUpgradeCopy added in v0.144.0

type ModelUpgradeInfoUpgradeCopy *string

type ModelVerification

type ModelVerification string
const ModelVerificationTrustedAccessForCyber ModelVerification = "trustedAccessForCyber"

type ModelsRequirements

type ModelsRequirements struct {
	// NewThread corresponds to the JSON schema field "newThread".
	NewThread interface{} `json:"newThread,omitempty,omitzero"`
}

type MultiAgentMode

type MultiAgentMode interface{}

Controls the effective multi-agent delegation instructions for a turn. `custom` means the configured mode hint defines the policy instead of a built-in policy.

type NetworkAccess

type NetworkAccess string
const NetworkAccessEnabled NetworkAccess = "enabled"
const NetworkAccessRestricted NetworkAccess = "restricted"

type NetworkDomainPermission

type NetworkDomainPermission string
const NetworkDomainPermissionAllow NetworkDomainPermission = "allow"
const NetworkDomainPermissionDeny NetworkDomainPermission = "deny"

type NetworkPolicyAmendment

type NetworkPolicyAmendment struct {
	// Action corresponds to the JSON schema field "action".
	Action NetworkPolicyRuleAction `json:"action"`

	// Host corresponds to the JSON schema field "host".
	Host string `json:"host"`
}

type NetworkPolicyRuleAction

type NetworkPolicyRuleAction string
const NetworkPolicyRuleActionAllow NetworkPolicyRuleAction = "allow"
const NetworkPolicyRuleActionDeny NetworkPolicyRuleAction = "deny"

type NetworkRequirements

type NetworkRequirements struct {
	// AllowLocalBinding corresponds to the JSON schema field "allowLocalBinding".
	AllowLocalBinding NetworkRequirementsAllowLocalBinding `json:"allowLocalBinding,omitempty,omitzero"`

	// Legacy compatibility view derived from `unix_sockets`.
	AllowUnixSockets *NetworkRequirementsAllowUnixSockets `json:"allowUnixSockets,omitempty,omitzero"`

	// AllowUpstreamProxy corresponds to the JSON schema field "allowUpstreamProxy".
	AllowUpstreamProxy NetworkRequirementsAllowUpstreamProxy `json:"allowUpstreamProxy,omitempty,omitzero"`

	// Legacy compatibility view derived from `domains`.
	AllowedDomains *NetworkRequirementsAllowedDomains `json:"allowedDomains,omitempty,omitzero"`

	// DangerouslyAllowAllUnixSockets corresponds to the JSON schema field
	// "dangerouslyAllowAllUnixSockets".
	DangerouslyAllowAllUnixSockets NetworkRequirementsDangerouslyAllowAllUnixSockets `json:"dangerouslyAllowAllUnixSockets,omitempty,omitzero"`

	// DangerouslyAllowNonLoopbackProxy corresponds to the JSON schema field
	// "dangerouslyAllowNonLoopbackProxy".
	DangerouslyAllowNonLoopbackProxy NetworkRequirementsDangerouslyAllowNonLoopbackProxy `json:"dangerouslyAllowNonLoopbackProxy,omitempty,omitzero"`

	// Legacy compatibility view derived from `domains`.
	DeniedDomains *NetworkRequirementsDeniedDomains `json:"deniedDomains,omitempty,omitzero"`

	// Canonical network permission map for `experimental_network`.
	Domains *NetworkRequirementsDomains `json:"domains,omitempty,omitzero"`

	// Enabled corresponds to the JSON schema field "enabled".
	Enabled NetworkRequirementsEnabled `json:"enabled,omitempty,omitzero"`

	// HTTPPort corresponds to the JSON schema field "httpPort".
	HTTPPort NetworkRequirementsHTTPPort `json:"httpPort,omitempty,omitzero"`

	// When true, only managed allowlist entries are respected while managed network
	// enforcement is active.
	ManagedAllowedDomainsOnly NetworkRequirementsManagedAllowedDomainsOnly `json:"managedAllowedDomainsOnly,omitempty,omitzero"`

	// SocksPort corresponds to the JSON schema field "socksPort".
	SocksPort NetworkRequirementsSocksPort `json:"socksPort,omitempty,omitzero"`

	// Canonical unix socket permission map for `experimental_network`.
	UnixSockets *NetworkRequirementsUnixSockets `json:"unixSockets,omitempty,omitzero"`
}

type NetworkRequirementsAllowLocalBinding added in v0.144.0

type NetworkRequirementsAllowLocalBinding *bool

type NetworkRequirementsAllowUnixSockets added in v0.144.0

type NetworkRequirementsAllowUnixSockets []string

Legacy compatibility view derived from `unix_sockets`.

type NetworkRequirementsAllowUpstreamProxy added in v0.144.0

type NetworkRequirementsAllowUpstreamProxy *bool

type NetworkRequirementsAllowedDomains added in v0.144.0

type NetworkRequirementsAllowedDomains []string

Legacy compatibility view derived from `domains`.

type NetworkRequirementsDangerouslyAllowAllUnixSockets added in v0.144.0

type NetworkRequirementsDangerouslyAllowAllUnixSockets *bool

type NetworkRequirementsDangerouslyAllowNonLoopbackProxy added in v0.144.0

type NetworkRequirementsDangerouslyAllowNonLoopbackProxy *bool

type NetworkRequirementsDeniedDomains added in v0.144.0

type NetworkRequirementsDeniedDomains []string

Legacy compatibility view derived from `domains`.

type NetworkRequirementsDomains added in v0.144.0

type NetworkRequirementsDomains map[string]NetworkDomainPermission

Canonical network permission map for `experimental_network`.

type NetworkRequirementsEnabled added in v0.144.0

type NetworkRequirementsEnabled *bool

type NetworkRequirementsHTTPPort added in v0.144.0

type NetworkRequirementsHTTPPort *int

type NetworkRequirementsManagedAllowedDomainsOnly added in v0.144.0

type NetworkRequirementsManagedAllowedDomainsOnly *bool

When true, only managed allowlist entries are respected while managed network enforcement is active.

type NetworkRequirementsSocksPort added in v0.144.0

type NetworkRequirementsSocksPort *int

type NetworkRequirementsUnixSockets added in v0.144.0

type NetworkRequirementsUnixSockets map[string]NetworkUnixSocketPermission

Canonical unix socket permission map for `experimental_network`.

type NetworkUnixSocketPermission

type NetworkUnixSocketPermission string
const NetworkUnixSocketPermissionAllow NetworkUnixSocketPermission = "allow"
const NetworkUnixSocketPermissionDeny NetworkUnixSocketPermission = "deny"

type NewThreadModelDefaults

type NewThreadModelDefaults struct {
	// Model corresponds to the JSON schema field "model".
	Model NewThreadModelDefaultsModel `json:"model,omitempty,omitzero"`

	// ModelReasoningEffort corresponds to the JSON schema field
	// "modelReasoningEffort".
	ModelReasoningEffort interface{} `json:"modelReasoningEffort,omitempty,omitzero"`

	// ServiceTier corresponds to the JSON schema field "serviceTier".
	ServiceTier NewThreadModelDefaultsServiceTier `json:"serviceTier,omitempty,omitzero"`
}

type NewThreadModelDefaultsModel added in v0.144.0

type NewThreadModelDefaultsModel *string

type NewThreadModelDefaultsServiceTier added in v0.144.0

type NewThreadModelDefaultsServiceTier *string

type NonSteerableTurnKind

type NonSteerableTurnKind string
const NonSteerableTurnKindCompact NonSteerableTurnKind = "compact"
const NonSteerableTurnKindReview NonSteerableTurnKind = "review"

type ParsedCommand

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

ParsedCommand preserves the complete JSON payload for a discriminated union.

func NewParsedCommand added in v0.145.0

func NewParsedCommand(value any) (ParsedCommand, error)

NewParsedCommand validates the discriminator and wraps a JSON-marshalable ParsedCommand value.

func (ParsedCommand) IsKnown added in v0.145.0

func (value ParsedCommand) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ParsedCommand) Kind added in v0.145.0

func (value ParsedCommand) Kind() ParsedCommandKind

Kind returns the payload discriminator, including unknown future values.

func (ParsedCommand) MarshalJSON added in v0.145.0

func (value ParsedCommand) MarshalJSON() ([]byte, error)

func (ParsedCommand) RawJSON added in v0.145.0

func (value ParsedCommand) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ParsedCommand) UnmarshalJSON added in v0.145.0

func (value *ParsedCommand) UnmarshalJSON(data []byte) error

type ParsedCommandKind added in v0.145.0

type ParsedCommandKind string

ParsedCommandKind identifies a known ParsedCommand variant.

const (
	ParsedCommandKindListFiles ParsedCommandKind = "list_files"
	ParsedCommandKindRead      ParsedCommandKind = "read"
	ParsedCommandKindSearch    ParsedCommandKind = "search"
	ParsedCommandKindUnknown   ParsedCommandKind = "unknown"
)

type PatchChangeKind

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

PatchChangeKind preserves the complete JSON payload for a discriminated union.

func NewPatchChangeKind added in v0.145.0

func NewPatchChangeKind(value any) (PatchChangeKind, error)

NewPatchChangeKind validates the discriminator and wraps a JSON-marshalable PatchChangeKind value.

func (PatchChangeKind) IsKnown added in v0.145.0

func (value PatchChangeKind) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (PatchChangeKind) Kind added in v0.145.0

func (value PatchChangeKind) Kind() PatchChangeKindKind

Kind returns the payload discriminator, including unknown future values.

func (PatchChangeKind) MarshalJSON added in v0.145.0

func (value PatchChangeKind) MarshalJSON() ([]byte, error)

func (PatchChangeKind) RawJSON added in v0.145.0

func (value PatchChangeKind) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*PatchChangeKind) UnmarshalJSON added in v0.145.0

func (value *PatchChangeKind) UnmarshalJSON(data []byte) error

type PatchChangeKindKind added in v0.145.0

type PatchChangeKindKind string

PatchChangeKindKind identifies a known PatchChangeKind variant.

const (
	PatchChangeKindKindAdd    PatchChangeKindKind = "add"
	PatchChangeKindKindDelete PatchChangeKindKind = "delete"
	PatchChangeKindKindUpdate PatchChangeKindKind = "update"
)

type PermissionGrantScope

type PermissionGrantScope string
const PermissionGrantScopeSession PermissionGrantScope = "session"
const PermissionGrantScopeTurn PermissionGrantScope = "turn"

type PermissionProfileListParams

type PermissionProfileListParams struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor PermissionProfileListParamsCursor `json:"cursor,omitempty,omitzero"`

	// Optional working directory to resolve project config layers.
	Cwd PermissionProfileListParamsCwd `json:"cwd,omitempty,omitzero"`

	// Optional page size; defaults to the full result set.
	Limit PermissionProfileListParamsLimit `json:"limit,omitempty,omitzero"`
}

type PermissionProfileListParamsCursor added in v0.144.0

type PermissionProfileListParamsCursor *string

Opaque pagination cursor returned by a previous call.

type PermissionProfileListParamsCwd added in v0.144.0

type PermissionProfileListParamsCwd *string

Optional working directory to resolve project config layers.

type PermissionProfileListParamsLimit added in v0.144.0

type PermissionProfileListParamsLimit *int

Optional page size; defaults to the full result set.

type PermissionProfileSummary

type PermissionProfileSummary struct {
	// Whether the effective requirements allow selecting this profile.
	Allowed bool `json:"allowed"`

	// Optional user-facing description for display in clients.
	Description PermissionProfileSummaryDescription `json:"description,omitempty,omitzero"`

	// Available permission profile identifier.
	ID string `json:"id"`
}

type PermissionProfileSummaryDescription added in v0.144.0

type PermissionProfileSummaryDescription *string

Optional user-facing description for display in clients.

type PermissionsRequestApprovalParams

type PermissionsRequestApprovalParams struct {
	ThreadID string `json:"threadId"`
	TurnID   string `json:"turnId"`
	ItemID   string `json:"itemId"`

	Reason      *string     `json:"reason,omitempty"`
	Permissions interface{} `json:"permissions"`
}

PermissionsRequestApprovalParams is maintained manually because the raw schema uses nested unions that the generator does not currently emit.

type PermissionsRequestApprovalResponse

type PermissionsRequestApprovalResponse struct {
	Permissions interface{} `json:"permissions"`
	Scope       interface{} `json:"scope,omitempty"`
}

PermissionsRequestApprovalResponse is maintained manually because the raw schema uses nested unions that the generator does not currently emit.

type Personality

type Personality string
const PersonalityFriendly Personality = "friendly"
const PersonalityNone Personality = "none"
const PersonalityPragmatic Personality = "pragmatic"

type PlanDeltaNotification

type PlanDeltaNotification = SanitizedPlanDeltaNotificationJSON

type PlanType

type PlanType string
const PlanTypeBusiness PlanType = "business"
const PlanTypeEdu PlanType = "edu"
const PlanTypeEnterprise PlanType = "enterprise"
const PlanTypeEnterpriseCbpUsageBased PlanType = "enterprise_cbp_usage_based"
const PlanTypeFree PlanType = "free"
const PlanTypeGo PlanType = "go"
const PlanTypePlus PlanType = "plus"
const PlanTypePro PlanType = "pro"
const PlanTypeProlite PlanType = "prolite"
const PlanTypeSelfServeBusinessUsageBased PlanType = "self_serve_business_usage_based"
const PlanTypeTeam PlanType = "team"
const PlanTypeUnknown PlanType = "unknown"

type PluginAuthPolicy

type PluginAuthPolicy string
const PluginAuthPolicyONINSTALL PluginAuthPolicy = "ON_INSTALL"
const PluginAuthPolicyONUSE PluginAuthPolicy = "ON_USE"

type PluginInstallParams

type PluginInstallParams struct {
	// MarketplacePath corresponds to the JSON schema field "marketplacePath".
	MarketplacePath interface{} `json:"marketplacePath,omitempty,omitzero"`

	// PluginName corresponds to the JSON schema field "pluginName".
	PluginName string `json:"pluginName"`

	// RemoteMarketplaceName corresponds to the JSON schema field
	// "remoteMarketplaceName".
	RemoteMarketplaceName PluginInstallParamsRemoteMarketplaceName `json:"remoteMarketplaceName,omitempty,omitzero"`
}

type PluginInstallParamsRemoteMarketplaceName added in v0.144.0

type PluginInstallParamsRemoteMarketplaceName *string

type PluginInstallResponse

type PluginInstallResponse = SanitizedPluginInstallResponseJSON

type PluginInstalledParams

type PluginInstalledParams struct {
	// Optional working directories used to discover repo marketplaces.
	Cwds *PluginInstalledParamsCwds `json:"cwds,omitempty,omitzero"`

	// Additional uninstalled plugin names that should be returned when present
	// locally. This is used by mention surfaces that intentionally expose install
	// entrypoints.
	InstallSuggestionPluginNames *PluginInstalledParamsInstallSuggestionPluginNames `json:"installSuggestionPluginNames,omitempty,omitzero"`
}

type PluginInstalledParamsCwds added in v0.144.0

type PluginInstalledParamsCwds []AbsolutePathBuf

Optional working directories used to discover repo marketplaces.

type PluginInstalledParamsInstallSuggestionPluginNames added in v0.144.0

type PluginInstalledParamsInstallSuggestionPluginNames []string

Additional uninstalled plugin names that should be returned when present locally. This is used by mention surfaces that intentionally expose install entrypoints.

type PluginInstalledResponse

type PluginInstalledResponse interface{}

type PluginListMarketplaceKind

type PluginListMarketplaceKind string
const PluginListMarketplaceKindCreatedByMeRemote PluginListMarketplaceKind = "created-by-me-remote"
const PluginListMarketplaceKindLocal PluginListMarketplaceKind = "local"
const PluginListMarketplaceKindSharedWithMe PluginListMarketplaceKind = "shared-with-me"
const PluginListMarketplaceKindVertical PluginListMarketplaceKind = "vertical"
const PluginListMarketplaceKindWorkspaceDirectory PluginListMarketplaceKind = "workspace-directory"

type PluginListParams

type PluginListParams struct {
	// Optional working directories used to discover repo marketplaces. When omitted,
	// only home-scoped marketplaces and the official curated marketplace are
	// considered.
	Cwds *PluginListParamsCwds `json:"cwds,omitempty,omitzero"`

	// Optional marketplace kind filter. When omitted, only local marketplaces are
	// queried, plus the default remote catalog when enabled by feature flag.
	MarketplaceKinds *PluginListParamsMarketplaceKinds `json:"marketplaceKinds,omitempty,omitzero"`
}

type PluginListParamsCwds added in v0.144.0

type PluginListParamsCwds []AbsolutePathBuf

Optional working directories used to discover repo marketplaces. When omitted, only home-scoped marketplaces and the official curated marketplace are considered.

type PluginListParamsMarketplaceKinds added in v0.144.0

type PluginListParamsMarketplaceKinds []PluginListMarketplaceKind

Optional marketplace kind filter. When omitted, only local marketplaces are queried, plus the default remote catalog when enabled by feature flag.

type PluginListResponse

type PluginListResponse interface{}

type PluginReadParams

type PluginReadParams struct {
	// MarketplacePath corresponds to the JSON schema field "marketplacePath".
	MarketplacePath interface{} `json:"marketplacePath,omitempty,omitzero"`

	// PluginName corresponds to the JSON schema field "pluginName".
	PluginName string `json:"pluginName"`

	// RemoteMarketplaceName corresponds to the JSON schema field
	// "remoteMarketplaceName".
	RemoteMarketplaceName PluginReadParamsRemoteMarketplaceName `json:"remoteMarketplaceName,omitempty,omitzero"`
}

type PluginReadParamsRemoteMarketplaceName added in v0.144.0

type PluginReadParamsRemoteMarketplaceName *string

type PluginReadResponse

type PluginReadResponse interface{}

type PluginShareCheckoutParams

type PluginShareCheckoutParams struct {
	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`
}

type PluginShareCheckoutResponse

type PluginShareCheckoutResponse interface{}

type PluginShareDeleteParams

type PluginShareDeleteParams struct {
	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`
}

type PluginShareDiscoverability

type PluginShareDiscoverability string
const PluginShareDiscoverabilityLISTED PluginShareDiscoverability = "LISTED"
const PluginShareDiscoverabilityPRIVATE PluginShareDiscoverability = "PRIVATE"
const PluginShareDiscoverabilityUNLISTED PluginShareDiscoverability = "UNLISTED"

type PluginShareListParams

type PluginShareListParams map[string]interface{}

type PluginShareListResponse

type PluginShareListResponse interface{}

type PluginSharePrincipal

type PluginSharePrincipal struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// PrincipalID corresponds to the JSON schema field "principalId".
	PrincipalID string `json:"principalId"`

	// PrincipalType corresponds to the JSON schema field "principalType".
	PrincipalType PluginSharePrincipalType `json:"principalType"`

	// Role corresponds to the JSON schema field "role".
	Role PluginSharePrincipalRole `json:"role"`
}

type PluginSharePrincipalRole

type PluginSharePrincipalRole string
const PluginSharePrincipalRoleEditor PluginSharePrincipalRole = "editor"
const PluginSharePrincipalRoleOwner PluginSharePrincipalRole = "owner"
const PluginSharePrincipalRoleReader PluginSharePrincipalRole = "reader"

type PluginSharePrincipalType

type PluginSharePrincipalType string
const PluginSharePrincipalTypeGroup PluginSharePrincipalType = "group"
const PluginSharePrincipalTypeUser PluginSharePrincipalType = "user"
const PluginSharePrincipalTypeWorkspace PluginSharePrincipalType = "workspace"

type PluginShareSaveParams

type PluginShareSaveParams struct {
	// Discoverability corresponds to the JSON schema field "discoverability".
	Discoverability interface{} `json:"discoverability,omitempty,omitzero"`

	// PluginPath corresponds to the JSON schema field "pluginPath".
	PluginPath AbsolutePathBuf `json:"pluginPath"`

	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID PluginShareSaveParamsRemotePluginID `json:"remotePluginId,omitempty,omitzero"`

	// ShareTargets corresponds to the JSON schema field "shareTargets".
	ShareTargets *PluginShareSaveParamsShareTargets `json:"shareTargets,omitempty,omitzero"`
}

type PluginShareSaveParamsRemotePluginID added in v0.144.0

type PluginShareSaveParamsRemotePluginID *string

type PluginShareSaveParamsShareTargets added in v0.144.0

type PluginShareSaveParamsShareTargets []PluginShareTarget

type PluginShareTarget

type PluginShareTarget struct {
	// PrincipalID corresponds to the JSON schema field "principalId".
	PrincipalID string `json:"principalId"`

	// PrincipalType corresponds to the JSON schema field "principalType".
	PrincipalType PluginSharePrincipalType `json:"principalType"`

	// Role corresponds to the JSON schema field "role".
	Role PluginShareTargetRole `json:"role"`
}

type PluginShareTargetRole

type PluginShareTargetRole string
const PluginShareTargetRoleEditor PluginShareTargetRole = "editor"
const PluginShareTargetRoleReader PluginShareTargetRole = "reader"

type PluginShareUpdateDiscoverability

type PluginShareUpdateDiscoverability string
const PluginShareUpdateDiscoverabilityPRIVATE PluginShareUpdateDiscoverability = "PRIVATE"
const PluginShareUpdateDiscoverabilityUNLISTED PluginShareUpdateDiscoverability = "UNLISTED"

type PluginShareUpdateTargetsParams

type PluginShareUpdateTargetsParams struct {
	// Discoverability corresponds to the JSON schema field "discoverability".
	Discoverability PluginShareUpdateDiscoverability `json:"discoverability"`

	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`

	// ShareTargets corresponds to the JSON schema field "shareTargets".
	ShareTargets []PluginShareTarget `json:"shareTargets"`
}

type PluginSkillReadParams

type PluginSkillReadParams struct {
	// RemoteMarketplaceName corresponds to the JSON schema field
	// "remoteMarketplaceName".
	RemoteMarketplaceName string `json:"remoteMarketplaceName"`

	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`

	// SkillName corresponds to the JSON schema field "skillName".
	SkillName string `json:"skillName"`
}

type PluginSource added in v0.145.0

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

PluginSource preserves the complete JSON payload for a discriminated union.

func NewPluginSource added in v0.145.0

func NewPluginSource(value any) (PluginSource, error)

NewPluginSource validates the discriminator and wraps a JSON-marshalable PluginSource value.

func (PluginSource) IsKnown added in v0.145.0

func (value PluginSource) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (PluginSource) Kind added in v0.145.0

func (value PluginSource) Kind() PluginSourceKind

Kind returns the payload discriminator, including unknown future values.

func (PluginSource) MarshalJSON added in v0.145.0

func (value PluginSource) MarshalJSON() ([]byte, error)

func (PluginSource) RawJSON added in v0.145.0

func (value PluginSource) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*PluginSource) UnmarshalJSON added in v0.145.0

func (value *PluginSource) UnmarshalJSON(data []byte) error

type PluginSourceKind added in v0.145.0

type PluginSourceKind string

PluginSourceKind identifies a known PluginSource variant.

const (
	PluginSourceKindGit    PluginSourceKind = "git"
	PluginSourceKindLocal  PluginSourceKind = "local"
	PluginSourceKindNpm    PluginSourceKind = "npm"
	PluginSourceKindRemote PluginSourceKind = "remote"
)

type PluginUninstallParams

type PluginUninstallParams struct {
	// PluginID corresponds to the JSON schema field "pluginId".
	PluginID string `json:"pluginId"`
}

type PluginsMigration

type PluginsMigration struct {
	// MarketplaceName corresponds to the JSON schema field "marketplaceName".
	MarketplaceName string `json:"marketplaceName"`

	// PluginNames corresponds to the JSON schema field "pluginNames".
	PluginNames []string `json:"pluginNames"`
}

type ProcessOutputStream

type ProcessOutputStream interface{}

Stream label for `process/outputDelta` notifications.

type ProcessTerminalSize

type ProcessTerminalSize struct {
	// Terminal width in character cells.
	Cols int `json:"cols"`

	// Terminal height in character cells.
	Rows int `json:"rows"`
}

PTY size in character cells for `process/spawn` PTY sessions.

type RateLimitReachedType

type RateLimitReachedType string
const RateLimitReachedTypeRateLimitReached RateLimitReachedType = "rate_limit_reached"
const RateLimitReachedTypeWorkspaceMemberCreditsDepleted RateLimitReachedType = "workspace_member_credits_depleted"
const RateLimitReachedTypeWorkspaceMemberUsageLimitReached RateLimitReachedType = "workspace_member_usage_limit_reached"
const RateLimitReachedTypeWorkspaceOwnerCreditsDepleted RateLimitReachedType = "workspace_owner_credits_depleted"
const RateLimitReachedTypeWorkspaceOwnerUsageLimitReached RateLimitReachedType = "workspace_owner_usage_limit_reached"

type RateLimitResetCredit

type RateLimitResetCredit struct {
	// Backend-provided display description for this credit, or `null` when
	// unavailable.
	Description RateLimitResetCreditDescription `json:"description,omitempty,omitzero"`

	// Unix timestamp in seconds when the credit expires, or `null` if it does not
	// expire.
	ExpiresAt RateLimitResetCreditExpiresAt `json:"expiresAt,omitempty,omitzero"`

	// Unix timestamp in seconds when the credit was granted.
	GrantedAt int `json:"grantedAt"`

	// Opaque backend identifier for this reset credit.
	ID string `json:"id"`

	// ResetType corresponds to the JSON schema field "resetType".
	ResetType RateLimitResetType `json:"resetType"`

	// Status corresponds to the JSON schema field "status".
	Status RateLimitResetCreditStatus `json:"status"`

	// Backend-provided display title for this credit, or `null` when unavailable.
	Title RateLimitResetCreditTitle `json:"title,omitempty,omitzero"`
}

type RateLimitResetCreditDescription added in v0.144.0

type RateLimitResetCreditDescription *string

Backend-provided display description for this credit, or `null` when unavailable.

type RateLimitResetCreditExpiresAt added in v0.144.0

type RateLimitResetCreditExpiresAt *int

Unix timestamp in seconds when the credit expires, or `null` if it does not expire.

type RateLimitResetCreditStatus

type RateLimitResetCreditStatus string
const RateLimitResetCreditStatusAvailable RateLimitResetCreditStatus = "available"
const RateLimitResetCreditStatusRedeemed RateLimitResetCreditStatus = "redeemed"
const RateLimitResetCreditStatusRedeeming RateLimitResetCreditStatus = "redeeming"
const RateLimitResetCreditStatusUnknown RateLimitResetCreditStatus = "unknown"

type RateLimitResetCreditTitle added in v0.144.0

type RateLimitResetCreditTitle *string

Backend-provided display title for this credit, or `null` when unavailable.

type RateLimitResetCreditsSummary

type RateLimitResetCreditsSummary struct {
	// AvailableCount corresponds to the JSON schema field "availableCount".
	AvailableCount int `json:"availableCount"`

	// Detail rows for available reset credits, when the backend provides them.
	//
	// `null` means only `availableCount` is known, while an empty array means details
	// were fetched and no available credits were returned. The backend may cap this
	// list, so its length can be less than `availableCount`.
	Credits *RateLimitResetCreditsSummaryCredits `json:"credits,omitempty,omitzero"`
}

type RateLimitResetCreditsSummaryCredits added in v0.144.0

type RateLimitResetCreditsSummaryCredits []RateLimitResetCredit

Detail rows for available reset credits, when the backend provides them.

`null` means only `availableCount` is known, while an empty array means details were fetched and no available credits were returned. The backend may cap this list, so its length can be less than `availableCount`.

type RateLimitResetType

type RateLimitResetType string
const RateLimitResetTypeCodexRateLimits RateLimitResetType = "codexRateLimits"
const RateLimitResetTypeUnknown RateLimitResetType = "unknown"

type RateLimitSnapshot

type RateLimitSnapshot struct {
	// Credits corresponds to the JSON schema field "credits".
	Credits interface{} `json:"credits,omitempty,omitzero"`

	// IndividualLimit corresponds to the JSON schema field "individualLimit".
	IndividualLimit interface{} `json:"individualLimit,omitempty,omitzero"`

	// LimitID corresponds to the JSON schema field "limitId".
	LimitID RateLimitSnapshotLimitID `json:"limitId,omitempty,omitzero"`

	// LimitName corresponds to the JSON schema field "limitName".
	LimitName RateLimitSnapshotLimitName `json:"limitName,omitempty,omitzero"`

	// PlanType corresponds to the JSON schema field "planType".
	PlanType interface{} `json:"planType,omitempty,omitzero"`

	// Primary corresponds to the JSON schema field "primary".
	Primary interface{} `json:"primary,omitempty,omitzero"`

	// RateLimitReachedType corresponds to the JSON schema field
	// "rateLimitReachedType".
	RateLimitReachedType interface{} `json:"rateLimitReachedType,omitempty,omitzero"`

	// Secondary corresponds to the JSON schema field "secondary".
	Secondary interface{} `json:"secondary,omitempty,omitzero"`
}

type RateLimitSnapshotLimitID added in v0.144.0

type RateLimitSnapshotLimitID *string

type RateLimitSnapshotLimitName added in v0.144.0

type RateLimitSnapshotLimitName *string

type RateLimitWindow

type RateLimitWindow struct {
	// ResetsAt corresponds to the JSON schema field "resetsAt".
	ResetsAt RateLimitWindowResetsAt `json:"resetsAt,omitempty,omitzero"`

	// UsedPercent corresponds to the JSON schema field "usedPercent".
	UsedPercent int `json:"usedPercent"`

	// WindowDurationMins corresponds to the JSON schema field "windowDurationMins".
	WindowDurationMins RateLimitWindowWindowDurationMins `json:"windowDurationMins,omitempty,omitzero"`
}

type RateLimitWindowResetsAt added in v0.144.0

type RateLimitWindowResetsAt *int

type RateLimitWindowWindowDurationMins added in v0.144.0

type RateLimitWindowWindowDurationMins *int

type RealtimeConversationVersion

type RealtimeConversationVersion string
const RealtimeConversationVersionV1 RealtimeConversationVersion = "v1"
const RealtimeConversationVersionV2 RealtimeConversationVersion = "v2"

type RealtimeOutputModality

type RealtimeOutputModality string
const RealtimeOutputModalityAudio RealtimeOutputModality = "audio"
const RealtimeOutputModalityText RealtimeOutputModality = "text"

type RealtimeVoice

type RealtimeVoice string
const RealtimeVoiceAlloy RealtimeVoice = "alloy"
const RealtimeVoiceArbor RealtimeVoice = "arbor"
const RealtimeVoiceAsh RealtimeVoice = "ash"
const RealtimeVoiceBallad RealtimeVoice = "ballad"
const RealtimeVoiceBreeze RealtimeVoice = "breeze"
const RealtimeVoiceCedar RealtimeVoice = "cedar"
const RealtimeVoiceCoral RealtimeVoice = "coral"
const RealtimeVoiceCove RealtimeVoice = "cove"
const RealtimeVoiceEcho RealtimeVoice = "echo"
const RealtimeVoiceEmber RealtimeVoice = "ember"
const RealtimeVoiceJuniper RealtimeVoice = "juniper"
const RealtimeVoiceMaple RealtimeVoice = "maple"
const RealtimeVoiceMarin RealtimeVoice = "marin"
const RealtimeVoiceSage RealtimeVoice = "sage"
const RealtimeVoiceShimmer RealtimeVoice = "shimmer"
const RealtimeVoiceSol RealtimeVoice = "sol"
const RealtimeVoiceSpruce RealtimeVoice = "spruce"
const RealtimeVoiceVale RealtimeVoice = "vale"
const RealtimeVoiceVerse RealtimeVoice = "verse"

type ReasoningEffort

type ReasoningEffort string

A non-empty reasoning effort value advertised by the model.

type ReasoningEffortOption

type ReasoningEffortOption struct {
	// Description corresponds to the JSON schema field "description".
	Description string `json:"description"`

	// ReasoningEffort corresponds to the JSON schema field "reasoningEffort".
	ReasoningEffort ReasoningEffort `json:"reasoningEffort"`
}

type ReasoningItemContent

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

ReasoningItemContent preserves the complete JSON payload for a discriminated union.

func NewReasoningItemContent added in v0.145.0

func NewReasoningItemContent(value any) (ReasoningItemContent, error)

NewReasoningItemContent validates the discriminator and wraps a JSON-marshalable ReasoningItemContent value.

func (ReasoningItemContent) IsKnown added in v0.145.0

func (value ReasoningItemContent) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ReasoningItemContent) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (ReasoningItemContent) MarshalJSON added in v0.145.0

func (value ReasoningItemContent) MarshalJSON() ([]byte, error)

func (ReasoningItemContent) RawJSON added in v0.145.0

func (value ReasoningItemContent) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ReasoningItemContent) UnmarshalJSON added in v0.145.0

func (value *ReasoningItemContent) UnmarshalJSON(data []byte) error

type ReasoningItemContentKind added in v0.145.0

type ReasoningItemContentKind string

ReasoningItemContentKind identifies a known ReasoningItemContent variant.

const (
	ReasoningItemContentKindReasoningText ReasoningItemContentKind = "reasoning_text"
	ReasoningItemContentKindText          ReasoningItemContentKind = "text"
)

type ReasoningItemReasoningSummary

type ReasoningItemReasoningSummary interface{}

type ReasoningSummary

type ReasoningSummary interface{}

A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#reasoning-summaries

type RemoteControlConnectionStatus

type RemoteControlConnectionStatus string
const RemoteControlConnectionStatusConnected RemoteControlConnectionStatus = "connected"
const RemoteControlConnectionStatusConnecting RemoteControlConnectionStatus = "connecting"
const RemoteControlConnectionStatusDisabled RemoteControlConnectionStatus = "disabled"
const RemoteControlConnectionStatusErrored RemoteControlConnectionStatus = "errored"

type RemoteControlDisableParams

type RemoteControlDisableParams struct {
	// Ephemeral corresponds to the JSON schema field "ephemeral".
	Ephemeral *bool `json:"ephemeral,omitempty,omitzero"`
}

type RemoteControlEnableParams

type RemoteControlEnableParams struct {
	// Ephemeral corresponds to the JSON schema field "ephemeral".
	Ephemeral *bool `json:"ephemeral,omitempty,omitzero"`
}

type RequestID

type RequestID interface{}

type ResidencyRequirement

type ResidencyRequirement string
const ResidencyRequirementUs ResidencyRequirement = "us"

type Resource

type Resource struct {
	// Meta corresponds to the JSON schema field "_meta".
	Meta interface{} `json:"_meta,omitempty,omitzero"`

	// Annotations corresponds to the JSON schema field "annotations".
	Annotations interface{} `json:"annotations,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description ResourceDescription `json:"description,omitempty,omitzero"`

	// Icons corresponds to the JSON schema field "icons".
	Icons *ResourceIcons `json:"icons,omitempty,omitzero"`

	// MimeType corresponds to the JSON schema field "mimeType".
	MimeType ResourceMimeType `json:"mimeType,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Size corresponds to the JSON schema field "size".
	Size ResourceSize `json:"size,omitempty,omitzero"`

	// Title corresponds to the JSON schema field "title".
	Title ResourceTitle `json:"title,omitempty,omitzero"`

	// Uri corresponds to the JSON schema field "uri".
	Uri string `json:"uri"`
}

A known resource that the server is capable of reading.

type ResourceContent

type ResourceContent interface{}

Contents returned when reading a resource from an MCP server.

type ResourceDescription added in v0.144.0

type ResourceDescription *string

type ResourceIcons added in v0.144.0

type ResourceIcons []interface{}

type ResourceMimeType added in v0.144.0

type ResourceMimeType *string

type ResourceSize added in v0.144.0

type ResourceSize *int

type ResourceTemplate

type ResourceTemplate struct {
	// Annotations corresponds to the JSON schema field "annotations".
	Annotations interface{} `json:"annotations,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description ResourceTemplateDescription `json:"description,omitempty,omitzero"`

	// MimeType corresponds to the JSON schema field "mimeType".
	MimeType ResourceTemplateMimeType `json:"mimeType,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Title corresponds to the JSON schema field "title".
	Title ResourceTemplateTitle `json:"title,omitempty,omitzero"`

	// UriTemplate corresponds to the JSON schema field "uriTemplate".
	UriTemplate string `json:"uriTemplate"`
}

A template description for resources available on the server.

type ResourceTemplateDescription added in v0.144.0

type ResourceTemplateDescription *string

type ResourceTemplateMimeType added in v0.144.0

type ResourceTemplateMimeType *string

type ResourceTemplateTitle added in v0.144.0

type ResourceTemplateTitle *string

type ResourceTitle added in v0.144.0

type ResourceTitle *string

type ResponseItem

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

ResponseItem preserves the complete JSON payload for a discriminated union.

func NewResponseItem added in v0.145.0

func NewResponseItem(value any) (ResponseItem, error)

NewResponseItem validates the discriminator and wraps a JSON-marshalable ResponseItem value.

func (ResponseItem) IsKnown added in v0.145.0

func (value ResponseItem) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ResponseItem) Kind added in v0.145.0

func (value ResponseItem) Kind() ResponseItemKind

Kind returns the payload discriminator, including unknown future values.

func (ResponseItem) MarshalJSON added in v0.145.0

func (value ResponseItem) MarshalJSON() ([]byte, error)

func (ResponseItem) RawJSON added in v0.145.0

func (value ResponseItem) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ResponseItem) UnmarshalJSON added in v0.145.0

func (value *ResponseItem) UnmarshalJSON(data []byte) error

type ResponseItemKind added in v0.145.0

type ResponseItemKind string

ResponseItemKind identifies a known ResponseItem variant.

const (
	ResponseItemKindAgentMessage         ResponseItemKind = "agent_message"
	ResponseItemKindCompaction           ResponseItemKind = "compaction"
	ResponseItemKindCompactionTrigger    ResponseItemKind = "compaction_trigger"
	ResponseItemKindContextCompaction    ResponseItemKind = "context_compaction"
	ResponseItemKindCustomToolCall       ResponseItemKind = "custom_tool_call"
	ResponseItemKindCustomToolCallOutput ResponseItemKind = "custom_tool_call_output"
	ResponseItemKindFunctionCall         ResponseItemKind = "function_call"
	ResponseItemKindFunctionCallOutput   ResponseItemKind = "function_call_output"
	ResponseItemKindImageGenerationCall  ResponseItemKind = "image_generation_call"
	ResponseItemKindLocalShellCall       ResponseItemKind = "local_shell_call"
	ResponseItemKindMessage              ResponseItemKind = "message"
	ResponseItemKindOther                ResponseItemKind = "other"
	ResponseItemKindReasoning            ResponseItemKind = "reasoning"
	ResponseItemKindToolSearchCall       ResponseItemKind = "tool_search_call"
	ResponseItemKindToolSearchOutput     ResponseItemKind = "tool_search_output"
	ResponseItemKindWebSearchCall        ResponseItemKind = "web_search_call"
)

type ResponsesApiWebSearchAction

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

ResponsesApiWebSearchAction preserves the complete JSON payload for a discriminated union.

func NewResponsesApiWebSearchAction added in v0.145.0

func NewResponsesApiWebSearchAction(value any) (ResponsesApiWebSearchAction, error)

NewResponsesApiWebSearchAction validates the discriminator and wraps a JSON-marshalable ResponsesApiWebSearchAction value.

func (ResponsesApiWebSearchAction) IsKnown added in v0.145.0

func (value ResponsesApiWebSearchAction) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ResponsesApiWebSearchAction) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (ResponsesApiWebSearchAction) MarshalJSON added in v0.145.0

func (value ResponsesApiWebSearchAction) MarshalJSON() ([]byte, error)

func (ResponsesApiWebSearchAction) RawJSON added in v0.145.0

RawJSON returns a copy of the complete union payload.

func (*ResponsesApiWebSearchAction) UnmarshalJSON added in v0.145.0

func (value *ResponsesApiWebSearchAction) UnmarshalJSON(data []byte) error

type ResponsesApiWebSearchActionKind added in v0.145.0

type ResponsesApiWebSearchActionKind string

ResponsesApiWebSearchActionKind identifies a known ResponsesApiWebSearchAction variant.

const (
	ResponsesApiWebSearchActionKindFindInPage ResponsesApiWebSearchActionKind = "find_in_page"
	ResponsesApiWebSearchActionKindOpenPage   ResponsesApiWebSearchActionKind = "open_page"
	ResponsesApiWebSearchActionKindOther      ResponsesApiWebSearchActionKind = "other"
	ResponsesApiWebSearchActionKindSearch     ResponsesApiWebSearchActionKind = "search"
)

type ReviewDecision

type ReviewDecision interface{}

User's decision in response to an ExecApprovalRequest.

type ReviewDelivery

type ReviewDelivery string
const ReviewDeliveryDetached ReviewDelivery = "detached"
const ReviewDeliveryInline ReviewDelivery = "inline"

type ReviewStartParams

type ReviewStartParams struct {
	// Where to run the review: inline (default) on the current thread or detached on
	// a new thread (returned in `reviewThreadId`).
	Delivery interface{} `json:"delivery,omitempty,omitzero"`

	// Target corresponds to the JSON schema field "target".
	Target ReviewTarget `json:"target"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ReviewStartResponse

type ReviewStartResponse interface{}

type ReviewTarget

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

ReviewTarget preserves the complete JSON payload for a discriminated union.

func NewReviewTarget added in v0.145.0

func NewReviewTarget(value any) (ReviewTarget, error)

NewReviewTarget validates the discriminator and wraps a JSON-marshalable ReviewTarget value.

func (ReviewTarget) IsKnown added in v0.145.0

func (value ReviewTarget) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ReviewTarget) Kind added in v0.145.0

func (value ReviewTarget) Kind() ReviewTargetKind

Kind returns the payload discriminator, including unknown future values.

func (ReviewTarget) MarshalJSON added in v0.145.0

func (value ReviewTarget) MarshalJSON() ([]byte, error)

func (ReviewTarget) RawJSON added in v0.145.0

func (value ReviewTarget) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ReviewTarget) UnmarshalJSON added in v0.145.0

func (value *ReviewTarget) UnmarshalJSON(data []byte) error

type ReviewTargetKind added in v0.145.0

type ReviewTargetKind string

ReviewTargetKind identifies a known ReviewTarget variant.

const (
	ReviewTargetKindBaseBranch         ReviewTargetKind = "baseBranch"
	ReviewTargetKindCommit             ReviewTargetKind = "commit"
	ReviewTargetKindCustom             ReviewTargetKind = "custom"
	ReviewTargetKindUncommittedChanges ReviewTargetKind = "uncommittedChanges"
)

type SandboxMode

type SandboxMode string
const SandboxModeDangerFullAccess SandboxMode = "danger-full-access"
const SandboxModeReadOnly SandboxMode = "read-only"
const SandboxModeWorkspaceWrite SandboxMode = "workspace-write"

type SandboxPolicy

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

SandboxPolicy preserves the complete JSON payload for a discriminated union.

func NewSandboxPolicy added in v0.145.0

func NewSandboxPolicy(value any) (SandboxPolicy, error)

NewSandboxPolicy validates the discriminator and wraps a JSON-marshalable SandboxPolicy value.

func (SandboxPolicy) IsKnown added in v0.145.0

func (value SandboxPolicy) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (SandboxPolicy) Kind added in v0.145.0

func (value SandboxPolicy) Kind() SandboxPolicyKind

Kind returns the payload discriminator, including unknown future values.

func (SandboxPolicy) MarshalJSON added in v0.145.0

func (value SandboxPolicy) MarshalJSON() ([]byte, error)

func (SandboxPolicy) RawJSON added in v0.145.0

func (value SandboxPolicy) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*SandboxPolicy) UnmarshalJSON added in v0.145.0

func (value *SandboxPolicy) UnmarshalJSON(data []byte) error

type SandboxPolicyKind added in v0.145.0

type SandboxPolicyKind string

SandboxPolicyKind identifies a known SandboxPolicy variant.

const (
	SandboxPolicyKindDangerFullAccess SandboxPolicyKind = "dangerFullAccess"
	SandboxPolicyKindExternalSandbox  SandboxPolicyKind = "externalSandbox"
	SandboxPolicyKindReadOnly         SandboxPolicyKind = "readOnly"
	SandboxPolicyKindWorkspaceWrite   SandboxPolicyKind = "workspaceWrite"
)

type SanitizedAccountLoginCompletedNotification

type SanitizedAccountLoginCompletedNotification = SanitizedAccountLoginCompletedNotificationJSON

Aliases for JSON-suffixed schema types.

type SanitizedAccountLoginCompletedNotificationJSON

type SanitizedAccountLoginCompletedNotificationJSON struct {
	// Error corresponds to the JSON schema field "error".
	Error SanitizedAccountLoginCompletedNotificationJSONError `json:"error,omitempty,omitzero"`

	// LoginID corresponds to the JSON schema field "loginId".
	LoginID SanitizedAccountLoginCompletedNotificationJSONLoginID `json:"loginId,omitempty,omitzero"`

	// Success corresponds to the JSON schema field "success".
	Success bool `json:"success"`
}

type SanitizedAccountLoginCompletedNotificationJSONError added in v0.144.0

type SanitizedAccountLoginCompletedNotificationJSONError *string

type SanitizedAccountLoginCompletedNotificationJSONLoginID added in v0.144.0

type SanitizedAccountLoginCompletedNotificationJSONLoginID *string

type SanitizedAccountRateLimitsUpdatedNotificationJSON

type SanitizedAccountRateLimitsUpdatedNotificationJSON struct {
	// RateLimits corresponds to the JSON schema field "rateLimits".
	RateLimits RateLimitSnapshot `json:"rateLimits"`
}

Sparse rolling rate-limit update.

Clients should merge available values into the most recent `account/rateLimits/read` response or refetch that snapshot. Nullable account metadata may be unavailable in a rolling update and does not clear a previously observed value.

type SanitizedAccountUpdatedNotification

type SanitizedAccountUpdatedNotification = SanitizedAccountUpdatedNotificationJSON

type SanitizedAccountUpdatedNotificationJSON

type SanitizedAccountUpdatedNotificationJSON struct {
	// AuthMode corresponds to the JSON schema field "authMode".
	AuthMode interface{} `json:"authMode,omitempty,omitzero"`

	// PlanType corresponds to the JSON schema field "planType".
	PlanType interface{} `json:"planType,omitempty,omitzero"`
}

type SanitizedAgentMessageDeltaNotification

type SanitizedAgentMessageDeltaNotification = SanitizedAgentMessageDeltaNotificationJSON

type SanitizedAgentMessageDeltaNotificationJSON

type SanitizedAgentMessageDeltaNotificationJSON struct {
	// Delta corresponds to the JSON schema field "delta".
	Delta string `json:"delta"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedAppListUpdatedNotification

type SanitizedAppListUpdatedNotification = SanitizedAppListUpdatedNotificationJSON

type SanitizedAppListUpdatedNotificationJSON

type SanitizedAppListUpdatedNotificationJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []AppInfo `json:"data"`
}

EXPERIMENTAL - notification emitted when the app list changes.

type SanitizedApplyPatchApprovalParams

type SanitizedApplyPatchApprovalParams = SanitizedApplyPatchApprovalParamsJSON

type SanitizedApplyPatchApprovalParamsJSON

type SanitizedApplyPatchApprovalParamsJSON struct {
	// Use to correlate this with [codex_protocol::protocol::PatchApplyBeginEvent] and
	// [codex_protocol::protocol::PatchApplyEndEvent].
	CallID string `json:"callId"`

	// ConversationID corresponds to the JSON schema field "conversationId".
	ConversationID ThreadID `json:"conversationId"`

	// FileChanges corresponds to the JSON schema field "fileChanges".
	FileChanges SanitizedApplyPatchApprovalParamsJSONFileChanges `json:"fileChanges"`

	// When set, the agent is asking the user to allow writes under this root for the
	// remainder of the session (unclear if this is honored today).
	GrantRoot SanitizedApplyPatchApprovalParamsJSONGrantRoot `json:"grantRoot,omitempty,omitzero"`

	// Optional explanatory reason (e.g. request for extra write access).
	Reason SanitizedApplyPatchApprovalParamsJSONReason `json:"reason,omitempty,omitzero"`
}

type SanitizedApplyPatchApprovalParamsJSONFileChanges added in v0.144.0

type SanitizedApplyPatchApprovalParamsJSONFileChanges map[string]FileChange

type SanitizedApplyPatchApprovalParamsJSONGrantRoot added in v0.144.0

type SanitizedApplyPatchApprovalParamsJSONGrantRoot *string

When set, the agent is asking the user to allow writes under this root for the remainder of the session (unclear if this is honored today).

type SanitizedApplyPatchApprovalParamsJSONReason added in v0.144.0

type SanitizedApplyPatchApprovalParamsJSONReason *string

Optional explanatory reason (e.g. request for extra write access).

type SanitizedApplyPatchApprovalResponse

type SanitizedApplyPatchApprovalResponse = SanitizedApplyPatchApprovalResponseJSON

type SanitizedApplyPatchApprovalResponseJSON

type SanitizedApplyPatchApprovalResponseJSON struct {
	// Decision corresponds to the JSON schema field "decision".
	Decision ReviewDecision `json:"decision"`
}

type SanitizedAppsListParams

type SanitizedAppsListParams = SanitizedAppsListParamsJSON

type SanitizedAppsListParamsJSON

type SanitizedAppsListParamsJSON struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedAppsListParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// When true, bypass app caches and fetch the latest data from sources.
	ForceRefetch *bool `json:"forceRefetch,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit SanitizedAppsListParamsJSONLimit `json:"limit,omitempty,omitzero"`

	// Optional thread id used to evaluate app feature gating from that thread's
	// config.
	ThreadID SanitizedAppsListParamsJSONThreadID `json:"threadId,omitempty,omitzero"`
}

EXPERIMENTAL - list available apps/connectors.

type SanitizedAppsListParamsJSONCursor added in v0.144.0

type SanitizedAppsListParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedAppsListParamsJSONLimit added in v0.144.0

type SanitizedAppsListParamsJSONLimit *int

Optional page size; defaults to a reasonable server-side value.

type SanitizedAppsListParamsJSONThreadID added in v0.144.0

type SanitizedAppsListParamsJSONThreadID *string

Optional thread id used to evaluate app feature gating from that thread's config.

type SanitizedAppsListResponse

type SanitizedAppsListResponse = SanitizedAppsListResponseJSON

type SanitizedAppsListResponseJSON

type SanitizedAppsListResponseJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []AppInfo `json:"data"`

	// Opaque cursor to pass to the next call to continue after the last item. If
	// None, there are no more items to return.
	NextCursor SanitizedAppsListResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

EXPERIMENTAL - app list response.

type SanitizedAppsListResponseJSONNextCursor added in v0.144.0

type SanitizedAppsListResponseJSONNextCursor *string

Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedAttestationGenerateParams added in v0.144.0

type SanitizedAttestationGenerateParams = SanitizedAttestationGenerateParamsJSON

type SanitizedAttestationGenerateParamsJSON added in v0.144.0

type SanitizedAttestationGenerateParamsJSON map[string]interface{}

type SanitizedAttestationGenerateResponse

type SanitizedAttestationGenerateResponse = SanitizedAttestationGenerateResponseJSON

type SanitizedAttestationGenerateResponseJSON

type SanitizedAttestationGenerateResponseJSON struct {
	// Opaque client attestation token.
	Token string `json:"token"`
}

type SanitizedCancelLoginAccountParams

type SanitizedCancelLoginAccountParams = SanitizedCancelLoginAccountParamsJSON

type SanitizedCancelLoginAccountParamsJSON

type SanitizedCancelLoginAccountParamsJSON struct {
	// LoginID corresponds to the JSON schema field "loginId".
	LoginID string `json:"loginId"`
}

type SanitizedCancelLoginAccountResponse

type SanitizedCancelLoginAccountResponse = SanitizedCancelLoginAccountResponseJSON

type SanitizedCancelLoginAccountResponseJSON

type SanitizedCancelLoginAccountResponseJSON struct {
	// Status corresponds to the JSON schema field "status".
	Status CancelLoginAccountStatus `json:"status"`
}

type SanitizedChatgptAuthTokensRefreshParams

type SanitizedChatgptAuthTokensRefreshParams = SanitizedChatgptAuthTokensRefreshParamsJSON

type SanitizedChatgptAuthTokensRefreshParamsJSON

type SanitizedChatgptAuthTokensRefreshParamsJSON struct {
	// Workspace/account identifier that Codex was previously using.
	//
	// Clients that manage multiple accounts/workspaces can use this as a hint to
	// refresh the token for the correct workspace.
	//
	// This may be `null` when the prior auth state did not include a workspace
	// identifier (`chatgpt_account_id`).
	PreviousAccountID SanitizedChatgptAuthTokensRefreshParamsJSONPreviousAccountID `json:"previousAccountId,omitempty,omitzero"`

	// Reason corresponds to the JSON schema field "reason".
	Reason ChatgptAuthTokensRefreshReason `json:"reason"`
}

type SanitizedChatgptAuthTokensRefreshParamsJSONPreviousAccountID added in v0.144.0

type SanitizedChatgptAuthTokensRefreshParamsJSONPreviousAccountID *string

Workspace/account identifier that Codex was previously using.

Clients that manage multiple accounts/workspaces can use this as a hint to refresh the token for the correct workspace.

This may be `null` when the prior auth state did not include a workspace identifier (`chatgpt_account_id`).

type SanitizedChatgptAuthTokensRefreshResponseJSON

type SanitizedChatgptAuthTokensRefreshResponseJSON struct {
	// AccessToken corresponds to the JSON schema field "accessToken".
	AccessToken string `json:"accessToken"`

	// ChatgptAccountID corresponds to the JSON schema field "chatgptAccountId".
	ChatgptAccountID string `json:"chatgptAccountId"`

	// ChatgptPlanType corresponds to the JSON schema field "chatgptPlanType".
	ChatgptPlanType SanitizedChatgptAuthTokensRefreshResponseJSONChatgptPlanType `json:"chatgptPlanType,omitempty,omitzero"`
}

type SanitizedChatgptAuthTokensRefreshResponseJSONChatgptPlanType added in v0.144.0

type SanitizedChatgptAuthTokensRefreshResponseJSONChatgptPlanType *string

type SanitizedCommandExecOutputDeltaNotification added in v0.144.0

type SanitizedCommandExecOutputDeltaNotification = SanitizedCommandExecOutputDeltaNotificationJSON

type SanitizedCommandExecOutputDeltaNotificationJSON added in v0.144.0

type SanitizedCommandExecOutputDeltaNotificationJSON struct {
	// `true` on the final streamed chunk for a stream when `outputBytesCap` truncated
	// later output on that stream.
	CapReached bool `json:"capReached"`

	// Base64-encoded output bytes.
	DeltaBase64 string `json:"deltaBase64"`

	// Client-supplied, connection-scoped `processId` from the original `command/exec`
	// request.
	ProcessID string `json:"processId"`

	// Output stream for this chunk.
	Stream interface{} `json:"stream"`
}

Base64-encoded output chunk emitted for a streaming `command/exec` request.

These notifications are connection-scoped. If the originating connection closes, the server terminates the process.

type SanitizedCommandExecResizeResponse added in v0.144.0

type SanitizedCommandExecResizeResponse = SanitizedCommandExecResizeResponseJSON

type SanitizedCommandExecResizeResponseJSON added in v0.144.0

type SanitizedCommandExecResizeResponseJSON map[string]interface{}

Empty success response for `command/exec/resize`.

type SanitizedCommandExecResponse

type SanitizedCommandExecResponse = SanitizedCommandExecResponseJSON

type SanitizedCommandExecResponseJSON

type SanitizedCommandExecResponseJSON struct {
	// Process exit code.
	ExitCode int `json:"exitCode"`

	// Buffered stderr capture.
	//
	// Empty when stderr was streamed via `command/exec/outputDelta`.
	Stderr string `json:"stderr"`

	// Buffered stdout capture.
	//
	// Empty when stdout was streamed via `command/exec/outputDelta`.
	Stdout string `json:"stdout"`
}

Final buffered result for `command/exec`.

type SanitizedCommandExecTerminateParams

type SanitizedCommandExecTerminateParams = SanitizedCommandExecTerminateParamsJSON

type SanitizedCommandExecTerminateParamsJSON

type SanitizedCommandExecTerminateParamsJSON struct {
	// Client-supplied, connection-scoped `processId` from the original `command/exec`
	// request.
	ProcessID string `json:"processId"`
}

Terminate a running `command/exec` session.

type SanitizedCommandExecTerminateResponse added in v0.144.0

type SanitizedCommandExecTerminateResponse = SanitizedCommandExecTerminateResponseJSON

type SanitizedCommandExecTerminateResponseJSON added in v0.144.0

type SanitizedCommandExecTerminateResponseJSON map[string]interface{}

Empty success response for `command/exec/terminate`.

type SanitizedCommandExecWriteParams

type SanitizedCommandExecWriteParams = SanitizedCommandExecWriteParamsJSON

type SanitizedCommandExecWriteParamsJSON

type SanitizedCommandExecWriteParamsJSON struct {
	// Close stdin after writing `deltaBase64`, if present.
	CloseStdin *bool `json:"closeStdin,omitempty,omitzero"`

	// Optional base64-encoded stdin bytes to write.
	DeltaBase64 SanitizedCommandExecWriteParamsJSONDeltaBase64 `json:"deltaBase64,omitempty,omitzero"`

	// Client-supplied, connection-scoped `processId` from the original `command/exec`
	// request.
	ProcessID string `json:"processId"`
}

Write stdin bytes to a running `command/exec` session, close stdin, or both.

type SanitizedCommandExecWriteParamsJSONDeltaBase64 added in v0.144.0

type SanitizedCommandExecWriteParamsJSONDeltaBase64 *string

Optional base64-encoded stdin bytes to write.

type SanitizedCommandExecWriteResponse added in v0.144.0

type SanitizedCommandExecWriteResponse = SanitizedCommandExecWriteResponseJSON

type SanitizedCommandExecWriteResponseJSON added in v0.144.0

type SanitizedCommandExecWriteResponseJSON map[string]interface{}

Empty success response for `command/exec/write`.

type SanitizedCommandExecutionOutputDeltaNotificationJSON

type SanitizedCommandExecutionOutputDeltaNotificationJSON struct {
	// Delta corresponds to the JSON schema field "delta".
	Delta string `json:"delta"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedCommandExecutionRequestApprovalResponseJSON

type SanitizedCommandExecutionRequestApprovalResponseJSON struct {
	// Decision corresponds to the JSON schema field "decision".
	Decision CommandExecutionApprovalDecision `json:"decision"`
}

type SanitizedConfigBatchWriteParams

type SanitizedConfigBatchWriteParams = SanitizedConfigBatchWriteParamsJSON

type SanitizedConfigBatchWriteParamsJSON

type SanitizedConfigBatchWriteParamsJSON struct {
	// Edits corresponds to the JSON schema field "edits".
	Edits []ConfigEdit `json:"edits"`

	// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
	ExpectedVersion SanitizedConfigBatchWriteParamsJSONExpectedVersion `json:"expectedVersion,omitempty,omitzero"`

	// Path to the config file to write; defaults to the user's `config.toml` when
	// omitted.
	FilePath SanitizedConfigBatchWriteParamsJSONFilePath `json:"filePath,omitempty,omitzero"`

	// When true, hot-reload the updated user config into all loaded threads after
	// writing.
	ReloadUserConfig *bool `json:"reloadUserConfig,omitempty,omitzero"`
}

type SanitizedConfigBatchWriteParamsJSONExpectedVersion added in v0.144.0

type SanitizedConfigBatchWriteParamsJSONExpectedVersion *string

type SanitizedConfigBatchWriteParamsJSONFilePath added in v0.144.0

type SanitizedConfigBatchWriteParamsJSONFilePath *string

Path to the config file to write; defaults to the user's `config.toml` when omitted.

type SanitizedConfigReadParams

type SanitizedConfigReadParams = SanitizedConfigReadParamsJSON

type SanitizedConfigReadParamsJSON

type SanitizedConfigReadParamsJSON struct {
	// Optional working directory to resolve project config layers. If specified,
	// return the effective config as seen from that directory (i.e., including any
	// project layers between `cwd` and the project/repo root).
	Cwd SanitizedConfigReadParamsJSONCwd `json:"cwd,omitempty,omitzero"`

	// IncludeLayers corresponds to the JSON schema field "includeLayers".
	IncludeLayers *bool `json:"includeLayers,omitempty,omitzero"`
}

type SanitizedConfigReadParamsJSONCwd added in v0.144.0

type SanitizedConfigReadParamsJSONCwd *string

Optional working directory to resolve project config layers. If specified, return the effective config as seen from that directory (i.e., including any project layers between `cwd` and the project/repo root).

type SanitizedConfigRequirementsReadResponse

type SanitizedConfigRequirementsReadResponse = SanitizedConfigRequirementsReadResponseJSON

type SanitizedConfigRequirementsReadResponseJSON

type SanitizedConfigRequirementsReadResponseJSON struct {
	// Null if no requirements are configured (e.g. no requirements.toml/MDM entries).
	Requirements interface{} `json:"requirements,omitempty,omitzero"`
}

type SanitizedConfigValueWriteParams

type SanitizedConfigValueWriteParams = SanitizedConfigValueWriteParamsJSON

type SanitizedConfigValueWriteParamsJSON

type SanitizedConfigValueWriteParamsJSON struct {
	// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
	ExpectedVersion SanitizedConfigValueWriteParamsJSONExpectedVersion `json:"expectedVersion,omitempty,omitzero"`

	// Path to the config file to write; defaults to the user's `config.toml` when
	// omitted.
	FilePath SanitizedConfigValueWriteParamsJSONFilePath `json:"filePath,omitempty,omitzero"`

	// KeyPath corresponds to the JSON schema field "keyPath".
	KeyPath string `json:"keyPath"`

	// MergeStrategy corresponds to the JSON schema field "mergeStrategy".
	MergeStrategy MergeStrategy `json:"mergeStrategy"`

	// Value corresponds to the JSON schema field "value".
	Value interface{} `json:"value"`
}

type SanitizedConfigValueWriteParamsJSONExpectedVersion added in v0.144.0

type SanitizedConfigValueWriteParamsJSONExpectedVersion *string

type SanitizedConfigValueWriteParamsJSONFilePath added in v0.144.0

type SanitizedConfigValueWriteParamsJSONFilePath *string

Path to the config file to write; defaults to the user's `config.toml` when omitted.

type SanitizedConfigWarningNotification

type SanitizedConfigWarningNotification = SanitizedConfigWarningNotificationJSON

type SanitizedConfigWarningNotificationJSON

type SanitizedConfigWarningNotificationJSON struct {
	// Optional extra guidance or error details.
	Details SanitizedConfigWarningNotificationJSONDetails `json:"details,omitempty,omitzero"`

	// Optional path to the config file that triggered the warning.
	Path SanitizedConfigWarningNotificationJSONPath `json:"path,omitempty,omitzero"`

	// Optional range for the error location inside the config file.
	Range interface{} `json:"range,omitempty,omitzero"`

	// Concise summary of the warning.
	Summary string `json:"summary"`
}

type SanitizedConfigWarningNotificationJSONDetails added in v0.144.0

type SanitizedConfigWarningNotificationJSONDetails *string

Optional extra guidance or error details.

type SanitizedConfigWarningNotificationJSONPath added in v0.144.0

type SanitizedConfigWarningNotificationJSONPath *string

Optional path to the config file that triggered the warning.

type SanitizedConsumeAccountRateLimitResetCreditParamsJSON

type SanitizedConsumeAccountRateLimitResetCreditParamsJSON struct {
	// Opaque reset-credit identifier to redeem. When omitted, the backend selects the
	// next available credit.
	CreditID SanitizedConsumeAccountRateLimitResetCreditParamsJSONCreditID `json:"creditId,omitempty,omitzero"`

	// Identifies one logical reset attempt. A UUID is recommended; reuse the same
	// value when retrying that attempt.
	IdempotencyKey string `json:"idempotencyKey"`
}

type SanitizedConsumeAccountRateLimitResetCreditParamsJSONCreditID added in v0.144.0

type SanitizedConsumeAccountRateLimitResetCreditParamsJSONCreditID *string

Opaque reset-credit identifier to redeem. When omitted, the backend selects the next available credit.

type SanitizedConsumeAccountRateLimitResetCreditResponseJSON

type SanitizedConsumeAccountRateLimitResetCreditResponseJSON struct {
	// Outcome corresponds to the JSON schema field "outcome".
	Outcome ConsumeAccountRateLimitResetCreditOutcome `json:"outcome"`
}

type SanitizedContextCompactedNotification

type SanitizedContextCompactedNotification = SanitizedContextCompactedNotificationJSON

type SanitizedContextCompactedNotificationJSON deprecated

type SanitizedContextCompactedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

Deprecated: Use `ContextCompaction` item type instead.

type SanitizedDeprecationNoticeNotification

type SanitizedDeprecationNoticeNotification = SanitizedDeprecationNoticeNotificationJSON

type SanitizedDeprecationNoticeNotificationJSON

type SanitizedDeprecationNoticeNotificationJSON struct {
	// Optional extra guidance, such as migration steps or rationale.
	Details SanitizedDeprecationNoticeNotificationJSONDetails `json:"details,omitempty,omitzero"`

	// Concise summary of what is deprecated.
	Summary string `json:"summary"`
}

type SanitizedDeprecationNoticeNotificationJSONDetails added in v0.144.0

type SanitizedDeprecationNoticeNotificationJSONDetails *string

Optional extra guidance, such as migration steps or rationale.

type SanitizedDynamicToolCallParams

type SanitizedDynamicToolCallParams = SanitizedDynamicToolCallParamsJSON

type SanitizedDynamicToolCallParamsJSON

type SanitizedDynamicToolCallParamsJSON struct {
	// Arguments corresponds to the JSON schema field "arguments".
	Arguments interface{} `json:"arguments"`

	// CallID corresponds to the JSON schema field "callId".
	CallID string `json:"callId"`

	// Namespace corresponds to the JSON schema field "namespace".
	Namespace SanitizedDynamicToolCallParamsJSONNamespace `json:"namespace,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// Tool corresponds to the JSON schema field "tool".
	Tool string `json:"tool"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedDynamicToolCallParamsJSONNamespace added in v0.144.0

type SanitizedDynamicToolCallParamsJSONNamespace *string

type SanitizedDynamicToolCallResponse

type SanitizedDynamicToolCallResponse = SanitizedDynamicToolCallResponseJSON

type SanitizedDynamicToolCallResponseJSON

type SanitizedDynamicToolCallResponseJSON struct {
	// ContentItems corresponds to the JSON schema field "contentItems".
	ContentItems []DynamicToolCallOutputContentItem `json:"contentItems"`

	// Success corresponds to the JSON schema field "success".
	Success bool `json:"success"`
}

type SanitizedErrorNotification

type SanitizedErrorNotification = SanitizedErrorNotificationJSON

type SanitizedErrorNotificationJSON

type SanitizedErrorNotificationJSON struct {
	// Error corresponds to the JSON schema field "error".
	Error TurnError `json:"error"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`

	// WillRetry corresponds to the JSON schema field "willRetry".
	WillRetry bool `json:"willRetry"`
}

type SanitizedExecCommandApprovalParams

type SanitizedExecCommandApprovalParams = SanitizedExecCommandApprovalParamsJSON

type SanitizedExecCommandApprovalParamsJSON

type SanitizedExecCommandApprovalParamsJSON struct {
	// Identifier for this specific approval callback.
	ApprovalID SanitizedExecCommandApprovalParamsJSONApprovalID `json:"approvalId,omitempty,omitzero"`

	// Use to correlate this with [codex_protocol::protocol::ExecCommandBeginEvent]
	// and [codex_protocol::protocol::ExecCommandEndEvent].
	CallID string `json:"callId"`

	// Command corresponds to the JSON schema field "command".
	Command []string `json:"command"`

	// ConversationID corresponds to the JSON schema field "conversationId".
	ConversationID ThreadID `json:"conversationId"`

	// Cwd corresponds to the JSON schema field "cwd".
	Cwd string `json:"cwd"`

	// ParsedCmd corresponds to the JSON schema field "parsedCmd".
	ParsedCmd []ParsedCommand `json:"parsedCmd"`

	// Reason corresponds to the JSON schema field "reason".
	Reason SanitizedExecCommandApprovalParamsJSONReason `json:"reason,omitempty,omitzero"`
}

type SanitizedExecCommandApprovalParamsJSONApprovalID added in v0.144.0

type SanitizedExecCommandApprovalParamsJSONApprovalID *string

Identifier for this specific approval callback.

type SanitizedExecCommandApprovalParamsJSONReason added in v0.144.0

type SanitizedExecCommandApprovalParamsJSONReason *string

type SanitizedExecCommandApprovalResponse

type SanitizedExecCommandApprovalResponse = SanitizedExecCommandApprovalResponseJSON

type SanitizedExecCommandApprovalResponseJSON

type SanitizedExecCommandApprovalResponseJSON struct {
	// Decision corresponds to the JSON schema field "decision".
	Decision ReviewDecision `json:"decision"`
}

type SanitizedExperimentalFeatureEnablementSetParamsJSON

type SanitizedExperimentalFeatureEnablementSetParamsJSON struct {
	// Process-wide runtime feature enablement keyed by canonical feature name.
	//
	// Only named features are updated. Omitted features are left unchanged. Send an
	// empty map for a no-op.
	Enablement SanitizedExperimentalFeatureEnablementSetParamsJSONEnablement `json:"enablement"`
}

type SanitizedExperimentalFeatureEnablementSetParamsJSONEnablement added in v0.144.0

type SanitizedExperimentalFeatureEnablementSetParamsJSONEnablement map[string]bool

Process-wide runtime feature enablement keyed by canonical feature name.

Only named features are updated. Omitted features are left unchanged. Send an empty map for a no-op.

type SanitizedExperimentalFeatureEnablementSetResponseJSON

type SanitizedExperimentalFeatureEnablementSetResponseJSON struct {
	// Feature enablement entries updated by this request.
	Enablement SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement `json:"enablement"`
}

type SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement added in v0.144.0

type SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement map[string]bool

Feature enablement entries updated by this request.

type SanitizedExperimentalFeatureListParams

type SanitizedExperimentalFeatureListParams = SanitizedExperimentalFeatureListParamsJSON

type SanitizedExperimentalFeatureListParamsJSON

type SanitizedExperimentalFeatureListParamsJSON struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedExperimentalFeatureListParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit SanitizedExperimentalFeatureListParamsJSONLimit `json:"limit,omitempty,omitzero"`

	// Optional loaded thread id. Pass this when showing feature state for an existing
	// thread so enablement is computed from that thread's refreshed config, including
	// project-local config for the thread's cwd.
	ThreadID SanitizedExperimentalFeatureListParamsJSONThreadID `json:"threadId,omitempty,omitzero"`
}

type SanitizedExperimentalFeatureListParamsJSONCursor added in v0.144.0

type SanitizedExperimentalFeatureListParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedExperimentalFeatureListParamsJSONLimit added in v0.144.0

type SanitizedExperimentalFeatureListParamsJSONLimit *int

Optional page size; defaults to a reasonable server-side value.

type SanitizedExperimentalFeatureListParamsJSONThreadID added in v0.144.0

type SanitizedExperimentalFeatureListParamsJSONThreadID *string

Optional loaded thread id. Pass this when showing feature state for an existing thread so enablement is computed from that thread's refreshed config, including project-local config for the thread's cwd.

type SanitizedExperimentalFeatureListResponse added in v0.144.0

type SanitizedExperimentalFeatureListResponse = SanitizedExperimentalFeatureListResponseJSON

type SanitizedExperimentalFeatureListResponseJSON added in v0.144.0

type SanitizedExperimentalFeatureListResponseJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []ExperimentalFeature `json:"data"`

	// Opaque cursor to pass to the next call to continue after the last item. If
	// None, there are no more items to return.
	NextCursor SanitizedExperimentalFeatureListResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

type SanitizedExperimentalFeatureListResponseJSONNextCursor added in v0.144.0

type SanitizedExperimentalFeatureListResponseJSONNextCursor *string

Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedExternalAgentConfigDetectParamsJSON

type SanitizedExternalAgentConfigDetectParamsJSON struct {
	// Zero or more working directories to include for repo-scoped detection.
	Cwds *SanitizedExternalAgentConfigDetectParamsJSONCwds `json:"cwds,omitempty,omitzero"`

	// If true, include detection under the user's home directory.
	IncludeHome *bool `json:"includeHome,omitempty,omitzero"`
}

type SanitizedExternalAgentConfigDetectParamsJSONCwds added in v0.144.0

type SanitizedExternalAgentConfigDetectParamsJSONCwds []string

Zero or more working directories to include for repo-scoped detection.

type SanitizedExternalAgentConfigDetectResponseJSON

type SanitizedExternalAgentConfigDetectResponseJSON struct {
	// Items corresponds to the JSON schema field "items".
	Items []ExternalAgentConfigMigrationItem `json:"items"`
}

type SanitizedExternalAgentConfigImportCompletedNotificationJSON

type SanitizedExternalAgentConfigImportCompletedNotificationJSON struct {
	// ImportID corresponds to the JSON schema field "importId".
	ImportID string `json:"importId"`

	// ItemTypeResults corresponds to the JSON schema field "itemTypeResults".
	ItemTypeResults []ExternalAgentConfigImportTypeResult `json:"itemTypeResults"`
}

type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON

type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []ExternalAgentConfigImportHistory `json:"data"`
}

type SanitizedExternalAgentConfigImportParamsJSON

type SanitizedExternalAgentConfigImportParamsJSON struct {
	// MigrationItems corresponds to the JSON schema field "migrationItems".
	MigrationItems []ExternalAgentConfigMigrationItem `json:"migrationItems"`

	// Source product that produced the migration items. Missing means unspecified.
	Source SanitizedExternalAgentConfigImportParamsJSONSource `json:"source,omitempty,omitzero"`
}

type SanitizedExternalAgentConfigImportParamsJSONSource added in v0.144.0

type SanitizedExternalAgentConfigImportParamsJSONSource *string

Source product that produced the migration items. Missing means unspecified.

type SanitizedExternalAgentConfigImportProgressNotificationJSON

type SanitizedExternalAgentConfigImportProgressNotificationJSON struct {
	// ImportID corresponds to the JSON schema field "importId".
	ImportID string `json:"importId"`

	// ItemTypeResults corresponds to the JSON schema field "itemTypeResults".
	ItemTypeResults []ExternalAgentConfigImportTypeResult `json:"itemTypeResults"`
}

type SanitizedExternalAgentConfigImportResponseJSON

type SanitizedExternalAgentConfigImportResponseJSON struct {
	// ImportID corresponds to the JSON schema field "importId".
	ImportID string `json:"importId"`
}

type SanitizedFeedbackUploadParams

type SanitizedFeedbackUploadParams = SanitizedFeedbackUploadParamsJSON

type SanitizedFeedbackUploadParamsJSON

type SanitizedFeedbackUploadParamsJSON struct {
	// Classification corresponds to the JSON schema field "classification".
	Classification string `json:"classification"`

	// ExtraLogFiles corresponds to the JSON schema field "extraLogFiles".
	ExtraLogFiles *SanitizedFeedbackUploadParamsJSONExtraLogFiles `json:"extraLogFiles,omitempty,omitzero"`

	// IncludeLogs corresponds to the JSON schema field "includeLogs".
	IncludeLogs *bool `json:"includeLogs,omitempty,omitzero"`

	// Reason corresponds to the JSON schema field "reason".
	Reason SanitizedFeedbackUploadParamsJSONReason `json:"reason,omitempty,omitzero"`

	// Tags corresponds to the JSON schema field "tags".
	Tags *SanitizedFeedbackUploadParamsJSONTags `json:"tags,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID SanitizedFeedbackUploadParamsJSONThreadID `json:"threadId,omitempty,omitzero"`
}

type SanitizedFeedbackUploadParamsJSONExtraLogFiles added in v0.144.0

type SanitizedFeedbackUploadParamsJSONExtraLogFiles []string

type SanitizedFeedbackUploadParamsJSONReason added in v0.144.0

type SanitizedFeedbackUploadParamsJSONReason *string

type SanitizedFeedbackUploadParamsJSONTags added in v0.144.0

type SanitizedFeedbackUploadParamsJSONTags map[string]string

type SanitizedFeedbackUploadParamsJSONThreadID added in v0.144.0

type SanitizedFeedbackUploadParamsJSONThreadID *string

type SanitizedFeedbackUploadResponse

type SanitizedFeedbackUploadResponse = SanitizedFeedbackUploadResponseJSON

type SanitizedFeedbackUploadResponseJSON

type SanitizedFeedbackUploadResponseJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedFileChangeOutputDeltaNotificationJSON

type SanitizedFileChangeOutputDeltaNotificationJSON struct {
	// Delta corresponds to the JSON schema field "delta".
	Delta string `json:"delta"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

Deprecated legacy notification for `apply_patch` textual output.

The server no longer emits this notification.

type SanitizedFileChangePatchUpdatedNotificationJSON

type SanitizedFileChangePatchUpdatedNotificationJSON struct {
	// Changes corresponds to the JSON schema field "changes".
	Changes []FileUpdateChange `json:"changes"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedFileChangeRequestApprovalParamsJSON

type SanitizedFileChangeRequestApprovalParamsJSON struct {
	// [UNSTABLE] When set, the agent is asking the user to allow writes under this
	// root for the remainder of the session (unclear if this is honored today).
	GrantRoot SanitizedFileChangeRequestApprovalParamsJSONGrantRoot `json:"grantRoot,omitempty,omitzero"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// Optional explanatory reason (e.g. request for extra write access).
	Reason SanitizedFileChangeRequestApprovalParamsJSONReason `json:"reason,omitempty,omitzero"`

	// Unix timestamp (in milliseconds) when this approval request started.
	StartedAtMs int `json:"startedAtMs"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedFileChangeRequestApprovalParamsJSONGrantRoot added in v0.144.0

type SanitizedFileChangeRequestApprovalParamsJSONGrantRoot *string

[UNSTABLE] When set, the agent is asking the user to allow writes under this root for the remainder of the session (unclear if this is honored today).

type SanitizedFileChangeRequestApprovalParamsJSONReason added in v0.144.0

type SanitizedFileChangeRequestApprovalParamsJSONReason *string

Optional explanatory reason (e.g. request for extra write access).

type SanitizedFileChangeRequestApprovalResponseJSON

type SanitizedFileChangeRequestApprovalResponseJSON struct {
	// Decision corresponds to the JSON schema field "decision".
	Decision FileChangeApprovalDecision `json:"decision"`
}

type SanitizedFsCopyResponse added in v0.144.0

type SanitizedFsCopyResponse = SanitizedFsCopyResponseJSON

type SanitizedFsCopyResponseJSON added in v0.144.0

type SanitizedFsCopyResponseJSON map[string]interface{}

Successful response for `fs/copy`.

type SanitizedFsCreateDirectoryResponse added in v0.144.0

type SanitizedFsCreateDirectoryResponse = SanitizedFsCreateDirectoryResponseJSON

type SanitizedFsCreateDirectoryResponseJSON added in v0.144.0

type SanitizedFsCreateDirectoryResponseJSON map[string]interface{}

Successful response for `fs/createDirectory`.

type SanitizedFsGetMetadataResponse

type SanitizedFsGetMetadataResponse = SanitizedFsGetMetadataResponseJSON

type SanitizedFsGetMetadataResponseJSON

type SanitizedFsGetMetadataResponseJSON struct {
	// File creation time in Unix milliseconds when available, otherwise `0`.
	CreatedAtMs int `json:"createdAtMs"`

	// Whether the path resolves to a directory.
	IsDirectory bool `json:"isDirectory"`

	// Whether the path resolves to a regular file.
	IsFile bool `json:"isFile"`

	// Whether the path itself is a symbolic link.
	IsSymlink bool `json:"isSymlink"`

	// File modification time in Unix milliseconds when available, otherwise `0`.
	ModifiedAtMs int `json:"modifiedAtMs"`
}

Metadata returned by `fs/getMetadata`.

type SanitizedFsReadDirectoryResponse

type SanitizedFsReadDirectoryResponse = SanitizedFsReadDirectoryResponseJSON

type SanitizedFsReadDirectoryResponseJSON

type SanitizedFsReadDirectoryResponseJSON struct {
	// Direct child entries in the requested directory.
	Entries []FsReadDirectoryEntry `json:"entries"`
}

Directory entries returned by `fs/readDirectory`.

type SanitizedFsReadFileResponse

type SanitizedFsReadFileResponse = SanitizedFsReadFileResponseJSON

type SanitizedFsReadFileResponseJSON

type SanitizedFsReadFileResponseJSON struct {
	// File contents encoded as base64.
	DataBase64 string `json:"dataBase64"`
}

Base64-encoded file contents returned by `fs/readFile`.

type SanitizedFsRemoveResponse added in v0.144.0

type SanitizedFsRemoveResponse = SanitizedFsRemoveResponseJSON

type SanitizedFsRemoveResponseJSON added in v0.144.0

type SanitizedFsRemoveResponseJSON map[string]interface{}

Successful response for `fs/remove`.

type SanitizedFsUnwatchParams

type SanitizedFsUnwatchParams = SanitizedFsUnwatchParamsJSON

type SanitizedFsUnwatchParamsJSON

type SanitizedFsUnwatchParamsJSON struct {
	// Watch identifier previously provided to `fs/watch`.
	WatchID string `json:"watchId"`
}

Stop filesystem watch notifications for a prior `fs/watch`.

type SanitizedFsUnwatchResponse added in v0.144.0

type SanitizedFsUnwatchResponse = SanitizedFsUnwatchResponseJSON

type SanitizedFsUnwatchResponseJSON added in v0.144.0

type SanitizedFsUnwatchResponseJSON map[string]interface{}

Successful response for `fs/unwatch`.

type SanitizedFsWriteFileResponse added in v0.144.0

type SanitizedFsWriteFileResponse = SanitizedFsWriteFileResponseJSON

type SanitizedFsWriteFileResponseJSON added in v0.144.0

type SanitizedFsWriteFileResponseJSON map[string]interface{}

Successful response for `fs/writeFile`.

type SanitizedFuzzyFileSearchParams

type SanitizedFuzzyFileSearchParams = SanitizedFuzzyFileSearchParamsJSON

type SanitizedFuzzyFileSearchParamsJSON

type SanitizedFuzzyFileSearchParamsJSON struct {
	// CancellationToken corresponds to the JSON schema field "cancellationToken".
	CancellationToken SanitizedFuzzyFileSearchParamsJSONCancellationToken `json:"cancellationToken,omitempty,omitzero"`

	// Query corresponds to the JSON schema field "query".
	Query string `json:"query"`

	// Roots corresponds to the JSON schema field "roots".
	Roots []string `json:"roots"`
}

type SanitizedFuzzyFileSearchParamsJSONCancellationToken added in v0.144.0

type SanitizedFuzzyFileSearchParamsJSONCancellationToken *string

type SanitizedFuzzyFileSearchResponse

type SanitizedFuzzyFileSearchResponse = SanitizedFuzzyFileSearchResponseJSON

type SanitizedFuzzyFileSearchResponseJSON

type SanitizedFuzzyFileSearchResponseJSON struct {
	// Files corresponds to the JSON schema field "files".
	Files []FuzzyFileSearchResult `json:"files"`
}

type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON

type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON struct {
	// SessionID corresponds to the JSON schema field "sessionId".
	SessionID string `json:"sessionId"`
}

type SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON

type SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON struct {
	// Files corresponds to the JSON schema field "files".
	Files []FuzzyFileSearchResult `json:"files"`

	// Query corresponds to the JSON schema field "query".
	Query string `json:"query"`

	// SessionID corresponds to the JSON schema field "sessionId".
	SessionID string `json:"sessionId"`
}

type SanitizedGetAccountParams

type SanitizedGetAccountParams = SanitizedGetAccountParamsJSON

type SanitizedGetAccountParamsJSON

type SanitizedGetAccountParamsJSON struct {
	// When `true`, requests a proactive token refresh before returning.
	//
	// In managed auth mode this triggers the normal refresh-token flow. In external
	// auth mode this flag is ignored. Clients should refresh tokens themselves and
	// call `account/login/start` with `chatgptAuthTokens`.
	RefreshToken *bool `json:"refreshToken,omitempty,omitzero"`
}

type SanitizedGetAccountRateLimitsResponse added in v0.144.0

type SanitizedGetAccountRateLimitsResponse = SanitizedGetAccountRateLimitsResponseJSON

type SanitizedGetAccountRateLimitsResponseJSON added in v0.144.0

type SanitizedGetAccountRateLimitsResponseJSON struct {
	// RateLimitResetCredits corresponds to the JSON schema field
	// "rateLimitResetCredits".
	RateLimitResetCredits interface{} `json:"rateLimitResetCredits,omitempty,omitzero"`

	// Backward-compatible single-bucket view; mirrors the historical payload.
	RateLimits SanitizedGetAccountRateLimitsResponseJSONRateLimits `json:"rateLimits"`

	// Multi-bucket view keyed by metered `limit_id` (for example, `codex`).
	RateLimitsByLimitID *SanitizedGetAccountRateLimitsResponseJSONRateLimitsByLimitID `json:"rateLimitsByLimitId,omitempty,omitzero"`
}

type SanitizedGetAccountRateLimitsResponseJSONRateLimits

type SanitizedGetAccountRateLimitsResponseJSONRateLimits struct {
	// Credits corresponds to the JSON schema field "credits".
	Credits interface{} `json:"credits,omitempty,omitzero"`

	// IndividualLimit corresponds to the JSON schema field "individualLimit".
	IndividualLimit interface{} `json:"individualLimit,omitempty,omitzero"`

	// LimitID corresponds to the JSON schema field "limitId".
	LimitID RateLimitSnapshotLimitID `json:"limitId,omitempty,omitzero"`

	// LimitName corresponds to the JSON schema field "limitName".
	LimitName RateLimitSnapshotLimitName `json:"limitName,omitempty,omitzero"`

	// PlanType corresponds to the JSON schema field "planType".
	PlanType interface{} `json:"planType,omitempty,omitzero"`

	// Primary corresponds to the JSON schema field "primary".
	Primary interface{} `json:"primary,omitempty,omitzero"`

	// RateLimitReachedType corresponds to the JSON schema field
	// "rateLimitReachedType".
	RateLimitReachedType interface{} `json:"rateLimitReachedType,omitempty,omitzero"`

	// Secondary corresponds to the JSON schema field "secondary".
	Secondary interface{} `json:"secondary,omitempty,omitzero"`
}

Backward-compatible single-bucket view; mirrors the historical payload.

type SanitizedGetAccountRateLimitsResponseJSONRateLimitsByLimitID added in v0.144.0

type SanitizedGetAccountRateLimitsResponseJSONRateLimitsByLimitID map[string]RateLimitSnapshot

Multi-bucket view keyed by metered `limit_id` (for example, `codex`).

type SanitizedGetAccountResponse

type SanitizedGetAccountResponse = SanitizedGetAccountResponseJSON

type SanitizedGetAccountResponseJSON

type SanitizedGetAccountResponseJSON struct {
	// Account corresponds to the JSON schema field "account".
	Account interface{} `json:"account,omitempty,omitzero"`

	// RequiresOpenaiAuth corresponds to the JSON schema field "requiresOpenaiAuth".
	RequiresOpenaiAuth bool `json:"requiresOpenaiAuth"`
}

type SanitizedGetAccountTokenUsageResponse

type SanitizedGetAccountTokenUsageResponse = SanitizedGetAccountTokenUsageResponseJSON

type SanitizedGetAccountTokenUsageResponseJSON

type SanitizedGetAccountTokenUsageResponseJSON struct {
	// DailyUsageBuckets corresponds to the JSON schema field "dailyUsageBuckets".
	DailyUsageBuckets *SanitizedGetAccountTokenUsageResponseJSONDailyUsageBuckets `json:"dailyUsageBuckets,omitempty,omitzero"`

	// Summary corresponds to the JSON schema field "summary".
	Summary AccountTokenUsageSummary `json:"summary"`
}

type SanitizedGetAccountTokenUsageResponseJSONDailyUsageBuckets added in v0.144.0

type SanitizedGetAccountTokenUsageResponseJSONDailyUsageBuckets []AccountTokenUsageDailyBucket

type SanitizedGetWorkspaceMessagesResponse

type SanitizedGetWorkspaceMessagesResponse = SanitizedGetWorkspaceMessagesResponseJSON

type SanitizedGetWorkspaceMessagesResponseJSON

type SanitizedGetWorkspaceMessagesResponseJSON struct {
	// Whether the workspace-message backend route is available for this client.
	FeatureEnabled bool `json:"featureEnabled"`

	// Active workspace messages returned by the backend.
	Messages []WorkspaceMessage `json:"messages"`
}

type SanitizedGuardianWarningNotification

type SanitizedGuardianWarningNotification = SanitizedGuardianWarningNotificationJSON

type SanitizedGuardianWarningNotificationJSON

type SanitizedGuardianWarningNotificationJSON struct {
	// Concise guardian warning message for the user.
	Message string `json:"message"`

	// Thread target for the guardian warning.
	ThreadID string `json:"threadId"`
}

type SanitizedHooksListParams

type SanitizedHooksListParams = SanitizedHooksListParamsJSON

type SanitizedHooksListParamsJSON

type SanitizedHooksListParamsJSON struct {
	// When empty, defaults to the current session working directory.
	Cwds []string `json:"cwds,omitempty,omitzero"`
}

type SanitizedInitializeParams

type SanitizedInitializeParams = SanitizedInitializeParamsJSON

type SanitizedInitializeParamsJSON

type SanitizedInitializeParamsJSON struct {
	// Capabilities corresponds to the JSON schema field "capabilities".
	Capabilities interface{} `json:"capabilities,omitempty,omitzero"`

	// ClientInfo corresponds to the JSON schema field "clientInfo".
	ClientInfo ClientInfo `json:"clientInfo"`
}

type SanitizedListMCPServerStatusParams

type SanitizedListMCPServerStatusParams = SanitizedListMCPServerStatusParamsJSON

type SanitizedListMCPServerStatusParamsJSON

type SanitizedListMCPServerStatusParamsJSON struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedListMCPServerStatusParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// Controls how much MCP inventory data to fetch for each server. Defaults to
	// `Full` when omitted.
	Detail interface{} `json:"detail,omitempty,omitzero"`

	// Optional page size; defaults to a server-defined value.
	Limit SanitizedListMCPServerStatusParamsJSONLimit `json:"limit,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID SanitizedListMCPServerStatusParamsJSONThreadID `json:"threadId,omitempty,omitzero"`
}

type SanitizedListMCPServerStatusParamsJSONCursor added in v0.144.0

type SanitizedListMCPServerStatusParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedListMCPServerStatusParamsJSONLimit added in v0.144.0

type SanitizedListMCPServerStatusParamsJSONLimit *int

Optional page size; defaults to a server-defined value.

type SanitizedListMCPServerStatusParamsJSONThreadID added in v0.144.0

type SanitizedListMCPServerStatusParamsJSONThreadID *string

type SanitizedListMCPServerStatusResponse

type SanitizedListMCPServerStatusResponse = SanitizedListMCPServerStatusResponseJSON

type SanitizedListMCPServerStatusResponseJSON

type SanitizedListMCPServerStatusResponseJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []MCPServerStatus `json:"data"`

	// Opaque cursor to pass to the next call to continue after the last item. If
	// None, there are no more items to return.
	NextCursor SanitizedListMCPServerStatusResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

type SanitizedListMCPServerStatusResponseJSONNextCursor added in v0.144.0

type SanitizedListMCPServerStatusResponseJSONNextCursor *string

Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedLogoutAccountResponse added in v0.144.0

type SanitizedLogoutAccountResponse = SanitizedLogoutAccountResponseJSON

type SanitizedLogoutAccountResponseJSON added in v0.144.0

type SanitizedLogoutAccountResponseJSON map[string]interface{}

type SanitizedMCPResourceReadParams

type SanitizedMCPResourceReadParams = SanitizedMCPResourceReadParamsJSON

type SanitizedMCPResourceReadParamsJSON

type SanitizedMCPResourceReadParamsJSON struct {
	// Server corresponds to the JSON schema field "server".
	Server string `json:"server"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID SanitizedMCPResourceReadParamsJSONThreadID `json:"threadId,omitempty,omitzero"`

	// Uri corresponds to the JSON schema field "uri".
	Uri string `json:"uri"`
}

type SanitizedMCPResourceReadParamsJSONThreadID added in v0.144.0

type SanitizedMCPResourceReadParamsJSONThreadID *string

type SanitizedMCPResourceReadResponse

type SanitizedMCPResourceReadResponse = SanitizedMCPResourceReadResponseJSON

type SanitizedMCPResourceReadResponseJSON

type SanitizedMCPResourceReadResponseJSON struct {
	// Contents corresponds to the JSON schema field "contents".
	Contents []ResourceContent `json:"contents"`
}

type SanitizedMCPServerElicitationRequestResponseJSON

type SanitizedMCPServerElicitationRequestResponseJSON struct {
	// Optional client metadata for form-mode action handling.
	Meta interface{} `json:"_meta,omitempty,omitzero"`

	// Action corresponds to the JSON schema field "action".
	Action MCPServerElicitationAction `json:"action"`

	// Structured user input for accepted elicitations, mirroring RMCP
	// `CreateElicitationResult`.
	//
	// This is nullable because decline/cancel responses have no content.
	Content interface{} `json:"content,omitempty,omitzero"`
}

type SanitizedMCPServerOauthLoginCompletedNotificationJSON

type SanitizedMCPServerOauthLoginCompletedNotificationJSON struct {
	// Error corresponds to the JSON schema field "error".
	Error SanitizedMCPServerOauthLoginCompletedNotificationJSONError `json:"error,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Success corresponds to the JSON schema field "success".
	Success bool `json:"success"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID SanitizedMCPServerOauthLoginCompletedNotificationJSONThreadID `json:"threadId,omitempty,omitzero"`
}

type SanitizedMCPServerOauthLoginCompletedNotificationJSONError added in v0.144.0

type SanitizedMCPServerOauthLoginCompletedNotificationJSONError *string

type SanitizedMCPServerOauthLoginCompletedNotificationJSONThreadID added in v0.144.0

type SanitizedMCPServerOauthLoginCompletedNotificationJSONThreadID *string

type SanitizedMCPServerOauthLoginParams

type SanitizedMCPServerOauthLoginParams = SanitizedMCPServerOauthLoginParamsJSON

type SanitizedMCPServerOauthLoginParamsJSON

type SanitizedMCPServerOauthLoginParamsJSON struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Scopes corresponds to the JSON schema field "scopes".
	Scopes *SanitizedMCPServerOauthLoginParamsJSONScopes `json:"scopes,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID SanitizedMCPServerOauthLoginParamsJSONThreadID `json:"threadId,omitempty,omitzero"`

	// TimeoutSecs corresponds to the JSON schema field "timeoutSecs".
	TimeoutSecs SanitizedMCPServerOauthLoginParamsJSONTimeoutSecs `json:"timeoutSecs,omitempty,omitzero"`
}

type SanitizedMCPServerOauthLoginParamsJSONScopes added in v0.144.0

type SanitizedMCPServerOauthLoginParamsJSONScopes []string

type SanitizedMCPServerOauthLoginParamsJSONThreadID added in v0.144.0

type SanitizedMCPServerOauthLoginParamsJSONThreadID *string

type SanitizedMCPServerOauthLoginParamsJSONTimeoutSecs added in v0.144.0

type SanitizedMCPServerOauthLoginParamsJSONTimeoutSecs *int

type SanitizedMCPServerOauthLoginResponse

type SanitizedMCPServerOauthLoginResponse = SanitizedMCPServerOauthLoginResponseJSON

type SanitizedMCPServerOauthLoginResponseJSON

type SanitizedMCPServerOauthLoginResponseJSON struct {
	// AuthorizationURL corresponds to the JSON schema field "authorizationUrl".
	AuthorizationURL string `json:"authorizationUrl"`
}

type SanitizedMCPServerRefreshResponse added in v0.144.0

type SanitizedMCPServerRefreshResponse = SanitizedMCPServerRefreshResponseJSON

type SanitizedMCPServerRefreshResponseJSON added in v0.144.0

type SanitizedMCPServerRefreshResponseJSON map[string]interface{}

type SanitizedMCPServerStatusUpdatedNotificationJSON

type SanitizedMCPServerStatusUpdatedNotificationJSON struct {
	// Error corresponds to the JSON schema field "error".
	Error SanitizedMCPServerStatusUpdatedNotificationJSONError `json:"error,omitempty,omitzero"`

	// FailureReason corresponds to the JSON schema field "failureReason".
	FailureReason interface{} `json:"failureReason,omitempty,omitzero"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// Status corresponds to the JSON schema field "status".
	Status MCPServerStartupState `json:"status"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID SanitizedMCPServerStatusUpdatedNotificationJSONThreadID `json:"threadId,omitempty,omitzero"`
}

type SanitizedMCPServerStatusUpdatedNotificationJSONError added in v0.144.0

type SanitizedMCPServerStatusUpdatedNotificationJSONError *string

type SanitizedMCPServerStatusUpdatedNotificationJSONThreadID added in v0.144.0

type SanitizedMCPServerStatusUpdatedNotificationJSONThreadID *string

type SanitizedMCPServerToolCallParams

type SanitizedMCPServerToolCallParams = SanitizedMCPServerToolCallParamsJSON

type SanitizedMCPServerToolCallParamsJSON

type SanitizedMCPServerToolCallParamsJSON struct {
	// Meta corresponds to the JSON schema field "_meta".
	Meta interface{} `json:"_meta,omitempty,omitzero"`

	// Arguments corresponds to the JSON schema field "arguments".
	Arguments interface{} `json:"arguments,omitempty,omitzero"`

	// Server corresponds to the JSON schema field "server".
	Server string `json:"server"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// Tool corresponds to the JSON schema field "tool".
	Tool string `json:"tool"`
}

type SanitizedMCPServerToolCallResponse

type SanitizedMCPServerToolCallResponse = SanitizedMCPServerToolCallResponseJSON

type SanitizedMCPServerToolCallResponseJSON

type SanitizedMCPServerToolCallResponseJSON struct {
	// Meta corresponds to the JSON schema field "_meta".
	Meta interface{} `json:"_meta,omitempty,omitzero"`

	// Content corresponds to the JSON schema field "content".
	Content []interface{} `json:"content"`

	// IsError corresponds to the JSON schema field "isError".
	IsError SanitizedMCPServerToolCallResponseJSONIsError `json:"isError,omitempty,omitzero"`

	// StructuredContent corresponds to the JSON schema field "structuredContent".
	StructuredContent interface{} `json:"structuredContent,omitempty,omitzero"`
}

type SanitizedMCPServerToolCallResponseJSONIsError added in v0.144.0

type SanitizedMCPServerToolCallResponseJSONIsError *bool

type SanitizedMCPToolCallProgressNotificationJSON

type SanitizedMCPToolCallProgressNotificationJSON struct {
	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// Message corresponds to the JSON schema field "message".
	Message string `json:"message"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedMarketplaceAddParams

type SanitizedMarketplaceAddParams = SanitizedMarketplaceAddParamsJSON

type SanitizedMarketplaceAddParamsJSON

type SanitizedMarketplaceAddParamsJSON struct {
	// RefName corresponds to the JSON schema field "refName".
	RefName SanitizedMarketplaceAddParamsJSONRefName `json:"refName,omitempty,omitzero"`

	// Source corresponds to the JSON schema field "source".
	Source string `json:"source"`

	// SparsePaths corresponds to the JSON schema field "sparsePaths".
	SparsePaths *SanitizedMarketplaceAddParamsJSONSparsePaths `json:"sparsePaths,omitempty,omitzero"`
}

type SanitizedMarketplaceAddParamsJSONRefName added in v0.144.0

type SanitizedMarketplaceAddParamsJSONRefName *string

type SanitizedMarketplaceAddParamsJSONSparsePaths added in v0.144.0

type SanitizedMarketplaceAddParamsJSONSparsePaths []string

type SanitizedMarketplaceRemoveParams

type SanitizedMarketplaceRemoveParams = SanitizedMarketplaceRemoveParamsJSON

type SanitizedMarketplaceRemoveParamsJSON

type SanitizedMarketplaceRemoveParamsJSON struct {
	// MarketplaceName corresponds to the JSON schema field "marketplaceName".
	MarketplaceName string `json:"marketplaceName"`
}

type SanitizedMarketplaceUpgradeParams

type SanitizedMarketplaceUpgradeParams = SanitizedMarketplaceUpgradeParamsJSON

type SanitizedMarketplaceUpgradeParamsJSON

type SanitizedMarketplaceUpgradeParamsJSON struct {
	// MarketplaceName corresponds to the JSON schema field "marketplaceName".
	MarketplaceName SanitizedMarketplaceUpgradeParamsJSONMarketplaceName `json:"marketplaceName,omitempty,omitzero"`
}

type SanitizedMarketplaceUpgradeParamsJSONMarketplaceName added in v0.144.0

type SanitizedMarketplaceUpgradeParamsJSONMarketplaceName *string

type SanitizedModelListParams

type SanitizedModelListParams = SanitizedModelListParamsJSON

type SanitizedModelListParamsJSON

type SanitizedModelListParamsJSON struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedModelListParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// When true, include models that are hidden from the default picker list.
	IncludeHidden SanitizedModelListParamsJSONIncludeHidden `json:"includeHidden,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit SanitizedModelListParamsJSONLimit `json:"limit,omitempty,omitzero"`
}

type SanitizedModelListParamsJSONCursor added in v0.144.0

type SanitizedModelListParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedModelListParamsJSONIncludeHidden added in v0.144.0

type SanitizedModelListParamsJSONIncludeHidden *bool

When true, include models that are hidden from the default picker list.

type SanitizedModelListParamsJSONLimit added in v0.144.0

type SanitizedModelListParamsJSONLimit *int

Optional page size; defaults to a reasonable server-side value.

type SanitizedModelListResponse

type SanitizedModelListResponse = SanitizedModelListResponseJSON

type SanitizedModelListResponseJSON

type SanitizedModelListResponseJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []Model `json:"data"`

	// Opaque cursor to pass to the next call to continue after the last item. If
	// None, there are no more items to return.
	NextCursor SanitizedModelListResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

type SanitizedModelListResponseJSONNextCursor added in v0.144.0

type SanitizedModelListResponseJSONNextCursor *string

Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedModelProviderCapabilitiesReadParams added in v0.144.0

type SanitizedModelProviderCapabilitiesReadParams = SanitizedModelProviderCapabilitiesReadParamsJSON

type SanitizedModelProviderCapabilitiesReadParamsJSON added in v0.144.0

type SanitizedModelProviderCapabilitiesReadParamsJSON map[string]interface{}

type SanitizedModelProviderCapabilitiesReadResponseJSON

type SanitizedModelProviderCapabilitiesReadResponseJSON struct {
	// ImageGeneration corresponds to the JSON schema field "imageGeneration".
	ImageGeneration bool `json:"imageGeneration"`

	// NamespaceTools corresponds to the JSON schema field "namespaceTools".
	NamespaceTools bool `json:"namespaceTools"`

	// WebSearch corresponds to the JSON schema field "webSearch".
	WebSearch bool `json:"webSearch"`
}

type SanitizedModelReroutedNotification

type SanitizedModelReroutedNotification = SanitizedModelReroutedNotificationJSON

type SanitizedModelReroutedNotificationJSON

type SanitizedModelReroutedNotificationJSON struct {
	// FromModel corresponds to the JSON schema field "fromModel".
	FromModel string `json:"fromModel"`

	// Reason corresponds to the JSON schema field "reason".
	Reason ModelRerouteReason `json:"reason"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// ToModel corresponds to the JSON schema field "toModel".
	ToModel string `json:"toModel"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedModelSafetyBufferingUpdatedNotificationJSON

type SanitizedModelSafetyBufferingUpdatedNotificationJSON struct {
	// FasterModel corresponds to the JSON schema field "fasterModel".
	FasterModel SanitizedModelSafetyBufferingUpdatedNotificationJSONFasterModel `json:"fasterModel,omitempty,omitzero"`

	// Model corresponds to the JSON schema field "model".
	Model string `json:"model"`

	// Reasons corresponds to the JSON schema field "reasons".
	Reasons []string `json:"reasons"`

	// ShowBufferingUi corresponds to the JSON schema field "showBufferingUi".
	ShowBufferingUi bool `json:"showBufferingUi"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`

	// UseCases corresponds to the JSON schema field "useCases".
	UseCases []string `json:"useCases"`
}

type SanitizedModelSafetyBufferingUpdatedNotificationJSONFasterModel added in v0.144.0

type SanitizedModelSafetyBufferingUpdatedNotificationJSONFasterModel *string

type SanitizedModelVerificationNotification

type SanitizedModelVerificationNotification = SanitizedModelVerificationNotificationJSON

type SanitizedModelVerificationNotificationJSON

type SanitizedModelVerificationNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`

	// Verifications corresponds to the JSON schema field "verifications".
	Verifications []ModelVerification `json:"verifications"`
}

type SanitizedPermissionProfileListParams

type SanitizedPermissionProfileListParams = SanitizedPermissionProfileListParamsJSON

type SanitizedPermissionProfileListParamsJSON

type SanitizedPermissionProfileListParamsJSON struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedPermissionProfileListParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// Optional working directory to resolve project config layers.
	Cwd SanitizedPermissionProfileListParamsJSONCwd `json:"cwd,omitempty,omitzero"`

	// Optional page size; defaults to the full result set.
	Limit SanitizedPermissionProfileListParamsJSONLimit `json:"limit,omitempty,omitzero"`
}

type SanitizedPermissionProfileListParamsJSONCursor added in v0.144.0

type SanitizedPermissionProfileListParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedPermissionProfileListParamsJSONCwd added in v0.144.0

type SanitizedPermissionProfileListParamsJSONCwd *string

Optional working directory to resolve project config layers.

type SanitizedPermissionProfileListParamsJSONLimit added in v0.144.0

type SanitizedPermissionProfileListParamsJSONLimit *int

Optional page size; defaults to the full result set.

type SanitizedPermissionProfileListResponse

type SanitizedPermissionProfileListResponse = SanitizedPermissionProfileListResponseJSON

type SanitizedPermissionProfileListResponseJSON

type SanitizedPermissionProfileListResponseJSON struct {
	// Data corresponds to the JSON schema field "data".
	Data []PermissionProfileSummary `json:"data"`

	// Opaque cursor to pass to the next call to continue after the last item. If
	// None, there are no more items to return.
	NextCursor SanitizedPermissionProfileListResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

type SanitizedPermissionProfileListResponseJSONNextCursor added in v0.144.0

type SanitizedPermissionProfileListResponseJSONNextCursor *string

Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedPermissionsRequestApprovalResponseJSON

type SanitizedPermissionsRequestApprovalResponseJSON struct {
	// Permissions corresponds to the JSON schema field "permissions".
	Permissions GrantedPermissionProfile `json:"permissions"`

	// Scope corresponds to the JSON schema field "scope".
	Scope interface{} `json:"scope,omitempty,omitzero"`

	// Review every subsequent command in this turn before normal sandboxed execution.
	StrictAutoReview SanitizedPermissionsRequestApprovalResponseJSONStrictAutoReview `json:"strictAutoReview,omitempty,omitzero"`
}

type SanitizedPermissionsRequestApprovalResponseJSONStrictAutoReview added in v0.144.0

type SanitizedPermissionsRequestApprovalResponseJSONStrictAutoReview *bool

Review every subsequent command in this turn before normal sandboxed execution.

type SanitizedPlanDeltaNotification

type SanitizedPlanDeltaNotification = SanitizedPlanDeltaNotificationJSON

type SanitizedPlanDeltaNotificationJSON

type SanitizedPlanDeltaNotificationJSON struct {
	// Delta corresponds to the JSON schema field "delta".
	Delta string `json:"delta"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content.

type SanitizedPluginInstallResponse

type SanitizedPluginInstallResponse = SanitizedPluginInstallResponseJSON

type SanitizedPluginInstallResponseJSON

type SanitizedPluginInstallResponseJSON struct {
	// AppsNeedingAuth corresponds to the JSON schema field "appsNeedingAuth".
	AppsNeedingAuth []AppSummary `json:"appsNeedingAuth"`

	// AuthPolicy corresponds to the JSON schema field "authPolicy".
	AuthPolicy PluginAuthPolicy `json:"authPolicy"`
}

type SanitizedPluginShareCheckoutParams

type SanitizedPluginShareCheckoutParams = SanitizedPluginShareCheckoutParamsJSON

type SanitizedPluginShareCheckoutParamsJSON

type SanitizedPluginShareCheckoutParamsJSON struct {
	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`
}

type SanitizedPluginShareDeleteParams

type SanitizedPluginShareDeleteParams = SanitizedPluginShareDeleteParamsJSON

type SanitizedPluginShareDeleteParamsJSON

type SanitizedPluginShareDeleteParamsJSON struct {
	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`
}

type SanitizedPluginShareDeleteResponse added in v0.144.0

type SanitizedPluginShareDeleteResponse = SanitizedPluginShareDeleteResponseJSON

type SanitizedPluginShareDeleteResponseJSON added in v0.144.0

type SanitizedPluginShareDeleteResponseJSON map[string]interface{}

type SanitizedPluginShareListParams added in v0.144.0

type SanitizedPluginShareListParams = SanitizedPluginShareListParamsJSON

type SanitizedPluginShareListParamsJSON added in v0.144.0

type SanitizedPluginShareListParamsJSON map[string]interface{}

type SanitizedPluginShareSaveResponse

type SanitizedPluginShareSaveResponse = SanitizedPluginShareSaveResponseJSON

type SanitizedPluginShareSaveResponseJSON

type SanitizedPluginShareSaveResponseJSON struct {
	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`

	// ShareURL corresponds to the JSON schema field "shareUrl".
	ShareURL string `json:"shareUrl"`
}

type SanitizedPluginShareUpdateTargetsParams

type SanitizedPluginShareUpdateTargetsParams = SanitizedPluginShareUpdateTargetsParamsJSON

type SanitizedPluginShareUpdateTargetsParamsJSON

type SanitizedPluginShareUpdateTargetsParamsJSON struct {
	// Discoverability corresponds to the JSON schema field "discoverability".
	Discoverability PluginShareUpdateDiscoverability `json:"discoverability"`

	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`

	// ShareTargets corresponds to the JSON schema field "shareTargets".
	ShareTargets []PluginShareTarget `json:"shareTargets"`
}

type SanitizedPluginShareUpdateTargetsResponseJSON

type SanitizedPluginShareUpdateTargetsResponseJSON struct {
	// Discoverability corresponds to the JSON schema field "discoverability".
	Discoverability PluginShareDiscoverability `json:"discoverability"`

	// Principals corresponds to the JSON schema field "principals".
	Principals []PluginSharePrincipal `json:"principals"`
}

type SanitizedPluginSkillReadParams

type SanitizedPluginSkillReadParams = SanitizedPluginSkillReadParamsJSON

type SanitizedPluginSkillReadParamsJSON

type SanitizedPluginSkillReadParamsJSON struct {
	// RemoteMarketplaceName corresponds to the JSON schema field
	// "remoteMarketplaceName".
	RemoteMarketplaceName string `json:"remoteMarketplaceName"`

	// RemotePluginID corresponds to the JSON schema field "remotePluginId".
	RemotePluginID string `json:"remotePluginId"`

	// SkillName corresponds to the JSON schema field "skillName".
	SkillName string `json:"skillName"`
}

type SanitizedPluginSkillReadResponse

type SanitizedPluginSkillReadResponse = SanitizedPluginSkillReadResponseJSON

type SanitizedPluginSkillReadResponseJSON

type SanitizedPluginSkillReadResponseJSON struct {
	// Contents corresponds to the JSON schema field "contents".
	Contents SanitizedPluginSkillReadResponseJSONContents `json:"contents,omitempty,omitzero"`
}

type SanitizedPluginSkillReadResponseJSONContents added in v0.144.0

type SanitizedPluginSkillReadResponseJSONContents *string

type SanitizedPluginUninstallParams

type SanitizedPluginUninstallParams = SanitizedPluginUninstallParamsJSON

type SanitizedPluginUninstallParamsJSON

type SanitizedPluginUninstallParamsJSON struct {
	// PluginID corresponds to the JSON schema field "pluginId".
	PluginID string `json:"pluginId"`
}

type SanitizedPluginUninstallResponse added in v0.144.0

type SanitizedPluginUninstallResponse = SanitizedPluginUninstallResponseJSON

type SanitizedPluginUninstallResponseJSON added in v0.144.0

type SanitizedPluginUninstallResponseJSON map[string]interface{}

type SanitizedProcessExitedNotification

type SanitizedProcessExitedNotification = SanitizedProcessExitedNotificationJSON

type SanitizedProcessExitedNotificationJSON

type SanitizedProcessExitedNotificationJSON struct {
	// Process exit code.
	ExitCode int `json:"exitCode"`

	// Client-supplied, connection-scoped `processHandle` from `process/spawn`.
	ProcessHandle string `json:"processHandle"`

	// Buffered stderr capture.
	//
	// Empty when stderr was streamed via `process/outputDelta`.
	Stderr string `json:"stderr"`

	// Whether stderr reached `outputBytesCap`.
	//
	// In streaming mode, stderr is empty and cap state is also reported on the final
	// stderr `process/outputDelta` notification.
	StderrCapReached bool `json:"stderrCapReached"`

	// Buffered stdout capture.
	//
	// Empty when stdout was streamed via `process/outputDelta`.
	Stdout string `json:"stdout"`

	// Whether stdout reached `outputBytesCap`.
	//
	// In streaming mode, stdout is empty and cap state is also reported on the final
	// stdout `process/outputDelta` notification.
	StdoutCapReached bool `json:"stdoutCapReached"`
}

Final process exit notification for `process/spawn`.

type SanitizedProcessOutputDeltaNotification added in v0.144.0

type SanitizedProcessOutputDeltaNotification = SanitizedProcessOutputDeltaNotificationJSON

type SanitizedProcessOutputDeltaNotificationJSON added in v0.144.0

type SanitizedProcessOutputDeltaNotificationJSON struct {
	// True on the final streamed chunk for this stream when output was truncated by
	// `outputBytesCap`.
	CapReached bool `json:"capReached"`

	// Base64-encoded output bytes.
	DeltaBase64 string `json:"deltaBase64"`

	// Client-supplied, connection-scoped `processHandle` from `process/spawn`.
	ProcessHandle string `json:"processHandle"`

	// Output stream this chunk belongs to.
	Stream interface{} `json:"stream"`
}

Base64-encoded output chunk emitted for a streaming `process/spawn` request.

type SanitizedRawResponseItemCompletedNotificationJSON

type SanitizedRawResponseItemCompletedNotificationJSON struct {
	// Item corresponds to the JSON schema field "item".
	Item ResponseItem `json:"item"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedReasoningSummaryPartAddedNotificationJSON

type SanitizedReasoningSummaryPartAddedNotificationJSON struct {
	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// SummaryIndex corresponds to the JSON schema field "summaryIndex".
	SummaryIndex int `json:"summaryIndex"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedReasoningSummaryTextDeltaNotificationJSON

type SanitizedReasoningSummaryTextDeltaNotificationJSON struct {
	// Delta corresponds to the JSON schema field "delta".
	Delta string `json:"delta"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// SummaryIndex corresponds to the JSON schema field "summaryIndex".
	SummaryIndex int `json:"summaryIndex"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedReasoningTextDeltaNotification

type SanitizedReasoningTextDeltaNotification = SanitizedReasoningTextDeltaNotificationJSON

type SanitizedReasoningTextDeltaNotificationJSON

type SanitizedReasoningTextDeltaNotificationJSON struct {
	// ContentIndex corresponds to the JSON schema field "contentIndex".
	ContentIndex int `json:"contentIndex"`

	// Delta corresponds to the JSON schema field "delta".
	Delta string `json:"delta"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedRemoteControlStatusChangedNotificationJSON

type SanitizedRemoteControlStatusChangedNotificationJSON struct {
	// EnvironmentID corresponds to the JSON schema field "environmentId".
	EnvironmentID SanitizedRemoteControlStatusChangedNotificationJSONEnvironmentID `json:"environmentId,omitempty,omitzero"`

	// InstallationID corresponds to the JSON schema field "installationId".
	InstallationID string `json:"installationId"`

	// ServerName corresponds to the JSON schema field "serverName".
	ServerName string `json:"serverName"`

	// Status corresponds to the JSON schema field "status".
	Status RemoteControlConnectionStatus `json:"status"`
}

Current remote-control connection status and remote identity exposed to clients.

type SanitizedRemoteControlStatusChangedNotificationJSONEnvironmentID added in v0.144.0

type SanitizedRemoteControlStatusChangedNotificationJSONEnvironmentID *string

type SanitizedReviewStartParams

type SanitizedReviewStartParams = SanitizedReviewStartParamsJSON

type SanitizedReviewStartParamsJSON

type SanitizedReviewStartParamsJSON struct {
	// Where to run the review: inline (default) on the current thread or detached on
	// a new thread (returned in `reviewThreadId`).
	Delivery interface{} `json:"delivery,omitempty,omitzero"`

	// Target corresponds to the JSON schema field "target".
	Target ReviewTarget `json:"target"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedSendAddCreditsNudgeEmailParams

type SanitizedSendAddCreditsNudgeEmailParams = SanitizedSendAddCreditsNudgeEmailParamsJSON

type SanitizedSendAddCreditsNudgeEmailParamsJSON

type SanitizedSendAddCreditsNudgeEmailParamsJSON struct {
	// CreditType corresponds to the JSON schema field "creditType".
	CreditType AddCreditsNudgeCreditType `json:"creditType"`
}

type SanitizedSendAddCreditsNudgeEmailResponseJSON

type SanitizedSendAddCreditsNudgeEmailResponseJSON struct {
	// Status corresponds to the JSON schema field "status".
	Status AddCreditsNudgeEmailStatus `json:"status"`
}

type SanitizedServerRequestResolvedNotificationJSON

type SanitizedServerRequestResolvedNotificationJSON struct {
	// RequestID corresponds to the JSON schema field "requestId".
	RequestID RequestID `json:"requestId"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedSkillsChangedNotification added in v0.144.0

type SanitizedSkillsChangedNotification = SanitizedSkillsChangedNotificationJSON

type SanitizedSkillsChangedNotificationJSON added in v0.144.0

type SanitizedSkillsChangedNotificationJSON map[string]interface{}

Notification emitted when watched local skill files change.

Treat this as an invalidation signal and re-run `skills/list` with the client's current parameters when refreshed skill metadata is needed.

type SanitizedSkillsConfigWriteResponse

type SanitizedSkillsConfigWriteResponse = SanitizedSkillsConfigWriteResponseJSON

type SanitizedSkillsConfigWriteResponseJSON

type SanitizedSkillsConfigWriteResponseJSON struct {
	// EffectiveEnabled corresponds to the JSON schema field "effectiveEnabled".
	EffectiveEnabled bool `json:"effectiveEnabled"`
}

type SanitizedSkillsExtraRootsSetResponse added in v0.144.0

type SanitizedSkillsExtraRootsSetResponse = SanitizedSkillsExtraRootsSetResponseJSON

type SanitizedSkillsExtraRootsSetResponseJSON added in v0.144.0

type SanitizedSkillsExtraRootsSetResponseJSON map[string]interface{}

type SanitizedSkillsListParams

type SanitizedSkillsListParams = SanitizedSkillsListParamsJSON

type SanitizedSkillsListParamsJSON

type SanitizedSkillsListParamsJSON struct {
	// When empty, defaults to the current session working directory.
	Cwds []string `json:"cwds,omitempty,omitzero"`

	// When true, bypass the skills cache and re-scan skills from disk.
	ForceReload *bool `json:"forceReload,omitempty,omitzero"`
}

type SanitizedTerminalInteractionNotificationJSON

type SanitizedTerminalInteractionNotificationJSON struct {
	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// ProcessID corresponds to the JSON schema field "processId".
	ProcessID string `json:"processId"`

	// Stdin corresponds to the JSON schema field "stdin".
	Stdin string `json:"stdin"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedThreadApproveGuardianDeniedActionParamsJSON

type SanitizedThreadApproveGuardianDeniedActionParamsJSON struct {
	// Serialized `codex_protocol::protocol::GuardianAssessmentEvent`.
	Event interface{} `json:"event"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadApproveGuardianDeniedActionResponse added in v0.144.0

type SanitizedThreadApproveGuardianDeniedActionResponse = SanitizedThreadApproveGuardianDeniedActionResponseJSON

type SanitizedThreadApproveGuardianDeniedActionResponseJSON added in v0.144.0

type SanitizedThreadApproveGuardianDeniedActionResponseJSON map[string]interface{}

type SanitizedThreadArchiveParams

type SanitizedThreadArchiveParams = SanitizedThreadArchiveParamsJSON

type SanitizedThreadArchiveParamsJSON

type SanitizedThreadArchiveParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadArchiveResponse added in v0.144.0

type SanitizedThreadArchiveResponse = SanitizedThreadArchiveResponseJSON

type SanitizedThreadArchiveResponseJSON added in v0.144.0

type SanitizedThreadArchiveResponseJSON map[string]interface{}

type SanitizedThreadArchivedNotification

type SanitizedThreadArchivedNotification = SanitizedThreadArchivedNotificationJSON

type SanitizedThreadArchivedNotificationJSON

type SanitizedThreadArchivedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadClosedNotification

type SanitizedThreadClosedNotification = SanitizedThreadClosedNotificationJSON

type SanitizedThreadClosedNotificationJSON

type SanitizedThreadClosedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadCompactStartParams

type SanitizedThreadCompactStartParams = SanitizedThreadCompactStartParamsJSON

type SanitizedThreadCompactStartParamsJSON

type SanitizedThreadCompactStartParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadCompactStartResponse added in v0.144.0

type SanitizedThreadCompactStartResponse = SanitizedThreadCompactStartResponseJSON

type SanitizedThreadCompactStartResponseJSON added in v0.144.0

type SanitizedThreadCompactStartResponseJSON map[string]interface{}

type SanitizedThreadDeleteParams

type SanitizedThreadDeleteParams = SanitizedThreadDeleteParamsJSON

type SanitizedThreadDeleteParamsJSON

type SanitizedThreadDeleteParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadDeleteResponse added in v0.144.0

type SanitizedThreadDeleteResponse = SanitizedThreadDeleteResponseJSON

type SanitizedThreadDeleteResponseJSON added in v0.144.0

type SanitizedThreadDeleteResponseJSON map[string]interface{}

type SanitizedThreadDeletedNotification

type SanitizedThreadDeletedNotification = SanitizedThreadDeletedNotificationJSON

type SanitizedThreadDeletedNotificationJSON

type SanitizedThreadDeletedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadGoalClearParams

type SanitizedThreadGoalClearParams = SanitizedThreadGoalClearParamsJSON

type SanitizedThreadGoalClearParamsJSON

type SanitizedThreadGoalClearParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadGoalClearResponse

type SanitizedThreadGoalClearResponse = SanitizedThreadGoalClearResponseJSON

type SanitizedThreadGoalClearResponseJSON

type SanitizedThreadGoalClearResponseJSON struct {
	// Cleared corresponds to the JSON schema field "cleared".
	Cleared bool `json:"cleared"`
}

type SanitizedThreadGoalClearedNotification

type SanitizedThreadGoalClearedNotification = SanitizedThreadGoalClearedNotificationJSON

type SanitizedThreadGoalClearedNotificationJSON

type SanitizedThreadGoalClearedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadGoalGetParams

type SanitizedThreadGoalGetParams = SanitizedThreadGoalGetParamsJSON

type SanitizedThreadGoalGetParamsJSON

type SanitizedThreadGoalGetParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadGoalSetParams

type SanitizedThreadGoalSetParams = SanitizedThreadGoalSetParamsJSON

type SanitizedThreadGoalSetParamsJSON

type SanitizedThreadGoalSetParamsJSON struct {
	// Objective corresponds to the JSON schema field "objective".
	Objective SanitizedThreadGoalSetParamsJSONObjective `json:"objective,omitempty,omitzero"`

	// Status corresponds to the JSON schema field "status".
	Status interface{} `json:"status,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TokenBudget corresponds to the JSON schema field "tokenBudget".
	TokenBudget SanitizedThreadGoalSetParamsJSONTokenBudget `json:"tokenBudget,omitempty,omitzero"`
}

type SanitizedThreadGoalSetParamsJSONObjective added in v0.144.0

type SanitizedThreadGoalSetParamsJSONObjective *string

type SanitizedThreadGoalSetParamsJSONTokenBudget added in v0.144.0

type SanitizedThreadGoalSetParamsJSONTokenBudget *int

type SanitizedThreadInjectItemsParams

type SanitizedThreadInjectItemsParams = SanitizedThreadInjectItemsParamsJSON

type SanitizedThreadInjectItemsParamsJSON

type SanitizedThreadInjectItemsParamsJSON struct {
	// Raw Responses API items to append to the thread's model-visible history.
	Items []interface{} `json:"items"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadInjectItemsResponse added in v0.144.0

type SanitizedThreadInjectItemsResponse = SanitizedThreadInjectItemsResponseJSON

type SanitizedThreadInjectItemsResponseJSON added in v0.144.0

type SanitizedThreadInjectItemsResponseJSON map[string]interface{}

type SanitizedThreadListParams

type SanitizedThreadListParams = SanitizedThreadListParamsJSON

type SanitizedThreadListParamsJSON

type SanitizedThreadListParamsJSON struct {
	// Optional archived filter; when set to true, only archived threads are returned.
	// If false or null, only non-archived threads are returned.
	Archived SanitizedThreadListParamsJSONArchived `json:"archived,omitempty,omitzero"`

	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedThreadListParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// Optional cwd filter or filters; when set, only threads whose session cwd
	// exactly matches one of these paths are returned.
	Cwd interface{} `json:"cwd,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit SanitizedThreadListParamsJSONLimit `json:"limit,omitempty,omitzero"`

	// Optional provider filter; when set, only sessions recorded under these
	// providers are returned. When present but empty, includes all providers.
	ModelProviders *SanitizedThreadListParamsJSONModelProviders `json:"modelProviders,omitempty,omitzero"`

	// Optional substring filter for the extracted thread title.
	SearchTerm SanitizedThreadListParamsJSONSearchTerm `json:"searchTerm,omitempty,omitzero"`

	// Optional sort direction; defaults to descending (newest first).
	SortDirection interface{} `json:"sortDirection,omitempty,omitzero"`

	// Optional sort key; defaults to created_at.
	SortKey interface{} `json:"sortKey,omitempty,omitzero"`

	// Optional source filter; when set, only sessions from these source kinds are
	// returned. When omitted or empty, defaults to interactive sources.
	SourceKinds *SanitizedThreadListParamsJSONSourceKinds `json:"sourceKinds,omitempty,omitzero"`

	// If true, return from the state DB without scanning JSONL rollouts to repair
	// thread metadata. Omitted or false preserves scan-and-repair behavior.
	UseStateDbOnly *bool `json:"useStateDbOnly,omitempty,omitzero"`
}

type SanitizedThreadListParamsJSONArchived added in v0.144.0

type SanitizedThreadListParamsJSONArchived *bool

Optional archived filter; when set to true, only archived threads are returned. If false or null, only non-archived threads are returned.

type SanitizedThreadListParamsJSONCursor added in v0.144.0

type SanitizedThreadListParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedThreadListParamsJSONLimit added in v0.144.0

type SanitizedThreadListParamsJSONLimit *int

Optional page size; defaults to a reasonable server-side value.

type SanitizedThreadListParamsJSONModelProviders added in v0.144.0

type SanitizedThreadListParamsJSONModelProviders []string

Optional provider filter; when set, only sessions recorded under these providers are returned. When present but empty, includes all providers.

type SanitizedThreadListParamsJSONSearchTerm added in v0.144.0

type SanitizedThreadListParamsJSONSearchTerm *string

Optional substring filter for the extracted thread title.

type SanitizedThreadListParamsJSONSourceKinds added in v0.144.0

type SanitizedThreadListParamsJSONSourceKinds []ThreadSourceKind

Optional source filter; when set, only sessions from these source kinds are returned. When omitted or empty, defaults to interactive sources.

type SanitizedThreadLoadedListParams

type SanitizedThreadLoadedListParams = SanitizedThreadLoadedListParamsJSON

type SanitizedThreadLoadedListParamsJSON

type SanitizedThreadLoadedListParamsJSON struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor SanitizedThreadLoadedListParamsJSONCursor `json:"cursor,omitempty,omitzero"`

	// Optional page size; defaults to no limit.
	Limit SanitizedThreadLoadedListParamsJSONLimit `json:"limit,omitempty,omitzero"`
}

type SanitizedThreadLoadedListParamsJSONCursor added in v0.144.0

type SanitizedThreadLoadedListParamsJSONCursor *string

Opaque pagination cursor returned by a previous call.

type SanitizedThreadLoadedListParamsJSONLimit added in v0.144.0

type SanitizedThreadLoadedListParamsJSONLimit *int

Optional page size; defaults to no limit.

type SanitizedThreadLoadedListResponse

type SanitizedThreadLoadedListResponse = SanitizedThreadLoadedListResponseJSON

type SanitizedThreadLoadedListResponseJSON

type SanitizedThreadLoadedListResponseJSON struct {
	// Thread ids for sessions currently loaded in memory.
	Data []string `json:"data"`

	// Opaque cursor to pass to the next call to continue after the last item. if
	// None, there are no more items to return.
	NextCursor SanitizedThreadLoadedListResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

type SanitizedThreadLoadedListResponseJSONNextCursor added in v0.144.0

type SanitizedThreadLoadedListResponseJSONNextCursor *string

Opaque cursor to pass to the next call to continue after the last item. if None, there are no more items to return.

type SanitizedThreadMetadataUpdateParams

type SanitizedThreadMetadataUpdateParams = SanitizedThreadMetadataUpdateParamsJSON

type SanitizedThreadMetadataUpdateParamsJSON

type SanitizedThreadMetadataUpdateParamsJSON struct {
	// Patch the stored Git metadata for this thread. Omit a field to leave it
	// unchanged, set it to `null` to clear it, or provide a string to replace the
	// stored value.
	GitInfo interface{} `json:"gitInfo,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadNameUpdatedNotification

type SanitizedThreadNameUpdatedNotification = SanitizedThreadNameUpdatedNotificationJSON

type SanitizedThreadNameUpdatedNotificationJSON

type SanitizedThreadNameUpdatedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// ThreadName corresponds to the JSON schema field "threadName".
	ThreadName SanitizedThreadNameUpdatedNotificationJSONThreadName `json:"threadName,omitempty,omitzero"`
}

type SanitizedThreadNameUpdatedNotificationJSONThreadName added in v0.144.0

type SanitizedThreadNameUpdatedNotificationJSONThreadName *string

type SanitizedThreadReadParams

type SanitizedThreadReadParams = SanitizedThreadReadParamsJSON

type SanitizedThreadReadParamsJSON

type SanitizedThreadReadParamsJSON struct {
	// When true, include turns and their items from rollout history.
	IncludeTurns *bool `json:"includeTurns,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadRealtimeClosedNotificationJSON

type SanitizedThreadRealtimeClosedNotificationJSON struct {
	// Reason corresponds to the JSON schema field "reason".
	Reason SanitizedThreadRealtimeClosedNotificationJSONReason `json:"reason,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - emitted when thread realtime transport closes.

type SanitizedThreadRealtimeClosedNotificationJSONReason added in v0.144.0

type SanitizedThreadRealtimeClosedNotificationJSONReason *string

type SanitizedThreadRealtimeErrorNotificationJSON

type SanitizedThreadRealtimeErrorNotificationJSON struct {
	// Message corresponds to the JSON schema field "message".
	Message string `json:"message"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - emitted when thread realtime encounters an error.

type SanitizedThreadRealtimeItemAddedNotificationJSON

type SanitizedThreadRealtimeItemAddedNotificationJSON struct {
	// Item corresponds to the JSON schema field "item".
	Item interface{} `json:"item"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - raw non-audio thread realtime item emitted by the backend.

type SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON

type SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON struct {
	// Audio corresponds to the JSON schema field "audio".
	Audio ThreadRealtimeAudioChunk `json:"audio"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - streamed output audio emitted by thread realtime.

type SanitizedThreadRealtimeSdpNotification

type SanitizedThreadRealtimeSdpNotification = SanitizedThreadRealtimeSdpNotificationJSON

type SanitizedThreadRealtimeSdpNotificationJSON

type SanitizedThreadRealtimeSdpNotificationJSON struct {
	// Sdp corresponds to the JSON schema field "sdp".
	Sdp string `json:"sdp"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - emitted with the remote SDP for a WebRTC realtime session.

type SanitizedThreadRealtimeStartedNotificationJSON

type SanitizedThreadRealtimeStartedNotificationJSON struct {
	// RealtimeSessionID corresponds to the JSON schema field "realtimeSessionId".
	RealtimeSessionID SanitizedThreadRealtimeStartedNotificationJSONRealtimeSessionID `json:"realtimeSessionId,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// Version corresponds to the JSON schema field "version".
	Version RealtimeConversationVersion `json:"version"`
}

EXPERIMENTAL - emitted when thread realtime startup is accepted.

type SanitizedThreadRealtimeStartedNotificationJSONRealtimeSessionID added in v0.144.0

type SanitizedThreadRealtimeStartedNotificationJSONRealtimeSessionID *string

type SanitizedThreadRealtimeTranscriptDeltaNotificationJSON

type SanitizedThreadRealtimeTranscriptDeltaNotificationJSON struct {
	// Live transcript delta from the realtime event.
	Delta string `json:"delta"`

	// Role corresponds to the JSON schema field "role".
	Role string `json:"role"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - flat transcript delta emitted whenever realtime transcript text changes.

type SanitizedThreadRealtimeTranscriptDoneNotificationJSON

type SanitizedThreadRealtimeTranscriptDoneNotificationJSON struct {
	// Role corresponds to the JSON schema field "role".
	Role string `json:"role"`

	// Final complete text for the transcript part.
	Text string `json:"text"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

EXPERIMENTAL - final transcript text emitted when realtime completes a transcript part.

type SanitizedThreadRollbackParams

type SanitizedThreadRollbackParams = SanitizedThreadRollbackParamsJSON

type SanitizedThreadRollbackParamsJSON

type SanitizedThreadRollbackParamsJSON struct {
	// The number of turns to drop from the end of the thread. Must be >= 1.
	//
	// This only modifies the thread's history and does not revert local file changes
	// that have been made by the agent. Clients are responsible for reverting these
	// changes.
	NumTurns int `json:"numTurns"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

DEPRECATED: `thread/rollback` will be removed soon.

type SanitizedThreadSetNameParams

type SanitizedThreadSetNameParams = SanitizedThreadSetNameParamsJSON

type SanitizedThreadSetNameParamsJSON

type SanitizedThreadSetNameParamsJSON struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadSetNameResponse added in v0.144.0

type SanitizedThreadSetNameResponse = SanitizedThreadSetNameResponseJSON

type SanitizedThreadSetNameResponseJSON added in v0.144.0

type SanitizedThreadSetNameResponseJSON map[string]interface{}

type SanitizedThreadShellCommandParams

type SanitizedThreadShellCommandParams = SanitizedThreadShellCommandParamsJSON

type SanitizedThreadShellCommandParamsJSON

type SanitizedThreadShellCommandParamsJSON struct {
	// Shell command string evaluated by the thread's configured shell. Unlike
	// `command/exec`, this intentionally preserves shell syntax such as pipes,
	// redirects, and quoting. This runs unsandboxed with full access rather than
	// inheriting the thread sandbox policy.
	Command string `json:"command"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadShellCommandResponse added in v0.144.0

type SanitizedThreadShellCommandResponse = SanitizedThreadShellCommandResponseJSON

type SanitizedThreadShellCommandResponseJSON added in v0.144.0

type SanitizedThreadShellCommandResponseJSON map[string]interface{}

type SanitizedThreadStatusChangedNotificationJSON

type SanitizedThreadStatusChangedNotificationJSON struct {
	// Status corresponds to the JSON schema field "status".
	Status ThreadStatus `json:"status"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadTokenUsageUpdatedNotificationJSON

type SanitizedThreadTokenUsageUpdatedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TokenUsage corresponds to the JSON schema field "tokenUsage".
	TokenUsage ThreadTokenUsage `json:"tokenUsage"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedThreadUnarchiveParams

type SanitizedThreadUnarchiveParams = SanitizedThreadUnarchiveParamsJSON

type SanitizedThreadUnarchiveParamsJSON

type SanitizedThreadUnarchiveParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadUnarchivedNotification

type SanitizedThreadUnarchivedNotification = SanitizedThreadUnarchivedNotificationJSON

type SanitizedThreadUnarchivedNotificationJSON

type SanitizedThreadUnarchivedNotificationJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadUnsubscribeParams

type SanitizedThreadUnsubscribeParams = SanitizedThreadUnsubscribeParamsJSON

type SanitizedThreadUnsubscribeParamsJSON

type SanitizedThreadUnsubscribeParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type SanitizedThreadUnsubscribeResponse

type SanitizedThreadUnsubscribeResponse = SanitizedThreadUnsubscribeResponseJSON

type SanitizedThreadUnsubscribeResponseJSON

type SanitizedThreadUnsubscribeResponseJSON struct {
	// Status corresponds to the JSON schema field "status".
	Status ThreadUnsubscribeStatus `json:"status"`
}

type SanitizedToolRequestUserInputParams

type SanitizedToolRequestUserInputParams = SanitizedToolRequestUserInputParamsJSON

type SanitizedToolRequestUserInputParamsJSON

type SanitizedToolRequestUserInputParamsJSON struct {
	// AutoResolutionMs corresponds to the JSON schema field "autoResolutionMs".
	AutoResolutionMs SanitizedToolRequestUserInputParamsJSONAutoResolutionMs `json:"autoResolutionMs,omitempty,omitzero"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID string `json:"itemId"`

	// Questions corresponds to the JSON schema field "questions".
	Questions []ToolRequestUserInputQuestion `json:"questions"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

EXPERIMENTAL. Params sent with a request_user_input event.

type SanitizedToolRequestUserInputParamsJSONAutoResolutionMs added in v0.144.0

type SanitizedToolRequestUserInputParamsJSONAutoResolutionMs *int

type SanitizedToolRequestUserInputResponse

type SanitizedToolRequestUserInputResponse = SanitizedToolRequestUserInputResponseJSON

type SanitizedToolRequestUserInputResponseJSON

type SanitizedToolRequestUserInputResponseJSON struct {
	// Answers corresponds to the JSON schema field "answers".
	Answers SanitizedToolRequestUserInputResponseJSONAnswers `json:"answers"`
}

EXPERIMENTAL. Response payload mapping question ids to answers.

type SanitizedToolRequestUserInputResponseJSONAnswers added in v0.144.0

type SanitizedToolRequestUserInputResponseJSONAnswers map[string]ToolRequestUserInputAnswer

type SanitizedTurnDiffUpdatedNotification

type SanitizedTurnDiffUpdatedNotification = SanitizedTurnDiffUpdatedNotificationJSON

type SanitizedTurnDiffUpdatedNotificationJSON

type SanitizedTurnDiffUpdatedNotificationJSON struct {
	// Diff corresponds to the JSON schema field "diff".
	Diff string `json:"diff"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

Notification that the turn-level unified diff has changed. Contains the latest aggregated diff across all file changes in the turn.

type SanitizedTurnInterruptParams

type SanitizedTurnInterruptParams = SanitizedTurnInterruptParamsJSON

type SanitizedTurnInterruptParamsJSON

type SanitizedTurnInterruptParamsJSON struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedTurnInterruptResponse added in v0.144.0

type SanitizedTurnInterruptResponse = SanitizedTurnInterruptResponseJSON

type SanitizedTurnInterruptResponseJSON added in v0.144.0

type SanitizedTurnInterruptResponseJSON map[string]interface{}

type SanitizedTurnModerationMetadataNotificationJSON

type SanitizedTurnModerationMetadataNotificationJSON struct {
	// Metadata corresponds to the JSON schema field "metadata".
	Metadata interface{} `json:"metadata"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedTurnPlanUpdatedNotification

type SanitizedTurnPlanUpdatedNotification = SanitizedTurnPlanUpdatedNotificationJSON

type SanitizedTurnPlanUpdatedNotificationJSON

type SanitizedTurnPlanUpdatedNotificationJSON struct {
	// Explanation corresponds to the JSON schema field "explanation".
	Explanation SanitizedTurnPlanUpdatedNotificationJSONExplanation `json:"explanation,omitempty,omitzero"`

	// Plan corresponds to the JSON schema field "plan".
	Plan []TurnPlanStep `json:"plan"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedTurnPlanUpdatedNotificationJSONExplanation added in v0.144.0

type SanitizedTurnPlanUpdatedNotificationJSONExplanation *string

type SanitizedTurnSteerResponse

type SanitizedTurnSteerResponse = SanitizedTurnSteerResponseJSON

type SanitizedTurnSteerResponseJSON

type SanitizedTurnSteerResponseJSON struct {
	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type SanitizedWarningNotification

type SanitizedWarningNotification = SanitizedWarningNotificationJSON

type SanitizedWarningNotificationJSON

type SanitizedWarningNotificationJSON struct {
	// Concise warning message for the user.
	Message string `json:"message"`

	// Optional thread target when the warning applies to a specific thread.
	ThreadID SanitizedWarningNotificationJSONThreadID `json:"threadId,omitempty,omitzero"`
}

type SanitizedWarningNotificationJSONThreadID added in v0.144.0

type SanitizedWarningNotificationJSONThreadID *string

Optional thread target when the warning applies to a specific thread.

type SanitizedWindowsSandboxReadinessResponseJSON

type SanitizedWindowsSandboxReadinessResponseJSON struct {
	// Status corresponds to the JSON schema field "status".
	Status WindowsSandboxReadiness `json:"status"`
}

type SanitizedWindowsSandboxSetupCompletedNotificationJSON

type SanitizedWindowsSandboxSetupCompletedNotificationJSON struct {
	// Error corresponds to the JSON schema field "error".
	Error SanitizedWindowsSandboxSetupCompletedNotificationJSONError `json:"error,omitempty,omitzero"`

	// Mode corresponds to the JSON schema field "mode".
	Mode WindowsSandboxSetupMode `json:"mode"`

	// Success corresponds to the JSON schema field "success".
	Success bool `json:"success"`
}

type SanitizedWindowsSandboxSetupCompletedNotificationJSONError added in v0.144.0

type SanitizedWindowsSandboxSetupCompletedNotificationJSONError *string

type SanitizedWindowsSandboxSetupStartResponseJSON

type SanitizedWindowsSandboxSetupStartResponseJSON struct {
	// Started corresponds to the JSON schema field "started".
	Started bool `json:"started"`
}

type SanitizedWindowsWorldWritableWarningNotificationJSON

type SanitizedWindowsWorldWritableWarningNotificationJSON struct {
	// ExtraCount corresponds to the JSON schema field "extraCount".
	ExtraCount int `json:"extraCount"`

	// FailedScan corresponds to the JSON schema field "failedScan".
	FailedScan bool `json:"failedScan"`

	// SamplePaths corresponds to the JSON schema field "samplePaths".
	SamplePaths []string `json:"samplePaths"`
}

type SelectedCapabilityRoot added in v0.144.0

type SelectedCapabilityRoot struct {
	// Stable identifier supplied by the capability selection platform.
	ID string `json:"id"`

	// Where the selected root can be resolved.
	Location interface{} `json:"location"`
}

A user-selected root that can expose one or more runtime capabilities.

type SendAddCreditsNudgeEmailParams

type SendAddCreditsNudgeEmailParams struct {
	// CreditType corresponds to the JSON schema field "creditType".
	CreditType AddCreditsNudgeCreditType `json:"creditType"`
}

type ServerNotification

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

ServerNotification preserves the complete JSON payload for a discriminated union.

func NewServerNotification added in v0.145.0

func NewServerNotification(value any) (ServerNotification, error)

NewServerNotification validates the discriminator and wraps a JSON-marshalable ServerNotification value.

func (ServerNotification) IsKnown added in v0.145.0

func (value ServerNotification) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ServerNotification) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (ServerNotification) MarshalJSON added in v0.145.0

func (value ServerNotification) MarshalJSON() ([]byte, error)

func (ServerNotification) RawJSON added in v0.145.0

func (value ServerNotification) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ServerNotification) UnmarshalJSON added in v0.145.0

func (value *ServerNotification) UnmarshalJSON(data []byte) error

type ServerNotificationKind added in v0.145.0

type ServerNotificationKind string

ServerNotificationKind identifies a known ServerNotification variant.

const (
	ServerNotificationKindAccountLoginCompleted                   ServerNotificationKind = "account/login/completed"
	ServerNotificationKindAccountRateLimitsUpdated                ServerNotificationKind = "account/rateLimits/updated"
	ServerNotificationKindAccountUpdated                          ServerNotificationKind = "account/updated"
	ServerNotificationKindAppListUpdated                          ServerNotificationKind = "app/list/updated"
	ServerNotificationKindCommandExecOutputDelta                  ServerNotificationKind = "command/exec/outputDelta"
	ServerNotificationKindConfigWarning                           ServerNotificationKind = "configWarning"
	ServerNotificationKindDeprecationNotice                       ServerNotificationKind = "deprecationNotice"
	ServerNotificationKindError                                   ServerNotificationKind = "error"
	ServerNotificationKindExternalAgentConfigImportCompleted      ServerNotificationKind = "externalAgentConfig/import/completed"
	ServerNotificationKindExternalAgentConfigImportProgress       ServerNotificationKind = "externalAgentConfig/import/progress"
	ServerNotificationKindFsChanged                               ServerNotificationKind = "fs/changed"
	ServerNotificationKindFuzzyFileSearchSessionCompleted         ServerNotificationKind = "fuzzyFileSearch/sessionCompleted"
	ServerNotificationKindFuzzyFileSearchSessionUpdated           ServerNotificationKind = "fuzzyFileSearch/sessionUpdated"
	ServerNotificationKindGuardianWarning                         ServerNotificationKind = "guardianWarning"
	ServerNotificationKindHookCompleted                           ServerNotificationKind = "hook/completed"
	ServerNotificationKindHookStarted                             ServerNotificationKind = "hook/started"
	ServerNotificationKindItemAgentMessageDelta                   ServerNotificationKind = "item/agentMessage/delta"
	ServerNotificationKindItemAutoApprovalReviewCompleted         ServerNotificationKind = "item/autoApprovalReview/completed"
	ServerNotificationKindItemAutoApprovalReviewStarted           ServerNotificationKind = "item/autoApprovalReview/started"
	ServerNotificationKindItemCommandExecutionOutputDelta         ServerNotificationKind = "item/commandExecution/outputDelta"
	ServerNotificationKindItemCommandExecutionTerminalInteraction ServerNotificationKind = "item/commandExecution/terminalInteraction"
	ServerNotificationKindItemCompleted                           ServerNotificationKind = "item/completed"
	ServerNotificationKindItemFileChangeOutputDelta               ServerNotificationKind = "item/fileChange/outputDelta"
	ServerNotificationKindItemFileChangePatchUpdated              ServerNotificationKind = "item/fileChange/patchUpdated"
	ServerNotificationKindItemMcpToolCallProgress                 ServerNotificationKind = "item/mcpToolCall/progress"
	ServerNotificationKindItemPlanDelta                           ServerNotificationKind = "item/plan/delta"
	ServerNotificationKindItemReasoningSummaryPartAdded           ServerNotificationKind = "item/reasoning/summaryPartAdded"
	ServerNotificationKindItemReasoningSummaryTextDelta           ServerNotificationKind = "item/reasoning/summaryTextDelta"
	ServerNotificationKindItemReasoningTextDelta                  ServerNotificationKind = "item/reasoning/textDelta"
	ServerNotificationKindItemStarted                             ServerNotificationKind = "item/started"
	ServerNotificationKindMcpServerOauthLoginCompleted            ServerNotificationKind = "mcpServer/oauthLogin/completed"
	ServerNotificationKindMcpServerStartupStatusUpdated           ServerNotificationKind = "mcpServer/startupStatus/updated"
	ServerNotificationKindModelRerouted                           ServerNotificationKind = "model/rerouted"
	ServerNotificationKindModelSafetyBufferingUpdated             ServerNotificationKind = "model/safetyBuffering/updated"
	ServerNotificationKindModelVerification                       ServerNotificationKind = "model/verification"
	ServerNotificationKindProcessExited                           ServerNotificationKind = "process/exited"
	ServerNotificationKindProcessOutputDelta                      ServerNotificationKind = "process/outputDelta"
	ServerNotificationKindRemoteControlStatusChanged              ServerNotificationKind = "remoteControl/status/changed"
	ServerNotificationKindServerRequestResolved                   ServerNotificationKind = "serverRequest/resolved"
	ServerNotificationKindSkillsChanged                           ServerNotificationKind = "skills/changed"
	ServerNotificationKindThreadArchived                          ServerNotificationKind = "thread/archived"
	ServerNotificationKindThreadClosed                            ServerNotificationKind = "thread/closed"
	ServerNotificationKindThreadCompacted                         ServerNotificationKind = "thread/compacted"
	ServerNotificationKindThreadDeleted                           ServerNotificationKind = "thread/deleted"
	ServerNotificationKindThreadGoalCleared                       ServerNotificationKind = "thread/goal/cleared"
	ServerNotificationKindThreadGoalUpdated                       ServerNotificationKind = "thread/goal/updated"
	ServerNotificationKindThreadNameUpdated                       ServerNotificationKind = "thread/name/updated"
	ServerNotificationKindThreadRealtimeClosed                    ServerNotificationKind = "thread/realtime/closed"
	ServerNotificationKindThreadRealtimeError                     ServerNotificationKind = "thread/realtime/error"
	ServerNotificationKindThreadRealtimeItemAdded                 ServerNotificationKind = "thread/realtime/itemAdded"
	ServerNotificationKindThreadRealtimeOutputAudioDelta          ServerNotificationKind = "thread/realtime/outputAudio/delta"
	ServerNotificationKindThreadRealtimeSdp                       ServerNotificationKind = "thread/realtime/sdp"
	ServerNotificationKindThreadRealtimeStarted                   ServerNotificationKind = "thread/realtime/started"
	ServerNotificationKindThreadRealtimeTranscriptDelta           ServerNotificationKind = "thread/realtime/transcript/delta"
	ServerNotificationKindThreadRealtimeTranscriptDone            ServerNotificationKind = "thread/realtime/transcript/done"
	ServerNotificationKindThreadSettingsUpdated                   ServerNotificationKind = "thread/settings/updated"
	ServerNotificationKindThreadStarted                           ServerNotificationKind = "thread/started"
	ServerNotificationKindThreadStatusChanged                     ServerNotificationKind = "thread/status/changed"
	ServerNotificationKindThreadTokenUsageUpdated                 ServerNotificationKind = "thread/tokenUsage/updated"
	ServerNotificationKindThreadUnarchived                        ServerNotificationKind = "thread/unarchived"
	ServerNotificationKindTurnCompleted                           ServerNotificationKind = "turn/completed"
	ServerNotificationKindTurnDiffUpdated                         ServerNotificationKind = "turn/diff/updated"
	ServerNotificationKindTurnModerationMetadata                  ServerNotificationKind = "turn/moderationMetadata"
	ServerNotificationKindTurnPlanUpdated                         ServerNotificationKind = "turn/plan/updated"
	ServerNotificationKindTurnStarted                             ServerNotificationKind = "turn/started"
	ServerNotificationKindWarning                                 ServerNotificationKind = "warning"
	ServerNotificationKindWindowsWorldWritableWarning             ServerNotificationKind = "windows/worldWritableWarning"
	ServerNotificationKindWindowsSandboxSetupCompleted            ServerNotificationKind = "windowsSandbox/setupCompleted"
)

type ServerRequest

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

ServerRequest preserves the complete JSON payload for a discriminated union.

func NewServerRequest added in v0.145.0

func NewServerRequest(value any) (ServerRequest, error)

NewServerRequest validates the discriminator and wraps a JSON-marshalable ServerRequest value.

func (ServerRequest) IsKnown added in v0.145.0

func (value ServerRequest) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ServerRequest) Kind added in v0.145.0

func (value ServerRequest) Kind() ServerRequestKind

Kind returns the payload discriminator, including unknown future values.

func (ServerRequest) MarshalJSON added in v0.145.0

func (value ServerRequest) MarshalJSON() ([]byte, error)

func (ServerRequest) RawJSON added in v0.145.0

func (value ServerRequest) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ServerRequest) UnmarshalJSON added in v0.145.0

func (value *ServerRequest) UnmarshalJSON(data []byte) error

type ServerRequestKind added in v0.145.0

type ServerRequestKind string

ServerRequestKind identifies a known ServerRequest variant.

const (
	ServerRequestKindAccountChatgptAuthTokensRefresh     ServerRequestKind = "account/chatgptAuthTokens/refresh"
	ServerRequestKindApplyPatchApproval                  ServerRequestKind = "applyPatchApproval"
	ServerRequestKindAttestationGenerate                 ServerRequestKind = "attestation/generate"
	ServerRequestKindExecCommandApproval                 ServerRequestKind = "execCommandApproval"
	ServerRequestKindItemCommandExecutionRequestApproval ServerRequestKind = "item/commandExecution/requestApproval"
	ServerRequestKindItemFileChangeRequestApproval       ServerRequestKind = "item/fileChange/requestApproval"
	ServerRequestKindItemPermissionsRequestApproval      ServerRequestKind = "item/permissions/requestApproval"
	ServerRequestKindItemToolCall                        ServerRequestKind = "item/tool/call"
	ServerRequestKindItemToolRequestUserInput            ServerRequestKind = "item/tool/requestUserInput"
	ServerRequestKindMcpServerElicitationRequest         ServerRequestKind = "mcpServer/elicitation/request"
)

type SessionMigration

type SessionMigration struct {
	// Cwd corresponds to the JSON schema field "cwd".
	Cwd string `json:"cwd"`

	// Path corresponds to the JSON schema field "path".
	Path string `json:"path"`

	// Title corresponds to the JSON schema field "title".
	Title SessionMigrationTitle `json:"title,omitempty,omitzero"`
}

type SessionMigrationTitle added in v0.144.0

type SessionMigrationTitle *string

type Settings

type Settings struct {
	// DeveloperInstructions corresponds to the JSON schema field
	// "developer_instructions".
	DeveloperInstructions SettingsDeveloperInstructions `json:"developer_instructions,omitempty,omitzero"`

	// Model corresponds to the JSON schema field "model".
	Model string `json:"model"`

	// ReasoningEffort corresponds to the JSON schema field "reasoning_effort".
	ReasoningEffort interface{} `json:"reasoning_effort,omitempty,omitzero"`
}

Settings for a collaboration mode.

type SettingsDeveloperInstructions added in v0.144.0

type SettingsDeveloperInstructions *string

type SkillMigration

type SkillMigration struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

type SkillsConfigWriteParams

type SkillsConfigWriteParams struct {
	// Enabled corresponds to the JSON schema field "enabled".
	Enabled bool `json:"enabled"`

	// Name-based selector.
	Name SkillsConfigWriteParamsName `json:"name,omitempty,omitzero"`

	// Path-based selector.
	Path interface{} `json:"path,omitempty,omitzero"`
}

type SkillsConfigWriteParamsName added in v0.144.0

type SkillsConfigWriteParamsName *string

Name-based selector.

type SkillsExtraRootsSetParams

type SkillsExtraRootsSetParams struct {
	// ExtraRoots corresponds to the JSON schema field "extraRoots".
	ExtraRoots []AbsolutePathBuf `json:"extraRoots"`
}

type SkillsListParams

type SkillsListParams struct {
	// When empty, defaults to the current session working directory.
	Cwds []string `json:"cwds,omitempty,omitzero"`

	// When true, bypass the skills cache and re-scan skills from disk.
	ForceReload *bool `json:"forceReload,omitempty,omitzero"`
}

type SkillsListResponse

type SkillsListResponse interface{}

type SortDirection

type SortDirection string
const SortDirectionAsc SortDirection = "asc"
const SortDirectionDesc SortDirection = "desc"

type SpendControlLimitSnapshot

type SpendControlLimitSnapshot struct {
	// Limit corresponds to the JSON schema field "limit".
	Limit string `json:"limit"`

	// RemainingPercent corresponds to the JSON schema field "remainingPercent".
	RemainingPercent int `json:"remainingPercent"`

	// ResetsAt corresponds to the JSON schema field "resetsAt".
	ResetsAt int `json:"resetsAt"`

	// Used corresponds to the JSON schema field "used".
	Used string `json:"used"`
}

type SubagentMigration

type SubagentMigration struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`
}

type TextElement

type TextElement struct {
	// Byte range in the parent `text` buffer that this element occupies.
	ByteRange TextElementByteRange `json:"byteRange"`

	// Optional human-readable placeholder for the element, displayed in the UI.
	Placeholder TextElementPlaceholder `json:"placeholder,omitempty,omitzero"`
}

type TextElementByteRange

type TextElementByteRange struct {
	// End corresponds to the JSON schema field "end".
	End int `json:"end"`

	// Start corresponds to the JSON schema field "start".
	Start int `json:"start"`
}

Byte range in the parent `text` buffer that this element occupies.

type TextElementPlaceholder added in v0.144.0

type TextElementPlaceholder *string

Optional human-readable placeholder for the element, displayed in the UI.

type TextPosition

type TextPosition struct {
	// 1-based column number (in Unicode scalar values).
	Column int `json:"column"`

	// 1-based line number.
	Line int `json:"line"`
}

type TextRange

type TextRange struct {
	// End corresponds to the JSON schema field "end".
	End TextPosition `json:"end"`

	// Start corresponds to the JSON schema field "start".
	Start TextPosition `json:"start"`
}

type Thread

type Thread struct {
	ID string `json:"id,omitempty"`
}

Thread represents a minimal thread descriptor used in thread responses.

type ThreadActiveFlag

type ThreadActiveFlag string
const ThreadActiveFlagWaitingOnApproval ThreadActiveFlag = "waitingOnApproval"
const ThreadActiveFlagWaitingOnUserInput ThreadActiveFlag = "waitingOnUserInput"

type ThreadApproveGuardianDeniedActionParams

type ThreadApproveGuardianDeniedActionParams struct {
	// Serialized `codex_protocol::protocol::GuardianAssessmentEvent`.
	Event interface{} `json:"event"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadArchiveParams

type ThreadArchiveParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadArchiveResponse

type ThreadArchiveResponse = SanitizedThreadArchiveResponseJSON

type ThreadCompactStartParams

type ThreadCompactStartParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadDeleteParams

type ThreadDeleteParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadDeleteResponse

type ThreadDeleteResponse = SanitizedThreadDeleteResponseJSON

type ThreadForkParams

type ThreadForkParams struct {
	ThreadID              string          `json:"threadId"`
	Ephemeral             *bool           `json:"ephemeral,omitempty"`
	Model                 *string         `json:"model,omitempty"`
	ModelProvider         *string         `json:"modelProvider,omitempty"`
	ServiceTier           *string         `json:"serviceTier,omitempty"`
	LastTurnID            *string         `json:"lastTurnId,omitempty"`
	Cwd                   *string         `json:"cwd,omitempty"`
	ApprovalPolicy        json.RawMessage `json:"approvalPolicy,omitempty"`
	Sandbox               json.RawMessage `json:"sandbox,omitempty"`
	Config                *map[string]any `json:"config,omitempty"`
	BaseInstructions      *string         `json:"baseInstructions,omitempty"`
	DeveloperInstructions *string         `json:"developerInstructions,omitempty"`
}

ThreadForkParams is maintained manually because the raw schema currently exceeds the generator's capabilities.

type ThreadForkParamsBaseInstructions added in v0.144.0

type ThreadForkParamsBaseInstructions *string

type ThreadForkParamsConfig added in v0.144.0

type ThreadForkParamsConfig map[string]interface{}

type ThreadForkParamsCwd added in v0.144.0

type ThreadForkParamsCwd *string

type ThreadForkParamsDeveloperInstructions added in v0.144.0

type ThreadForkParamsDeveloperInstructions *string

type ThreadForkParamsLastTurnID added in v0.144.0

type ThreadForkParamsLastTurnID *string

Optional last turn id to fork through, inclusive.

When specified, turns after `last_turn_id` are omitted from the fork. The referenced turn cannot be in progress.

type ThreadForkParamsModel added in v0.144.0

type ThreadForkParamsModel *string

Configuration overrides for the forked thread, if any.

type ThreadForkParamsModelProvider added in v0.144.0

type ThreadForkParamsModelProvider *string

type ThreadForkParamsServiceTier added in v0.144.0

type ThreadForkParamsServiceTier *string

type ThreadForkResponse

type ThreadForkResponse interface{}

type ThreadGoal

type ThreadGoal struct {
	ThreadID        string           `json:"threadId"`
	Objective       string           `json:"objective"`
	Status          ThreadGoalStatus `json:"status"`
	TokenBudget     *int64           `json:"tokenBudget"`
	TokensUsed      int64            `json:"tokensUsed"`
	TimeUsedSeconds int64            `json:"timeUsedSeconds"`
	CreatedAt       int64            `json:"createdAt"`
	UpdatedAt       int64            `json:"updatedAt"`
}

ThreadGoal describes persisted long-running goal metadata for a thread.

type ThreadGoalClearParams

type ThreadGoalClearParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadGoalGetParams

type ThreadGoalGetParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadGoalGetResponse

type ThreadGoalGetResponse struct {
	Goal *ThreadGoal `json:"goal"`
}

ThreadGoalGetResponse is maintained manually because the raw schema currently exceeds the generator's capabilities.

type ThreadGoalSetParams

type ThreadGoalSetParams struct {
	// Objective corresponds to the JSON schema field "objective".
	Objective ThreadGoalSetParamsObjective `json:"objective,omitempty,omitzero"`

	// Status corresponds to the JSON schema field "status".
	Status interface{} `json:"status,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TokenBudget corresponds to the JSON schema field "tokenBudget".
	TokenBudget ThreadGoalSetParamsTokenBudget `json:"tokenBudget,omitempty,omitzero"`
}

type ThreadGoalSetParamsObjective added in v0.144.0

type ThreadGoalSetParamsObjective *string

type ThreadGoalSetParamsTokenBudget added in v0.144.0

type ThreadGoalSetParamsTokenBudget *int

type ThreadGoalSetResponse

type ThreadGoalSetResponse struct {
	Goal ThreadGoal `json:"goal"`
}

ThreadGoalSetResponse is maintained manually because the raw schema currently exceeds the generator's capabilities.

type ThreadGoalStatus

type ThreadGoalStatus string
const ThreadGoalStatusActive ThreadGoalStatus = "active"
const ThreadGoalStatusBlocked ThreadGoalStatus = "blocked"
const ThreadGoalStatusBudgetLimited ThreadGoalStatus = "budgetLimited"
const ThreadGoalStatusComplete ThreadGoalStatus = "complete"
const ThreadGoalStatusPaused ThreadGoalStatus = "paused"
const ThreadGoalStatusUsageLimited ThreadGoalStatus = "usageLimited"

type ThreadGoalUpdatedNotification

type ThreadGoalUpdatedNotification struct {
	ThreadID string     `json:"threadId"`
	TurnID   *string    `json:"turnId"`
	Goal     ThreadGoal `json:"goal"`
}

ThreadGoalUpdatedNotification is the payload for thread/goal/updated.

type ThreadHistoryMode added in v0.144.0

type ThreadHistoryMode string
const ThreadHistoryModeLegacy ThreadHistoryMode = "legacy"
const ThreadHistoryModePaginated ThreadHistoryMode = "paginated"

type ThreadID

type ThreadID string

type ThreadInjectItemsParams

type ThreadInjectItemsParams struct {
	// Raw Responses API items to append to the thread's model-visible history.
	Items []interface{} `json:"items"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadItem added in v0.145.0

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

ThreadItem preserves the complete JSON payload for a discriminated union.

func NewThreadItem added in v0.145.0

func NewThreadItem(value any) (ThreadItem, error)

NewThreadItem validates the discriminator and wraps a JSON-marshalable ThreadItem value.

func (ThreadItem) IsKnown added in v0.145.0

func (value ThreadItem) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ThreadItem) Kind added in v0.145.0

func (value ThreadItem) Kind() ThreadItemKind

Kind returns the payload discriminator, including unknown future values.

func (ThreadItem) MarshalJSON added in v0.145.0

func (value ThreadItem) MarshalJSON() ([]byte, error)

func (ThreadItem) RawJSON added in v0.145.0

func (value ThreadItem) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ThreadItem) UnmarshalJSON added in v0.145.0

func (value *ThreadItem) UnmarshalJSON(data []byte) error

type ThreadItemKind added in v0.145.0

type ThreadItemKind string

ThreadItemKind identifies a known ThreadItem variant.

const (
	ThreadItemKindAgentMessage        ThreadItemKind = "agentMessage"
	ThreadItemKindCollabAgentToolCall ThreadItemKind = "collabAgentToolCall"
	ThreadItemKindCommandExecution    ThreadItemKind = "commandExecution"
	ThreadItemKindContextCompaction   ThreadItemKind = "contextCompaction"
	ThreadItemKindDynamicToolCall     ThreadItemKind = "dynamicToolCall"
	ThreadItemKindEnteredReviewMode   ThreadItemKind = "enteredReviewMode"
	ThreadItemKindExitedReviewMode    ThreadItemKind = "exitedReviewMode"
	ThreadItemKindFileChange          ThreadItemKind = "fileChange"
	ThreadItemKindHookPrompt          ThreadItemKind = "hookPrompt"
	ThreadItemKindImageGeneration     ThreadItemKind = "imageGeneration"
	ThreadItemKindImageView           ThreadItemKind = "imageView"
	ThreadItemKindMcpToolCall         ThreadItemKind = "mcpToolCall"
	ThreadItemKindPlan                ThreadItemKind = "plan"
	ThreadItemKindReasoning           ThreadItemKind = "reasoning"
	ThreadItemKindSleep               ThreadItemKind = "sleep"
	ThreadItemKindSubAgentActivity    ThreadItemKind = "subAgentActivity"
	ThreadItemKindUserMessage         ThreadItemKind = "userMessage"
	ThreadItemKindWebSearch           ThreadItemKind = "webSearch"
)

type ThreadListCwdFilter

type ThreadListCwdFilter interface{}

type ThreadListParams

type ThreadListParams struct {
	// Optional archived filter; when set to true, only archived threads are returned.
	// If false or null, only non-archived threads are returned.
	Archived ThreadListParamsArchived `json:"archived,omitempty,omitzero"`

	// Opaque pagination cursor returned by a previous call.
	Cursor ThreadListParamsCursor `json:"cursor,omitempty,omitzero"`

	// Optional cwd filter or filters; when set, only threads whose session cwd
	// exactly matches one of these paths are returned.
	Cwd interface{} `json:"cwd,omitempty,omitzero"`

	// Optional page size; defaults to a reasonable server-side value.
	Limit ThreadListParamsLimit `json:"limit,omitempty,omitzero"`

	// Optional provider filter; when set, only sessions recorded under these
	// providers are returned. When present but empty, includes all providers.
	ModelProviders *ThreadListParamsModelProviders `json:"modelProviders,omitempty,omitzero"`

	// Optional substring filter for the extracted thread title.
	SearchTerm ThreadListParamsSearchTerm `json:"searchTerm,omitempty,omitzero"`

	// Optional sort direction; defaults to descending (newest first).
	SortDirection interface{} `json:"sortDirection,omitempty,omitzero"`

	// Optional sort key; defaults to created_at.
	SortKey interface{} `json:"sortKey,omitempty,omitzero"`

	// Optional source filter; when set, only sessions from these source kinds are
	// returned. When omitted or empty, defaults to interactive sources.
	SourceKinds *ThreadListParamsSourceKinds `json:"sourceKinds,omitempty,omitzero"`

	// If true, return from the state DB without scanning JSONL rollouts to repair
	// thread metadata. Omitted or false preserves scan-and-repair behavior.
	UseStateDbOnly *bool `json:"useStateDbOnly,omitempty,omitzero"`
}

type ThreadListParamsArchived added in v0.144.0

type ThreadListParamsArchived *bool

Optional archived filter; when set to true, only archived threads are returned. If false or null, only non-archived threads are returned.

type ThreadListParamsCursor added in v0.144.0

type ThreadListParamsCursor *string

Opaque pagination cursor returned by a previous call.

type ThreadListParamsLimit added in v0.144.0

type ThreadListParamsLimit *int

Optional page size; defaults to a reasonable server-side value.

type ThreadListParamsModelProviders added in v0.144.0

type ThreadListParamsModelProviders []string

Optional provider filter; when set, only sessions recorded under these providers are returned. When present but empty, includes all providers.

type ThreadListParamsSearchTerm added in v0.144.0

type ThreadListParamsSearchTerm *string

Optional substring filter for the extracted thread title.

type ThreadListParamsSourceKinds added in v0.144.0

type ThreadListParamsSourceKinds []ThreadSourceKind

Optional source filter; when set, only sessions from these source kinds are returned. When omitted or empty, defaults to interactive sources.

type ThreadListResponse

type ThreadListResponse interface{}

type ThreadLoadedListParams

type ThreadLoadedListParams struct {
	// Opaque pagination cursor returned by a previous call.
	Cursor ThreadLoadedListParamsCursor `json:"cursor,omitempty,omitzero"`

	// Optional page size; defaults to no limit.
	Limit ThreadLoadedListParamsLimit `json:"limit,omitempty,omitzero"`
}

type ThreadLoadedListParamsCursor added in v0.144.0

type ThreadLoadedListParamsCursor *string

Opaque pagination cursor returned by a previous call.

type ThreadLoadedListParamsLimit added in v0.144.0

type ThreadLoadedListParamsLimit *int

Optional page size; defaults to no limit.

type ThreadMemoryMode added in v0.144.0

type ThreadMemoryMode string
const ThreadMemoryModeDisabled ThreadMemoryMode = "disabled"
const ThreadMemoryModeEnabled ThreadMemoryMode = "enabled"

type ThreadMetadataGitInfoUpdateParams

type ThreadMetadataGitInfoUpdateParams struct {
	// Omit to leave the stored branch unchanged, set to `null` to clear it, or
	// provide a non-empty string to replace it.
	Branch ThreadMetadataGitInfoUpdateParamsBranch `json:"branch,omitempty,omitzero"`

	// Omit to leave the stored origin URL unchanged, set to `null` to clear it, or
	// provide a non-empty string to replace it.
	OriginURL ThreadMetadataGitInfoUpdateParamsOriginURL `json:"originUrl,omitempty,omitzero"`

	// Omit to leave the stored commit unchanged, set to `null` to clear it, or
	// provide a non-empty string to replace it.
	Sha ThreadMetadataGitInfoUpdateParamsSha `json:"sha,omitempty,omitzero"`
}

type ThreadMetadataGitInfoUpdateParamsBranch added in v0.144.0

type ThreadMetadataGitInfoUpdateParamsBranch *string

Omit to leave the stored branch unchanged, set to `null` to clear it, or provide a non-empty string to replace it.

type ThreadMetadataGitInfoUpdateParamsOriginURL added in v0.144.0

type ThreadMetadataGitInfoUpdateParamsOriginURL *string

Omit to leave the stored origin URL unchanged, set to `null` to clear it, or provide a non-empty string to replace it.

type ThreadMetadataGitInfoUpdateParamsSha added in v0.144.0

type ThreadMetadataGitInfoUpdateParamsSha *string

Omit to leave the stored commit unchanged, set to `null` to clear it, or provide a non-empty string to replace it.

type ThreadMetadataUpdateParams

type ThreadMetadataUpdateParams struct {
	// Patch the stored Git metadata for this thread. Omit a field to leave it
	// unchanged, set it to `null` to clear it, or provide a string to replace the
	// stored value.
	GitInfo interface{} `json:"gitInfo,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadMetadataUpdateResponse

type ThreadMetadataUpdateResponse interface{}

type ThreadReadParams

type ThreadReadParams struct {
	// When true, include turns and their items from rollout history.
	IncludeTurns *bool `json:"includeTurns,omitempty,omitzero"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadReadResponse

type ThreadReadResponse interface{}

type ThreadRealtimeAudioChunk

type ThreadRealtimeAudioChunk struct {
	// Data corresponds to the JSON schema field "data".
	Data string `json:"data"`

	// ItemID corresponds to the JSON schema field "itemId".
	ItemID ThreadRealtimeAudioChunkItemID `json:"itemId,omitempty,omitzero"`

	// NumChannels corresponds to the JSON schema field "numChannels".
	NumChannels int `json:"numChannels"`

	// SampleRate corresponds to the JSON schema field "sampleRate".
	SampleRate int `json:"sampleRate"`

	// SamplesPerChannel corresponds to the JSON schema field "samplesPerChannel".
	SamplesPerChannel ThreadRealtimeAudioChunkSamplesPerChannel `json:"samplesPerChannel,omitempty,omitzero"`
}

EXPERIMENTAL - thread realtime audio chunk.

type ThreadRealtimeAudioChunkItemID added in v0.144.0

type ThreadRealtimeAudioChunkItemID *string

type ThreadRealtimeAudioChunkSamplesPerChannel added in v0.144.0

type ThreadRealtimeAudioChunkSamplesPerChannel *int

type ThreadRealtimeStartTransport added in v0.144.0

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

ThreadRealtimeStartTransport preserves the complete JSON payload for a discriminated union.

func NewThreadRealtimeStartTransport added in v0.145.0

func NewThreadRealtimeStartTransport(value any) (ThreadRealtimeStartTransport, error)

NewThreadRealtimeStartTransport validates the discriminator and wraps a JSON-marshalable ThreadRealtimeStartTransport value.

func (ThreadRealtimeStartTransport) IsKnown added in v0.145.0

func (value ThreadRealtimeStartTransport) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ThreadRealtimeStartTransport) Kind added in v0.145.0

Kind returns the payload discriminator, including unknown future values.

func (ThreadRealtimeStartTransport) MarshalJSON added in v0.145.0

func (value ThreadRealtimeStartTransport) MarshalJSON() ([]byte, error)

func (ThreadRealtimeStartTransport) RawJSON added in v0.145.0

RawJSON returns a copy of the complete union payload.

func (*ThreadRealtimeStartTransport) UnmarshalJSON added in v0.145.0

func (value *ThreadRealtimeStartTransport) UnmarshalJSON(data []byte) error

type ThreadRealtimeStartTransportKind added in v0.145.0

type ThreadRealtimeStartTransportKind string

ThreadRealtimeStartTransportKind identifies a known ThreadRealtimeStartTransport variant.

const (
	ThreadRealtimeStartTransportKindWebrtc    ThreadRealtimeStartTransportKind = "webrtc"
	ThreadRealtimeStartTransportKindWebsocket ThreadRealtimeStartTransportKind = "websocket"
)

type ThreadResponse

type ThreadResponse struct {
	ThreadID string  `json:"threadId,omitempty"`
	Thread   *Thread `json:"thread,omitempty"`
}

ThreadResponse is the shared shape for thread/start and thread/resume responses.

type ThreadResumeInitialTurnsPageParams added in v0.144.0

type ThreadResumeInitialTurnsPageParams struct {
	// How much item detail to include for each returned turn; defaults to summary.
	ItemsView interface{} `json:"itemsView,omitempty,omitzero"`

	// Optional turn page size.
	Limit ThreadResumeInitialTurnsPageParamsLimit `json:"limit,omitempty,omitzero"`

	// Optional turn pagination direction; defaults to descending.
	SortDirection interface{} `json:"sortDirection,omitempty,omitzero"`
}

type ThreadResumeInitialTurnsPageParamsLimit added in v0.144.0

type ThreadResumeInitialTurnsPageParamsLimit *int

Optional turn page size.

type ThreadResumeParams

type ThreadResumeParams struct {
	ThreadID              string          `json:"threadId"`
	Model                 *string         `json:"model,omitempty"`
	ModelProvider         *string         `json:"modelProvider,omitempty"`
	ServiceTier           *string         `json:"serviceTier,omitempty"`
	Cwd                   *string         `json:"cwd,omitempty"`
	ApprovalPolicy        json.RawMessage `json:"approvalPolicy,omitempty"`
	Sandbox               json.RawMessage `json:"sandbox,omitempty"`
	Config                *map[string]any `json:"config,omitempty"`
	BaseInstructions      *string         `json:"baseInstructions,omitempty"`
	DeveloperInstructions *string         `json:"developerInstructions,omitempty"`
}

ThreadResumeParams is maintained manually because the raw schema currently exceeds the generator's capabilities.

type ThreadResumeParamsBaseInstructions added in v0.144.0

type ThreadResumeParamsBaseInstructions *string

type ThreadResumeParamsConfig added in v0.144.0

type ThreadResumeParamsConfig map[string]interface{}

type ThreadResumeParamsCwd added in v0.144.0

type ThreadResumeParamsCwd *string

type ThreadResumeParamsDeveloperInstructions added in v0.144.0

type ThreadResumeParamsDeveloperInstructions *string

type ThreadResumeParamsModel added in v0.144.0

type ThreadResumeParamsModel *string

Configuration overrides for the resumed thread, if any.

type ThreadResumeParamsModelProvider added in v0.144.0

type ThreadResumeParamsModelProvider *string

type ThreadResumeParamsServiceTier added in v0.144.0

type ThreadResumeParamsServiceTier *string

type ThreadResumeResponse

type ThreadResumeResponse = ThreadResponse

ThreadResumeResponse is the response payload for thread/resume.

type ThreadRollbackParams

type ThreadRollbackParams struct {
	// The number of turns to drop from the end of the thread. Must be >= 1.
	//
	// This only modifies the thread's history and does not revert local file changes
	// that have been made by the agent. Clients are responsible for reverting these
	// changes.
	NumTurns int `json:"numTurns"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

DEPRECATED: `thread/rollback` will be removed soon.

type ThreadRollbackResponse

type ThreadRollbackResponse interface{}

type ThreadSetNameParams

type ThreadSetNameParams struct {
	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadSetNameResponse

type ThreadSetNameResponse = SanitizedThreadSetNameResponseJSON

type ThreadSettingsUpdatedNotification

type ThreadSettingsUpdatedNotification interface{}

type ThreadShellCommandParams

type ThreadShellCommandParams struct {
	// Shell command string evaluated by the thread's configured shell. Unlike
	// `command/exec`, this intentionally preserves shell syntax such as pipes,
	// redirects, and quoting. This runs unsandboxed with full access rather than
	// inheriting the thread sandbox policy.
	Command string `json:"command"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadSortKey

type ThreadSortKey string
const ThreadSortKeyCreatedAt ThreadSortKey = "created_at"
const ThreadSortKeyRecencyAt ThreadSortKey = "recency_at"
const ThreadSortKeyUpdatedAt ThreadSortKey = "updated_at"

type ThreadSource added in v0.144.0

type ThreadSource string

type ThreadSourceKind

type ThreadSourceKind string
const ThreadSourceKindAppServer ThreadSourceKind = "appServer"
const ThreadSourceKindCli ThreadSourceKind = "cli"
const ThreadSourceKindExec ThreadSourceKind = "exec"
const ThreadSourceKindSubAgent ThreadSourceKind = "subAgent"
const ThreadSourceKindSubAgentCompact ThreadSourceKind = "subAgentCompact"
const ThreadSourceKindSubAgentOther ThreadSourceKind = "subAgentOther"
const ThreadSourceKindSubAgentReview ThreadSourceKind = "subAgentReview"
const ThreadSourceKindSubAgentThreadSpawn ThreadSourceKind = "subAgentThreadSpawn"
const ThreadSourceKindUnknown ThreadSourceKind = "unknown"
const ThreadSourceKindVscode ThreadSourceKind = "vscode"

type ThreadStartParams

type ThreadStartParams struct {
	Model                 *string         `json:"model,omitempty"`
	ModelProvider         *string         `json:"modelProvider,omitempty"`
	ServiceTier           *string         `json:"serviceTier,omitempty"`
	Cwd                   *string         `json:"cwd,omitempty"`
	ApprovalPolicy        json.RawMessage `json:"approvalPolicy,omitempty"`
	Sandbox               json.RawMessage `json:"sandbox,omitempty"`
	Config                *map[string]any `json:"config,omitempty"`
	ServiceName           *string         `json:"serviceName,omitempty"`
	BaseInstructions      *string         `json:"baseInstructions,omitempty"`
	DeveloperInstructions *string         `json:"developerInstructions,omitempty"`
	Ephemeral             *bool           `json:"ephemeral,omitempty"`
}

ThreadStartParams is maintained manually because the raw schema currently exceeds the generator's capabilities.

type ThreadStartParamsBaseInstructions added in v0.144.0

type ThreadStartParamsBaseInstructions *string

type ThreadStartParamsConfig added in v0.144.0

type ThreadStartParamsConfig map[string]interface{}

type ThreadStartParamsCwd added in v0.144.0

type ThreadStartParamsCwd *string

type ThreadStartParamsDeveloperInstructions added in v0.144.0

type ThreadStartParamsDeveloperInstructions *string

type ThreadStartParamsEphemeral added in v0.144.0

type ThreadStartParamsEphemeral *bool

type ThreadStartParamsModel added in v0.144.0

type ThreadStartParamsModel *string

type ThreadStartParamsModelProvider added in v0.144.0

type ThreadStartParamsModelProvider *string

type ThreadStartParamsServiceName added in v0.144.0

type ThreadStartParamsServiceName *string

type ThreadStartParamsServiceTier added in v0.144.0

type ThreadStartParamsServiceTier *string

type ThreadStartResponse

type ThreadStartResponse = ThreadResponse

ThreadStartResponse is the response payload for thread/start.

type ThreadStartSource added in v0.144.0

type ThreadStartSource string
const ThreadStartSourceClear ThreadStartSource = "clear"
const ThreadStartSourceStartup ThreadStartSource = "startup"

type ThreadStartedNotification

type ThreadStartedNotification interface{}

type ThreadStatus

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

ThreadStatus preserves the complete JSON payload for a discriminated union.

func NewThreadStatus added in v0.145.0

func NewThreadStatus(value any) (ThreadStatus, error)

NewThreadStatus validates the discriminator and wraps a JSON-marshalable ThreadStatus value.

func (ThreadStatus) IsKnown added in v0.145.0

func (value ThreadStatus) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (ThreadStatus) Kind added in v0.145.0

func (value ThreadStatus) Kind() ThreadStatusKind

Kind returns the payload discriminator, including unknown future values.

func (ThreadStatus) MarshalJSON added in v0.145.0

func (value ThreadStatus) MarshalJSON() ([]byte, error)

func (ThreadStatus) RawJSON added in v0.145.0

func (value ThreadStatus) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ThreadStatus) UnmarshalJSON added in v0.145.0

func (value *ThreadStatus) UnmarshalJSON(data []byte) error

type ThreadStatusKind added in v0.145.0

type ThreadStatusKind string

ThreadStatusKind identifies a known ThreadStatus variant.

const (
	ThreadStatusKindActive      ThreadStatusKind = "active"
	ThreadStatusKindIdle        ThreadStatusKind = "idle"
	ThreadStatusKindNotLoaded   ThreadStatusKind = "notLoaded"
	ThreadStatusKindSystemError ThreadStatusKind = "systemError"
)

type ThreadTokenUsage

type ThreadTokenUsage struct {
	// Last corresponds to the JSON schema field "last".
	Last TokenUsageBreakdown `json:"last"`

	// ModelContextWindow corresponds to the JSON schema field "modelContextWindow".
	ModelContextWindow ThreadTokenUsageModelContextWindow `json:"modelContextWindow,omitempty,omitzero"`

	// Total corresponds to the JSON schema field "total".
	Total TokenUsageBreakdown `json:"total"`
}

type ThreadTokenUsageModelContextWindow added in v0.144.0

type ThreadTokenUsageModelContextWindow *int

type ThreadUnarchiveParams

type ThreadUnarchiveParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadUnarchiveResponse

type ThreadUnarchiveResponse interface{}

type ThreadUnsubscribeParams

type ThreadUnsubscribeParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type ThreadUnsubscribeStatus

type ThreadUnsubscribeStatus string
const ThreadUnsubscribeStatusNotLoaded ThreadUnsubscribeStatus = "notLoaded"
const ThreadUnsubscribeStatusNotSubscribed ThreadUnsubscribeStatus = "notSubscribed"
const ThreadUnsubscribeStatusUnsubscribed ThreadUnsubscribeStatus = "unsubscribed"

type TokenUsageBreakdown

type TokenUsageBreakdown struct {
	// CachedInputTokens corresponds to the JSON schema field "cachedInputTokens".
	CachedInputTokens int `json:"cachedInputTokens"`

	// InputTokens corresponds to the JSON schema field "inputTokens".
	InputTokens int `json:"inputTokens"`

	// OutputTokens corresponds to the JSON schema field "outputTokens".
	OutputTokens int `json:"outputTokens"`

	// ReasoningOutputTokens corresponds to the JSON schema field
	// "reasoningOutputTokens".
	ReasoningOutputTokens int `json:"reasoningOutputTokens"`

	// TotalTokens corresponds to the JSON schema field "totalTokens".
	TotalTokens int `json:"totalTokens"`
}

type Tool

type Tool struct {
	// Meta corresponds to the JSON schema field "_meta".
	Meta interface{} `json:"_meta,omitempty,omitzero"`

	// Annotations corresponds to the JSON schema field "annotations".
	Annotations interface{} `json:"annotations,omitempty,omitzero"`

	// Description corresponds to the JSON schema field "description".
	Description ToolDescription `json:"description,omitempty,omitzero"`

	// Icons corresponds to the JSON schema field "icons".
	Icons *ToolIcons `json:"icons,omitempty,omitzero"`

	// InputSchema corresponds to the JSON schema field "inputSchema".
	InputSchema interface{} `json:"inputSchema"`

	// Name corresponds to the JSON schema field "name".
	Name string `json:"name"`

	// OutputSchema corresponds to the JSON schema field "outputSchema".
	OutputSchema interface{} `json:"outputSchema,omitempty,omitzero"`

	// Title corresponds to the JSON schema field "title".
	Title ToolTitle `json:"title,omitempty,omitzero"`
}

Definition for a tool the client can call.

type ToolDescription added in v0.144.0

type ToolDescription *string

type ToolIcons added in v0.144.0

type ToolIcons []interface{}

type ToolRequestUserInputAnswer

type ToolRequestUserInputAnswer struct {
	// Answers corresponds to the JSON schema field "answers".
	Answers []string `json:"answers"`
}

EXPERIMENTAL. Captures a user's answer to a request_user_input question.

type ToolRequestUserInputOption

type ToolRequestUserInputOption struct {
	// Description corresponds to the JSON schema field "description".
	Description string `json:"description"`

	// Label corresponds to the JSON schema field "label".
	Label string `json:"label"`
}

EXPERIMENTAL. Defines a single selectable option for request_user_input.

type ToolRequestUserInputParams

type ToolRequestUserInputParams = SanitizedToolRequestUserInputParams

ToolRequestUserInputParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type ToolRequestUserInputQuestion

type ToolRequestUserInputQuestion struct {
	// Header corresponds to the JSON schema field "header".
	Header string `json:"header"`

	// ID corresponds to the JSON schema field "id".
	ID string `json:"id"`

	// IsOther corresponds to the JSON schema field "isOther".
	IsOther bool `json:"isOther,omitempty,omitzero"`

	// IsSecret corresponds to the JSON schema field "isSecret".
	IsSecret bool `json:"isSecret,omitempty,omitzero"`

	// Options corresponds to the JSON schema field "options".
	Options *ToolRequestUserInputQuestionOptions `json:"options,omitempty,omitzero"`

	// Question corresponds to the JSON schema field "question".
	Question string `json:"question"`
}

EXPERIMENTAL. Represents one request_user_input question and its required options.

type ToolRequestUserInputQuestionOptions added in v0.144.0

type ToolRequestUserInputQuestionOptions []ToolRequestUserInputOption

type ToolRequestUserInputResponse

type ToolRequestUserInputResponse = SanitizedToolRequestUserInputResponse

ToolRequestUserInputResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.

type ToolTitle added in v0.144.0

type ToolTitle *string

type TurnCompletedNotification

type TurnCompletedNotification = TurnNotification

TurnCompletedNotification is the payload for turn/completed.

type TurnEnvironmentParams added in v0.144.0

type TurnEnvironmentParams struct {
	// Cwd corresponds to the JSON schema field "cwd".
	Cwd LegacyAppPathString `json:"cwd"`

	// EnvironmentID corresponds to the JSON schema field "environmentId".
	EnvironmentID string `json:"environmentId"`
}

type TurnError

type TurnError struct {
	// AdditionalDetails corresponds to the JSON schema field "additionalDetails".
	AdditionalDetails TurnErrorAdditionalDetails `json:"additionalDetails,omitempty,omitzero"`

	// CodexErrorInfo corresponds to the JSON schema field "codexErrorInfo".
	CodexErrorInfo interface{} `json:"codexErrorInfo,omitempty,omitzero"`

	// Message corresponds to the JSON schema field "message".
	Message string `json:"message"`
}

type TurnErrorAdditionalDetails added in v0.144.0

type TurnErrorAdditionalDetails *string

type TurnInterruptParams

type TurnInterruptParams struct {
	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`

	// TurnID corresponds to the JSON schema field "turnId".
	TurnID string `json:"turnId"`
}

type TurnInterruptResponse

type TurnInterruptResponse = SanitizedTurnInterruptResponseJSON

type TurnItemsView added in v0.144.0

type TurnItemsView interface{}

type TurnNotification

type TurnNotification struct {
	ThreadID string                `json:"threadId,omitempty"`
	Turn     *TurnNotificationTurn `json:"turn,omitempty"`
}

TurnNotification describes turn/started and turn/completed notifications.

type TurnNotificationError

type TurnNotificationError struct {
	Message string `json:"message,omitempty"`
}

TurnNotificationError describes a turn error payload.

type TurnNotificationTurn

type TurnNotificationTurn struct {
	ID     string                 `json:"id,omitempty"`
	Status string                 `json:"status,omitempty"`
	Error  *TurnNotificationError `json:"error,omitempty"`
}

TurnNotificationTurn describes a turn summary in notifications.

type TurnPlanStep

type TurnPlanStep struct {
	// Status corresponds to the JSON schema field "status".
	Status TurnPlanStepStatus `json:"status"`

	// Step corresponds to the JSON schema field "step".
	Step string `json:"step"`
}

type TurnPlanStepStatus

type TurnPlanStepStatus string
const TurnPlanStepStatusCompleted TurnPlanStepStatus = "completed"
const TurnPlanStepStatusInProgress TurnPlanStepStatus = "inProgress"
const TurnPlanStepStatusPending TurnPlanStepStatus = "pending"

type TurnStartParams

type TurnStartParams struct {
	ThreadID            string                     `json:"threadId"`
	Input               []TurnStartParamsInputElem `json:"input"`
	ClientUserMessageID *string                    `json:"clientUserMessageId,omitempty"`
	Cwd                 *string                    `json:"cwd,omitempty"`
	ApprovalPolicy      json.RawMessage            `json:"approvalPolicy,omitempty"`
	SandboxPolicy       json.RawMessage            `json:"sandboxPolicy,omitempty"`
	Model               *string                    `json:"model,omitempty"`
	ServiceTier         *string                    `json:"serviceTier,omitempty"`
	Effort              json.RawMessage            `json:"effort,omitempty"`
	Summary             json.RawMessage            `json:"summary,omitempty"`
	OutputSchema        json.RawMessage            `json:"outputSchema,omitempty"`
}

TurnStartParams is maintained manually because the raw schema currently exceeds the generator's capabilities.

type TurnStartParamsClientUserMessageID added in v0.144.0

type TurnStartParamsClientUserMessageID *string

type TurnStartParamsCwd added in v0.144.0

type TurnStartParamsCwd *string

Override the working directory for this turn and subsequent turns.

type TurnStartParamsInputElem

type TurnStartParamsInputElem interface{}

TurnStartParamsInputElem is maintained manually because turn input entries are represented by the high-level codex.Input type before marshaling.

type TurnStartParamsModel added in v0.144.0

type TurnStartParamsModel *string

Override the model for this turn and subsequent turns.

type TurnStartParamsServiceTier added in v0.144.0

type TurnStartParamsServiceTier *string

Override the service tier for this turn and subsequent turns.

type TurnStartResponse

type TurnStartResponse interface{}

type TurnStartedNotification

type TurnStartedNotification = TurnNotification

TurnStartedNotification is the payload for turn/started.

type TurnSteerParams

type TurnSteerParams struct {
	// ClientUserMessageID corresponds to the JSON schema field "clientUserMessageId".
	ClientUserMessageID TurnSteerParamsClientUserMessageID `json:"clientUserMessageId,omitempty,omitzero"`

	// Required active turn id precondition. The request fails when it does not match
	// the currently active turn.
	ExpectedTurnID string `json:"expectedTurnId"`

	// Input corresponds to the JSON schema field "input".
	Input []UserInput `json:"input"`

	// ThreadID corresponds to the JSON schema field "threadId".
	ThreadID string `json:"threadId"`
}

type TurnSteerParamsClientUserMessageID added in v0.144.0

type TurnSteerParamsClientUserMessageID *string

type TurnSteerParamsInputElem

type TurnSteerParamsInputElem = UserInput

TurnSteerParamsInputElem is retained for source compatibility.

type TurnSteerResponse

type TurnSteerResponse = SanitizedTurnSteerResponseJSON

type UserInput

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

UserInput preserves the complete JSON payload for a discriminated union.

func NewUserInput added in v0.145.0

func NewUserInput(value any) (UserInput, error)

NewUserInput validates the discriminator and wraps a JSON-marshalable UserInput value.

func (UserInput) IsKnown added in v0.145.0

func (value UserInput) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (UserInput) Kind added in v0.145.0

func (value UserInput) Kind() UserInputKind

Kind returns the payload discriminator, including unknown future values.

func (UserInput) MarshalJSON added in v0.145.0

func (value UserInput) MarshalJSON() ([]byte, error)

func (UserInput) RawJSON added in v0.145.0

func (value UserInput) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*UserInput) UnmarshalJSON added in v0.145.0

func (value *UserInput) UnmarshalJSON(data []byte) error

type UserInputKind added in v0.145.0

type UserInputKind string

UserInputKind identifies a known UserInput variant.

const (
	UserInputKindImage      UserInputKind = "image"
	UserInputKindLocalImage UserInputKind = "localImage"
	UserInputKindMention    UserInputKind = "mention"
	UserInputKindSkill      UserInputKind = "skill"
	UserInputKindText       UserInputKind = "text"
)

type WarningNotification

type WarningNotification = SanitizedWarningNotificationJSON

type WebSearchAction added in v0.145.0

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

WebSearchAction preserves the complete JSON payload for a discriminated union.

func NewWebSearchAction added in v0.145.0

func NewWebSearchAction(value any) (WebSearchAction, error)

NewWebSearchAction validates the discriminator and wraps a JSON-marshalable WebSearchAction value.

func (WebSearchAction) IsKnown added in v0.145.0

func (value WebSearchAction) IsKnown() bool

IsKnown reports whether the discriminator was present in the generation schema.

func (WebSearchAction) Kind added in v0.145.0

func (value WebSearchAction) Kind() WebSearchActionKind

Kind returns the payload discriminator, including unknown future values.

func (WebSearchAction) MarshalJSON added in v0.145.0

func (value WebSearchAction) MarshalJSON() ([]byte, error)

func (WebSearchAction) RawJSON added in v0.145.0

func (value WebSearchAction) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*WebSearchAction) UnmarshalJSON added in v0.145.0

func (value *WebSearchAction) UnmarshalJSON(data []byte) error

type WebSearchActionKind added in v0.145.0

type WebSearchActionKind string

WebSearchActionKind identifies a known WebSearchAction variant.

const (
	WebSearchActionKindFindInPage WebSearchActionKind = "findInPage"
	WebSearchActionKindOpenPage   WebSearchActionKind = "openPage"
	WebSearchActionKindOther      WebSearchActionKind = "other"
	WebSearchActionKindSearch     WebSearchActionKind = "search"
)

type WebSearchMode

type WebSearchMode string
const WebSearchModeCached WebSearchMode = "cached"
const WebSearchModeDisabled WebSearchMode = "disabled"
const WebSearchModeIndexed WebSearchMode = "indexed"
const WebSearchModeLive WebSearchMode = "live"

type WindowsSandboxReadiness

type WindowsSandboxReadiness string
const WindowsSandboxReadinessNotConfigured WindowsSandboxReadiness = "notConfigured"
const WindowsSandboxReadinessReady WindowsSandboxReadiness = "ready"
const WindowsSandboxReadinessUpdateRequired WindowsSandboxReadiness = "updateRequired"

type WindowsSandboxSetupMode

type WindowsSandboxSetupMode string
const WindowsSandboxSetupModeElevated WindowsSandboxSetupMode = "elevated"
const WindowsSandboxSetupModeUnelevated WindowsSandboxSetupMode = "unelevated"

type WindowsSandboxSetupStartParams

type WindowsSandboxSetupStartParams struct {
	// Cwd corresponds to the JSON schema field "cwd".
	Cwd interface{} `json:"cwd,omitempty,omitzero"`

	// Mode corresponds to the JSON schema field "mode".
	Mode WindowsSandboxSetupMode `json:"mode"`
}

type WorkspaceMessage

type WorkspaceMessage struct {
	// Unix timestamp (in seconds) when the message was archived.
	ArchivedAt WorkspaceMessageArchivedAt `json:"archivedAt,omitempty,omitzero"`

	// Unix timestamp (in seconds) when the message was created.
	CreatedAt WorkspaceMessageCreatedAt `json:"createdAt,omitempty,omitzero"`

	// MessageBody corresponds to the JSON schema field "messageBody".
	MessageBody string `json:"messageBody"`

	// MessageID corresponds to the JSON schema field "messageId".
	MessageID string `json:"messageId"`

	// MessageType corresponds to the JSON schema field "messageType".
	MessageType WorkspaceMessageType `json:"messageType"`
}

type WorkspaceMessageArchivedAt added in v0.144.0

type WorkspaceMessageArchivedAt *int

Unix timestamp (in seconds) when the message was archived.

type WorkspaceMessageCreatedAt added in v0.144.0

type WorkspaceMessageCreatedAt *int

Unix timestamp (in seconds) when the message was created.

type WorkspaceMessageType

type WorkspaceMessageType string
const WorkspaceMessageTypeAnnouncement WorkspaceMessageType = "announcement"
const WorkspaceMessageTypeHeadline WorkspaceMessageType = "headline"
const WorkspaceMessageTypeUnknown WorkspaceMessageType = "unknown"

Jump to

Keyboard shortcuts

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