protocol

package
v0.147.0 Latest Latest
Warning

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

 Go to latest Published: Aug 13, 2026 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Overview

Package protocol contains the app-server wire model generated from the Codex release identified by GeneratedCodexVersion and GeneratedCodexCommit.

Prefer canonical exported names such as MCPServerOAuthLoginParams. Deprecated aliases preserve older acronym spellings for a migration window. Types named Sanitized...JSON are generator implementation details retained for source compatibility; application code should use the corresponding canonical alias. Legacy acronym spellings such as Mcp... and Oauth... are also deprecated in favor of MCP... and OAuth....

Discriminated unions such as ThreadItem preserve their complete JSON payload and expose Kind, IsKnown, and RawJSON. Unknown future variants therefore round trip without forcing callers to depend on generator implementation structs. Mixed approval decisions use validated raw-preserving wrappers with checked and Must constructors. Fixed choices such as thread sorting and file-change decisions use named string types and constants.

Index

Constants

View Source 
const ClientRequestKindConfigMcpServerReload = ClientRequestKindConfigMCPServerReload

ClientRequestKindConfigMcpServerReload is the former spelling of ClientRequestKindConfigMCPServerReload.

Deprecated: use ClientRequestKindConfigMCPServerReload.

View Source 
const ClientRequestKindMcpServerOauthLogin = ClientRequestKindMCPServerOAuthLogin

ClientRequestKindMcpServerOauthLogin is the former spelling of ClientRequestKindMCPServerOAuthLogin.

Deprecated: use ClientRequestKindMCPServerOAuthLogin.

View Source 
const ClientRequestKindMcpServerResourceRead = ClientRequestKindMCPServerResourceRead

ClientRequestKindMcpServerResourceRead is the former spelling of ClientRequestKindMCPServerResourceRead.

Deprecated: use ClientRequestKindMCPServerResourceRead.

View Source 
const ClientRequestKindMcpServerStatusList = ClientRequestKindMCPServerStatusList

ClientRequestKindMcpServerStatusList is the former spelling of ClientRequestKindMCPServerStatusList.

Deprecated: use ClientRequestKindMCPServerStatusList.

View Source 
const ClientRequestKindMcpServerToolCall = ClientRequestKindMCPServerToolCall

ClientRequestKindMcpServerToolCall is the former spelling of ClientRequestKindMCPServerToolCall.

Deprecated: use ClientRequestKindMCPServerToolCall.

View Source 
const GeneratedCodexCommit = "be6e8eac029b183056b7e4402879f15d2c85f61b"

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

View Source 
const GeneratedCodexVersion = "0.147.0"

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

View Source 
const GuardianApprovalReviewActionKindMcpToolCall = GuardianApprovalReviewActionKindMCPToolCall

GuardianApprovalReviewActionKindMcpToolCall is the former spelling of GuardianApprovalReviewActionKindMCPToolCall.

Deprecated: use GuardianApprovalReviewActionKindMCPToolCall.

View Source 
const ServerNotificationKindItemMcpToolCallProgress = ServerNotificationKindItemMCPToolCallProgress

ServerNotificationKindItemMcpToolCallProgress is the former spelling of ServerNotificationKindItemMCPToolCallProgress.

Deprecated: use ServerNotificationKindItemMCPToolCallProgress.

View Source 
const ServerNotificationKindMcpServerOauthLoginCompleted = ServerNotificationKindMCPServerOAuthLoginCompleted

ServerNotificationKindMcpServerOauthLoginCompleted is the former spelling of ServerNotificationKindMCPServerOAuthLoginCompleted.

Deprecated: use ServerNotificationKindMCPServerOAuthLoginCompleted.

View Source 
const ServerNotificationKindMcpServerStartupStatusUpdated = ServerNotificationKindMCPServerStartupStatusUpdated

ServerNotificationKindMcpServerStartupStatusUpdated is the former spelling of ServerNotificationKindMCPServerStartupStatusUpdated.

Deprecated: use ServerNotificationKindMCPServerStartupStatusUpdated.

View Source 
const ServerRequestKindMcpServerElicitationRequest = ServerRequestKindMCPServerElicitationRequest

ServerRequestKindMcpServerElicitationRequest is the former spelling of ServerRequestKindMCPServerElicitationRequest.

Deprecated: use ServerRequestKindMCPServerElicitationRequest.

View Source 
const ThreadItemKindMcpToolCall = ThreadItemKindMCPToolCall

ThreadItemKindMcpToolCall is the former spelling of ThreadItemKindMCPToolCall.

Deprecated: use ThreadItemKindMCPToolCall.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbsolutePathBuf 

type AbsolutePathBuf string

AbsolutePathBuf represents a generated Codex app-server protocol type. 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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type AccountKind added in v0.145.0 

type AccountKind string

AccountKind identifies a known Account variant. 

const (
	// AccountKindAmazonBedrock is a generated Codex app-server protocol constant.
	AccountKindAmazonBedrock AccountKind = "amazonBedrock"
	// AccountKindApiKey is a generated Codex app-server protocol constant.
	AccountKindApiKey AccountKind = "apiKey"
	// AccountKindChatgpt is a generated Codex app-server protocol constant.
	AccountKindChatgpt AccountKind = "chatgpt"
)

type AccountLoginCompletedNotification 

type AccountLoginCompletedNotification = SanitizedAccountLoginCompletedNotificationJSON

AccountLoginCompletedNotification is a generated alias for a Codex app-server protocol type. Fallback types for schemas that failed to generate.

type AccountRateLimitsUpdatedNotification 

type AccountRateLimitsUpdatedNotification = SanitizedAccountRateLimitsUpdatedNotificationJSON

AccountRateLimitsUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

AccountTokenUsageDailyBucket represents a generated Codex app-server protocol type.

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"`
}

AccountTokenUsageSummary represents a generated Codex app-server protocol type.

type AccountTokenUsageSummaryCurrentStreakDays added in v0.144.0 

type AccountTokenUsageSummaryCurrentStreakDays *int

AccountTokenUsageSummaryCurrentStreakDays represents a generated Codex app-server protocol type.

type AccountTokenUsageSummaryLifetimeTokens added in v0.144.0 

type AccountTokenUsageSummaryLifetimeTokens *int

AccountTokenUsageSummaryLifetimeTokens represents a generated Codex app-server protocol type.

type AccountTokenUsageSummaryLongestRunningTurnSec added in v0.144.0 

type AccountTokenUsageSummaryLongestRunningTurnSec *int

AccountTokenUsageSummaryLongestRunningTurnSec represents a generated Codex app-server protocol type.

type AccountTokenUsageSummaryLongestStreakDays added in v0.144.0 

type AccountTokenUsageSummaryLongestStreakDays *int

AccountTokenUsageSummaryLongestStreakDays represents a generated Codex app-server protocol type.

type AccountTokenUsageSummaryPeakDailyTokens added in v0.144.0 

type AccountTokenUsageSummaryPeakDailyTokens *int

AccountTokenUsageSummaryPeakDailyTokens represents a generated Codex app-server protocol type.

type AccountUpdatedNotification 

type AccountUpdatedNotification = SanitizedAccountUpdatedNotificationJSON

AccountUpdatedNotification is a generated alias for a Codex app-server protocol type.

type AddCreditsNudgeCreditType 

type AddCreditsNudgeCreditType string

AddCreditsNudgeCreditType represents a generated Codex app-server protocol type. 

const AddCreditsNudgeCreditTypeCredits AddCreditsNudgeCreditType = "credits"

AddCreditsNudgeCreditTypeCredits is a generated Codex app-server protocol constant. 

const AddCreditsNudgeCreditTypeUsageLimit AddCreditsNudgeCreditType = "usage_limit"

AddCreditsNudgeCreditTypeUsageLimit is a generated Codex app-server protocol constant.

type AddCreditsNudgeEmailStatus 

type AddCreditsNudgeEmailStatus string

AddCreditsNudgeEmailStatus represents a generated Codex app-server protocol type. 

const AddCreditsNudgeEmailStatusCooldownActive AddCreditsNudgeEmailStatus = "cooldown_active"

AddCreditsNudgeEmailStatusCooldownActive is a generated Codex app-server protocol constant. 

const AddCreditsNudgeEmailStatusSent AddCreditsNudgeEmailStatus = "sent"

AddCreditsNudgeEmailStatusSent is a generated Codex app-server protocol constant.

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"`
}

AdditionalContextEntry represents a generated Codex app-server protocol type.

type AdditionalContextKind 

type AdditionalContextKind string

AdditionalContextKind represents a generated Codex app-server protocol type. 

const AdditionalContextKindApplication AdditionalContextKind = "application"

AdditionalContextKindApplication is a generated Codex app-server protocol constant. 

const AdditionalContextKindUntrusted AdditionalContextKind = "untrusted"

AdditionalContextKindUntrusted is a generated Codex app-server protocol constant.

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"`
}

AdditionalFileSystemPermissions represents a generated Codex app-server protocol type.

type AdditionalFileSystemPermissionsEntries added in v0.144.0 

type AdditionalFileSystemPermissionsEntries []FileSystemSandboxEntry

AdditionalFileSystemPermissionsEntries represents a generated Codex app-server protocol type.

type AdditionalFileSystemPermissionsGlobScanMaxDepth added in v0.144.0 

type AdditionalFileSystemPermissionsGlobScanMaxDepth *int

AdditionalFileSystemPermissionsGlobScanMaxDepth represents a generated Codex app-server protocol type.

type AdditionalFileSystemPermissionsRead added in v0.144.0 

type AdditionalFileSystemPermissionsRead []LegacyAppPathString

AdditionalFileSystemPermissionsRead represents a generated Codex app-server protocol type. This will be removed in favor of `entries`.

type AdditionalFileSystemPermissionsWrite added in v0.144.0 

type AdditionalFileSystemPermissionsWrite []LegacyAppPathString

AdditionalFileSystemPermissionsWrite represents a generated Codex app-server protocol type. 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"`
}

AdditionalNetworkPermissions represents a generated Codex app-server protocol type.

type AdditionalNetworkPermissionsEnabled added in v0.144.0 

type AdditionalNetworkPermissionsEnabled *bool

AdditionalNetworkPermissionsEnabled represents a generated Codex app-server protocol type.

type AdditionalPermissionProfile added in v0.147.0 

type AdditionalPermissionProfile struct {
	// FileSystem corresponds to the JSON schema field "fileSystem".
	FileSystem *AdditionalFileSystemPermissions `json:"fileSystem,omitempty,omitzero"`

	// Partial overlay used for per-command permission requests.
	Network *AdditionalNetworkPermissions `json:"network,omitempty,omitzero"`
}

AdditionalPermissionProfile represents a generated Codex app-server protocol type.

type AgentMessageDeltaNotification 

type AgentMessageDeltaNotification = SanitizedAgentMessageDeltaNotificationJSON

AgentMessageDeltaNotification is a generated alias for a Codex app-server protocol type.

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 

func (value AgentMessageInputContent) Kind() AgentMessageInputContentKind

Kind returns the payload discriminator, including unknown future values.

func (AgentMessageInputContent) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type AgentMessageInputContentKind added in v0.145.0 

type AgentMessageInputContentKind string

AgentMessageInputContentKind identifies a known AgentMessageInputContent variant. 

const (
	// AgentMessageInputContentKindEncryptedContent is a generated Codex app-server protocol constant.
	AgentMessageInputContentKindEncryptedContent AgentMessageInputContentKind = "encrypted_content"
	// AgentMessageInputContentKindInputText is a generated Codex app-server protocol constant.
	AgentMessageInputContentKindInputText AgentMessageInputContentKind = "input_text"
)

type AmazonBedrockCredentialSource deprecated 

type AmazonBedrockCredentialSource string

AmazonBedrockCredentialSource is retained for source compatibility with Codex protocol versions before 0.145.0.

Deprecated: Amazon Bedrock login credentials are now supplied directly in LoginAccountParams. 

const AmazonBedrockCredentialSourceAwsManaged AmazonBedrockCredentialSource = "awsManaged"

AmazonBedrockCredentialSourceAwsManaged is retained for source compatibility.

Deprecated: Amazon Bedrock login credentials are now supplied directly in LoginAccountParams. 

const AmazonBedrockCredentialSourceCodexManaged AmazonBedrockCredentialSource = "codexManaged"

AmazonBedrockCredentialSourceCodexManaged is retained for source compatibility.

Deprecated: Amazon Bedrock login credentials are now supplied directly in LoginAccountParams.

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"`
}

AppBranding represents a generated Codex app-server protocol type. EXPERIMENTAL - app metadata returned by app-list APIs.

type AppBrandingCategory added in v0.144.0 

type AppBrandingCategory *string

AppBrandingCategory represents a generated Codex app-server protocol type.

type AppBrandingDeveloper added in v0.144.0 

type AppBrandingDeveloper *string

AppBrandingDeveloper represents a generated Codex app-server protocol type.

type AppBrandingPrivacyPolicy added in v0.144.0 

type AppBrandingPrivacyPolicy *string

AppBrandingPrivacyPolicy represents a generated Codex app-server protocol type.

type AppBrandingTermsOfService added in v0.144.0 

type AppBrandingTermsOfService *string

AppBrandingTermsOfService represents a generated Codex app-server protocol type.

type AppBrandingWebsite added in v0.144.0 

type AppBrandingWebsite *string

AppBrandingWebsite represents a generated Codex app-server protocol type.

type AppInfo 

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

	// Branding corresponds to the JSON schema field "branding".
	Branding *AppBranding `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"`
}

AppInfo represents a generated Codex app-server protocol type. EXPERIMENTAL - app metadata returned by app-list APIs.

type AppInfoDescription added in v0.144.0 

type AppInfoDescription *string

AppInfoDescription represents a generated Codex app-server protocol type.

type AppInfoDistributionChannel added in v0.144.0 

type AppInfoDistributionChannel *string

AppInfoDistributionChannel represents a generated Codex app-server protocol type.

type AppInfoIconAssets added in v0.144.0 

type AppInfoIconAssets map[string]string

AppInfoIconAssets represents a generated Codex app-server protocol type.

type AppInfoIconDarkAssets added in v0.144.0 

type AppInfoIconDarkAssets map[string]string

AppInfoIconDarkAssets represents a generated Codex app-server protocol type.

type AppInfoInstallURL added in v0.144.0 

type AppInfoInstallURL *string

AppInfoInstallURL represents a generated Codex app-server protocol type.

type AppInfoLabels added in v0.144.0 

type AppInfoLabels map[string]string

AppInfoLabels represents a generated Codex app-server protocol type.

type AppInfoLogoURL added in v0.144.0 

type AppInfoLogoURL *string

AppInfoLogoURL represents a generated Codex app-server protocol type.

type AppInfoLogoURLDark added in v0.144.0 

type AppInfoLogoURLDark *string

AppInfoLogoURLDark represents a generated Codex app-server protocol type.

type AppListUpdatedNotification 

type AppListUpdatedNotification = SanitizedAppListUpdatedNotificationJSON

AppListUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`

	// Deprecated: Codex 0.146 removed this field; retained for Go SDK source
	// compatibility.
	FirstPartyType AppMetadataFirstPartyType `json:"firstPartyType,omitempty,omitzero"`

	// Review corresponds to the JSON schema field "review".
	Review *AppReview `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"`
}

AppMetadata represents a generated Codex app-server protocol type.

type AppMetadataCategories added in v0.144.0 

type AppMetadataCategories []string

AppMetadataCategories represents a generated Codex app-server protocol type.

type AppMetadataDeveloper added in v0.144.0 

type AppMetadataDeveloper *string

AppMetadataDeveloper represents a generated Codex app-server protocol type.

type AppMetadataFirstPartyRequiresInstall added in v0.144.0 

type AppMetadataFirstPartyRequiresInstall *bool

AppMetadataFirstPartyRequiresInstall represents a generated Codex app-server protocol type.

type AppMetadataFirstPartyType added in v0.144.0 

type AppMetadataFirstPartyType *string

AppMetadataFirstPartyType represents a generated Codex app-server protocol type. Deprecated: Codex 0.146 removed this field; retained for Go SDK source compatibility.

type AppMetadataScreenshots added in v0.144.0 

type AppMetadataScreenshots []AppScreenshot

AppMetadataScreenshots represents a generated Codex app-server protocol type.

type AppMetadataSeoDescription added in v0.144.0 

type AppMetadataSeoDescription *string

AppMetadataSeoDescription represents a generated Codex app-server protocol type.

type AppMetadataShowInComposerWhenUnlinked added in v0.144.0 

type AppMetadataShowInComposerWhenUnlinked *bool

AppMetadataShowInComposerWhenUnlinked represents a generated Codex app-server protocol type.

type AppMetadataSubCategories added in v0.144.0 

type AppMetadataSubCategories []string

AppMetadataSubCategories represents a generated Codex app-server protocol type.

type AppMetadataVersion added in v0.144.0 

type AppMetadataVersion *string

AppMetadataVersion represents a generated Codex app-server protocol type.

type AppMetadataVersionID added in v0.144.0 

type AppMetadataVersionID *string

AppMetadataVersionID represents a generated Codex app-server protocol type.

type AppMetadataVersionNotes added in v0.144.0 

type AppMetadataVersionNotes *string

AppMetadataVersionNotes represents a generated Codex app-server protocol type.

type AppReview 

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

AppReview represents a generated Codex app-server protocol type.

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"`
}

AppScreenshot represents a generated Codex app-server protocol type.

type AppScreenshotFileID added in v0.144.0 

type AppScreenshotFileID *string

AppScreenshotFileID represents a generated Codex app-server protocol type.

type AppScreenshotURL added in v0.144.0 

type AppScreenshotURL *string

AppScreenshotURL represents a generated Codex app-server protocol type.

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"`
}

AppSummary represents a generated Codex app-server protocol type. EXPERIMENTAL - app metadata summary for plugin responses.

type AppSummaryCategory added in v0.144.0 

type AppSummaryCategory *string

AppSummaryCategory represents a generated Codex app-server protocol type.

type AppSummaryDescription added in v0.144.0 

type AppSummaryDescription *string

AppSummaryDescription represents a generated Codex app-server protocol type.

type AppSummaryInstallURL added in v0.144.0 

type AppSummaryInstallURL *string

AppSummaryInstallURL represents a generated Codex app-server protocol type.

type AppToolSummary added in v0.147.0 

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

	// DisabledReason corresponds to the JSON schema field "disabledReason".
	DisabledReason AppToolSummaryDisabledReason `json:"disabledReason,omitempty,omitzero"`

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

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

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

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

AppToolSummary represents a generated Codex app-server protocol type. EXPERIMENTAL - metadata returned by app/read.

type AppToolSummaryDisabledReason added in v0.147.0 

type AppToolSummaryDisabledReason *string

AppToolSummaryDisabledReason represents a generated Codex app-server protocol type.

type AppToolSummaryTitle added in v0.147.0 

type AppToolSummaryTitle *string

AppToolSummaryTitle represents a generated Codex app-server protocol type.

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

ApprovalsReviewer represents a generated Codex app-server protocol type. 

const ApprovalsReviewerAutoReview ApprovalsReviewer = "auto_review"

ApprovalsReviewerAutoReview is a generated Codex app-server protocol constant. 

const ApprovalsReviewerGuardianSubagent ApprovalsReviewer = "guardian_subagent"

ApprovalsReviewerGuardianSubagent is a generated Codex app-server protocol constant. 

const ApprovalsReviewerUser ApprovalsReviewer = "user"

ApprovalsReviewerUser is a generated Codex app-server protocol constant.

type AppsInstalledParams added in v0.147.0 

type AppsInstalledParams struct {
	// When true and Apps are permitted, refresh and publish the hosted connector
	// runtime tool snapshot first.
	ForceRefresh *bool `json:"forceRefresh,omitempty,omitzero"`

	// Optional loaded thread id used to evaluate effective app configuration.
	ThreadID AppsInstalledParamsThreadID `json:"threadId,omitempty,omitzero"`
}

AppsInstalledParams represents a generated Codex app-server protocol type. Read the committed installed connector runtime snapshot.

type AppsInstalledParamsThreadID added in v0.147.0 

type AppsInstalledParamsThreadID *string

AppsInstalledParamsThreadID represents a generated Codex app-server protocol type. Optional loaded thread id used to evaluate effective app configuration.

type AppsInstalledResponse added in v0.147.0 

type AppsInstalledResponse = SanitizedAppsInstalledResponseJSON

AppsInstalledResponse is a generated alias for a Codex app-server protocol type.

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"`
}

AppsListParams represents a generated Codex app-server protocol type. EXPERIMENTAL - list available apps/connectors.

type AppsListParamsCursor added in v0.144.0 

type AppsListParamsCursor *string

AppsListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type AppsListParamsLimit added in v0.144.0 

type AppsListParamsLimit *int

AppsListParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type AppsListParamsThreadID added in v0.144.0 

type AppsListParamsThreadID *string

AppsListParamsThreadID represents a generated Codex app-server protocol type. Optional thread id used to evaluate app feature gating from that thread's config.

type AppsListResponse 

type AppsListResponse = SanitizedAppsListResponseJSON

AppsListResponse is a generated alias for a Codex app-server protocol type.

type AppsReadParams added in v0.147.0 

type AppsReadParams struct {
	// App ids to read. The server accepts at most 100 ids and deduplicates repeated
	// ids while preserving their first-request order.
	AppIds []string `json:"appIds"`

	// When true, include display-only public tool summaries in the returned metadata.
	IncludeTools *bool `json:"includeTools,omitempty,omitzero"`
}

AppsReadParams represents a generated Codex app-server protocol type. EXPERIMENTAL - read metadata for specific apps/connectors.

type AppsReadResponse added in v0.147.0 

type AppsReadResponse = SanitizedAppsReadResponseJSON

AppsReadResponse is a generated alias for a Codex app-server protocol type.

type AskForApproval 

type AskForApproval interface{}

AskForApproval represents a generated Codex app-server protocol type.

type AttestationGenerateParams 

type AttestationGenerateParams = SanitizedAttestationGenerateParamsJSON

AttestationGenerateParams is a generated alias for a Codex app-server protocol type.

type AttestationGenerateResponse 

type AttestationGenerateResponse = SanitizedAttestationGenerateResponseJSON

AttestationGenerateResponse is a generated alias for a Codex app-server protocol type.

type AuthMode 

type AuthMode interface{}

AuthMode represents a generated Codex app-server protocol type. Authentication mode for OpenAI-backed providers.

type BrowserUseRequirements added in v0.147.0 

type BrowserUseRequirements struct {
	// DisableAutoReview corresponds to the JSON schema field "disableAutoReview".
	DisableAutoReview BrowserUseRequirementsDisableAutoReview `json:"disableAutoReview,omitempty,omitzero"`
}

BrowserUseRequirements represents a generated Codex app-server protocol type.

type BrowserUseRequirementsDisableAutoReview added in v0.147.0 

type BrowserUseRequirementsDisableAutoReview *bool

BrowserUseRequirementsDisableAutoReview represents a generated Codex app-server protocol type.

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"`
}

ByteRange represents a generated Codex app-server protocol type.

type CancelLoginAccountParams 

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

CancelLoginAccountParams represents a generated Codex app-server protocol type.

type CancelLoginAccountResponse 

type CancelLoginAccountResponse = SanitizedCancelLoginAccountResponseJSON

CancelLoginAccountResponse is a generated alias for a Codex app-server protocol type.

type CancelLoginAccountStatus 

type CancelLoginAccountStatus string

CancelLoginAccountStatus represents a generated Codex app-server protocol type. 

const CancelLoginAccountStatusCanceled CancelLoginAccountStatus = "canceled"

CancelLoginAccountStatusCanceled is a generated Codex app-server protocol constant. 

const CancelLoginAccountStatusNotFound CancelLoginAccountStatus = "notFound"

CancelLoginAccountStatusNotFound is a generated Codex app-server protocol constant.

type CapabilityRootLocation 

type CapabilityRootLocation interface{}

CapabilityRootLocation represents a generated Codex app-server protocol type. Location used to resolve a selected capability root.

type ChatgptAuthTokensRefreshParams 

type ChatgptAuthTokensRefreshParams = SanitizedChatgptAuthTokensRefreshParamsJSON

ChatgptAuthTokensRefreshParams is a generated alias for a Codex app-server protocol type.

type ChatgptAuthTokensRefreshReason 

type ChatgptAuthTokensRefreshReason interface{}

ChatgptAuthTokensRefreshReason represents a generated Codex app-server protocol type.

type ChatgptAuthTokensRefreshResponse 

type ChatgptAuthTokensRefreshResponse = SanitizedChatgptAuthTokensRefreshResponseJSON

ChatgptAuthTokensRefreshResponse is a generated alias for a Codex app-server protocol type.

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"`
}

ClientInfo represents a generated Codex app-server protocol type.

type ClientInfoTitle added in v0.144.0 

type ClientInfoTitle *string

ClientInfoTitle represents a generated Codex app-server protocol type.

type ClientNotification 

type ClientNotification interface{}

ClientNotification represents a generated Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ClientRequestKind added in v0.145.0 

type ClientRequestKind string

ClientRequestKind identifies a known ClientRequest variant. 

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

type CodexAppServerProtocolV2 

type CodexAppServerProtocolV2 interface{}

CodexAppServerProtocolV2 represents a generated Codex app-server protocol type.

type CodexErrorInfo 

type CodexErrorInfo interface{}

CodexErrorInfo represents a generated Codex app-server protocol type. 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 CodexResponseHandoffMode added in v0.147.0 

type CodexResponseHandoffMode string

CodexResponseHandoffMode represents a generated Codex app-server protocol type. 

const CodexResponseHandoffModeBemTags CodexResponseHandoffMode = "bemTags"

CodexResponseHandoffModeBemTags is a generated Codex app-server protocol constant. 

const CodexResponseHandoffModeCommentary CodexResponseHandoffMode = "commentary"

CodexResponseHandoffModeCommentary is a generated Codex app-server protocol constant. 

const CodexResponseHandoffModeThinking CodexResponseHandoffMode = "thinking"

CodexResponseHandoffModeThinking is a generated Codex app-server protocol constant.

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"`
}

CollaborationMode represents a generated Codex app-server protocol type. 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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type CommandActionKind added in v0.145.0 

type CommandActionKind string

CommandActionKind identifies a known CommandAction variant. 

const (
	// CommandActionKindListFiles is a generated Codex app-server protocol constant.
	CommandActionKindListFiles CommandActionKind = "listFiles"
	// CommandActionKindRead is a generated Codex app-server protocol constant.
	CommandActionKindRead CommandActionKind = "read"
	// CommandActionKindSearch is a generated Codex app-server protocol constant.
	CommandActionKindSearch CommandActionKind = "search"
	// CommandActionKindUnknown is a generated Codex app-server protocol constant.
	CommandActionKindUnknown CommandActionKind = "unknown"
)

type CommandExecOutputDeltaNotification 

type CommandExecOutputDeltaNotification = SanitizedCommandExecOutputDeltaNotificationJSON

CommandExecOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

type CommandExecOutputStream 

type CommandExecOutputStream interface{}

CommandExecOutputStream represents a generated Codex app-server protocol type. 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 SandboxPolicy `json:"sandboxPolicy,omitempty,omitzero"`

	// Optional initial PTY size in character cells. Only valid when `tty` is true.
	Size *CommandExecTerminalSize `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"`
}

CommandExecParams represents a generated Codex app-server protocol type. 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

CommandExecParamsCwd represents a generated Codex app-server protocol type. Optional working directory. Defaults to the server cwd.

type CommandExecParamsEnv added in v0.144.0 

type CommandExecParamsEnv map[string]*string

CommandExecParamsEnv represents a generated Codex app-server protocol type. 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

CommandExecParamsOutputBytesCap represents a generated Codex app-server protocol type. 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

CommandExecParamsProcessID represents a generated Codex app-server protocol type. 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

CommandExecParamsTimeoutMs represents a generated Codex app-server protocol type. 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"`
}

CommandExecResizeParams represents a generated Codex app-server protocol type. 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"`
}

CommandExecResizeParamsSize represents a generated Codex app-server protocol type. New PTY size in character cells.

type CommandExecResizeResponse 

type CommandExecResizeResponse = SanitizedCommandExecResizeResponseJSON

CommandExecResizeResponse is a generated alias for a Codex app-server protocol type.

type CommandExecResponse 

type CommandExecResponse = SanitizedCommandExecResponseJSON

CommandExecResponse is a generated alias for a Codex app-server protocol type.

type CommandExecTerminalSize 

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

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

CommandExecTerminalSize represents a generated Codex app-server protocol type. 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"`
}

CommandExecTerminateParams represents a generated Codex app-server protocol type. Terminate a running `command/exec` session.

type CommandExecTerminateResponse 

type CommandExecTerminateResponse = SanitizedCommandExecTerminateResponseJSON

CommandExecTerminateResponse is a generated alias for a Codex app-server protocol type.

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"`
}

CommandExecWriteParams represents a generated Codex app-server protocol type. Write stdin bytes to a running `command/exec` session, close stdin, or both.

type CommandExecWriteParamsDeltaBase64 added in v0.144.0 

type CommandExecWriteParamsDeltaBase64 *string

CommandExecWriteParamsDeltaBase64 represents a generated Codex app-server protocol type. Optional base64-encoded stdin bytes to write.

type CommandExecWriteResponse 

type CommandExecWriteResponse = SanitizedCommandExecWriteResponseJSON

CommandExecWriteResponse is a generated alias for a Codex app-server protocol type.

type CommandExecutionApprovalDecision 

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

CommandExecutionApprovalDecision preserves simple, structured, and future command-approval decisions. Checked constructors accept only known variants; JSON decoding retains well-formed future string or single-key object variants.

func MustCommandExecutionApprovalDecision added in v0.147.0 

func MustCommandExecutionApprovalDecision(value any) CommandExecutionApprovalDecision

MustCommandExecutionApprovalDecision is like NewCommandExecutionApprovalDecision but panics when value is not a known decision. It is intended for constants and static policy configuration.

func NewCommandExecutionApprovalDecision added in v0.147.0 

func NewCommandExecutionApprovalDecision(value any) (CommandExecutionApprovalDecision, error)

NewCommandExecutionApprovalDecision validates and wraps a command approval decision.

func (CommandExecutionApprovalDecision) IsKnown added in v0.147.0 

func (d CommandExecutionApprovalDecision) IsKnown() bool

IsKnown reports whether Kind is defined by the pinned protocol.

func (CommandExecutionApprovalDecision) Kind added in v0.147.0 

func (d CommandExecutionApprovalDecision) Kind() CommandExecutionApprovalDecisionKind

Kind returns the decoded wire variant.

func (CommandExecutionApprovalDecision) MarshalJSON added in v0.147.0 

func (d CommandExecutionApprovalDecision) MarshalJSON() ([]byte, error)

func (CommandExecutionApprovalDecision) RawJSON added in v0.147.0 

func (d CommandExecutionApprovalDecision) RawJSON() json.RawMessage

RawJSON returns a copy of the complete command approval decision.

func (*CommandExecutionApprovalDecision) UnmarshalJSON added in v0.147.0 

func (d *CommandExecutionApprovalDecision) UnmarshalJSON(data []byte) error

type CommandExecutionApprovalDecisionKind added in v0.147.0 

type CommandExecutionApprovalDecisionKind string

CommandExecutionApprovalDecisionKind identifies a command approval variant. 

const (
	CommandExecutionApprovalDecisionKindAccept                        CommandExecutionApprovalDecisionKind = "accept"
	CommandExecutionApprovalDecisionKindAcceptForSession              CommandExecutionApprovalDecisionKind = "acceptForSession"
	CommandExecutionApprovalDecisionKindDecline                       CommandExecutionApprovalDecisionKind = "decline"
	CommandExecutionApprovalDecisionKindCancel                        CommandExecutionApprovalDecisionKind = "cancel"
	CommandExecutionApprovalDecisionKindAcceptWithExecpolicyAmendment CommandExecutionApprovalDecisionKind = "acceptWithExecpolicyAmendment"
	CommandExecutionApprovalDecisionKindApplyNetworkPolicyAmendment   CommandExecutionApprovalDecisionKind = "applyNetworkPolicyAmendment"
)

type CommandExecutionOutputDeltaNotification 

type CommandExecutionOutputDeltaNotification = SanitizedCommandExecutionOutputDeltaNotificationJSON

CommandExecutionOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

type CommandExecutionRequestApprovalParams 

type CommandExecutionRequestApprovalParams struct {
	ThreadID      string  `json:"threadId"`
	TurnID        string  `json:"turnId"`
	ItemID        string  `json:"itemId"`
	StartedAtMs   int64   `json:"startedAtMs"`
	EnvironmentID *string `json:"environmentId"`

	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"`
}

CommandMigration represents a generated Codex app-server protocol type.

type ComputerUseRequirements 

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

ComputerUseRequirements represents a generated Codex app-server protocol type.

type ComputerUseRequirementsAllowLockedComputerUse added in v0.144.0 

type ComputerUseRequirementsAllowLockedComputerUse *bool

ComputerUseRequirementsAllowLockedComputerUse represents a generated Codex app-server protocol type.

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 updated runtime settings into loaded threads after
	// writing. Session-static model, reasoning-effort, Plan-mode reasoning-effort,
	// service-tier, and personality defaults are not reloaded.
	ReloadUserConfig *bool `json:"reloadUserConfig,omitempty,omitzero"`
}

ConfigBatchWriteParams represents a generated Codex app-server protocol type.

type ConfigBatchWriteParamsExpectedVersion added in v0.144.0 

type ConfigBatchWriteParamsExpectedVersion *string

ConfigBatchWriteParamsExpectedVersion represents a generated Codex app-server protocol type.

type ConfigBatchWriteParamsFilePath added in v0.144.0 

type ConfigBatchWriteParamsFilePath *string

ConfigBatchWriteParamsFilePath represents a generated Codex app-server protocol type. 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"`
}

ConfigEdit represents a generated Codex app-server protocol type.

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 

func (value ConfigLayerSource) Kind() ConfigLayerSourceKind

Kind returns the payload discriminator, including unknown future values.

func (ConfigLayerSource) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ConfigLayerSourceKind added in v0.145.0 

type ConfigLayerSourceKind string

ConfigLayerSourceKind identifies a known ConfigLayerSource variant. 

const (
	// ConfigLayerSourceKindEnterpriseManaged is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindEnterpriseManaged ConfigLayerSourceKind = "enterpriseManaged"
	// ConfigLayerSourceKindLegacyManagedConfigTomlFromFile is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindLegacyManagedConfigTomlFromFile ConfigLayerSourceKind = "legacyManagedConfigTomlFromFile"
	// ConfigLayerSourceKindLegacyManagedConfigTomlFromMdm is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindLegacyManagedConfigTomlFromMdm ConfigLayerSourceKind = "legacyManagedConfigTomlFromMdm"
	// ConfigLayerSourceKindMdm is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindMdm ConfigLayerSourceKind = "mdm"
	// ConfigLayerSourceKindProject is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindProject ConfigLayerSourceKind = "project"
	// ConfigLayerSourceKindSessionFlags is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindSessionFlags ConfigLayerSourceKind = "sessionFlags"
	// ConfigLayerSourceKindSystem is a generated Codex app-server protocol constant.
	ConfigLayerSourceKindSystem ConfigLayerSourceKind = "system"
	// ConfigLayerSourceKindUser is a generated Codex app-server protocol constant.
	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"`
}

ConfigReadParams represents a generated Codex app-server protocol type.

type ConfigReadParamsCwd added in v0.144.0 

type ConfigReadParamsCwd *string

ConfigReadParamsCwd represents a generated Codex app-server protocol type. 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{}

ConfigReadResponse represents a generated Codex app-server protocol type.

type ConfigRequirements 

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

	// AllowLoginShell corresponds to the JSON schema field "allowLoginShell".
	AllowLoginShell ConfigRequirementsAllowLoginShell `json:"allowLoginShell,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"`

	// BrowserUse corresponds to the JSON schema field "browserUse".
	BrowserUse *BrowserUseRequirements `json:"browserUse,omitempty,omitzero"`

	// CheckForUpdateOnStartup corresponds to the JSON schema field
	// "checkForUpdateOnStartup".
	CheckForUpdateOnStartup ConfigRequirementsCheckForUpdateOnStartup `json:"checkForUpdateOnStartup,omitempty,omitzero"`

	// ComputerUse corresponds to the JSON schema field "computerUse".
	ComputerUse *ComputerUseRequirements `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 *ResidencyRequirement `json:"enforceResidency,omitempty,omitzero"`

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

	// Feedback corresponds to the JSON schema field "feedback".
	Feedback *FeedbackRequirements `json:"feedback,omitempty,omitzero"`

	// LogDir corresponds to the JSON schema field "logDir".
	LogDir ConfigRequirementsLogDir `json:"logDir,omitempty,omitzero"`

	// ModelCatalogJSON corresponds to the JSON schema field "modelCatalogJson".
	ModelCatalogJSON ConfigRequirementsModelCatalogJSON `json:"modelCatalogJson,omitempty,omitzero"`

	// Models corresponds to the JSON schema field "models".
	Models *ModelsRequirements `json:"models,omitempty,omitzero"`

	// SqliteHome corresponds to the JSON schema field "sqliteHome".
	SqliteHome ConfigRequirementsSqliteHome `json:"sqliteHome,omitempty,omitzero"`

	// WindowsSandboxPrivateDesktop corresponds to the JSON schema field
	// "windowsSandboxPrivateDesktop".
	WindowsSandboxPrivateDesktop ConfigRequirementsWindowsSandboxPrivateDesktop `json:"windowsSandboxPrivateDesktop,omitempty,omitzero"`
}

ConfigRequirements represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowAppshots added in v0.144.0 

type ConfigRequirementsAllowAppshots *bool

ConfigRequirementsAllowAppshots represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowLoginShell added in v0.147.0 

type ConfigRequirementsAllowLoginShell *bool

ConfigRequirementsAllowLoginShell represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowManagedHooksOnly added in v0.144.0 

type ConfigRequirementsAllowManagedHooksOnly *bool

ConfigRequirementsAllowManagedHooksOnly represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowRemoteControl added in v0.144.0 

type ConfigRequirementsAllowRemoteControl *bool

ConfigRequirementsAllowRemoteControl represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowedApprovalPolicies added in v0.144.0 

type ConfigRequirementsAllowedApprovalPolicies []AskForApproval

ConfigRequirementsAllowedApprovalPolicies represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowedPermissionProfiles added in v0.144.0 

type ConfigRequirementsAllowedPermissionProfiles map[string]bool

ConfigRequirementsAllowedPermissionProfiles represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowedSandboxModes added in v0.144.0 

type ConfigRequirementsAllowedSandboxModes []SandboxMode

ConfigRequirementsAllowedSandboxModes represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowedWebSearchModes added in v0.144.0 

type ConfigRequirementsAllowedWebSearchModes []WebSearchMode

ConfigRequirementsAllowedWebSearchModes represents a generated Codex app-server protocol type.

type ConfigRequirementsAllowedWindowsSandboxImplementations added in v0.144.0 

type ConfigRequirementsAllowedWindowsSandboxImplementations []WindowsSandboxSetupMode

ConfigRequirementsAllowedWindowsSandboxImplementations represents a generated Codex app-server protocol type.

type ConfigRequirementsCheckForUpdateOnStartup added in v0.147.0 

type ConfigRequirementsCheckForUpdateOnStartup *bool

ConfigRequirementsCheckForUpdateOnStartup represents a generated Codex app-server protocol type.

type ConfigRequirementsDefaultPermissions added in v0.144.0 

type ConfigRequirementsDefaultPermissions *string

ConfigRequirementsDefaultPermissions represents a generated Codex app-server protocol type.

type ConfigRequirementsFeatureRequirements added in v0.144.0 

type ConfigRequirementsFeatureRequirements map[string]bool

ConfigRequirementsFeatureRequirements represents a generated Codex app-server protocol type.

type ConfigRequirementsLogDir added in v0.147.0 

type ConfigRequirementsLogDir *string

ConfigRequirementsLogDir represents a generated Codex app-server protocol type.

type ConfigRequirementsModelCatalog added in v0.147.0 

type ConfigRequirementsModelCatalog = ConfigRequirementsModelCatalogJSON

ConfigRequirementsModelCatalog is a generated alias for a Codex app-server protocol type. Aliases for JSON-suffixed schema types.

type ConfigRequirementsModelCatalogJSON added in v0.147.0 

type ConfigRequirementsModelCatalogJSON *string

ConfigRequirementsModelCatalogJSON represents a generated Codex app-server protocol type.

type ConfigRequirementsReadResponse 

type ConfigRequirementsReadResponse = SanitizedConfigRequirementsReadResponseJSON

ConfigRequirementsReadResponse is a generated alias for a Codex app-server protocol type.

type ConfigRequirementsSqliteHome added in v0.147.0 

type ConfigRequirementsSqliteHome *string

ConfigRequirementsSqliteHome represents a generated Codex app-server protocol type.

type ConfigRequirementsWindowsSandboxPrivateDesktop added in v0.147.0 

type ConfigRequirementsWindowsSandboxPrivateDesktop *bool

ConfigRequirementsWindowsSandboxPrivateDesktop represents a generated Codex app-server protocol type.

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"`
}

ConfigValueWriteParams represents a generated Codex app-server protocol type.

type ConfigValueWriteParamsExpectedVersion added in v0.144.0 

type ConfigValueWriteParamsExpectedVersion *string

ConfigValueWriteParamsExpectedVersion represents a generated Codex app-server protocol type.

type ConfigValueWriteParamsFilePath added in v0.144.0 

type ConfigValueWriteParamsFilePath *string

ConfigValueWriteParamsFilePath represents a generated Codex app-server protocol type. Path to the config file to write; defaults to the user's `config.toml` when omitted.

type ConfigWarningNotification 

type ConfigWarningNotification = SanitizedConfigWarningNotificationJSON

ConfigWarningNotification is a generated alias for a Codex app-server protocol type.

type ConfigWriteResponse 

type ConfigWriteResponse interface{}

ConfigWriteResponse represents a generated Codex app-server protocol type.

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 

func (value ConfiguredHookHandler) Kind() ConfiguredHookHandlerKind

Kind returns the payload discriminator, including unknown future values.

func (ConfiguredHookHandler) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ConfiguredHookHandlerKind added in v0.145.0 

type ConfiguredHookHandlerKind string

ConfiguredHookHandlerKind identifies a known ConfiguredHookHandler variant. 

const (
	// ConfiguredHookHandlerKindAgent is a generated Codex app-server protocol constant.
	ConfiguredHookHandlerKindAgent ConfiguredHookHandlerKind = "agent"
	// ConfiguredHookHandlerKindCommand is a generated Codex app-server protocol constant.
	ConfiguredHookHandlerKindCommand ConfiguredHookHandlerKind = "command"
	// ConfiguredHookHandlerKindPrompt is a generated Codex app-server protocol constant.
	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"`
}

ConfiguredHookMatcherGroup represents a generated Codex app-server protocol type.

type ConfiguredHookMatcherGroupMatcher added in v0.144.0 

type ConfiguredHookMatcherGroupMatcher *string

ConfiguredHookMatcherGroupMatcher represents a generated Codex app-server protocol type.

type ConnectorMetadata added in v0.147.0 

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

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

	// IconURL corresponds to the JSON schema field "iconUrl".
	IconURL ConnectorMetadataIconURL `json:"iconUrl,omitempty,omitzero"`

	// IconURLDark corresponds to the JSON schema field "iconUrlDark".
	IconURLDark ConnectorMetadataIconURLDark `json:"iconUrlDark,omitempty,omitzero"`

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

	// InstallURL corresponds to the JSON schema field "installUrl".
	InstallURL ConnectorMetadataInstallURL `json:"installUrl,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"`

	// ToolSummaries corresponds to the JSON schema field "toolSummaries".
	ToolSummaries *ConnectorMetadataToolSummaries `json:"toolSummaries,omitempty,omitzero"`
}

ConnectorMetadata represents a generated Codex app-server protocol type. EXPERIMENTAL - metadata returned by app/read.

type ConnectorMetadataDescription added in v0.147.0 

type ConnectorMetadataDescription *string

ConnectorMetadataDescription represents a generated Codex app-server protocol type.

type ConnectorMetadataDistributionChannel added in v0.147.0 

type ConnectorMetadataDistributionChannel *string

ConnectorMetadataDistributionChannel represents a generated Codex app-server protocol type.

type ConnectorMetadataIconURL added in v0.147.0 

type ConnectorMetadataIconURL *string

ConnectorMetadataIconURL represents a generated Codex app-server protocol type.

type ConnectorMetadataIconURLDark added in v0.147.0 

type ConnectorMetadataIconURLDark *string

ConnectorMetadataIconURLDark represents a generated Codex app-server protocol type.

type ConnectorMetadataInstallURL added in v0.147.0 

type ConnectorMetadataInstallURL *string

ConnectorMetadataInstallURL represents a generated Codex app-server protocol type.

type ConnectorMetadataToolSummaries added in v0.147.0 

type ConnectorMetadataToolSummaries []AppToolSummary

ConnectorMetadataToolSummaries represents a generated Codex app-server protocol type.

type ConsumeAccountRateLimitResetCreditOutcome 

type ConsumeAccountRateLimitResetCreditOutcome interface{}

ConsumeAccountRateLimitResetCreditOutcome represents a generated Codex app-server protocol type.

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"`
}

ConsumeAccountRateLimitResetCreditParams represents a generated Codex app-server protocol type.

type ConsumeAccountRateLimitResetCreditParamsCreditID added in v0.144.0 

type ConsumeAccountRateLimitResetCreditParamsCreditID *string

ConsumeAccountRateLimitResetCreditParamsCreditID represents a generated Codex app-server protocol type. Opaque reset-credit identifier to redeem. When omitted, the backend selects the next available credit.

type ConsumeAccountRateLimitResetCreditResponse 

type ConsumeAccountRateLimitResetCreditResponse = SanitizedConsumeAccountRateLimitResetCreditResponseJSON

ConsumeAccountRateLimitResetCreditResponse is a generated alias for a Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ContentItemKind added in v0.145.0 

type ContentItemKind string

ContentItemKind identifies a known ContentItem variant. 

const (
	// ContentItemKindInputAudio is a generated Codex app-server protocol constant.
	ContentItemKindInputAudio ContentItemKind = "input_audio"
	// ContentItemKindInputImage is a generated Codex app-server protocol constant.
	ContentItemKindInputImage ContentItemKind = "input_image"
	// ContentItemKindInputText is a generated Codex app-server protocol constant.
	ContentItemKindInputText ContentItemKind = "input_text"
	// ContentItemKindOutputText is a generated Codex app-server protocol constant.
	ContentItemKindOutputText ContentItemKind = "output_text"
)

type ContextCompactedNotification 

type ContextCompactedNotification = SanitizedContextCompactedNotificationJSON

ContextCompactedNotification is a generated alias for a Codex app-server protocol type.

type ConversationTextRole 

type ConversationTextRole string

ConversationTextRole represents a generated Codex app-server protocol type. 

const ConversationTextRoleAssistant ConversationTextRole = "assistant"

ConversationTextRoleAssistant is a generated Codex app-server protocol constant. 

const ConversationTextRoleDeveloper ConversationTextRole = "developer"

ConversationTextRoleDeveloper is a generated Codex app-server protocol constant. 

const ConversationTextRoleUser ConversationTextRole = "user"

ConversationTextRoleUser is a generated Codex app-server protocol constant.

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"`
}

CreditsSnapshot represents a generated Codex app-server protocol type.

type CreditsSnapshotBalance added in v0.144.0 

type CreditsSnapshotBalance *string

CreditsSnapshotBalance represents a generated Codex app-server protocol type.

type DeprecationNoticeNotification 

type DeprecationNoticeNotification = SanitizedDeprecationNoticeNotificationJSON

DeprecationNoticeNotification is a generated alias for a Codex app-server protocol type.

type DesktopOnboardingEntrypoint added in v0.147.0 

type DesktopOnboardingEntrypoint string

DesktopOnboardingEntrypoint represents a generated Codex app-server protocol type. 

const DesktopOnboardingEntrypointLifeSciences DesktopOnboardingEntrypoint = "life_sciences"

DesktopOnboardingEntrypointLifeSciences is a generated Codex app-server protocol constant.

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 

func (value DynamicToolCallOutputContentItem) Kind() DynamicToolCallOutputContentItemKind

Kind returns the payload discriminator, including unknown future values.

func (DynamicToolCallOutputContentItem) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

func (DynamicToolCallOutputContentItem) RawJSON added in v0.145.0 

func (value DynamicToolCallOutputContentItem) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*DynamicToolCallOutputContentItem) UnmarshalJSON added in v0.145.0 

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type DynamicToolCallOutputContentItemKind added in v0.145.0 

type DynamicToolCallOutputContentItemKind string

DynamicToolCallOutputContentItemKind identifies a known DynamicToolCallOutputContentItem variant. 

const (
	// DynamicToolCallOutputContentItemKindInputAudio is a generated Codex app-server protocol constant.
	DynamicToolCallOutputContentItemKindInputAudio DynamicToolCallOutputContentItemKind = "inputAudio"
	// DynamicToolCallOutputContentItemKindInputImage is a generated Codex app-server protocol constant.
	DynamicToolCallOutputContentItemKindInputImage DynamicToolCallOutputContentItemKind = "inputImage"
	// DynamicToolCallOutputContentItemKindInputText is a generated Codex app-server protocol constant.
	DynamicToolCallOutputContentItemKindInputText DynamicToolCallOutputContentItemKind = "inputText"
)

type DynamicToolCallParams 

type DynamicToolCallParams = SanitizedDynamicToolCallParamsJSON

DynamicToolCallParams is a generated alias for a Codex app-server protocol type.

type DynamicToolCallResponse 

type DynamicToolCallResponse = SanitizedDynamicToolCallResponseJSON

DynamicToolCallResponse is a generated alias for a Codex app-server protocol type.

type DynamicToolNamespaceTool 

type DynamicToolNamespaceTool interface{}

DynamicToolNamespaceTool represents a generated Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type DynamicToolSpecKind added in v0.145.0 

type DynamicToolSpecKind string

DynamicToolSpecKind identifies a known DynamicToolSpec variant. 

const (
	// DynamicToolSpecKindFunction is a generated Codex app-server protocol constant.
	DynamicToolSpecKindFunction DynamicToolSpecKind = "function"
	// DynamicToolSpecKindNamespace is a generated Codex app-server protocol constant.
	DynamicToolSpecKindNamespace DynamicToolSpecKind = "namespace"
)

type EnvironmentConnectionNotification added in v0.147.0 

type EnvironmentConnectionNotification = SanitizedEnvironmentConnectionNotificationJSON

EnvironmentConnectionNotification is a generated alias for a Codex app-server protocol type.

type ErrorNotification 

type ErrorNotification struct {
	ThreadID  string    `json:"threadId"`
	TurnID    string    `json:"turnId"`
	WillRetry bool      `json:"willRetry"`
	Error     TurnError `json:"error"`
}

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"`
}

ExperimentalFeature represents a generated Codex app-server protocol type.

type ExperimentalFeatureAnnouncement added in v0.144.0 

type ExperimentalFeatureAnnouncement *string

ExperimentalFeatureAnnouncement represents a generated Codex app-server protocol type. 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

ExperimentalFeatureDescription represents a generated Codex app-server protocol type. 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

ExperimentalFeatureDisplayName represents a generated Codex app-server protocol type. 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"`
}

ExperimentalFeatureEnablementSetParams represents a generated Codex app-server protocol type.

type ExperimentalFeatureEnablementSetParamsEnablement added in v0.144.0 

type ExperimentalFeatureEnablementSetParamsEnablement map[string]bool

ExperimentalFeatureEnablementSetParamsEnablement represents a generated Codex app-server protocol type. 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 ExperimentalFeatureEnablementSetResponse 

type ExperimentalFeatureEnablementSetResponse = SanitizedExperimentalFeatureEnablementSetResponseJSON

ExperimentalFeatureEnablementSetResponse is a generated alias for a Codex app-server protocol type.

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"`
}

ExperimentalFeatureListParams represents a generated Codex app-server protocol type.

type ExperimentalFeatureListParamsCursor added in v0.144.0 

type ExperimentalFeatureListParamsCursor *string

ExperimentalFeatureListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type ExperimentalFeatureListParamsLimit added in v0.144.0 

type ExperimentalFeatureListParamsLimit *int

ExperimentalFeatureListParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type ExperimentalFeatureListParamsThreadID added in v0.144.0 

type ExperimentalFeatureListParamsThreadID *string

ExperimentalFeatureListParamsThreadID represents a generated Codex app-server protocol type. 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 ExperimentalFeatureListResponse 

type ExperimentalFeatureListResponse = SanitizedExperimentalFeatureListResponseJSON

ExperimentalFeatureListResponse is a generated alias for a Codex app-server protocol type.

type ExperimentalFeatureStage added in v0.144.0 

type ExperimentalFeatureStage interface{}

ExperimentalFeatureStage represents a generated Codex app-server protocol type.

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"`

	// Maximum age in days for detected sessions. Missing values use the default
	// limit.
	MaxSessionAgeDays ExternalAgentConfigDetectParamsMaxSessionAgeDays `json:"maxSessionAgeDays,omitempty,omitzero"`

	// Maximum number of sessions to detect. Missing values use the default limit.
	MaxSessions ExternalAgentConfigDetectParamsMaxSessions `json:"maxSessions,omitempty,omitzero"`

	// Optional migration-source selector. Missing or unrecognized values use the
	// default source.
	MigrationSource ExternalAgentConfigDetectParamsMigrationSource `json:"migrationSource,omitempty,omitzero"`

	// Deprecated field retained for compatibility. This field is ignored; use
	// `migrationSource` to select the migration source.
	Source ExternalAgentConfigDetectParamsSource `json:"source,omitempty,omitzero"`
}

ExternalAgentConfigDetectParams represents a generated Codex app-server protocol type.

type ExternalAgentConfigDetectParamsCwds added in v0.144.0 

type ExternalAgentConfigDetectParamsCwds []string

ExternalAgentConfigDetectParamsCwds represents a generated Codex app-server protocol type. Zero or more working directories to include for repo-scoped detection.

type ExternalAgentConfigDetectParamsMaxSessionAgeDays added in v0.147.0 

type ExternalAgentConfigDetectParamsMaxSessionAgeDays *int

ExternalAgentConfigDetectParamsMaxSessionAgeDays represents a generated Codex app-server protocol type. Maximum age in days for detected sessions. Missing values use the default limit.

type ExternalAgentConfigDetectParamsMaxSessions added in v0.147.0 

type ExternalAgentConfigDetectParamsMaxSessions *int

ExternalAgentConfigDetectParamsMaxSessions represents a generated Codex app-server protocol type. Maximum number of sessions to detect. Missing values use the default limit.

type ExternalAgentConfigDetectParamsMigrationSource added in v0.147.0 

type ExternalAgentConfigDetectParamsMigrationSource *string

ExternalAgentConfigDetectParamsMigrationSource represents a generated Codex app-server protocol type. Optional migration-source selector. Missing or unrecognized values use the default source.

type ExternalAgentConfigDetectParamsSource added in v0.147.0 

type ExternalAgentConfigDetectParamsSource *string

ExternalAgentConfigDetectParamsSource represents a generated Codex app-server protocol type. Deprecated field retained for compatibility. This field is ignored; use `migrationSource` to select the migration source.

type ExternalAgentConfigDetectResponse 

type ExternalAgentConfigDetectResponse = SanitizedExternalAgentConfigDetectResponseJSON

ExternalAgentConfigDetectResponse is a generated alias for a Codex app-server protocol type.

type ExternalAgentConfigImportCompletedNotification 

type ExternalAgentConfigImportCompletedNotification = SanitizedExternalAgentConfigImportCompletedNotificationJSON

ExternalAgentConfigImportCompletedNotification is a generated alias for a Codex app-server protocol type.

type ExternalAgentConfigImportHistoriesReadResponse 

type ExternalAgentConfigImportHistoriesReadResponse = SanitizedExternalAgentConfigImportHistoriesReadResponseJSON

ExternalAgentConfigImportHistoriesReadResponse is a generated alias for a Codex app-server protocol type.

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"`

	// ProviderID corresponds to the JSON schema field "providerId".
	ProviderID ExternalAgentConfigImportHistoryProviderID `json:"providerId,omitempty,omitzero"`

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

ExternalAgentConfigImportHistory represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryProviderID added in v0.147.0 

type ExternalAgentConfigImportHistoryProviderID *string

ExternalAgentConfigImportHistoryProviderID represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordParams added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordParams struct {
	// Completed results grouped by imported item type.
	ItemTypeResults []ExternalAgentConfigImportHistoryRecordTypeResultParams `json:"itemTypeResults"`

	// Opaque provider identifier for the externally completed import.
	ProviderID string `json:"providerId"`
}

ExternalAgentConfigImportHistoryRecordParams represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordResponse added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordResponse = SanitizedExternalAgentConfigImportHistoryRecordResponseJSON

ExternalAgentConfigImportHistoryRecordResponse is a generated alias for a Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordSuccessParams added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordSuccessParams struct {
	// Cwd corresponds to the JSON schema field "cwd".
	Cwd ExternalAgentConfigImportHistoryRecordSuccessParamsCwd `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 ExternalAgentConfigImportHistoryRecordSuccessParamsSource `json:"source,omitempty,omitzero"`

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

	// Original title for an imported session, when available.
	Title ExternalAgentConfigImportHistoryRecordSuccessParamsTitle `json:"title,omitempty,omitzero"`
}

ExternalAgentConfigImportHistoryRecordSuccessParams represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordSuccessParamsCwd added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordSuccessParamsCwd *string

ExternalAgentConfigImportHistoryRecordSuccessParamsCwd represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordSuccessParamsSource added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordSuccessParamsSource *string

ExternalAgentConfigImportHistoryRecordSuccessParamsSource represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordSuccessParamsTarget added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordSuccessParamsTarget *string

ExternalAgentConfigImportHistoryRecordSuccessParamsTarget represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportHistoryRecordSuccessParamsTitle added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordSuccessParamsTitle *string

ExternalAgentConfigImportHistoryRecordSuccessParamsTitle represents a generated Codex app-server protocol type. Original title for an imported session, when available.

type ExternalAgentConfigImportHistoryRecordTypeResultParams added in v0.147.0 

type ExternalAgentConfigImportHistoryRecordTypeResultParams 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 []ExternalAgentConfigImportHistoryRecordSuccessParams `json:"successes"`
}

ExternalAgentConfigImportHistoryRecordTypeResultParams represents a generated Codex app-server protocol type.

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"`

	// SubErrorType corresponds to the JSON schema field "subErrorType".
	SubErrorType ExternalAgentConfigImportItemTypeFailureSubErrorType `json:"subErrorType,omitempty,omitzero"`
}

ExternalAgentConfigImportItemTypeFailure represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeFailureCwd added in v0.144.0 

type ExternalAgentConfigImportItemTypeFailureCwd *string

ExternalAgentConfigImportItemTypeFailureCwd represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeFailureErrorType added in v0.144.0 

type ExternalAgentConfigImportItemTypeFailureErrorType *string

ExternalAgentConfigImportItemTypeFailureErrorType represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeFailureSource added in v0.144.0 

type ExternalAgentConfigImportItemTypeFailureSource *string

ExternalAgentConfigImportItemTypeFailureSource represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeFailureSubErrorType added in v0.147.0 

type ExternalAgentConfigImportItemTypeFailureSubErrorType *string

ExternalAgentConfigImportItemTypeFailureSubErrorType represents a generated Codex app-server protocol type.

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"`

	// Original title for an imported session; null for other item types.
	Title ExternalAgentConfigImportItemTypeSuccessTitle `json:"title,omitempty,omitzero"`
}

ExternalAgentConfigImportItemTypeSuccess represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeSuccessCwd added in v0.144.0 

type ExternalAgentConfigImportItemTypeSuccessCwd *string

ExternalAgentConfigImportItemTypeSuccessCwd represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeSuccessSource added in v0.144.0 

type ExternalAgentConfigImportItemTypeSuccessSource *string

ExternalAgentConfigImportItemTypeSuccessSource represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeSuccessTarget added in v0.144.0 

type ExternalAgentConfigImportItemTypeSuccessTarget *string

ExternalAgentConfigImportItemTypeSuccessTarget represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportItemTypeSuccessTitle added in v0.147.0 

type ExternalAgentConfigImportItemTypeSuccessTitle *string

ExternalAgentConfigImportItemTypeSuccessTitle represents a generated Codex app-server protocol type. Original title for an imported session; null for other item types.

type ExternalAgentConfigImportParams 

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

	// Migration-source selector used to produce the migration items. Pass the same
	// value to detection and import; missing or unrecognized values use the default
	// source.
	MigrationSource ExternalAgentConfigImportParamsMigrationSource `json:"migrationSource,omitempty,omitzero"`

	// Opaque provider identifier supplied by the caller for analytics attribution and
	// import history display. This does not select the migration source.
	ProviderID ExternalAgentConfigImportParamsProviderID `json:"providerId,omitempty,omitzero"`

	// Optional identifier for the product that initiated the import.
	Source ExternalAgentConfigImportParamsSource `json:"source,omitempty,omitzero"`
}

ExternalAgentConfigImportParams represents a generated Codex app-server protocol type.

type ExternalAgentConfigImportParamsMigrationSource added in v0.147.0 

type ExternalAgentConfigImportParamsMigrationSource *string

ExternalAgentConfigImportParamsMigrationSource represents a generated Codex app-server protocol type. Migration-source selector used to produce the migration items. Pass the same value to detection and import; missing or unrecognized values use the default source.

type ExternalAgentConfigImportParamsProviderID added in v0.147.0 

type ExternalAgentConfigImportParamsProviderID *string

ExternalAgentConfigImportParamsProviderID represents a generated Codex app-server protocol type. Opaque provider identifier supplied by the caller for analytics attribution and import history display. This does not select the migration source.

type ExternalAgentConfigImportParamsSource added in v0.144.0 

type ExternalAgentConfigImportParamsSource *string

ExternalAgentConfigImportParamsSource represents a generated Codex app-server protocol type. Optional identifier for the product that initiated the import.

type ExternalAgentConfigImportProgressNotification 

type ExternalAgentConfigImportProgressNotification = SanitizedExternalAgentConfigImportProgressNotificationJSON

ExternalAgentConfigImportProgressNotification is a generated alias for a Codex app-server protocol type.

type ExternalAgentConfigImportResponse 

type ExternalAgentConfigImportResponse = SanitizedExternalAgentConfigImportResponseJSON

ExternalAgentConfigImportResponse is a generated alias for a Codex app-server protocol type.

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"`
}

ExternalAgentConfigImportTypeResult represents a generated Codex app-server protocol type.

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 *MigrationDetails `json:"details,omitempty,omitzero"`

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

ExternalAgentConfigMigrationItem represents a generated Codex app-server protocol type.

type ExternalAgentConfigMigrationItemCwd added in v0.144.0 

type ExternalAgentConfigMigrationItemCwd *string

ExternalAgentConfigMigrationItemCwd represents a generated Codex app-server protocol type. Null or empty means home-scoped migration; non-empty means repo-scoped migration.

type ExternalAgentConfigMigrationItemType 

type ExternalAgentConfigMigrationItemType string

ExternalAgentConfigMigrationItemType represents a generated Codex app-server protocol type. 

const ExternalAgentConfigMigrationItemTypeAGENTSMD ExternalAgentConfigMigrationItemType = "AGENTS_MD"

ExternalAgentConfigMigrationItemTypeAGENTSMD is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeCOMMANDS ExternalAgentConfigMigrationItemType = "COMMANDS"

ExternalAgentConfigMigrationItemTypeCOMMANDS is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeCONFIG ExternalAgentConfigMigrationItemType = "CONFIG"

ExternalAgentConfigMigrationItemTypeCONFIG is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeHOOKS ExternalAgentConfigMigrationItemType = "HOOKS"

ExternalAgentConfigMigrationItemTypeHOOKS is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeMCPSERVERCONFIG ExternalAgentConfigMigrationItemType = "MCP_SERVER_CONFIG"

ExternalAgentConfigMigrationItemTypeMCPSERVERCONFIG is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeMEMORY ExternalAgentConfigMigrationItemType = "MEMORY"

ExternalAgentConfigMigrationItemTypeMEMORY is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypePLUGINS ExternalAgentConfigMigrationItemType = "PLUGINS"

ExternalAgentConfigMigrationItemTypePLUGINS is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeSESSIONS ExternalAgentConfigMigrationItemType = "SESSIONS"

ExternalAgentConfigMigrationItemTypeSESSIONS is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeSKILLS ExternalAgentConfigMigrationItemType = "SKILLS"

ExternalAgentConfigMigrationItemTypeSKILLS is a generated Codex app-server protocol constant. 

const ExternalAgentConfigMigrationItemTypeSUBAGENTS ExternalAgentConfigMigrationItemType = "SUBAGENTS"

ExternalAgentConfigMigrationItemTypeSUBAGENTS is a generated Codex app-server protocol constant.

type ExternalAgentDetectedConnectorCandidate added in v0.147.0 

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

	// SessionCount corresponds to the JSON schema field "sessionCount".
	SessionCount int `json:"sessionCount"`

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

ExternalAgentDetectedConnectorCandidate represents a generated Codex app-server protocol type.

type ExternalAgentDetectedConnectorSource added in v0.147.0 

type ExternalAgentDetectedConnectorSource string

ExternalAgentDetectedConnectorSource represents a generated Codex app-server protocol type. 

const ExternalAgentDetectedConnectorSourceRemoteMCPServersConfig ExternalAgentDetectedConnectorSource = "remoteMcpServersConfig"

ExternalAgentDetectedConnectorSourceRemoteMCPServersConfig is a generated Codex app-server protocol constant. 

const ExternalAgentDetectedConnectorSourceSessionToolUse ExternalAgentDetectedConnectorSource = "sessionToolUse"

ExternalAgentDetectedConnectorSourceSessionToolUse is a generated Codex app-server protocol constant.

type ExternalAgentImportedConnectorCandidate added in v0.147.0 

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

	// SessionCount corresponds to the JSON schema field "sessionCount".
	SessionCount int `json:"sessionCount"`

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

ExternalAgentImportedConnectorCandidate represents a generated Codex app-server protocol type.

type ExternalAgentImportedConnectorSource added in v0.147.0 

type ExternalAgentImportedConnectorSource string

ExternalAgentImportedConnectorSource represents a generated Codex app-server protocol type. 

const ExternalAgentImportedConnectorSourceRemoteMCPServersConfig ExternalAgentImportedConnectorSource = "remoteMcpServersConfig"

ExternalAgentImportedConnectorSourceRemoteMCPServersConfig is a generated Codex app-server protocol constant.

type FeedbackRequirements added in v0.147.0 

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

FeedbackRequirements represents a generated Codex app-server protocol type.

type FeedbackRequirementsEnabled added in v0.147.0 

type FeedbackRequirementsEnabled *bool

FeedbackRequirementsEnabled represents a generated Codex app-server protocol type.

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"`
}

FeedbackUploadParams represents a generated Codex app-server protocol type.

type FeedbackUploadParamsExtraLogFiles added in v0.144.0 

type FeedbackUploadParamsExtraLogFiles []string

FeedbackUploadParamsExtraLogFiles represents a generated Codex app-server protocol type.

type FeedbackUploadParamsReason added in v0.144.0 

type FeedbackUploadParamsReason *string

FeedbackUploadParamsReason represents a generated Codex app-server protocol type.

type FeedbackUploadParamsTags added in v0.144.0 

type FeedbackUploadParamsTags map[string]string

FeedbackUploadParamsTags represents a generated Codex app-server protocol type.

type FeedbackUploadParamsThreadID added in v0.144.0 

type FeedbackUploadParamsThreadID *string

FeedbackUploadParamsThreadID represents a generated Codex app-server protocol type.

type FeedbackUploadResponse 

type FeedbackUploadResponse = SanitizedFeedbackUploadResponseJSON

FeedbackUploadResponse is a generated alias for a Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type FileChangeApprovalDecision 

type FileChangeApprovalDecision string

FileChangeApprovalDecision is a fixed file-change approval choice. 

const (
	FileChangeApprovalDecisionAccept           FileChangeApprovalDecision = "accept"
	FileChangeApprovalDecisionAcceptForSession FileChangeApprovalDecision = "acceptForSession"
	FileChangeApprovalDecisionDecline          FileChangeApprovalDecision = "decline"
	FileChangeApprovalDecisionCancel           FileChangeApprovalDecision = "cancel"
)

type FileChangeKind added in v0.145.0 

type FileChangeKind string

FileChangeKind identifies a known FileChange variant. 

const (
	// FileChangeKindAdd is a generated Codex app-server protocol constant.
	FileChangeKindAdd FileChangeKind = "add"
	// FileChangeKindDelete is a generated Codex app-server protocol constant.
	FileChangeKindDelete FileChangeKind = "delete"
	// FileChangeKindUpdate is a generated Codex app-server protocol constant.
	FileChangeKindUpdate FileChangeKind = "update"
)

type FileChangeOutputDeltaNotification 

type FileChangeOutputDeltaNotification = SanitizedFileChangeOutputDeltaNotificationJSON

FileChangeOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

type FileChangePatchUpdatedNotification 

type FileChangePatchUpdatedNotification = SanitizedFileChangePatchUpdatedNotificationJSON

FileChangePatchUpdatedNotification is a generated alias for a Codex app-server protocol type.

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

FileSystemAccessMode represents a generated Codex app-server protocol type. 

const FileSystemAccessModeDeny FileSystemAccessMode = "deny"

FileSystemAccessModeDeny is a generated Codex app-server protocol constant. 

const FileSystemAccessModeRead FileSystemAccessMode = "read"

FileSystemAccessModeRead is a generated Codex app-server protocol constant. 

const FileSystemAccessModeWrite FileSystemAccessMode = "write"

FileSystemAccessModeWrite is a generated Codex app-server protocol constant.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type FileSystemPathKind added in v0.145.0 

type FileSystemPathKind string

FileSystemPathKind identifies a known FileSystemPath variant. 

const (
	// FileSystemPathKindGlobPattern is a generated Codex app-server protocol constant.
	FileSystemPathKindGlobPattern FileSystemPathKind = "glob_pattern"
	// FileSystemPathKindPath is a generated Codex app-server protocol constant.
	FileSystemPathKindPath FileSystemPathKind = "path"
	// FileSystemPathKindSpecial is a generated Codex app-server protocol constant.
	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"`
}

FileSystemSandboxEntry represents a generated Codex app-server protocol type.

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 

func (value FileSystemSpecialPath) Kind() FileSystemSpecialPathKind

Kind returns the payload discriminator, including unknown future values.

func (FileSystemSpecialPath) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type FileSystemSpecialPathKind added in v0.145.0 

type FileSystemSpecialPathKind string

FileSystemSpecialPathKind identifies a known FileSystemSpecialPath variant. 

const (
	// FileSystemSpecialPathKindMinimal is a generated Codex app-server protocol constant.
	FileSystemSpecialPathKindMinimal FileSystemSpecialPathKind = "minimal"
	// FileSystemSpecialPathKindProjectRoots is a generated Codex app-server protocol constant.
	FileSystemSpecialPathKindProjectRoots FileSystemSpecialPathKind = "project_roots"
	// FileSystemSpecialPathKindRoot is a generated Codex app-server protocol constant.
	FileSystemSpecialPathKindRoot FileSystemSpecialPathKind = "root"
	// FileSystemSpecialPathKindSlashTmp is a generated Codex app-server protocol constant.
	FileSystemSpecialPathKindSlashTmp FileSystemSpecialPathKind = "slash_tmp"
	// FileSystemSpecialPathKindTmpdir is a generated Codex app-server protocol constant.
	FileSystemSpecialPathKindTmpdir FileSystemSpecialPathKind = "tmpdir"
	// FileSystemSpecialPathKindUnknown is a generated Codex app-server protocol constant.
	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"`
}

FileUpdateChange represents a generated Codex app-server protocol type.

type FsChangedNotification 

type FsChangedNotification interface{}

FsChangedNotification represents a generated Codex app-server protocol type.

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"`
}

FsCopyParams represents a generated Codex app-server protocol type. Copy a file or directory tree on the host filesystem.

type FsCopyResponse 

type FsCopyResponse = SanitizedFsCopyResponseJSON

FsCopyResponse is a generated alias for a Codex app-server protocol type.

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"`
}

FsCreateDirectoryParams represents a generated Codex app-server protocol type. Create a directory on the host filesystem.

type FsCreateDirectoryParamsRecursive added in v0.144.0 

type FsCreateDirectoryParamsRecursive *bool

FsCreateDirectoryParamsRecursive represents a generated Codex app-server protocol type. Whether parent directories should also be created. Defaults to `true`.

type FsCreateDirectoryResponse 

type FsCreateDirectoryResponse = SanitizedFsCreateDirectoryResponseJSON

FsCreateDirectoryResponse is a generated alias for a Codex app-server protocol type.

type FsGetMetadataParams 

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

FsGetMetadataParams represents a generated Codex app-server protocol type. Request metadata for an absolute path.

type FsGetMetadataResponse 

type FsGetMetadataResponse = SanitizedFsGetMetadataResponseJSON

FsGetMetadataResponse is a generated alias for a Codex app-server protocol type.

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"`
}

FsReadDirectoryEntry represents a generated Codex app-server protocol type. A directory entry returned by `fs/readDirectory`.

type FsReadDirectoryParams 

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

FsReadDirectoryParams represents a generated Codex app-server protocol type. List direct child names for a directory.

type FsReadDirectoryResponse 

type FsReadDirectoryResponse = SanitizedFsReadDirectoryResponseJSON

FsReadDirectoryResponse is a generated alias for a Codex app-server protocol type.

type FsReadFileParams 

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

FsReadFileParams represents a generated Codex app-server protocol type. Read a file from the host filesystem.

type FsReadFileResponse 

type FsReadFileResponse = SanitizedFsReadFileResponseJSON

FsReadFileResponse is a generated alias for a Codex app-server protocol type.

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"`
}

FsRemoveParams represents a generated Codex app-server protocol type. Remove a file or directory tree from the host filesystem.

type FsRemoveParamsForce added in v0.144.0 

type FsRemoveParamsForce *bool

FsRemoveParamsForce represents a generated Codex app-server protocol type. Whether missing paths should be ignored. Defaults to `true`.

type FsRemoveParamsRecursive added in v0.144.0 

type FsRemoveParamsRecursive *bool

FsRemoveParamsRecursive represents a generated Codex app-server protocol type. Whether directory removal should recurse. Defaults to `true`.

type FsRemoveResponse 

type FsRemoveResponse = SanitizedFsRemoveResponseJSON

FsRemoveResponse is a generated alias for a Codex app-server protocol type.

type FsUnwatchParams 

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

FsUnwatchParams represents a generated Codex app-server protocol type. Stop filesystem watch notifications for a prior `fs/watch`.

type FsUnwatchResponse 

type FsUnwatchResponse = SanitizedFsUnwatchResponseJSON

FsUnwatchResponse is a generated alias for a Codex app-server protocol type.

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"`
}

FsWatchParams represents a generated Codex app-server protocol type. Start filesystem watch notifications for an absolute path.

type FsWatchResponse 

type FsWatchResponse interface{}

FsWatchResponse represents a generated Codex app-server protocol type.

type FsWriteFileParams 

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

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

FsWriteFileParams represents a generated Codex app-server protocol type. Write a file on the host filesystem.

type FsWriteFileResponse 

type FsWriteFileResponse = SanitizedFsWriteFileResponseJSON

FsWriteFileResponse is a generated alias for a Codex app-server protocol type.

type FunctionCallOutputBody 

type FunctionCallOutputBody interface{}

FunctionCallOutputBody represents a generated Codex app-server protocol type.

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 

func (value FunctionCallOutputContentItem) Kind() FunctionCallOutputContentItemKind

Kind returns the payload discriminator, including unknown future values.

func (FunctionCallOutputContentItem) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

func (FunctionCallOutputContentItem) RawJSON added in v0.145.0 

func (value FunctionCallOutputContentItem) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*FunctionCallOutputContentItem) UnmarshalJSON added in v0.145.0 

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type FunctionCallOutputContentItemKind added in v0.145.0 

type FunctionCallOutputContentItemKind string

FunctionCallOutputContentItemKind identifies a known FunctionCallOutputContentItem variant. 

const (
	// FunctionCallOutputContentItemKindEncryptedContent is a generated Codex app-server protocol constant.
	FunctionCallOutputContentItemKindEncryptedContent FunctionCallOutputContentItemKind = "encrypted_content"
	// FunctionCallOutputContentItemKindInputAudio is a generated Codex app-server protocol constant.
	FunctionCallOutputContentItemKindInputAudio FunctionCallOutputContentItemKind = "input_audio"
	// FunctionCallOutputContentItemKindInputImage is a generated Codex app-server protocol constant.
	FunctionCallOutputContentItemKindInputImage FunctionCallOutputContentItemKind = "input_image"
	// FunctionCallOutputContentItemKindInputText is a generated Codex app-server protocol constant.
	FunctionCallOutputContentItemKindInputText FunctionCallOutputContentItemKind = "input_text"
)

type FuzzyFileSearchMatchType 

type FuzzyFileSearchMatchType string

FuzzyFileSearchMatchType represents a generated Codex app-server protocol type. 

const FuzzyFileSearchMatchTypeDirectory FuzzyFileSearchMatchType = "directory"

FuzzyFileSearchMatchTypeDirectory is a generated Codex app-server protocol constant. 

const FuzzyFileSearchMatchTypeFile FuzzyFileSearchMatchType = "file"

FuzzyFileSearchMatchTypeFile is a generated Codex app-server protocol constant.

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"`
}

FuzzyFileSearchParams represents a generated Codex app-server protocol type.

type FuzzyFileSearchParamsCancellationToken added in v0.144.0 

type FuzzyFileSearchParamsCancellationToken *string

FuzzyFileSearchParamsCancellationToken represents a generated Codex app-server protocol type.

type FuzzyFileSearchResponse 

type FuzzyFileSearchResponse = SanitizedFuzzyFileSearchResponseJSON

FuzzyFileSearchResponse is a generated alias for a Codex app-server protocol type.

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"`
}

FuzzyFileSearchResult represents a generated Codex app-server protocol type. Superset of [`codex_file_search::FileMatch`]

type FuzzyFileSearchResultIndices added in v0.144.0 

type FuzzyFileSearchResultIndices []int

FuzzyFileSearchResultIndices represents a generated Codex app-server protocol type.

type FuzzyFileSearchSessionCompletedNotification 

type FuzzyFileSearchSessionCompletedNotification = SanitizedFuzzyFileSearchSessionCompletedNotificationJSON

FuzzyFileSearchSessionCompletedNotification is a generated alias for a Codex app-server protocol type.

type FuzzyFileSearchSessionUpdatedNotification 

type FuzzyFileSearchSessionUpdatedNotification = SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON

FuzzyFileSearchSessionUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

GetAccountParams represents a generated Codex app-server protocol type.

type GetAccountRateLimitsResponse 

type GetAccountRateLimitsResponse = SanitizedGetAccountRateLimitsResponseJSON

GetAccountRateLimitsResponse is a generated alias for a Codex app-server protocol type.

type GetAccountResponse 

type GetAccountResponse = SanitizedGetAccountResponseJSON

GetAccountResponse is a generated alias for a Codex app-server protocol type.

type GetAccountTokenUsageResponse 

type GetAccountTokenUsageResponse = SanitizedGetAccountTokenUsageResponseJSON

GetAccountTokenUsageResponse is a generated alias for a Codex app-server protocol type.

type GetWorkspaceMessagesResponse 

type GetWorkspaceMessagesResponse = SanitizedGetWorkspaceMessagesResponseJSON

GetWorkspaceMessagesResponse is a generated alias for a Codex app-server protocol type.

type GitInfo added in v0.147.0 

type GitInfo struct {
	SHA       *string `json:"sha,omitempty"`
	Branch    *string `json:"branch,omitempty"`
	OriginURL *string `json:"originUrl,omitempty"`
}

GitInfo describes the source-control state captured for a thread.

type GrantedPermissionProfile 

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

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

GrantedPermissionProfile represents a generated Codex app-server protocol type.

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 

func (value GuardianApprovalReviewAction) Kind() GuardianApprovalReviewActionKind

Kind returns the payload discriminator, including unknown future values.

func (GuardianApprovalReviewAction) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

func (GuardianApprovalReviewAction) RawJSON added in v0.145.0 

func (value GuardianApprovalReviewAction) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*GuardianApprovalReviewAction) UnmarshalJSON added in v0.145.0 

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type GuardianApprovalReviewActionKind added in v0.145.0 

type GuardianApprovalReviewActionKind string

GuardianApprovalReviewActionKind identifies a known GuardianApprovalReviewAction variant. 

const (
	// GuardianApprovalReviewActionKindApplyPatch is a generated Codex app-server protocol constant.
	GuardianApprovalReviewActionKindApplyPatch GuardianApprovalReviewActionKind = "applyPatch"
	// GuardianApprovalReviewActionKindCommand is a generated Codex app-server protocol constant.
	GuardianApprovalReviewActionKindCommand GuardianApprovalReviewActionKind = "command"
	// GuardianApprovalReviewActionKindExecve is a generated Codex app-server protocol constant.
	GuardianApprovalReviewActionKindExecve GuardianApprovalReviewActionKind = "execve"
	// GuardianApprovalReviewActionKindMCPToolCall is a generated Codex app-server protocol constant.
	GuardianApprovalReviewActionKindMCPToolCall GuardianApprovalReviewActionKind = "mcpToolCall"
	// GuardianApprovalReviewActionKindNetworkAccess is a generated Codex app-server protocol constant.
	GuardianApprovalReviewActionKindNetworkAccess GuardianApprovalReviewActionKind = "networkAccess"
	// GuardianApprovalReviewActionKindRequestPermissions is a generated Codex app-server protocol constant.
	GuardianApprovalReviewActionKindRequestPermissions GuardianApprovalReviewActionKind = "requestPermissions"
)

type GuardianWarningNotification 

type GuardianWarningNotification = SanitizedGuardianWarningNotificationJSON

GuardianWarningNotification is a generated alias for a Codex app-server protocol type.

type HookCompletedNotification 

type HookCompletedNotification interface{}

HookCompletedNotification represents a generated Codex app-server protocol type.

type HookMigration 

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

HookMigration represents a generated Codex app-server protocol type.

type HookStartedNotification 

type HookStartedNotification interface{}

HookStartedNotification represents a generated Codex app-server protocol type.

type HooksListParams 

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

HooksListParams represents a generated Codex app-server protocol type.

type HooksListResponse 

type HooksListResponse interface{}

HooksListResponse represents a generated Codex app-server protocol type.

type ImageDetail 

type ImageDetail string

ImageDetail represents a generated Codex app-server protocol type. 

const ImageDetailAuto ImageDetail = "auto"

ImageDetailAuto is a generated Codex app-server protocol constant. 

const ImageDetailHigh ImageDetail = "high"

ImageDetailHigh is a generated Codex app-server protocol constant. 

const ImageDetailLow ImageDetail = "low"

ImageDetailLow is a generated Codex app-server protocol constant. 

const ImageDetailOriginal ImageDetail = "original"

ImageDetailOriginal is a generated Codex app-server protocol constant.

type InitializeCapabilities 

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

	// MCP extension settings declared by the app-server client.
	Extensions *InitializeCapabilitiesExtensions `json:"extensions,omitempty,omitzero"`

	// Legacy opt-in for the `openai/form` MCP extension.
	//
	// New clients should declare `openai/form` in [`Self::extensions`].
	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"`
}

InitializeCapabilities represents a generated Codex app-server protocol type. Client-declared capabilities negotiated during initialize.

type InitializeCapabilitiesExtensions added in v0.147.0 

type InitializeCapabilitiesExtensions map[string]interface{}

InitializeCapabilitiesExtensions represents a generated Codex app-server protocol type. MCP extension settings declared by the app-server client.

type InitializeCapabilitiesOptOutNotificationMethods added in v0.144.0 

type InitializeCapabilitiesOptOutNotificationMethods []string

InitializeCapabilitiesOptOutNotificationMethods represents a generated Codex app-server protocol type. 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 *InitializeCapabilities `json:"capabilities,omitempty,omitzero"`

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

InitializeParams represents a generated Codex app-server protocol type.

type InitializeResponse 

type InitializeResponse interface{}

InitializeResponse represents a generated Codex app-server protocol type.

type InputModality 

type InputModality interface{}

InputModality represents a generated Codex app-server protocol type. Canonical user-input modality tags advertised by a model.

type InstalledApp added in v0.147.0 

type InstalledApp struct {
	// Whether the connector is enabled and has a non-synthetic, model-visible tool
	// allowed by effective MCP and app/tool policy in the committed runtime snapshot.
	Callable bool `json:"callable"`

	// Effective enabled state after applying global, workspace, local, and managed
	// configuration at read time.
	Enabled bool `json:"enabled"`

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

	// Best-effort name carried by the runtime tool catalog. Canonical app metadata
	// remains owned by `app/read`.
	RuntimeName InstalledAppRuntimeName `json:"runtimeName,omitempty,omitzero"`
}

InstalledApp represents a generated Codex app-server protocol type. Installed connector runtime state.

type InstalledAppRuntimeName added in v0.147.0 

type InstalledAppRuntimeName *string

InstalledAppRuntimeName represents a generated Codex app-server protocol type. Best-effort name carried by the runtime tool catalog. Canonical app metadata remains owned by `app/read`.

type InternalChatMessageMetadataPassthrough 

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

InternalChatMessageMetadataPassthrough represents a generated Codex app-server protocol type. 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

InternalChatMessageMetadataPassthroughTurnID represents a generated Codex app-server protocol type.

type ItemCompletedNotification 

type ItemCompletedNotification struct {
	ThreadID      string     `json:"threadId"`
	TurnID        string     `json:"turnId"`
	Item          ThreadItem `json:"item"`
	CompletedAtMs int64      `json:"completedAtMs"`
}

ItemCompletedNotification is the payload for item/completed.

type ItemGuardianApprovalReviewCompletedNotification 

type ItemGuardianApprovalReviewCompletedNotification interface{}

ItemGuardianApprovalReviewCompletedNotification represents a generated Codex app-server protocol type.

type ItemGuardianApprovalReviewStartedNotification 

type ItemGuardianApprovalReviewStartedNotification interface{}

ItemGuardianApprovalReviewStartedNotification represents a generated Codex app-server protocol type.

type ItemStartedNotification 

type ItemStartedNotification interface{}

ItemStartedNotification represents a generated Codex app-server protocol type.

type LegacyAppPathString 

type LegacyAppPathString string

LegacyAppPathString represents a generated Codex app-server protocol type.

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 *MCPServerStatusDetail `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"`
}

ListMCPServerStatusParams represents a generated Codex app-server protocol type.

type ListMCPServerStatusParamsCursor added in v0.144.0 

type ListMCPServerStatusParamsCursor *string

ListMCPServerStatusParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type ListMCPServerStatusParamsLimit added in v0.144.0 

type ListMCPServerStatusParamsLimit *int

ListMCPServerStatusParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a server-defined value.

type ListMCPServerStatusParamsThreadID added in v0.144.0 

type ListMCPServerStatusParamsThreadID *string

ListMCPServerStatusParamsThreadID represents a generated Codex app-server protocol type.

type ListMCPServerStatusResponse added in v0.147.0 

type ListMCPServerStatusResponse = SanitizedListMCPServerStatusResponseJSON

ListMCPServerStatusResponse is a generated alias for a Codex app-server protocol type.

type ListMcpServerStatusParams deprecated 

type ListMcpServerStatusParams = ListMCPServerStatusParams

ListMcpServerStatusParams is the former spelling of ListMCPServerStatusParams.

Deprecated: use ListMCPServerStatusParams.

type ListMcpServerStatusResponse deprecated 

type ListMcpServerStatusResponse = ListMCPServerStatusResponse

ListMcpServerStatusResponse is the former spelling of ListMCPServerStatusResponse.

Deprecated: use ListMCPServerStatusResponse.

type LocalShellAction 

type LocalShellAction interface{}

LocalShellAction represents a generated Codex app-server protocol type.

type LocalShellStatus 

type LocalShellStatus string

LocalShellStatus represents a generated Codex app-server protocol type. 

const LocalShellStatusCompleted LocalShellStatus = "completed"

LocalShellStatusCompleted is a generated Codex app-server protocol constant. 

const LocalShellStatusInProgress LocalShellStatus = "in_progress"

LocalShellStatusInProgress is a generated Codex app-server protocol constant. 

const LocalShellStatusIncomplete LocalShellStatus = "incomplete"

LocalShellStatusIncomplete is a generated Codex app-server protocol constant.

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 

func (value LoginAccountParams) Kind() LoginAccountParamsKind

Kind returns the payload discriminator, including unknown future values.

func (LoginAccountParams) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type LoginAccountParamsKind added in v0.145.0 

type LoginAccountParamsKind string

LoginAccountParamsKind identifies a known LoginAccountParams variant. 

const (
	// LoginAccountParamsKindAmazonBedrock is a generated Codex app-server protocol constant.
	LoginAccountParamsKindAmazonBedrock LoginAccountParamsKind = "amazonBedrock"
	// LoginAccountParamsKindApiKey is a generated Codex app-server protocol constant.
	LoginAccountParamsKindApiKey LoginAccountParamsKind = "apiKey"
	// LoginAccountParamsKindChatgpt is a generated Codex app-server protocol constant.
	LoginAccountParamsKindChatgpt LoginAccountParamsKind = "chatgpt"
	// LoginAccountParamsKindChatgptAuthTokens is a generated Codex app-server protocol constant.
	LoginAccountParamsKindChatgptAuthTokens LoginAccountParamsKind = "chatgptAuthTokens"
	// LoginAccountParamsKindChatgptDeviceCode is a generated Codex app-server protocol constant.
	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 

func (value LoginAccountResponse) Kind() LoginAccountResponseKind

Kind returns the payload discriminator, including unknown future values.

func (LoginAccountResponse) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type LoginAccountResponseKind added in v0.145.0 

type LoginAccountResponseKind string

LoginAccountResponseKind identifies a known LoginAccountResponse variant. 

const (
	// LoginAccountResponseKindAmazonBedrock is a generated Codex app-server protocol constant.
	LoginAccountResponseKindAmazonBedrock LoginAccountResponseKind = "amazonBedrock"
	// LoginAccountResponseKindApiKey is a generated Codex app-server protocol constant.
	LoginAccountResponseKindApiKey LoginAccountResponseKind = "apiKey"
	// LoginAccountResponseKindChatgpt is a generated Codex app-server protocol constant.
	LoginAccountResponseKindChatgpt LoginAccountResponseKind = "chatgpt"
	// LoginAccountResponseKindChatgptAuthTokens is a generated Codex app-server protocol constant.
	LoginAccountResponseKindChatgptAuthTokens LoginAccountResponseKind = "chatgptAuthTokens"
	// LoginAccountResponseKindChatgptDeviceCode is a generated Codex app-server protocol constant.
	LoginAccountResponseKindChatgptDeviceCode LoginAccountResponseKind = "chatgptDeviceCode"
)

type LoginAppBrand added in v0.144.0 

type LoginAppBrand string

LoginAppBrand represents a generated Codex app-server protocol type. 

const LoginAppBrandChatgpt LoginAppBrand = "chatgpt"

LoginAppBrandChatgpt is a generated Codex app-server protocol constant. 

const LoginAppBrandCodex LoginAppBrand = "codex"

LoginAppBrandCodex is a generated Codex app-server protocol constant.

type LogoutAccountResponse 

type LogoutAccountResponse = SanitizedLogoutAccountResponseJSON

LogoutAccountResponse is a generated alias for a Codex app-server protocol type.

type MCPAuthStatus 

type MCPAuthStatus string

MCPAuthStatus represents a generated Codex app-server protocol type. 

const MCPAuthStatusBearerToken MCPAuthStatus = "bearerToken"

MCPAuthStatusBearerToken is a generated Codex app-server protocol constant. 

const MCPAuthStatusNotLoggedIn MCPAuthStatus = "notLoggedIn"

MCPAuthStatusNotLoggedIn is a generated Codex app-server protocol constant. 

const MCPAuthStatusOAuth MCPAuthStatus = "oAuth"

MCPAuthStatusOAuth is a generated Codex app-server protocol constant. 

const MCPAuthStatusUnknown MCPAuthStatus = "unknown"

MCPAuthStatusUnknown is a generated Codex app-server protocol constant. 

const MCPAuthStatusUnsupported MCPAuthStatus = "unsupported"

MCPAuthStatusUnsupported is a generated Codex app-server protocol constant.

type MCPElicitationArrayType 

type MCPElicitationArrayType string

MCPElicitationArrayType represents a generated Codex app-server protocol type. 

const MCPElicitationArrayTypeArray MCPElicitationArrayType = "array"

MCPElicitationArrayTypeArray is a generated Codex app-server protocol constant.

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"`
}

MCPElicitationBooleanSchema represents a generated Codex app-server protocol type.

type MCPElicitationBooleanSchemaDefault added in v0.144.0 

type MCPElicitationBooleanSchemaDefault *bool

MCPElicitationBooleanSchemaDefault represents a generated Codex app-server protocol type.

type MCPElicitationBooleanSchemaDescription added in v0.144.0 

type MCPElicitationBooleanSchemaDescription *string

MCPElicitationBooleanSchemaDescription represents a generated Codex app-server protocol type.

type MCPElicitationBooleanSchemaTitle added in v0.144.0 

type MCPElicitationBooleanSchemaTitle *string

MCPElicitationBooleanSchemaTitle represents a generated Codex app-server protocol type.

type MCPElicitationBooleanType 

type MCPElicitationBooleanType string

MCPElicitationBooleanType represents a generated Codex app-server protocol type. 

const MCPElicitationBooleanTypeBoolean MCPElicitationBooleanType = "boolean"

MCPElicitationBooleanTypeBoolean is a generated Codex app-server protocol constant.

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"`
}

MCPElicitationConstOption represents a generated Codex app-server protocol type.

type MCPElicitationEnumSchema 

type MCPElicitationEnumSchema interface{}

MCPElicitationEnumSchema represents a generated Codex app-server protocol type.

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"`
}

MCPElicitationLegacyTitledEnumSchema represents a generated Codex app-server protocol type.

type MCPElicitationLegacyTitledEnumSchemaDefault added in v0.144.0 

type MCPElicitationLegacyTitledEnumSchemaDefault *string

MCPElicitationLegacyTitledEnumSchemaDefault represents a generated Codex app-server protocol type.

type MCPElicitationLegacyTitledEnumSchemaDescription added in v0.144.0 

type MCPElicitationLegacyTitledEnumSchemaDescription *string

MCPElicitationLegacyTitledEnumSchemaDescription represents a generated Codex app-server protocol type.

type MCPElicitationLegacyTitledEnumSchemaEnumNames added in v0.144.0 

type MCPElicitationLegacyTitledEnumSchemaEnumNames []string

MCPElicitationLegacyTitledEnumSchemaEnumNames represents a generated Codex app-server protocol type.

type MCPElicitationLegacyTitledEnumSchemaTitle added in v0.144.0 

type MCPElicitationLegacyTitledEnumSchemaTitle *string

MCPElicitationLegacyTitledEnumSchemaTitle represents a generated Codex app-server protocol type.

type MCPElicitationMultiSelectEnumSchema 

type MCPElicitationMultiSelectEnumSchema interface{}

MCPElicitationMultiSelectEnumSchema represents a generated Codex app-server protocol type.

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"`
}

MCPElicitationNumberSchema represents a generated Codex app-server protocol type.

type MCPElicitationNumberSchemaDefault added in v0.144.0 

type MCPElicitationNumberSchemaDefault *float64

MCPElicitationNumberSchemaDefault represents a generated Codex app-server protocol type.

type MCPElicitationNumberSchemaDescription added in v0.144.0 

type MCPElicitationNumberSchemaDescription *string

MCPElicitationNumberSchemaDescription represents a generated Codex app-server protocol type.

type MCPElicitationNumberSchemaMaximum added in v0.144.0 

type MCPElicitationNumberSchemaMaximum *float64

MCPElicitationNumberSchemaMaximum represents a generated Codex app-server protocol type.

type MCPElicitationNumberSchemaMinimum added in v0.144.0 

type MCPElicitationNumberSchemaMinimum *float64

MCPElicitationNumberSchemaMinimum represents a generated Codex app-server protocol type.

type MCPElicitationNumberSchemaTitle added in v0.144.0 

type MCPElicitationNumberSchemaTitle *string

MCPElicitationNumberSchemaTitle represents a generated Codex app-server protocol type.

type MCPElicitationNumberType 

type MCPElicitationNumberType string

MCPElicitationNumberType represents a generated Codex app-server protocol type. 

const MCPElicitationNumberTypeInteger MCPElicitationNumberType = "integer"

MCPElicitationNumberTypeInteger is a generated Codex app-server protocol constant. 

const MCPElicitationNumberTypeNumber MCPElicitationNumberType = "number"

MCPElicitationNumberTypeNumber is a generated Codex app-server protocol constant.

type MCPElicitationObjectType 

type MCPElicitationObjectType string

MCPElicitationObjectType represents a generated Codex app-server protocol type. 

const MCPElicitationObjectTypeObject MCPElicitationObjectType = "object"

MCPElicitationObjectTypeObject is a generated Codex app-server protocol constant.

type MCPElicitationPrimitiveSchema 

type MCPElicitationPrimitiveSchema interface{}

MCPElicitationPrimitiveSchema represents a generated Codex app-server protocol type.

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"`
}

MCPElicitationSchema represents a generated Codex app-server protocol 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

MCPElicitationSchemaProperties represents a generated Codex app-server protocol type.

type MCPElicitationSchemaRequired added in v0.144.0 

type MCPElicitationSchemaRequired []string

MCPElicitationSchemaRequired represents a generated Codex app-server protocol type.

type MCPElicitationSchemaSchema added in v0.144.0 

type MCPElicitationSchemaSchema *string

MCPElicitationSchemaSchema represents a generated Codex app-server protocol type.

type MCPElicitationSingleSelectEnumSchema 

type MCPElicitationSingleSelectEnumSchema interface{}

MCPElicitationSingleSelectEnumSchema represents a generated Codex app-server protocol type.

type MCPElicitationStringFormat 

type MCPElicitationStringFormat string

MCPElicitationStringFormat represents a generated Codex app-server protocol type. 

const MCPElicitationStringFormatDate MCPElicitationStringFormat = "date"

MCPElicitationStringFormatDate is a generated Codex app-server protocol constant. 

const MCPElicitationStringFormatDateTime MCPElicitationStringFormat = "date-time"

MCPElicitationStringFormatDateTime is a generated Codex app-server protocol constant. 

const MCPElicitationStringFormatEmail MCPElicitationStringFormat = "email"

MCPElicitationStringFormatEmail is a generated Codex app-server protocol constant. 

const MCPElicitationStringFormatUri MCPElicitationStringFormat = "uri"

MCPElicitationStringFormatUri is a generated Codex app-server protocol constant.

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 *MCPElicitationStringFormat `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"`
}

MCPElicitationStringSchema represents a generated Codex app-server protocol type.

type MCPElicitationStringSchemaDefault added in v0.144.0 

type MCPElicitationStringSchemaDefault *string

MCPElicitationStringSchemaDefault represents a generated Codex app-server protocol type.

type MCPElicitationStringSchemaDescription added in v0.144.0 

type MCPElicitationStringSchemaDescription *string

MCPElicitationStringSchemaDescription represents a generated Codex app-server protocol type.

type MCPElicitationStringSchemaMaxLength added in v0.144.0 

type MCPElicitationStringSchemaMaxLength *int

MCPElicitationStringSchemaMaxLength represents a generated Codex app-server protocol type.

type MCPElicitationStringSchemaMinLength added in v0.144.0 

type MCPElicitationStringSchemaMinLength *int

MCPElicitationStringSchemaMinLength represents a generated Codex app-server protocol type.

type MCPElicitationStringSchemaTitle added in v0.144.0 

type MCPElicitationStringSchemaTitle *string

MCPElicitationStringSchemaTitle represents a generated Codex app-server protocol type.

type MCPElicitationStringType 

type MCPElicitationStringType string

MCPElicitationStringType represents a generated Codex app-server protocol type. 

const MCPElicitationStringTypeString MCPElicitationStringType = "string"

MCPElicitationStringTypeString is a generated Codex app-server protocol constant.

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"`
}

MCPResourceReadParams represents a generated Codex app-server protocol type.

type MCPResourceReadParamsThreadID added in v0.144.0 

type MCPResourceReadParamsThreadID *string

MCPResourceReadParamsThreadID represents a generated Codex app-server protocol type.

type MCPResourceReadResponse added in v0.147.0 

type MCPResourceReadResponse = SanitizedMCPResourceReadResponseJSON

MCPResourceReadResponse is a generated alias for a Codex app-server protocol type.

type MCPServerElicitationAction 

type MCPServerElicitationAction string

MCPServerElicitationAction represents a generated Codex app-server protocol type. 

const MCPServerElicitationActionAccept MCPServerElicitationAction = "accept"

MCPServerElicitationActionAccept is a generated Codex app-server protocol constant. 

const MCPServerElicitationActionCancel MCPServerElicitationAction = "cancel"

MCPServerElicitationActionCancel is a generated Codex app-server protocol constant. 

const MCPServerElicitationActionDecline MCPServerElicitationAction = "decline"

MCPServerElicitationActionDecline is a generated Codex app-server protocol constant.

type MCPServerElicitationRequestParams added in v0.147.0 

type MCPServerElicitationRequestParams = json.RawMessage

MCPServerElicitationRequestParams preserves the complete mixed elicitation request payload. Its variants do not share a stable discriminator.

type MCPServerElicitationRequestResponse added in v0.147.0 

type MCPServerElicitationRequestResponse = SanitizedMCPServerElicitationRequestResponseJSON

MCPServerElicitationRequestResponse is a generated alias for a Codex app-server protocol type.

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"`
}

MCPServerInfo represents a generated Codex app-server protocol type. Presentation metadata advertised by an initialized MCP server.

type MCPServerInfoDescription added in v0.144.0 

type MCPServerInfoDescription *string

MCPServerInfoDescription represents a generated Codex app-server protocol type.

type MCPServerInfoIcons added in v0.144.0 

type MCPServerInfoIcons []interface{}

MCPServerInfoIcons represents a generated Codex app-server protocol type.

type MCPServerInfoTitle added in v0.144.0 

type MCPServerInfoTitle *string

MCPServerInfoTitle represents a generated Codex app-server protocol type.

type MCPServerInfoWebsiteURL added in v0.144.0 

type MCPServerInfoWebsiteURL *string

MCPServerInfoWebsiteURL represents a generated Codex app-server protocol type.

type MCPServerMigration 

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

MCPServerMigration represents a generated Codex app-server protocol type.

type MCPServerOAuthLoginCompletedNotification added in v0.147.0 

type MCPServerOAuthLoginCompletedNotification = SanitizedMCPServerOAuthLoginCompletedNotificationJSON

MCPServerOAuthLoginCompletedNotification is a generated alias for a Codex app-server protocol type.

type MCPServerOAuthLoginParams added in v0.147.0 

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"`
}

MCPServerOAuthLoginParams represents a generated Codex app-server protocol type.

type MCPServerOAuthLoginParamsScopes added in v0.147.0 

type MCPServerOAuthLoginParamsScopes []string

MCPServerOAuthLoginParamsScopes represents a generated Codex app-server protocol type.

type MCPServerOAuthLoginParamsThreadID added in v0.147.0 

type MCPServerOAuthLoginParamsThreadID *string

MCPServerOAuthLoginParamsThreadID represents a generated Codex app-server protocol type.

type MCPServerOAuthLoginParamsTimeoutSecs added in v0.147.0 

type MCPServerOAuthLoginParamsTimeoutSecs *int

MCPServerOAuthLoginParamsTimeoutSecs represents a generated Codex app-server protocol type.

type MCPServerOAuthLoginResponse added in v0.147.0 

type MCPServerOAuthLoginResponse = SanitizedMCPServerOAuthLoginResponseJSON

MCPServerOAuthLoginResponse is a generated alias for a Codex app-server protocol type.

type MCPServerOauthLoginParams deprecated 

type MCPServerOauthLoginParams = MCPServerOAuthLoginParams

MCPServerOauthLoginParams is the former spelling of MCPServerOAuthLoginParams.

Deprecated: use MCPServerOAuthLoginParams.

type MCPServerOauthLoginParamsScopes deprecated added in v0.144.0 

type MCPServerOauthLoginParamsScopes = MCPServerOAuthLoginParamsScopes

MCPServerOauthLoginParamsScopes is the former spelling of MCPServerOAuthLoginParamsScopes.

Deprecated: use MCPServerOAuthLoginParamsScopes.

type MCPServerOauthLoginParamsThreadID deprecated added in v0.144.0 

type MCPServerOauthLoginParamsThreadID = MCPServerOAuthLoginParamsThreadID

MCPServerOauthLoginParamsThreadID is the former spelling of MCPServerOAuthLoginParamsThreadID.

Deprecated: use MCPServerOAuthLoginParamsThreadID.

type MCPServerOauthLoginParamsTimeoutSecs deprecated added in v0.144.0 

type MCPServerOauthLoginParamsTimeoutSecs = MCPServerOAuthLoginParamsTimeoutSecs

MCPServerOauthLoginParamsTimeoutSecs is the former spelling of MCPServerOAuthLoginParamsTimeoutSecs.

Deprecated: use MCPServerOAuthLoginParamsTimeoutSecs.

type MCPServerRefreshResponse added in v0.147.0 

type MCPServerRefreshResponse = SanitizedMCPServerRefreshResponseJSON

MCPServerRefreshResponse is a generated alias for a Codex app-server protocol type.

type MCPServerStartupFailureReason 

type MCPServerStartupFailureReason string

MCPServerStartupFailureReason represents a generated Codex app-server protocol type. 

const MCPServerStartupFailureReasonReauthenticationRequired MCPServerStartupFailureReason = "reauthenticationRequired"

MCPServerStartupFailureReasonReauthenticationRequired is a generated Codex app-server protocol constant.

type MCPServerStartupState 

type MCPServerStartupState string

MCPServerStartupState represents a generated Codex app-server protocol type. 

const MCPServerStartupStateCancelled MCPServerStartupState = "cancelled"

MCPServerStartupStateCancelled is a generated Codex app-server protocol constant. 

const MCPServerStartupStateFailed MCPServerStartupState = "failed"

MCPServerStartupStateFailed is a generated Codex app-server protocol constant. 

const MCPServerStartupStateReady MCPServerStartupState = "ready"

MCPServerStartupStateReady is a generated Codex app-server protocol constant. 

const MCPServerStartupStateStarting MCPServerStartupState = "starting"

MCPServerStartupStateStarting is a generated Codex app-server protocol constant.

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 *MCPServerInfo `json:"serverInfo,omitempty,omitzero"`

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

MCPServerStatus represents a generated Codex app-server protocol type.

type MCPServerStatusDetail 

type MCPServerStatusDetail string

MCPServerStatusDetail represents a generated Codex app-server protocol type. 

const MCPServerStatusDetailFull MCPServerStatusDetail = "full"

MCPServerStatusDetailFull is a generated Codex app-server protocol constant. 

const MCPServerStatusDetailToolsAndAuthOnly MCPServerStatusDetail = "toolsAndAuthOnly"

MCPServerStatusDetailToolsAndAuthOnly is a generated Codex app-server protocol constant.

type MCPServerStatusTools added in v0.144.0 

type MCPServerStatusTools map[string]Tool

MCPServerStatusTools represents a generated Codex app-server protocol type.

type MCPServerStatusUpdatedNotification added in v0.147.0 

type MCPServerStatusUpdatedNotification = SanitizedMCPServerStatusUpdatedNotificationJSON

MCPServerStatusUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

MCPServerToolCallParams represents a generated Codex app-server protocol type.

type MCPServerToolCallResponse added in v0.147.0 

type MCPServerToolCallResponse = SanitizedMCPServerToolCallResponseJSON

MCPServerToolCallResponse is a generated alias for a Codex app-server protocol type.

type MCPToolCallProgressNotification added in v0.147.0 

type MCPToolCallProgressNotification = SanitizedMCPToolCallProgressNotificationJSON

MCPToolCallProgressNotification is a generated alias for a Codex app-server protocol type.

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"`

	// SessionEnd corresponds to the JSON schema field "SessionEnd".
	SessionEnd []ConfiguredHookMatcherGroup `json:"SessionEnd,omitempty,omitzero"`

	// 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"`
}

ManagedHooksRequirements represents a generated Codex app-server protocol type.

type ManagedHooksRequirementsManagedDir added in v0.144.0 

type ManagedHooksRequirementsManagedDir *string

ManagedHooksRequirementsManagedDir represents a generated Codex app-server protocol type.

type ManagedHooksRequirementsWindowsManagedDir added in v0.144.0 

type ManagedHooksRequirementsWindowsManagedDir *string

ManagedHooksRequirementsWindowsManagedDir represents a generated Codex app-server protocol type.

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"`
}

MarketplaceAddParams represents a generated Codex app-server protocol type.

type MarketplaceAddParamsRefName added in v0.144.0 

type MarketplaceAddParamsRefName *string

MarketplaceAddParamsRefName represents a generated Codex app-server protocol type.

type MarketplaceAddParamsSparsePaths added in v0.144.0 

type MarketplaceAddParamsSparsePaths []string

MarketplaceAddParamsSparsePaths represents a generated Codex app-server protocol type.

type MarketplaceAddResponse 

type MarketplaceAddResponse interface{}

MarketplaceAddResponse represents a generated Codex app-server protocol type.

type MarketplaceRemoveParams 

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

MarketplaceRemoveParams represents a generated Codex app-server protocol type.

type MarketplaceRemoveResponse 

type MarketplaceRemoveResponse interface{}

MarketplaceRemoveResponse represents a generated Codex app-server protocol type.

type MarketplaceUpgradeParams 

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

MarketplaceUpgradeParams represents a generated Codex app-server protocol type.

type MarketplaceUpgradeParamsMarketplaceName added in v0.144.0 

type MarketplaceUpgradeParamsMarketplaceName *string

MarketplaceUpgradeParamsMarketplaceName represents a generated Codex app-server protocol type.

type MarketplaceUpgradeResponse 

type MarketplaceUpgradeResponse interface{}

MarketplaceUpgradeResponse represents a generated Codex app-server protocol type.

type McpResourceReadParams deprecated 

type McpResourceReadParams = MCPResourceReadParams

McpResourceReadParams is the former spelling of MCPResourceReadParams.

Deprecated: use MCPResourceReadParams.

type McpResourceReadResponse deprecated 

type McpResourceReadResponse = MCPResourceReadResponse

McpResourceReadResponse is the former spelling of MCPResourceReadResponse.

Deprecated: use MCPResourceReadResponse.

type McpServerElicitationRequestParams deprecated 

type McpServerElicitationRequestParams = MCPServerElicitationRequestParams

McpServerElicitationRequestParams is the former spelling of MCPServerElicitationRequestParams.

Deprecated: use MCPServerElicitationRequestParams.

type McpServerElicitationRequestResponse deprecated 

type McpServerElicitationRequestResponse = MCPServerElicitationRequestResponse

McpServerElicitationRequestResponse is the former spelling of MCPServerElicitationRequestResponse.

Deprecated: use MCPServerElicitationRequestResponse.

type McpServerOauthLoginCompletedNotification deprecated 

type McpServerOauthLoginCompletedNotification = MCPServerOAuthLoginCompletedNotification

McpServerOauthLoginCompletedNotification is the former spelling of MCPServerOAuthLoginCompletedNotification.

Deprecated: use MCPServerOAuthLoginCompletedNotification.

type McpServerOauthLoginParams deprecated 

type McpServerOauthLoginParams = MCPServerOAuthLoginParams

McpServerOauthLoginParams is the former spelling of MCPServerOAuthLoginParams.

Deprecated: use MCPServerOAuthLoginParams.

type McpServerOauthLoginResponse deprecated 

type McpServerOauthLoginResponse = MCPServerOAuthLoginResponse

McpServerOauthLoginResponse is the former spelling of MCPServerOAuthLoginResponse.

Deprecated: use MCPServerOAuthLoginResponse.

type McpServerRefreshResponse deprecated 

type McpServerRefreshResponse = MCPServerRefreshResponse

McpServerRefreshResponse is the former spelling of MCPServerRefreshResponse.

Deprecated: use MCPServerRefreshResponse.

type McpServerStatusUpdatedNotification deprecated 

type McpServerStatusUpdatedNotification = MCPServerStatusUpdatedNotification

McpServerStatusUpdatedNotification is the former spelling of MCPServerStatusUpdatedNotification.

Deprecated: use MCPServerStatusUpdatedNotification.

type McpServerToolCallParams deprecated 

type McpServerToolCallParams = MCPServerToolCallParams

McpServerToolCallParams is the former spelling of MCPServerToolCallParams.

Deprecated: use MCPServerToolCallParams.

type McpServerToolCallResponse deprecated 

type McpServerToolCallResponse = MCPServerToolCallResponse

McpServerToolCallResponse is the former spelling of MCPServerToolCallResponse.

Deprecated: use MCPServerToolCallResponse.

type McpToolCallProgressNotification deprecated 

type McpToolCallProgressNotification = MCPToolCallProgressNotification

McpToolCallProgressNotification is the former spelling of MCPToolCallProgressNotification.

Deprecated: use MCPToolCallProgressNotification.

type MergeStrategy 

type MergeStrategy string

MergeStrategy represents a generated Codex app-server protocol type. 

const MergeStrategyReplace MergeStrategy = "replace"

MergeStrategyReplace is a generated Codex app-server protocol constant. 

const MergeStrategyUpsert MergeStrategy = "upsert"

MergeStrategyUpsert is a generated Codex app-server protocol constant.

type MessagePhase 

type MessagePhase interface{}

MessagePhase represents a generated Codex app-server protocol type. 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"`

	// Memory corresponds to the JSON schema field "memory".
	Memory []string `json:"memory,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"`
}

MigrationDetails represents a generated Codex app-server protocol type.

type ModeKind 

type ModeKind string

ModeKind represents a generated Codex app-server protocol type. 

const ModeKindDefault ModeKind = "default"

ModeKindDefault is a generated Codex app-server protocol constant. 

const ModeKindPlan ModeKind = "plan"

ModeKindPlan is a generated Codex app-server protocol constant.

type Model 

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

	// AvailabilityNux corresponds to the JSON schema field "availabilityNux".
	AvailabilityNux *ModelAvailabilityNux `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"`

	// ModelSpecialty corresponds to the JSON schema field "modelSpecialty".
	ModelSpecialty ModelModelSpecialty `json:"modelSpecialty,omitempty,omitzero"`

	// 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 *ModelUpgradeInfo `json:"upgradeInfo,omitempty,omitzero"`
}

Model represents a generated Codex app-server protocol type.

type ModelAvailabilityNux 

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

ModelAvailabilityNux represents a generated Codex app-server protocol type.

type ModelDefaultServiceTier added in v0.144.0 

type ModelDefaultServiceTier *string

ModelDefaultServiceTier represents a generated Codex app-server protocol type. 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"`
}

ModelListParams represents a generated Codex app-server protocol type.

type ModelListParamsCursor added in v0.144.0 

type ModelListParamsCursor *string

ModelListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type ModelListParamsIncludeHidden added in v0.144.0 

type ModelListParamsIncludeHidden *bool

ModelListParamsIncludeHidden represents a generated Codex app-server protocol type. When true, include models that are hidden from the default picker list.

type ModelListParamsLimit added in v0.144.0 

type ModelListParamsLimit *int

ModelListParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type ModelListResponse 

type ModelListResponse = SanitizedModelListResponseJSON

ModelListResponse is a generated alias for a Codex app-server protocol type.

type ModelModelSpecialty added in v0.147.0 

type ModelModelSpecialty *string

ModelModelSpecialty represents a generated Codex app-server protocol type.

type ModelProviderCapabilitiesReadParams 

type ModelProviderCapabilitiesReadParams map[string]interface{}

ModelProviderCapabilitiesReadParams represents a generated Codex app-server protocol type.

type ModelProviderCapabilitiesReadResponse 

type ModelProviderCapabilitiesReadResponse = SanitizedModelProviderCapabilitiesReadResponseJSON

ModelProviderCapabilitiesReadResponse is a generated alias for a Codex app-server protocol type.

type ModelRerouteReason 

type ModelRerouteReason string

ModelRerouteReason represents a generated Codex app-server protocol type. 

const ModelRerouteReasonHighRiskCyberActivity ModelRerouteReason = "highRiskCyberActivity"

ModelRerouteReasonHighRiskCyberActivity is a generated Codex app-server protocol constant.

type ModelReroutedNotification 

type ModelReroutedNotification = SanitizedModelReroutedNotificationJSON

ModelReroutedNotification is a generated alias for a Codex app-server protocol type.

type ModelSafetyBufferingUpdatedNotification 

type ModelSafetyBufferingUpdatedNotification = SanitizedModelSafetyBufferingUpdatedNotificationJSON

ModelSafetyBufferingUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

ModelServiceTier represents a generated Codex app-server protocol type.

type ModelUpgrade added in v0.144.0 

type ModelUpgrade *string

ModelUpgrade represents a generated Codex app-server protocol type.

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"`
}

ModelUpgradeInfo represents a generated Codex app-server protocol type.

type ModelUpgradeInfoMigrationMarkdown added in v0.144.0 

type ModelUpgradeInfoMigrationMarkdown *string

ModelUpgradeInfoMigrationMarkdown represents a generated Codex app-server protocol type. 

type ModelUpgradeInfoModelLink *string

ModelUpgradeInfoModelLink represents a generated Codex app-server protocol type.

type ModelUpgradeInfoUpgradeCopy added in v0.144.0 

type ModelUpgradeInfoUpgradeCopy *string

ModelUpgradeInfoUpgradeCopy represents a generated Codex app-server protocol type.

type ModelVerification 

type ModelVerification string

ModelVerification represents a generated Codex app-server protocol type. 

const ModelVerificationTrustedAccessForCyber ModelVerification = "trustedAccessForCyber"

ModelVerificationTrustedAccessForCyber is a generated Codex app-server protocol constant.

type ModelVerificationNotification 

type ModelVerificationNotification = SanitizedModelVerificationNotificationJSON

ModelVerificationNotification is a generated alias for a Codex app-server protocol type.

type ModelsRequirements 

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

ModelsRequirements represents a generated Codex app-server protocol type.

type MultiAgentMode 

type MultiAgentMode interface{}

MultiAgentMode represents a generated Codex app-server protocol type. 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

NetworkAccess represents a generated Codex app-server protocol type. 

const NetworkAccessEnabled NetworkAccess = "enabled"

NetworkAccessEnabled is a generated Codex app-server protocol constant. 

const NetworkAccessRestricted NetworkAccess = "restricted"

NetworkAccessRestricted is a generated Codex app-server protocol constant.

type NetworkApprovalContext added in v0.147.0 

type NetworkApprovalContext struct {
	// Host corresponds to the JSON schema field "host".
	Host string `json:"host"`

	// Protocol corresponds to the JSON schema field "protocol".
	Protocol NetworkApprovalProtocol `json:"protocol"`
}

NetworkApprovalContext represents a generated Codex app-server protocol type.

type NetworkApprovalProtocol added in v0.147.0 

type NetworkApprovalProtocol string

NetworkApprovalProtocol represents a generated Codex app-server protocol type. 

const NetworkApprovalProtocolHTTP NetworkApprovalProtocol = "http"

NetworkApprovalProtocolHTTP is a generated Codex app-server protocol constant. 

const NetworkApprovalProtocolHttps NetworkApprovalProtocol = "https"

NetworkApprovalProtocolHttps is a generated Codex app-server protocol constant. 

const NetworkApprovalProtocolSocks5Tcp NetworkApprovalProtocol = "socks5Tcp"

NetworkApprovalProtocolSocks5Tcp is a generated Codex app-server protocol constant. 

const NetworkApprovalProtocolSocks5Udp NetworkApprovalProtocol = "socks5Udp"

NetworkApprovalProtocolSocks5Udp is a generated Codex app-server protocol constant.

type NetworkDomainPermission 

type NetworkDomainPermission string

NetworkDomainPermission represents a generated Codex app-server protocol type. 

const NetworkDomainPermissionAllow NetworkDomainPermission = "allow"

NetworkDomainPermissionAllow is a generated Codex app-server protocol constant. 

const NetworkDomainPermissionDeny NetworkDomainPermission = "deny"

NetworkDomainPermissionDeny is a generated Codex app-server protocol constant.

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"`
}

NetworkPolicyAmendment represents a generated Codex app-server protocol type.

type NetworkPolicyRuleAction 

type NetworkPolicyRuleAction string

NetworkPolicyRuleAction represents a generated Codex app-server protocol type. 

const NetworkPolicyRuleActionAllow NetworkPolicyRuleAction = "allow"

NetworkPolicyRuleActionAllow is a generated Codex app-server protocol constant. 

const NetworkPolicyRuleActionDeny NetworkPolicyRuleAction = "deny"

NetworkPolicyRuleActionDeny is a generated Codex app-server protocol constant.

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"`
}

NetworkRequirements represents a generated Codex app-server protocol type.

type NetworkRequirementsAllowLocalBinding added in v0.144.0 

type NetworkRequirementsAllowLocalBinding *bool

NetworkRequirementsAllowLocalBinding represents a generated Codex app-server protocol type.

type NetworkRequirementsAllowUnixSockets added in v0.144.0 

type NetworkRequirementsAllowUnixSockets []string

NetworkRequirementsAllowUnixSockets represents a generated Codex app-server protocol type. Legacy compatibility view derived from `unix_sockets`.

type NetworkRequirementsAllowUpstreamProxy added in v0.144.0 

type NetworkRequirementsAllowUpstreamProxy *bool

NetworkRequirementsAllowUpstreamProxy represents a generated Codex app-server protocol type.

type NetworkRequirementsAllowedDomains added in v0.144.0 

type NetworkRequirementsAllowedDomains []string

NetworkRequirementsAllowedDomains represents a generated Codex app-server protocol type. Legacy compatibility view derived from `domains`.

type NetworkRequirementsDangerouslyAllowAllUnixSockets added in v0.144.0 

type NetworkRequirementsDangerouslyAllowAllUnixSockets *bool

NetworkRequirementsDangerouslyAllowAllUnixSockets represents a generated Codex app-server protocol type.

type NetworkRequirementsDangerouslyAllowNonLoopbackProxy added in v0.144.0 

type NetworkRequirementsDangerouslyAllowNonLoopbackProxy *bool

NetworkRequirementsDangerouslyAllowNonLoopbackProxy represents a generated Codex app-server protocol type.

type NetworkRequirementsDeniedDomains added in v0.144.0 

type NetworkRequirementsDeniedDomains []string

NetworkRequirementsDeniedDomains represents a generated Codex app-server protocol type. Legacy compatibility view derived from `domains`.

type NetworkRequirementsDomains added in v0.144.0 

type NetworkRequirementsDomains map[string]NetworkDomainPermission

NetworkRequirementsDomains represents a generated Codex app-server protocol type. Canonical network permission map for `experimental_network`.

type NetworkRequirementsEnabled added in v0.144.0 

type NetworkRequirementsEnabled *bool

NetworkRequirementsEnabled represents a generated Codex app-server protocol type.

type NetworkRequirementsHTTPPort added in v0.144.0 

type NetworkRequirementsHTTPPort *int

NetworkRequirementsHTTPPort represents a generated Codex app-server protocol type.

type NetworkRequirementsManagedAllowedDomainsOnly added in v0.144.0 

type NetworkRequirementsManagedAllowedDomainsOnly *bool

NetworkRequirementsManagedAllowedDomainsOnly represents a generated Codex app-server protocol type. When true, only managed allowlist entries are respected while managed network enforcement is active.

type NetworkRequirementsSocksPort added in v0.144.0 

type NetworkRequirementsSocksPort *int

NetworkRequirementsSocksPort represents a generated Codex app-server protocol type.

type NetworkRequirementsUnixSockets added in v0.144.0 

type NetworkRequirementsUnixSockets map[string]NetworkUnixSocketPermission

NetworkRequirementsUnixSockets represents a generated Codex app-server protocol type. Canonical unix socket permission map for `experimental_network`.

type NetworkUnixSocketPermission 

type NetworkUnixSocketPermission string

NetworkUnixSocketPermission represents a generated Codex app-server protocol type. 

const NetworkUnixSocketPermissionAllow NetworkUnixSocketPermission = "allow"

NetworkUnixSocketPermissionAllow is a generated Codex app-server protocol constant. 

const NetworkUnixSocketPermissionDeny NetworkUnixSocketPermission = "deny"

NetworkUnixSocketPermissionDeny is a generated Codex app-server protocol constant.

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 *ReasoningEffort `json:"modelReasoningEffort,omitempty,omitzero"`

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

NewThreadModelDefaults represents a generated Codex app-server protocol type.

type NewThreadModelDefaultsModel added in v0.144.0 

type NewThreadModelDefaultsModel *string

NewThreadModelDefaultsModel represents a generated Codex app-server protocol type.

type NewThreadModelDefaultsServiceTier added in v0.144.0 

type NewThreadModelDefaultsServiceTier *string

NewThreadModelDefaultsServiceTier represents a generated Codex app-server protocol type.

type NonSteerableTurnKind 

type NonSteerableTurnKind string

NonSteerableTurnKind represents a generated Codex app-server protocol type. 

const NonSteerableTurnKindCompact NonSteerableTurnKind = "compact"

NonSteerableTurnKindCompact is a generated Codex app-server protocol constant. 

const NonSteerableTurnKindReview NonSteerableTurnKind = "review"

NonSteerableTurnKindReview is a generated Codex app-server protocol constant.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ParsedCommandKind added in v0.145.0 

type ParsedCommandKind string

ParsedCommandKind identifies a known ParsedCommand variant. 

const (
	// ParsedCommandKindListFiles is a generated Codex app-server protocol constant.
	ParsedCommandKindListFiles ParsedCommandKind = "list_files"
	// ParsedCommandKindRead is a generated Codex app-server protocol constant.
	ParsedCommandKindRead ParsedCommandKind = "read"
	// ParsedCommandKindSearch is a generated Codex app-server protocol constant.
	ParsedCommandKindSearch ParsedCommandKind = "search"
	// ParsedCommandKindUnknown is a generated Codex app-server protocol constant.
	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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type PatchChangeKindKind added in v0.145.0 

type PatchChangeKindKind string

PatchChangeKindKind identifies a known PatchChangeKind variant. 

const (
	// PatchChangeKindKindAdd is a generated Codex app-server protocol constant.
	PatchChangeKindKindAdd PatchChangeKindKind = "add"
	// PatchChangeKindKindDelete is a generated Codex app-server protocol constant.
	PatchChangeKindKindDelete PatchChangeKindKind = "delete"
	// PatchChangeKindKindUpdate is a generated Codex app-server protocol constant.
	PatchChangeKindKindUpdate PatchChangeKindKind = "update"
)

type PermissionGrantScope 

type PermissionGrantScope string

PermissionGrantScope represents a generated Codex app-server protocol type. 

const PermissionGrantScopeSession PermissionGrantScope = "session"

PermissionGrantScopeSession is a generated Codex app-server protocol constant. 

const PermissionGrantScopeTurn PermissionGrantScope = "turn"

PermissionGrantScopeTurn is a generated Codex app-server protocol constant.

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"`
}

PermissionProfileListParams represents a generated Codex app-server protocol type.

type PermissionProfileListParamsCursor added in v0.144.0 

type PermissionProfileListParamsCursor *string

PermissionProfileListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type PermissionProfileListParamsCwd added in v0.144.0 

type PermissionProfileListParamsCwd *string

PermissionProfileListParamsCwd represents a generated Codex app-server protocol type. Optional working directory to resolve project config layers.

type PermissionProfileListParamsLimit added in v0.144.0 

type PermissionProfileListParamsLimit *int

PermissionProfileListParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to the full result set.

type PermissionProfileListResponse 

type PermissionProfileListResponse = SanitizedPermissionProfileListResponseJSON

PermissionProfileListResponse is a generated alias for a Codex app-server protocol type.

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"`
}

PermissionProfileSummary represents a generated Codex app-server protocol type.

type PermissionProfileSummaryDescription added in v0.144.0 

type PermissionProfileSummaryDescription *string

PermissionProfileSummaryDescription represents a generated Codex app-server protocol type. 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"`
	EnvironmentID *string         `json:"environmentId"`
	StartedAtMs   int64           `json:"startedAtMs"`
	Cwd           AbsolutePathBuf `json:"cwd"`

	Reason      *string     `json:"reason"`
	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"`
	StrictAutoReview *bool       `json:"strictAutoReview,omitempty"`
}

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

type Personality 

type Personality string

Personality represents a generated Codex app-server protocol type. 

const PersonalityFriendly Personality = "friendly"

PersonalityFriendly is a generated Codex app-server protocol constant. 

const PersonalityNone Personality = "none"

PersonalityNone is a generated Codex app-server protocol constant. 

const PersonalityPragmatic Personality = "pragmatic"

PersonalityPragmatic is a generated Codex app-server protocol constant.

type PlanDeltaNotification 

type PlanDeltaNotification = SanitizedPlanDeltaNotificationJSON

PlanDeltaNotification is a generated alias for a Codex app-server protocol type.

type PlanType 

type PlanType string

PlanType represents a generated Codex app-server protocol type. 

const PlanTypeBusiness PlanType = "business"

PlanTypeBusiness is a generated Codex app-server protocol constant. 

const PlanTypeEdu PlanType = "edu"

PlanTypeEdu is a generated Codex app-server protocol constant. 

const PlanTypeEnt26 PlanType = "ent26"

PlanTypeEnt26 is a generated Codex app-server protocol constant. 

const PlanTypeEnterprise PlanType = "enterprise"

PlanTypeEnterprise is a generated Codex app-server protocol constant. 

const PlanTypeEnterpriseCbpAutomation PlanType = "enterprise_cbp_automation"

PlanTypeEnterpriseCbpAutomation is a generated Codex app-server protocol constant. 

const PlanTypeEnterpriseCbpUsageBased PlanType = "enterprise_cbp_usage_based"

PlanTypeEnterpriseCbpUsageBased is a generated Codex app-server protocol constant. 

const PlanTypeFree PlanType = "free"

PlanTypeFree is a generated Codex app-server protocol constant. 

const PlanTypeGo PlanType = "go"

PlanTypeGo is a generated Codex app-server protocol constant. 

const PlanTypePlus PlanType = "plus"

PlanTypePlus is a generated Codex app-server protocol constant. 

const PlanTypePro PlanType = "pro"

PlanTypePro is a generated Codex app-server protocol constant. 

const PlanTypeProlite PlanType = "prolite"

PlanTypeProlite is a generated Codex app-server protocol constant. 

const PlanTypeSelfServeBusinessProlite PlanType = "self_serve_business_prolite"

PlanTypeSelfServeBusinessProlite is a generated Codex app-server protocol constant. 

const PlanTypeSelfServeBusinessUsageBased PlanType = "self_serve_business_usage_based"

PlanTypeSelfServeBusinessUsageBased is a generated Codex app-server protocol constant. 

const PlanTypeTeam PlanType = "team"

PlanTypeTeam is a generated Codex app-server protocol constant. 

const PlanTypeUnknown PlanType = "unknown"

PlanTypeUnknown is a generated Codex app-server protocol constant.

type PluginAuthPolicy 

type PluginAuthPolicy string

PluginAuthPolicy represents a generated Codex app-server protocol type. 

const PluginAuthPolicyONINSTALL PluginAuthPolicy = "ON_INSTALL"

PluginAuthPolicyONINSTALL is a generated Codex app-server protocol constant. 

const PluginAuthPolicyONUSE PluginAuthPolicy = "ON_USE"

PluginAuthPolicyONUSE is a generated Codex app-server protocol constant.

type PluginInstallParams 

type PluginInstallParams struct {
	// MarketplacePath corresponds to the JSON schema field "marketplacePath".
	MarketplacePath *AbsolutePathBuf `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"`
}

PluginInstallParams represents a generated Codex app-server protocol type.

type PluginInstallParamsRemoteMarketplaceName added in v0.144.0 

type PluginInstallParamsRemoteMarketplaceName *string

PluginInstallParamsRemoteMarketplaceName represents a generated Codex app-server protocol type.

type PluginInstallResponse 

type PluginInstallResponse = SanitizedPluginInstallResponseJSON

PluginInstallResponse is a generated alias for a Codex app-server protocol type.

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"`
}

PluginInstalledParams represents a generated Codex app-server protocol type.

type PluginInstalledParamsCwds added in v0.144.0 

type PluginInstalledParamsCwds []AbsolutePathBuf

PluginInstalledParamsCwds represents a generated Codex app-server protocol type. Optional working directories used to discover repo marketplaces.

type PluginInstalledParamsInstallSuggestionPluginNames added in v0.144.0 

type PluginInstalledParamsInstallSuggestionPluginNames []string

PluginInstalledParamsInstallSuggestionPluginNames represents a generated Codex app-server protocol type. 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{}

PluginInstalledResponse represents a generated Codex app-server protocol type.

type PluginListMarketplaceKind 

type PluginListMarketplaceKind string

PluginListMarketplaceKind represents a generated Codex app-server protocol type. 

const PluginListMarketplaceKindCreatedByMeRemote PluginListMarketplaceKind = "created-by-me-remote"

PluginListMarketplaceKindCreatedByMeRemote is a generated Codex app-server protocol constant. 

const PluginListMarketplaceKindLocal PluginListMarketplaceKind = "local"

PluginListMarketplaceKindLocal is a generated Codex app-server protocol constant. 

const PluginListMarketplaceKindSharedWithMe PluginListMarketplaceKind = "shared-with-me"

PluginListMarketplaceKindSharedWithMe is a generated Codex app-server protocol constant. 

const PluginListMarketplaceKindVertical PluginListMarketplaceKind = "vertical"

PluginListMarketplaceKindVertical is a generated Codex app-server protocol constant. 

const PluginListMarketplaceKindWorkspaceDirectory PluginListMarketplaceKind = "workspace-directory"

PluginListMarketplaceKindWorkspaceDirectory is a generated Codex app-server protocol constant.

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"`

	// Whether the client requests a fresh remote plugin catalog fetch.
	ForceRefetch *bool `json:"forceRefetch,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"`
}

PluginListParams represents a generated Codex app-server protocol type.

type PluginListParamsCwds added in v0.144.0 

type PluginListParamsCwds []AbsolutePathBuf

PluginListParamsCwds represents a generated Codex app-server protocol type. 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

PluginListParamsMarketplaceKinds represents a generated Codex app-server protocol type. 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{}

PluginListResponse represents a generated Codex app-server protocol type.

type PluginReadParams 

type PluginReadParams struct {
	// MarketplacePath corresponds to the JSON schema field "marketplacePath".
	MarketplacePath *AbsolutePathBuf `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"`
}

PluginReadParams represents a generated Codex app-server protocol type.

type PluginReadParamsRemoteMarketplaceName added in v0.144.0 

type PluginReadParamsRemoteMarketplaceName *string

PluginReadParamsRemoteMarketplaceName represents a generated Codex app-server protocol type.

type PluginReadResponse 

type PluginReadResponse interface{}

PluginReadResponse represents a generated Codex app-server protocol type.

type PluginSearchScope added in v0.147.0 

type PluginSearchScope string

PluginSearchScope represents a generated Codex app-server protocol type. 

const PluginSearchScopeGlobal PluginSearchScope = "global"

PluginSearchScopeGlobal is a generated Codex app-server protocol constant. 

const PluginSearchScopePersonal PluginSearchScope = "personal"

PluginSearchScopePersonal is a generated Codex app-server protocol constant. 

const PluginSearchScopeWorkspace PluginSearchScope = "workspace"

PluginSearchScopeWorkspace is a generated Codex app-server protocol constant.

type PluginShareCheckoutParams 

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

PluginShareCheckoutParams represents a generated Codex app-server protocol type.

type PluginShareCheckoutResponse 

type PluginShareCheckoutResponse interface{}

PluginShareCheckoutResponse represents a generated Codex app-server protocol type.

type PluginShareDeleteParams 

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

PluginShareDeleteParams represents a generated Codex app-server protocol type.

type PluginShareDeleteResponse 

type PluginShareDeleteResponse = SanitizedPluginShareDeleteResponseJSON

PluginShareDeleteResponse is a generated alias for a Codex app-server protocol type.

type PluginShareDiscoverability 

type PluginShareDiscoverability string

PluginShareDiscoverability represents a generated Codex app-server protocol type. 

const PluginShareDiscoverabilityLISTED PluginShareDiscoverability = "LISTED"

PluginShareDiscoverabilityLISTED is a generated Codex app-server protocol constant. 

const PluginShareDiscoverabilityPRIVATE PluginShareDiscoverability = "PRIVATE"

PluginShareDiscoverabilityPRIVATE is a generated Codex app-server protocol constant. 

const PluginShareDiscoverabilityUNLISTED PluginShareDiscoverability = "UNLISTED"

PluginShareDiscoverabilityUNLISTED is a generated Codex app-server protocol constant.

type PluginShareListParams 

type PluginShareListParams map[string]interface{}

PluginShareListParams represents a generated Codex app-server protocol type.

type PluginShareListResponse 

type PluginShareListResponse interface{}

PluginShareListResponse represents a generated Codex app-server protocol type.

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"`
}

PluginSharePrincipal represents a generated Codex app-server protocol type.

type PluginSharePrincipalRole 

type PluginSharePrincipalRole string

PluginSharePrincipalRole represents a generated Codex app-server protocol type. 

const PluginSharePrincipalRoleEditor PluginSharePrincipalRole = "editor"

PluginSharePrincipalRoleEditor is a generated Codex app-server protocol constant. 

const PluginSharePrincipalRoleOwner PluginSharePrincipalRole = "owner"

PluginSharePrincipalRoleOwner is a generated Codex app-server protocol constant. 

const PluginSharePrincipalRoleReader PluginSharePrincipalRole = "reader"

PluginSharePrincipalRoleReader is a generated Codex app-server protocol constant.

type PluginSharePrincipalType 

type PluginSharePrincipalType string

PluginSharePrincipalType represents a generated Codex app-server protocol type. 

const PluginSharePrincipalTypeGroup PluginSharePrincipalType = "group"

PluginSharePrincipalTypeGroup is a generated Codex app-server protocol constant. 

const PluginSharePrincipalTypeUser PluginSharePrincipalType = "user"

PluginSharePrincipalTypeUser is a generated Codex app-server protocol constant. 

const PluginSharePrincipalTypeWorkspace PluginSharePrincipalType = "workspace"

PluginSharePrincipalTypeWorkspace is a generated Codex app-server protocol constant.

type PluginShareSaveParams 

type PluginShareSaveParams struct {
	// Discoverability corresponds to the JSON schema field "discoverability".
	Discoverability *PluginShareDiscoverability `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"`
}

PluginShareSaveParams represents a generated Codex app-server protocol type.

type PluginShareSaveParamsRemotePluginID added in v0.144.0 

type PluginShareSaveParamsRemotePluginID *string

PluginShareSaveParamsRemotePluginID represents a generated Codex app-server protocol type.

type PluginShareSaveParamsShareTargets added in v0.144.0 

type PluginShareSaveParamsShareTargets []PluginShareTarget

PluginShareSaveParamsShareTargets represents a generated Codex app-server protocol type.

type PluginShareSaveResponse 

type PluginShareSaveResponse = SanitizedPluginShareSaveResponseJSON

PluginShareSaveResponse is a generated alias for a Codex app-server protocol type.

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"`
}

PluginShareTarget represents a generated Codex app-server protocol type.

type PluginShareTargetRole 

type PluginShareTargetRole string

PluginShareTargetRole represents a generated Codex app-server protocol type. 

const PluginShareTargetRoleEditor PluginShareTargetRole = "editor"

PluginShareTargetRoleEditor is a generated Codex app-server protocol constant. 

const PluginShareTargetRoleReader PluginShareTargetRole = "reader"

PluginShareTargetRoleReader is a generated Codex app-server protocol constant.

type PluginShareUpdateDiscoverability 

type PluginShareUpdateDiscoverability string

PluginShareUpdateDiscoverability represents a generated Codex app-server protocol type. 

const PluginShareUpdateDiscoverabilityLISTED PluginShareUpdateDiscoverability = "LISTED"

PluginShareUpdateDiscoverabilityLISTED is a generated Codex app-server protocol constant. 

const PluginShareUpdateDiscoverabilityPRIVATE PluginShareUpdateDiscoverability = "PRIVATE"

PluginShareUpdateDiscoverabilityPRIVATE is a generated Codex app-server protocol constant. 

const PluginShareUpdateDiscoverabilityUNLISTED PluginShareUpdateDiscoverability = "UNLISTED"

PluginShareUpdateDiscoverabilityUNLISTED is a generated Codex app-server protocol constant.

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"`
}

PluginShareUpdateTargetsParams represents a generated Codex app-server protocol type.

type PluginShareUpdateTargetsResponse 

type PluginShareUpdateTargetsResponse = SanitizedPluginShareUpdateTargetsResponseJSON

PluginShareUpdateTargetsResponse is a generated alias for a Codex app-server protocol type.

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"`
}

PluginSkillReadParams represents a generated Codex app-server protocol type.

type PluginSkillReadResponse 

type PluginSkillReadResponse = SanitizedPluginSkillReadResponseJSON

PluginSkillReadResponse is a generated alias for a Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type PluginSourceKind added in v0.145.0 

type PluginSourceKind string

PluginSourceKind identifies a known PluginSource variant. 

const (
	// PluginSourceKindGit is a generated Codex app-server protocol constant.
	PluginSourceKindGit PluginSourceKind = "git"
	// PluginSourceKindLocal is a generated Codex app-server protocol constant.
	PluginSourceKindLocal PluginSourceKind = "local"
	// PluginSourceKindNpm is a generated Codex app-server protocol constant.
	PluginSourceKindNpm PluginSourceKind = "npm"
	// PluginSourceKindRemote is a generated Codex app-server protocol constant.
	PluginSourceKindRemote PluginSourceKind = "remote"
)

type PluginUninstallParams 

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

PluginUninstallParams represents a generated Codex app-server protocol type.

type PluginUninstallResponse 

type PluginUninstallResponse = SanitizedPluginUninstallResponseJSON

PluginUninstallResponse is a generated alias for a Codex app-server protocol type.

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"`
}

PluginsMigration represents a generated Codex app-server protocol type.

type ProcessExitedNotification 

type ProcessExitedNotification = SanitizedProcessExitedNotificationJSON

ProcessExitedNotification is a generated alias for a Codex app-server protocol type.

type ProcessOutputDeltaNotification 

type ProcessOutputDeltaNotification = SanitizedProcessOutputDeltaNotificationJSON

ProcessOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

type ProcessOutputStream 

type ProcessOutputStream interface{}

ProcessOutputStream represents a generated Codex app-server protocol type. 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"`
}

ProcessTerminalSize represents a generated Codex app-server protocol type. PTY size in character cells for `process/spawn` PTY sessions.

type RateLimitReachedType 

type RateLimitReachedType string

RateLimitReachedType represents a generated Codex app-server protocol type. 

const RateLimitReachedTypeRateLimitReached RateLimitReachedType = "rate_limit_reached"

RateLimitReachedTypeRateLimitReached is a generated Codex app-server protocol constant. 

const RateLimitReachedTypeWorkspaceMemberCreditsDepleted RateLimitReachedType = "workspace_member_credits_depleted"

RateLimitReachedTypeWorkspaceMemberCreditsDepleted is a generated Codex app-server protocol constant. 

const RateLimitReachedTypeWorkspaceMemberUsageLimitReached RateLimitReachedType = "workspace_member_usage_limit_reached"

RateLimitReachedTypeWorkspaceMemberUsageLimitReached is a generated Codex app-server protocol constant. 

const RateLimitReachedTypeWorkspaceOwnerCreditsDepleted RateLimitReachedType = "workspace_owner_credits_depleted"

RateLimitReachedTypeWorkspaceOwnerCreditsDepleted is a generated Codex app-server protocol constant. 

const RateLimitReachedTypeWorkspaceOwnerUsageLimitReached RateLimitReachedType = "workspace_owner_usage_limit_reached"

RateLimitReachedTypeWorkspaceOwnerUsageLimitReached is a generated Codex app-server protocol constant.

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"`
}

RateLimitResetCredit represents a generated Codex app-server protocol type.

type RateLimitResetCreditDescription added in v0.144.0 

type RateLimitResetCreditDescription *string

RateLimitResetCreditDescription represents a generated Codex app-server protocol type. Backend-provided display description for this credit, or `null` when unavailable.

type RateLimitResetCreditExpiresAt added in v0.144.0 

type RateLimitResetCreditExpiresAt *int

RateLimitResetCreditExpiresAt represents a generated Codex app-server protocol type. Unix timestamp in seconds when the credit expires, or `null` if it does not expire.

type RateLimitResetCreditStatus 

type RateLimitResetCreditStatus string

RateLimitResetCreditStatus represents a generated Codex app-server protocol type. 

const RateLimitResetCreditStatusAvailable RateLimitResetCreditStatus = "available"

RateLimitResetCreditStatusAvailable is a generated Codex app-server protocol constant. 

const RateLimitResetCreditStatusRedeemed RateLimitResetCreditStatus = "redeemed"

RateLimitResetCreditStatusRedeemed is a generated Codex app-server protocol constant. 

const RateLimitResetCreditStatusRedeeming RateLimitResetCreditStatus = "redeeming"

RateLimitResetCreditStatusRedeeming is a generated Codex app-server protocol constant. 

const RateLimitResetCreditStatusUnknown RateLimitResetCreditStatus = "unknown"

RateLimitResetCreditStatusUnknown is a generated Codex app-server protocol constant.

type RateLimitResetCreditTitle added in v0.144.0 

type RateLimitResetCreditTitle *string

RateLimitResetCreditTitle represents a generated Codex app-server protocol type. 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"`
}

RateLimitResetCreditsSummary represents a generated Codex app-server protocol type.

type RateLimitResetCreditsSummaryCredits added in v0.144.0 

type RateLimitResetCreditsSummaryCredits []RateLimitResetCredit

RateLimitResetCreditsSummaryCredits represents a generated Codex app-server protocol type. 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

RateLimitResetType represents a generated Codex app-server protocol type. 

const RateLimitResetTypeCodexRateLimits RateLimitResetType = "codexRateLimits"

RateLimitResetTypeCodexRateLimits is a generated Codex app-server protocol constant. 

const RateLimitResetTypeUnknown RateLimitResetType = "unknown"

RateLimitResetTypeUnknown is a generated Codex app-server protocol constant.

type RateLimitSnapshot 

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

	// IndividualLimit corresponds to the JSON schema field "individualLimit".
	IndividualLimit *SpendControlLimitSnapshot `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 *PlanType `json:"planType,omitempty,omitzero"`

	// Primary corresponds to the JSON schema field "primary".
	Primary *RateLimitWindow `json:"primary,omitempty,omitzero"`

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

	// Secondary corresponds to the JSON schema field "secondary".
	Secondary *RateLimitWindow `json:"secondary,omitempty,omitzero"`

	// Backend-reported spend-control state. `None` is unavailable, not a
	// sparse-update recovery.
	SpendControlReached RateLimitSnapshotSpendControlReached `json:"spendControlReached,omitempty,omitzero"`
}

RateLimitSnapshot represents a generated Codex app-server protocol type.

type RateLimitSnapshotLimitID added in v0.144.0 

type RateLimitSnapshotLimitID *string

RateLimitSnapshotLimitID represents a generated Codex app-server protocol type.

type RateLimitSnapshotLimitName added in v0.144.0 

type RateLimitSnapshotLimitName *string

RateLimitSnapshotLimitName represents a generated Codex app-server protocol type.

type RateLimitSnapshotSpendControlReached added in v0.147.0 

type RateLimitSnapshotSpendControlReached *bool

RateLimitSnapshotSpendControlReached represents a generated Codex app-server protocol type. Backend-reported spend-control state. `None` is unavailable, not a sparse-update recovery.

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"`
}

RateLimitWindow represents a generated Codex app-server protocol type.

type RateLimitWindowResetsAt added in v0.144.0 

type RateLimitWindowResetsAt *int

RateLimitWindowResetsAt represents a generated Codex app-server protocol type.

type RateLimitWindowWindowDurationMins added in v0.144.0 

type RateLimitWindowWindowDurationMins *int

RateLimitWindowWindowDurationMins represents a generated Codex app-server protocol type.

type RawResponseCompletedNotification added in v0.147.0 

type RawResponseCompletedNotification = SanitizedRawResponseCompletedNotificationJSON

RawResponseCompletedNotification is a generated alias for a Codex app-server protocol type.

type RawResponseItemCompletedNotification 

type RawResponseItemCompletedNotification = SanitizedRawResponseItemCompletedNotificationJSON

RawResponseItemCompletedNotification is a generated alias for a Codex app-server protocol type.

type RealtimeConversationVersion 

type RealtimeConversationVersion string

RealtimeConversationVersion represents a generated Codex app-server protocol type. 

const RealtimeConversationVersionV1 RealtimeConversationVersion = "v1"

RealtimeConversationVersionV1 is a generated Codex app-server protocol constant. 

const RealtimeConversationVersionV2 RealtimeConversationVersion = "v2"

RealtimeConversationVersionV2 is a generated Codex app-server protocol constant. 

const RealtimeConversationVersionV3 RealtimeConversationVersion = "v3"

RealtimeConversationVersionV3 is a generated Codex app-server protocol constant.

type RealtimeOutputModality 

type RealtimeOutputModality string

RealtimeOutputModality represents a generated Codex app-server protocol type. 

const RealtimeOutputModalityAudio RealtimeOutputModality = "audio"

RealtimeOutputModalityAudio is a generated Codex app-server protocol constant. 

const RealtimeOutputModalityText RealtimeOutputModality = "text"

RealtimeOutputModalityText is a generated Codex app-server protocol constant.

type RealtimeVoice 

type RealtimeVoice string

RealtimeVoice represents a generated Codex app-server protocol type. 

const RealtimeVoiceAlloy RealtimeVoice = "alloy"

RealtimeVoiceAlloy is a generated Codex app-server protocol constant. 

const RealtimeVoiceArbor RealtimeVoice = "arbor"

RealtimeVoiceArbor is a generated Codex app-server protocol constant. 

const RealtimeVoiceAsh RealtimeVoice = "ash"

RealtimeVoiceAsh is a generated Codex app-server protocol constant. 

const RealtimeVoiceBallad RealtimeVoice = "ballad"

RealtimeVoiceBallad is a generated Codex app-server protocol constant. 

const RealtimeVoiceBreeze RealtimeVoice = "breeze"

RealtimeVoiceBreeze is a generated Codex app-server protocol constant. 

const RealtimeVoiceCedar RealtimeVoice = "cedar"

RealtimeVoiceCedar is a generated Codex app-server protocol constant. 

const RealtimeVoiceCoral RealtimeVoice = "coral"

RealtimeVoiceCoral is a generated Codex app-server protocol constant. 

const RealtimeVoiceCove RealtimeVoice = "cove"

RealtimeVoiceCove is a generated Codex app-server protocol constant. 

const RealtimeVoiceEcho RealtimeVoice = "echo"

RealtimeVoiceEcho is a generated Codex app-server protocol constant. 

const RealtimeVoiceEmber RealtimeVoice = "ember"

RealtimeVoiceEmber is a generated Codex app-server protocol constant. 

const RealtimeVoiceJuniper RealtimeVoice = "juniper"

RealtimeVoiceJuniper is a generated Codex app-server protocol constant. 

const RealtimeVoiceMaple RealtimeVoice = "maple"

RealtimeVoiceMaple is a generated Codex app-server protocol constant. 

const RealtimeVoiceMarin RealtimeVoice = "marin"

RealtimeVoiceMarin is a generated Codex app-server protocol constant. 

const RealtimeVoiceSage RealtimeVoice = "sage"

RealtimeVoiceSage is a generated Codex app-server protocol constant. 

const RealtimeVoiceShimmer RealtimeVoice = "shimmer"

RealtimeVoiceShimmer is a generated Codex app-server protocol constant. 

const RealtimeVoiceSol RealtimeVoice = "sol"

RealtimeVoiceSol is a generated Codex app-server protocol constant. 

const RealtimeVoiceSpruce RealtimeVoice = "spruce"

RealtimeVoiceSpruce is a generated Codex app-server protocol constant. 

const RealtimeVoiceVale RealtimeVoice = "vale"

RealtimeVoiceVale is a generated Codex app-server protocol constant. 

const RealtimeVoiceVerse RealtimeVoice = "verse"

RealtimeVoiceVerse is a generated Codex app-server protocol constant.

type ReasoningEffort 

type ReasoningEffort string

ReasoningEffort represents a generated Codex app-server protocol type. 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"`
}

ReasoningEffortOption represents a generated Codex app-server protocol type.

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 

func (value ReasoningItemContent) Kind() ReasoningItemContentKind

Kind returns the payload discriminator, including unknown future values.

func (ReasoningItemContent) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ReasoningItemContentKind added in v0.145.0 

type ReasoningItemContentKind string

ReasoningItemContentKind identifies a known ReasoningItemContent variant. 

const (
	// ReasoningItemContentKindReasoningText is a generated Codex app-server protocol constant.
	ReasoningItemContentKindReasoningText ReasoningItemContentKind = "reasoning_text"
	// ReasoningItemContentKindText is a generated Codex app-server protocol constant.
	ReasoningItemContentKindText ReasoningItemContentKind = "text"
)

type ReasoningItemReasoningSummary 

type ReasoningItemReasoningSummary interface{}

ReasoningItemReasoningSummary represents a generated Codex app-server protocol type.

type ReasoningSummary 

type ReasoningSummary interface{}

ReasoningSummary represents a generated Codex app-server protocol type. 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 ReasoningSummaryPartAddedNotification 

type ReasoningSummaryPartAddedNotification = SanitizedReasoningSummaryPartAddedNotificationJSON

ReasoningSummaryPartAddedNotification is a generated alias for a Codex app-server protocol type.

type ReasoningSummaryTextDeltaNotification 

type ReasoningSummaryTextDeltaNotification = SanitizedReasoningSummaryTextDeltaNotificationJSON

ReasoningSummaryTextDeltaNotification is a generated alias for a Codex app-server protocol type.

type ReasoningTextDeltaNotification 

type ReasoningTextDeltaNotification = SanitizedReasoningTextDeltaNotificationJSON

ReasoningTextDeltaNotification is a generated alias for a Codex app-server protocol type.

type RemoteControlConnectionStatus 

type RemoteControlConnectionStatus string

RemoteControlConnectionStatus represents a generated Codex app-server protocol type. 

const RemoteControlConnectionStatusConnected RemoteControlConnectionStatus = "connected"

RemoteControlConnectionStatusConnected is a generated Codex app-server protocol constant. 

const RemoteControlConnectionStatusConnecting RemoteControlConnectionStatus = "connecting"

RemoteControlConnectionStatusConnecting is a generated Codex app-server protocol constant. 

const RemoteControlConnectionStatusDisabled RemoteControlConnectionStatus = "disabled"

RemoteControlConnectionStatusDisabled is a generated Codex app-server protocol constant. 

const RemoteControlConnectionStatusErrored RemoteControlConnectionStatus = "errored"

RemoteControlConnectionStatusErrored is a generated Codex app-server protocol constant.

type RemoteControlDisableParams 

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

RemoteControlDisableParams represents a generated Codex app-server protocol type.

type RemoteControlEnableParams 

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

RemoteControlEnableParams represents a generated Codex app-server protocol type.

type RemoteControlStatusChangedNotification 

type RemoteControlStatusChangedNotification = SanitizedRemoteControlStatusChangedNotificationJSON

RemoteControlStatusChangedNotification is a generated alias for a Codex app-server protocol type.

type RequestID 

type RequestID interface{}

RequestID represents a generated Codex app-server protocol type.

type ResidencyRequirement 

type ResidencyRequirement string

ResidencyRequirement represents a generated Codex app-server protocol type. 

const ResidencyRequirementUs ResidencyRequirement = "us"

ResidencyRequirementUs is a generated Codex app-server protocol constant.

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"`
}

Resource represents a generated Codex app-server protocol type. A known resource that the server is capable of reading.

type ResourceContent 

type ResourceContent interface{}

ResourceContent represents a generated Codex app-server protocol type. Contents returned when reading a resource from an MCP server.

type ResourceDescription added in v0.144.0 

type ResourceDescription *string

ResourceDescription represents a generated Codex app-server protocol type.

type ResourceIcons added in v0.144.0 

type ResourceIcons []interface{}

ResourceIcons represents a generated Codex app-server protocol type.

type ResourceMimeType added in v0.144.0 

type ResourceMimeType *string

ResourceMimeType represents a generated Codex app-server protocol type.

type ResourceSize added in v0.144.0 

type ResourceSize *int

ResourceSize represents a generated Codex app-server protocol type.

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"`
}

ResourceTemplate represents a generated Codex app-server protocol type. A template description for resources available on the server.

type ResourceTemplateDescription added in v0.144.0 

type ResourceTemplateDescription *string

ResourceTemplateDescription represents a generated Codex app-server protocol type.

type ResourceTemplateMimeType added in v0.144.0 

type ResourceTemplateMimeType *string

ResourceTemplateMimeType represents a generated Codex app-server protocol type.

type ResourceTemplateTitle added in v0.144.0 

type ResourceTemplateTitle *string

ResourceTemplateTitle represents a generated Codex app-server protocol type.

type ResourceTitle added in v0.144.0 

type ResourceTitle *string

ResourceTitle represents a generated Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ResponseItemKind added in v0.145.0 

type ResponseItemKind string

ResponseItemKind identifies a known ResponseItem variant. 

const (
	// ResponseItemKindAgentMessage is a generated Codex app-server protocol constant.
	ResponseItemKindAgentMessage ResponseItemKind = "agent_message"
	// ResponseItemKindCompaction is a generated Codex app-server protocol constant.
	ResponseItemKindCompaction ResponseItemKind = "compaction"
	// ResponseItemKindCompactionTrigger is a generated Codex app-server protocol constant.
	ResponseItemKindCompactionTrigger ResponseItemKind = "compaction_trigger"
	// ResponseItemKindContextCompaction is a generated Codex app-server protocol constant.
	ResponseItemKindContextCompaction ResponseItemKind = "context_compaction"
	// ResponseItemKindCustomToolCall is a generated Codex app-server protocol constant.
	ResponseItemKindCustomToolCall ResponseItemKind = "custom_tool_call"
	// ResponseItemKindCustomToolCallOutput is a generated Codex app-server protocol constant.
	ResponseItemKindCustomToolCallOutput ResponseItemKind = "custom_tool_call_output"
	// ResponseItemKindFunctionCall is a generated Codex app-server protocol constant.
	ResponseItemKindFunctionCall ResponseItemKind = "function_call"
	// ResponseItemKindFunctionCallOutput is a generated Codex app-server protocol constant.
	ResponseItemKindFunctionCallOutput ResponseItemKind = "function_call_output"
	// ResponseItemKindImageGenerationCall is a generated Codex app-server protocol constant.
	ResponseItemKindImageGenerationCall ResponseItemKind = "image_generation_call"
	// ResponseItemKindLocalShellCall is a generated Codex app-server protocol constant.
	ResponseItemKindLocalShellCall ResponseItemKind = "local_shell_call"
	// ResponseItemKindMessage is a generated Codex app-server protocol constant.
	ResponseItemKindMessage ResponseItemKind = "message"
	// ResponseItemKindOther is a generated Codex app-server protocol constant.
	ResponseItemKindOther ResponseItemKind = "other"
	// ResponseItemKindReasoning is a generated Codex app-server protocol constant.
	ResponseItemKindReasoning ResponseItemKind = "reasoning"
	// ResponseItemKindToolSearchCall is a generated Codex app-server protocol constant.
	ResponseItemKindToolSearchCall ResponseItemKind = "tool_search_call"
	// ResponseItemKindToolSearchOutput is a generated Codex app-server protocol constant.
	ResponseItemKindToolSearchOutput ResponseItemKind = "tool_search_output"
	// ResponseItemKindWebSearchCall is a generated Codex app-server protocol constant.
	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 

func (value ResponsesApiWebSearchAction) Kind() ResponsesApiWebSearchActionKind

Kind returns the payload discriminator, including unknown future values.

func (ResponsesApiWebSearchAction) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

func (ResponsesApiWebSearchAction) RawJSON added in v0.145.0 

func (value ResponsesApiWebSearchAction) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ResponsesApiWebSearchAction) UnmarshalJSON added in v0.145.0 

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ResponsesApiWebSearchActionKind added in v0.145.0 

type ResponsesApiWebSearchActionKind string

ResponsesApiWebSearchActionKind identifies a known ResponsesApiWebSearchAction variant. 

const (
	// ResponsesApiWebSearchActionKindFindInPage is a generated Codex app-server protocol constant.
	ResponsesApiWebSearchActionKindFindInPage ResponsesApiWebSearchActionKind = "find_in_page"
	// ResponsesApiWebSearchActionKindOpenPage is a generated Codex app-server protocol constant.
	ResponsesApiWebSearchActionKindOpenPage ResponsesApiWebSearchActionKind = "open_page"
	// ResponsesApiWebSearchActionKindOther is a generated Codex app-server protocol constant.
	ResponsesApiWebSearchActionKindOther ResponsesApiWebSearchActionKind = "other"
	// ResponsesApiWebSearchActionKindSearch is a generated Codex app-server protocol constant.
	ResponsesApiWebSearchActionKindSearch ResponsesApiWebSearchActionKind = "search"
)

type ReviewDecision 

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

ReviewDecision preserves simple, structured, and future legacy approval decisions. Checked constructors accept only known variants; JSON decoding retains well-formed future string or single-key object variants.

func MustReviewDecision added in v0.147.0 

func MustReviewDecision(value any) ReviewDecision

MustReviewDecision is like NewReviewDecision but panics when value is not a known decision. It is intended for constants and static policy configuration.

func NewReviewDecision added in v0.147.0 

func NewReviewDecision(value any) (ReviewDecision, error)

NewReviewDecision validates and wraps a legacy approval decision.

func (ReviewDecision) IsKnown added in v0.147.0 

func (d ReviewDecision) IsKnown() bool

IsKnown reports whether Kind is defined by the pinned protocol.

func (ReviewDecision) Kind added in v0.147.0 

func (d ReviewDecision) Kind() ReviewDecisionKind

Kind returns the decoded wire variant.

func (ReviewDecision) MarshalJSON added in v0.147.0 

func (d ReviewDecision) MarshalJSON() ([]byte, error)

func (ReviewDecision) RawJSON added in v0.147.0 

func (d ReviewDecision) RawJSON() json.RawMessage

RawJSON returns a copy of the complete legacy approval decision.

func (*ReviewDecision) UnmarshalJSON added in v0.147.0 

func (d *ReviewDecision) UnmarshalJSON(data []byte) error

type ReviewDecisionKind added in v0.147.0 

type ReviewDecisionKind string

ReviewDecisionKind identifies a legacy approval-decision variant. 

const (
	ReviewDecisionKindApproved                    ReviewDecisionKind = "approved"
	ReviewDecisionKindApprovedExecpolicyAmendment ReviewDecisionKind = "approved_execpolicy_amendment"
	ReviewDecisionKindApprovedForSession          ReviewDecisionKind = "approved_for_session"
	ReviewDecisionKindNetworkPolicyAmendment      ReviewDecisionKind = "network_policy_amendment"
	ReviewDecisionKindDenied                      ReviewDecisionKind = "denied"
	ReviewDecisionKindTimedOut                    ReviewDecisionKind = "timed_out"
	ReviewDecisionKindAbort                       ReviewDecisionKind = "abort"
)

type ReviewDelivery 

type ReviewDelivery string

ReviewDelivery represents a generated Codex app-server protocol type. 

const ReviewDeliveryDetached ReviewDelivery = "detached"

ReviewDeliveryDetached is a generated Codex app-server protocol constant. 

const ReviewDeliveryInline ReviewDelivery = "inline"

ReviewDeliveryInline is a generated Codex app-server protocol constant.

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 *ReviewDelivery `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"`
}

ReviewStartParams represents a generated Codex app-server protocol type.

type ReviewStartResponse 

type ReviewStartResponse interface{}

ReviewStartResponse represents a generated Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ReviewTargetKind added in v0.145.0 

type ReviewTargetKind string

ReviewTargetKind identifies a known ReviewTarget variant. 

const (
	// ReviewTargetKindBaseBranch is a generated Codex app-server protocol constant.
	ReviewTargetKindBaseBranch ReviewTargetKind = "baseBranch"
	// ReviewTargetKindCommit is a generated Codex app-server protocol constant.
	ReviewTargetKindCommit ReviewTargetKind = "commit"
	// ReviewTargetKindCustom is a generated Codex app-server protocol constant.
	ReviewTargetKindCustom ReviewTargetKind = "custom"
	// ReviewTargetKindUncommittedChanges is a generated Codex app-server protocol constant.
	ReviewTargetKindUncommittedChanges ReviewTargetKind = "uncommittedChanges"
)

type SandboxMode 

type SandboxMode string

SandboxMode represents a generated Codex app-server protocol type. 

const SandboxModeDangerFullAccess SandboxMode = "danger-full-access"

SandboxModeDangerFullAccess is a generated Codex app-server protocol constant. 

const SandboxModeReadOnly SandboxMode = "read-only"

SandboxModeReadOnly is a generated Codex app-server protocol constant. 

const SandboxModeWorkspaceWrite SandboxMode = "workspace-write"

SandboxModeWorkspaceWrite is a generated Codex app-server protocol constant.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type SandboxPolicyKind added in v0.145.0 

type SandboxPolicyKind string

SandboxPolicyKind identifies a known SandboxPolicy variant. 

const (
	// SandboxPolicyKindDangerFullAccess is a generated Codex app-server protocol constant.
	SandboxPolicyKindDangerFullAccess SandboxPolicyKind = "dangerFullAccess"
	// SandboxPolicyKindExternalSandbox is a generated Codex app-server protocol constant.
	SandboxPolicyKindExternalSandbox SandboxPolicyKind = "externalSandbox"
	// SandboxPolicyKindReadOnly is a generated Codex app-server protocol constant.
	SandboxPolicyKindReadOnly SandboxPolicyKind = "readOnly"
	// SandboxPolicyKindWorkspaceWrite is a generated Codex app-server protocol constant.
	SandboxPolicyKindWorkspaceWrite SandboxPolicyKind = "workspaceWrite"
)

type SanitizedAccountLoginCompletedNotification 

type SanitizedAccountLoginCompletedNotification = SanitizedAccountLoginCompletedNotificationJSON

SanitizedAccountLoginCompletedNotification is a generated alias for a Codex app-server protocol type.

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"`

	// OnboardingEntrypoint corresponds to the JSON schema field
	// "onboardingEntrypoint".
	OnboardingEntrypoint *DesktopOnboardingEntrypoint `json:"onboardingEntrypoint,omitempty,omitzero"`

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

SanitizedAccountLoginCompletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use AccountLoginCompletedNotification.

type SanitizedAccountLoginCompletedNotificationJSONError added in v0.144.0 

type SanitizedAccountLoginCompletedNotificationJSONError *string

SanitizedAccountLoginCompletedNotificationJSONError represents a generated Codex app-server protocol type.

type SanitizedAccountLoginCompletedNotificationJSONLoginID added in v0.144.0 

type SanitizedAccountLoginCompletedNotificationJSONLoginID *string

SanitizedAccountLoginCompletedNotificationJSONLoginID represents a generated Codex app-server protocol type.

type SanitizedAccountRateLimitsUpdatedNotification 

type SanitizedAccountRateLimitsUpdatedNotification = SanitizedAccountRateLimitsUpdatedNotificationJSON

SanitizedAccountRateLimitsUpdatedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedAccountRateLimitsUpdatedNotificationJSON 

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

SanitizedAccountRateLimitsUpdatedNotificationJSON represents a generated Codex app-server protocol type. 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. Deprecated: use AccountRateLimitsUpdatedNotification.

type SanitizedAccountUpdatedNotification 

type SanitizedAccountUpdatedNotification = SanitizedAccountUpdatedNotificationJSON

SanitizedAccountUpdatedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedAccountUpdatedNotificationJSON 

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

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

SanitizedAccountUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use AccountUpdatedNotification.

type SanitizedAgentMessageDeltaNotification 

type SanitizedAgentMessageDeltaNotification = SanitizedAgentMessageDeltaNotificationJSON

SanitizedAgentMessageDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedAgentMessageDeltaNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use AgentMessageDeltaNotification.

type SanitizedAppListUpdatedNotification 

type SanitizedAppListUpdatedNotification = SanitizedAppListUpdatedNotificationJSON

SanitizedAppListUpdatedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedAppListUpdatedNotificationJSON 

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

SanitizedAppListUpdatedNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - notification emitted when the app list changes. Deprecated: use AppListUpdatedNotification.

type SanitizedApplyPatchApprovalParams 

type SanitizedApplyPatchApprovalParams = SanitizedApplyPatchApprovalParamsJSON

SanitizedApplyPatchApprovalParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedApplyPatchApprovalParamsJSON represents a generated Codex app-server protocol type.

type SanitizedApplyPatchApprovalParamsJSONFileChanges added in v0.144.0 

type SanitizedApplyPatchApprovalParamsJSONFileChanges map[string]FileChange

SanitizedApplyPatchApprovalParamsJSONFileChanges represents a generated Codex app-server protocol type.

type SanitizedApplyPatchApprovalParamsJSONGrantRoot added in v0.144.0 

type SanitizedApplyPatchApprovalParamsJSONGrantRoot *string

SanitizedApplyPatchApprovalParamsJSONGrantRoot represents a generated Codex app-server protocol type. 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

SanitizedApplyPatchApprovalParamsJSONReason represents a generated Codex app-server protocol type. Optional explanatory reason (e.g. request for extra write access).

type SanitizedApplyPatchApprovalResponse 

type SanitizedApplyPatchApprovalResponse = SanitizedApplyPatchApprovalResponseJSON

SanitizedApplyPatchApprovalResponse is a generated alias for a Codex app-server protocol type.

type SanitizedApplyPatchApprovalResponseJSON 

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

SanitizedApplyPatchApprovalResponseJSON represents a generated Codex app-server protocol type.

type SanitizedAppsInstalledParams added in v0.147.0 

type SanitizedAppsInstalledParams = SanitizedAppsInstalledParamsJSON

SanitizedAppsInstalledParams is a generated alias for a Codex app-server protocol type.

type SanitizedAppsInstalledParamsJSON added in v0.147.0 

type SanitizedAppsInstalledParamsJSON struct {
	// When true and Apps are permitted, refresh and publish the hosted connector
	// runtime tool snapshot first.
	ForceRefresh *bool `json:"forceRefresh,omitempty,omitzero"`

	// Optional loaded thread id used to evaluate effective app configuration.
	ThreadID SanitizedAppsInstalledParamsJSONThreadID `json:"threadId,omitempty,omitzero"`
}

SanitizedAppsInstalledParamsJSON represents a generated Codex app-server protocol type. Read the committed installed connector runtime snapshot.

type SanitizedAppsInstalledParamsJSONThreadID added in v0.147.0 

type SanitizedAppsInstalledParamsJSONThreadID *string

SanitizedAppsInstalledParamsJSONThreadID represents a generated Codex app-server protocol type. Optional loaded thread id used to evaluate effective app configuration.

type SanitizedAppsInstalledResponse added in v0.147.0 

type SanitizedAppsInstalledResponse = SanitizedAppsInstalledResponseJSON

SanitizedAppsInstalledResponse is a generated alias for a Codex app-server protocol type.

type SanitizedAppsInstalledResponseJSON added in v0.147.0 

type SanitizedAppsInstalledResponseJSON struct {
	// Apps corresponds to the JSON schema field "apps".
	Apps []InstalledApp `json:"apps"`
}

SanitizedAppsInstalledResponseJSON represents a generated Codex app-server protocol type. The installed connectors in one committed runtime snapshot. Deprecated: use AppsInstalledResponse.

type SanitizedAppsListParams 

type SanitizedAppsListParams = SanitizedAppsListParamsJSON

SanitizedAppsListParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedAppsListParamsJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - list available apps/connectors.

type SanitizedAppsListParamsJSONCursor added in v0.144.0 

type SanitizedAppsListParamsJSONCursor *string

SanitizedAppsListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedAppsListParamsJSONLimit added in v0.144.0 

type SanitizedAppsListParamsJSONLimit *int

SanitizedAppsListParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type SanitizedAppsListParamsJSONThreadID added in v0.144.0 

type SanitizedAppsListParamsJSONThreadID *string

SanitizedAppsListParamsJSONThreadID represents a generated Codex app-server protocol type. Optional thread id used to evaluate app feature gating from that thread's config.

type SanitizedAppsListResponse 

type SanitizedAppsListResponse = SanitizedAppsListResponseJSON

SanitizedAppsListResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedAppsListResponseJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - app list response. Deprecated: use AppsListResponse.

type SanitizedAppsListResponseJSONNextCursor added in v0.144.0 

type SanitizedAppsListResponseJSONNextCursor *string

SanitizedAppsListResponseJSONNextCursor represents a generated Codex app-server protocol type. Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedAppsReadParams added in v0.147.0 

type SanitizedAppsReadParams = SanitizedAppsReadParamsJSON

SanitizedAppsReadParams is a generated alias for a Codex app-server protocol type.

type SanitizedAppsReadParamsJSON added in v0.147.0 

type SanitizedAppsReadParamsJSON struct {
	// App ids to read. The server accepts at most 100 ids and deduplicates repeated
	// ids while preserving their first-request order.
	AppIds []string `json:"appIds"`

	// When true, include display-only public tool summaries in the returned metadata.
	IncludeTools *bool `json:"includeTools,omitempty,omitzero"`
}

SanitizedAppsReadParamsJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - read metadata for specific apps/connectors.

type SanitizedAppsReadResponse added in v0.147.0 

type SanitizedAppsReadResponse = SanitizedAppsReadResponseJSON

SanitizedAppsReadResponse is a generated alias for a Codex app-server protocol type.

type SanitizedAppsReadResponseJSON added in v0.147.0 

type SanitizedAppsReadResponseJSON struct {
	// Apps corresponds to the JSON schema field "apps".
	Apps []ConnectorMetadata `json:"apps"`

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

SanitizedAppsReadResponseJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - app/read response. Deprecated: use AppsReadResponse.

type SanitizedAttestationGenerateParams added in v0.144.0 

type SanitizedAttestationGenerateParams = SanitizedAttestationGenerateParamsJSON

SanitizedAttestationGenerateParams is a generated alias for a Codex app-server protocol type.

type SanitizedAttestationGenerateParamsJSON added in v0.144.0 

type SanitizedAttestationGenerateParamsJSON map[string]interface{}

SanitizedAttestationGenerateParamsJSON represents a generated Codex app-server protocol type. Deprecated: use AttestationGenerateParams.

type SanitizedAttestationGenerateResponse 

type SanitizedAttestationGenerateResponse = SanitizedAttestationGenerateResponseJSON

SanitizedAttestationGenerateResponse is a generated alias for a Codex app-server protocol type.

type SanitizedAttestationGenerateResponseJSON 

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

SanitizedAttestationGenerateResponseJSON represents a generated Codex app-server protocol type. Deprecated: use AttestationGenerateResponse.

type SanitizedCancelLoginAccountParams 

type SanitizedCancelLoginAccountParams = SanitizedCancelLoginAccountParamsJSON

SanitizedCancelLoginAccountParams is a generated alias for a Codex app-server protocol type.

type SanitizedCancelLoginAccountParamsJSON 

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

SanitizedCancelLoginAccountParamsJSON represents a generated Codex app-server protocol type.

type SanitizedCancelLoginAccountResponse 

type SanitizedCancelLoginAccountResponse = SanitizedCancelLoginAccountResponseJSON

SanitizedCancelLoginAccountResponse is a generated alias for a Codex app-server protocol type.

type SanitizedCancelLoginAccountResponseJSON 

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

SanitizedCancelLoginAccountResponseJSON represents a generated Codex app-server protocol type. Deprecated: use CancelLoginAccountResponse.

type SanitizedChatgptAuthTokensRefreshParams 

type SanitizedChatgptAuthTokensRefreshParams = SanitizedChatgptAuthTokensRefreshParamsJSON

SanitizedChatgptAuthTokensRefreshParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedChatgptAuthTokensRefreshParamsJSON represents a generated Codex app-server protocol type. Deprecated: use ChatgptAuthTokensRefreshParams.

type SanitizedChatgptAuthTokensRefreshParamsJSONPreviousAccountID added in v0.144.0 

type SanitizedChatgptAuthTokensRefreshParamsJSONPreviousAccountID *string

SanitizedChatgptAuthTokensRefreshParamsJSONPreviousAccountID represents a generated Codex app-server protocol type. 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 SanitizedChatgptAuthTokensRefreshResponse 

type SanitizedChatgptAuthTokensRefreshResponse = SanitizedChatgptAuthTokensRefreshResponseJSON

SanitizedChatgptAuthTokensRefreshResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedChatgptAuthTokensRefreshResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ChatgptAuthTokensRefreshResponse.

type SanitizedChatgptAuthTokensRefreshResponseJSONChatgptPlanType added in v0.144.0 

type SanitizedChatgptAuthTokensRefreshResponseJSONChatgptPlanType *string

SanitizedChatgptAuthTokensRefreshResponseJSONChatgptPlanType represents a generated Codex app-server protocol type.

type SanitizedCommandExecOutputDeltaNotification added in v0.144.0 

type SanitizedCommandExecOutputDeltaNotification = SanitizedCommandExecOutputDeltaNotificationJSON

SanitizedCommandExecOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedCommandExecOutputDeltaNotificationJSON represents a generated Codex app-server protocol type. 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. Deprecated: use CommandExecOutputDeltaNotification.

type SanitizedCommandExecResizeResponse added in v0.144.0 

type SanitizedCommandExecResizeResponse = SanitizedCommandExecResizeResponseJSON

SanitizedCommandExecResizeResponse is a generated alias for a Codex app-server protocol type.

type SanitizedCommandExecResizeResponseJSON added in v0.144.0 

type SanitizedCommandExecResizeResponseJSON map[string]interface{}

SanitizedCommandExecResizeResponseJSON represents a generated Codex app-server protocol type. Empty success response for `command/exec/resize`. Deprecated: use CommandExecResizeResponse.

type SanitizedCommandExecResponse 

type SanitizedCommandExecResponse = SanitizedCommandExecResponseJSON

SanitizedCommandExecResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedCommandExecResponseJSON represents a generated Codex app-server protocol type. Final buffered result for `command/exec`. Deprecated: use CommandExecResponse.

type SanitizedCommandExecTerminateParams 

type SanitizedCommandExecTerminateParams = SanitizedCommandExecTerminateParamsJSON

SanitizedCommandExecTerminateParams is a generated alias for a Codex app-server protocol type.

type SanitizedCommandExecTerminateParamsJSON 

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

SanitizedCommandExecTerminateParamsJSON represents a generated Codex app-server protocol type. Terminate a running `command/exec` session.

type SanitizedCommandExecTerminateResponse added in v0.144.0 

type SanitizedCommandExecTerminateResponse = SanitizedCommandExecTerminateResponseJSON

SanitizedCommandExecTerminateResponse is a generated alias for a Codex app-server protocol type.

type SanitizedCommandExecTerminateResponseJSON added in v0.144.0 

type SanitizedCommandExecTerminateResponseJSON map[string]interface{}

SanitizedCommandExecTerminateResponseJSON represents a generated Codex app-server protocol type. Empty success response for `command/exec/terminate`. Deprecated: use CommandExecTerminateResponse.

type SanitizedCommandExecWriteParams 

type SanitizedCommandExecWriteParams = SanitizedCommandExecWriteParamsJSON

SanitizedCommandExecWriteParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedCommandExecWriteParamsJSON represents a generated Codex app-server protocol type. Write stdin bytes to a running `command/exec` session, close stdin, or both.

type SanitizedCommandExecWriteParamsJSONDeltaBase64 added in v0.144.0 

type SanitizedCommandExecWriteParamsJSONDeltaBase64 *string

SanitizedCommandExecWriteParamsJSONDeltaBase64 represents a generated Codex app-server protocol type. Optional base64-encoded stdin bytes to write.

type SanitizedCommandExecWriteResponse added in v0.144.0 

type SanitizedCommandExecWriteResponse = SanitizedCommandExecWriteResponseJSON

SanitizedCommandExecWriteResponse is a generated alias for a Codex app-server protocol type.

type SanitizedCommandExecWriteResponseJSON added in v0.144.0 

type SanitizedCommandExecWriteResponseJSON map[string]interface{}

SanitizedCommandExecWriteResponseJSON represents a generated Codex app-server protocol type. Empty success response for `command/exec/write`. Deprecated: use CommandExecWriteResponse.

type SanitizedCommandExecutionOutputDeltaNotification 

type SanitizedCommandExecutionOutputDeltaNotification = SanitizedCommandExecutionOutputDeltaNotificationJSON

SanitizedCommandExecutionOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedCommandExecutionOutputDeltaNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use CommandExecutionOutputDeltaNotification.

type SanitizedCommandExecutionRequestApprovalParams added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParams = SanitizedCommandExecutionRequestApprovalParamsJSON

SanitizedCommandExecutionRequestApprovalParams is a generated alias for a Codex app-server protocol type.

type SanitizedCommandExecutionRequestApprovalParamsJSON added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSON struct {
	// Unique identifier for this specific approval callback.
	//
	// For regular shell/unified_exec approvals, this is null.
	//
	// For zsh-exec-bridge subcommand approvals, multiple callbacks can belong to one
	// parent `itemId`, so `approvalId` is a distinct opaque callback id (a UUID) used
	// to disambiguate routing.
	ApprovalID SanitizedCommandExecutionRequestApprovalParamsJSONApprovalID `json:"approvalId,omitempty,omitzero"`

	// The command to be executed.
	Command SanitizedCommandExecutionRequestApprovalParamsJSONCommand `json:"command,omitempty,omitzero"`

	// Best-effort parsed command actions for friendly display.
	CommandActions *SanitizedCommandExecutionRequestApprovalParamsJSONCommandActions `json:"commandActions,omitempty,omitzero"`

	// The command's working directory.
	Cwd *LegacyAppPathString `json:"cwd,omitempty,omitzero"`

	// Environment in which the command will run.
	EnvironmentID SanitizedCommandExecutionRequestApprovalParamsJSONEnvironmentID `json:"environmentId,omitempty,omitzero"`

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

	// Optional context for a managed-network approval prompt.
	NetworkApprovalContext *NetworkApprovalContext `json:"networkApprovalContext,omitempty,omitzero"`

	// Optional proposed execpolicy amendment to allow similar commands without
	// prompting.
	ProposedExecpolicyAmendment *SanitizedCommandExecutionRequestApprovalParamsJSONProposedExecpolicyAmendment `json:"proposedExecpolicyAmendment,omitempty,omitzero"`

	// Optional proposed network policy amendments (allow/deny host) for future
	// requests.
	ProposedNetworkPolicyAmendments *SanitizedCommandExecutionRequestApprovalParamsJSONProposedNetworkPolicyAmendments `json:"proposedNetworkPolicyAmendments,omitempty,omitzero"`

	// Optional explanatory reason (e.g. request for network access).
	Reason SanitizedCommandExecutionRequestApprovalParamsJSONReason `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"`
}

SanitizedCommandExecutionRequestApprovalParamsJSON represents a generated Codex app-server protocol type.

type SanitizedCommandExecutionRequestApprovalParamsJSONApprovalID added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONApprovalID *string

SanitizedCommandExecutionRequestApprovalParamsJSONApprovalID represents a generated Codex app-server protocol type. Unique identifier for this specific approval callback.

For regular shell/unified_exec approvals, this is null.

For zsh-exec-bridge subcommand approvals, multiple callbacks can belong to one parent `itemId`, so `approvalId` is a distinct opaque callback id (a UUID) used to disambiguate routing.

type SanitizedCommandExecutionRequestApprovalParamsJSONCommand added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONCommand *string

SanitizedCommandExecutionRequestApprovalParamsJSONCommand represents a generated Codex app-server protocol type. The command to be executed.

type SanitizedCommandExecutionRequestApprovalParamsJSONCommandActions added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONCommandActions []CommandAction

SanitizedCommandExecutionRequestApprovalParamsJSONCommandActions represents a generated Codex app-server protocol type. Best-effort parsed command actions for friendly display.

type SanitizedCommandExecutionRequestApprovalParamsJSONEnvironmentID added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONEnvironmentID *string

SanitizedCommandExecutionRequestApprovalParamsJSONEnvironmentID represents a generated Codex app-server protocol type. Environment in which the command will run.

type SanitizedCommandExecutionRequestApprovalParamsJSONProposedExecpolicyAmendment added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONProposedExecpolicyAmendment []string

SanitizedCommandExecutionRequestApprovalParamsJSONProposedExecpolicyAmendment represents a generated Codex app-server protocol type. Optional proposed execpolicy amendment to allow similar commands without prompting.

type SanitizedCommandExecutionRequestApprovalParamsJSONProposedNetworkPolicyAmendments added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONProposedNetworkPolicyAmendments []NetworkPolicyAmendment

SanitizedCommandExecutionRequestApprovalParamsJSONProposedNetworkPolicyAmendments represents a generated Codex app-server protocol type. Optional proposed network policy amendments (allow/deny host) for future requests.

type SanitizedCommandExecutionRequestApprovalParamsJSONReason added in v0.147.0 

type SanitizedCommandExecutionRequestApprovalParamsJSONReason *string

SanitizedCommandExecutionRequestApprovalParamsJSONReason represents a generated Codex app-server protocol type. Optional explanatory reason (e.g. request for network access).

type SanitizedCommandExecutionRequestApprovalResponse 

type SanitizedCommandExecutionRequestApprovalResponse = SanitizedCommandExecutionRequestApprovalResponseJSON

SanitizedCommandExecutionRequestApprovalResponse is a generated alias for a Codex app-server protocol type.

type SanitizedCommandExecutionRequestApprovalResponseJSON 

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

SanitizedCommandExecutionRequestApprovalResponseJSON represents a generated Codex app-server protocol type.

type SanitizedConfigBatchWriteParams 

type SanitizedConfigBatchWriteParams = SanitizedConfigBatchWriteParamsJSON

SanitizedConfigBatchWriteParams is a generated alias for a Codex app-server protocol type.

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 updated runtime settings into loaded threads after
	// writing. Session-static model, reasoning-effort, Plan-mode reasoning-effort,
	// service-tier, and personality defaults are not reloaded.
	ReloadUserConfig *bool `json:"reloadUserConfig,omitempty,omitzero"`
}

SanitizedConfigBatchWriteParamsJSON represents a generated Codex app-server protocol type.

type SanitizedConfigBatchWriteParamsJSONExpectedVersion added in v0.144.0 

type SanitizedConfigBatchWriteParamsJSONExpectedVersion *string

SanitizedConfigBatchWriteParamsJSONExpectedVersion represents a generated Codex app-server protocol type.

type SanitizedConfigBatchWriteParamsJSONFilePath added in v0.144.0 

type SanitizedConfigBatchWriteParamsJSONFilePath *string

SanitizedConfigBatchWriteParamsJSONFilePath represents a generated Codex app-server protocol type. Path to the config file to write; defaults to the user's `config.toml` when omitted.

type SanitizedConfigReadParams 

type SanitizedConfigReadParams = SanitizedConfigReadParamsJSON

SanitizedConfigReadParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedConfigReadParamsJSON represents a generated Codex app-server protocol type.

type SanitizedConfigReadParamsJSONCwd added in v0.144.0 

type SanitizedConfigReadParamsJSONCwd *string

SanitizedConfigReadParamsJSONCwd represents a generated Codex app-server protocol type. 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

SanitizedConfigRequirementsReadResponse is a generated alias for a Codex app-server protocol type.

type SanitizedConfigRequirementsReadResponseJSON 

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

SanitizedConfigRequirementsReadResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ConfigRequirementsReadResponse.

type SanitizedConfigValueWriteParams 

type SanitizedConfigValueWriteParams = SanitizedConfigValueWriteParamsJSON

SanitizedConfigValueWriteParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedConfigValueWriteParamsJSON represents a generated Codex app-server protocol type.

type SanitizedConfigValueWriteParamsJSONExpectedVersion added in v0.144.0 

type SanitizedConfigValueWriteParamsJSONExpectedVersion *string

SanitizedConfigValueWriteParamsJSONExpectedVersion represents a generated Codex app-server protocol type.

type SanitizedConfigValueWriteParamsJSONFilePath added in v0.144.0 

type SanitizedConfigValueWriteParamsJSONFilePath *string

SanitizedConfigValueWriteParamsJSONFilePath represents a generated Codex app-server protocol type. Path to the config file to write; defaults to the user's `config.toml` when omitted.

type SanitizedConfigWarningNotification 

type SanitizedConfigWarningNotification = SanitizedConfigWarningNotificationJSON

SanitizedConfigWarningNotification is a generated alias for a Codex app-server protocol type.

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 *TextRange `json:"range,omitempty,omitzero"`

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

SanitizedConfigWarningNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ConfigWarningNotification.

type SanitizedConfigWarningNotificationJSONDetails added in v0.144.0 

type SanitizedConfigWarningNotificationJSONDetails *string

SanitizedConfigWarningNotificationJSONDetails represents a generated Codex app-server protocol type. Optional extra guidance or error details.

type SanitizedConfigWarningNotificationJSONPath added in v0.144.0 

type SanitizedConfigWarningNotificationJSONPath *string

SanitizedConfigWarningNotificationJSONPath represents a generated Codex app-server protocol type. Optional path to the config file that triggered the warning.

type SanitizedConsumeAccountRateLimitResetCreditParams 

type SanitizedConsumeAccountRateLimitResetCreditParams = SanitizedConsumeAccountRateLimitResetCreditParamsJSON

SanitizedConsumeAccountRateLimitResetCreditParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedConsumeAccountRateLimitResetCreditParamsJSON represents a generated Codex app-server protocol type.

type SanitizedConsumeAccountRateLimitResetCreditParamsJSONCreditID added in v0.144.0 

type SanitizedConsumeAccountRateLimitResetCreditParamsJSONCreditID *string

SanitizedConsumeAccountRateLimitResetCreditParamsJSONCreditID represents a generated Codex app-server protocol type. Opaque reset-credit identifier to redeem. When omitted, the backend selects the next available credit.

type SanitizedConsumeAccountRateLimitResetCreditResponse 

type SanitizedConsumeAccountRateLimitResetCreditResponse = SanitizedConsumeAccountRateLimitResetCreditResponseJSON

SanitizedConsumeAccountRateLimitResetCreditResponse is a generated alias for a Codex app-server protocol type.

type SanitizedConsumeAccountRateLimitResetCreditResponseJSON 

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

SanitizedConsumeAccountRateLimitResetCreditResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ConsumeAccountRateLimitResetCreditResponse.

type SanitizedContextCompactedNotification 

type SanitizedContextCompactedNotification = SanitizedContextCompactedNotificationJSON

SanitizedContextCompactedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedContextCompactedNotificationJSON 

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"`
}

SanitizedContextCompactedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: Use `ContextCompaction` item type instead. Deprecated: use ContextCompactedNotification.

type SanitizedDeprecationNoticeNotification 

type SanitizedDeprecationNoticeNotification = SanitizedDeprecationNoticeNotificationJSON

SanitizedDeprecationNoticeNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedDeprecationNoticeNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use DeprecationNoticeNotification.

type SanitizedDeprecationNoticeNotificationJSONDetails added in v0.144.0 

type SanitizedDeprecationNoticeNotificationJSONDetails *string

SanitizedDeprecationNoticeNotificationJSONDetails represents a generated Codex app-server protocol type. Optional extra guidance, such as migration steps or rationale.

type SanitizedDynamicToolCallParams 

type SanitizedDynamicToolCallParams = SanitizedDynamicToolCallParamsJSON

SanitizedDynamicToolCallParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedDynamicToolCallParamsJSON represents a generated Codex app-server protocol type. Deprecated: use DynamicToolCallParams.

type SanitizedDynamicToolCallParamsJSONNamespace added in v0.144.0 

type SanitizedDynamicToolCallParamsJSONNamespace *string

SanitizedDynamicToolCallParamsJSONNamespace represents a generated Codex app-server protocol type.

type SanitizedDynamicToolCallResponse 

type SanitizedDynamicToolCallResponse = SanitizedDynamicToolCallResponseJSON

SanitizedDynamicToolCallResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedDynamicToolCallResponseJSON represents a generated Codex app-server protocol type. Deprecated: use DynamicToolCallResponse.

type SanitizedEnvironmentConnectionNotification added in v0.147.0 

type SanitizedEnvironmentConnectionNotification = SanitizedEnvironmentConnectionNotificationJSON

SanitizedEnvironmentConnectionNotification is a generated alias for a Codex app-server protocol type.

type SanitizedEnvironmentConnectionNotificationJSON added in v0.147.0 

type SanitizedEnvironmentConnectionNotificationJSON struct {
	// EnvironmentID corresponds to the JSON schema field "environmentId".
	EnvironmentID string `json:"environmentId"`

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

SanitizedEnvironmentConnectionNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use EnvironmentConnectionNotification.

type SanitizedErrorNotification 

type SanitizedErrorNotification = SanitizedErrorNotificationJSON

SanitizedErrorNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedErrorNotificationJSON represents a generated Codex app-server protocol type.

type SanitizedExecCommandApprovalParams 

type SanitizedExecCommandApprovalParams = SanitizedExecCommandApprovalParamsJSON

SanitizedExecCommandApprovalParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedExecCommandApprovalParamsJSON represents a generated Codex app-server protocol type.

type SanitizedExecCommandApprovalParamsJSONApprovalID added in v0.144.0 

type SanitizedExecCommandApprovalParamsJSONApprovalID *string

SanitizedExecCommandApprovalParamsJSONApprovalID represents a generated Codex app-server protocol type. Identifier for this specific approval callback.

type SanitizedExecCommandApprovalParamsJSONReason added in v0.144.0 

type SanitizedExecCommandApprovalParamsJSONReason *string

SanitizedExecCommandApprovalParamsJSONReason represents a generated Codex app-server protocol type.

type SanitizedExecCommandApprovalResponse 

type SanitizedExecCommandApprovalResponse = SanitizedExecCommandApprovalResponseJSON

SanitizedExecCommandApprovalResponse is a generated alias for a Codex app-server protocol type.

type SanitizedExecCommandApprovalResponseJSON 

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

SanitizedExecCommandApprovalResponseJSON represents a generated Codex app-server protocol type.

type SanitizedExperimentalFeatureEnablementSetParams 

type SanitizedExperimentalFeatureEnablementSetParams = SanitizedExperimentalFeatureEnablementSetParamsJSON

SanitizedExperimentalFeatureEnablementSetParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedExperimentalFeatureEnablementSetParamsJSON represents a generated Codex app-server protocol type.

type SanitizedExperimentalFeatureEnablementSetParamsJSONEnablement added in v0.144.0 

type SanitizedExperimentalFeatureEnablementSetParamsJSONEnablement map[string]bool

SanitizedExperimentalFeatureEnablementSetParamsJSONEnablement represents a generated Codex app-server protocol type. 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 SanitizedExperimentalFeatureEnablementSetResponse 

type SanitizedExperimentalFeatureEnablementSetResponse = SanitizedExperimentalFeatureEnablementSetResponseJSON

SanitizedExperimentalFeatureEnablementSetResponse is a generated alias for a Codex app-server protocol type.

type SanitizedExperimentalFeatureEnablementSetResponseJSON 

type SanitizedExperimentalFeatureEnablementSetResponseJSON struct {
	// Feature enablement entries updated by this request.
	Enablement SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement `json:"enablement"`
}

SanitizedExperimentalFeatureEnablementSetResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ExperimentalFeatureEnablementSetResponse.

type SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement added in v0.144.0 

type SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement map[string]bool

SanitizedExperimentalFeatureEnablementSetResponseJSONEnablement represents a generated Codex app-server protocol type. Feature enablement entries updated by this request.

type SanitizedExperimentalFeatureListParams 

type SanitizedExperimentalFeatureListParams = SanitizedExperimentalFeatureListParamsJSON

SanitizedExperimentalFeatureListParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedExperimentalFeatureListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedExperimentalFeatureListParamsJSONCursor added in v0.144.0 

type SanitizedExperimentalFeatureListParamsJSONCursor *string

SanitizedExperimentalFeatureListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedExperimentalFeatureListParamsJSONLimit added in v0.144.0 

type SanitizedExperimentalFeatureListParamsJSONLimit *int

SanitizedExperimentalFeatureListParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type SanitizedExperimentalFeatureListParamsJSONThreadID added in v0.144.0 

type SanitizedExperimentalFeatureListParamsJSONThreadID *string

SanitizedExperimentalFeatureListParamsJSONThreadID represents a generated Codex app-server protocol type. 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

SanitizedExperimentalFeatureListResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedExperimentalFeatureListResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ExperimentalFeatureListResponse.

type SanitizedExperimentalFeatureListResponseJSONNextCursor added in v0.144.0 

type SanitizedExperimentalFeatureListResponseJSONNextCursor *string

SanitizedExperimentalFeatureListResponseJSONNextCursor represents a generated Codex app-server protocol type. Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedExternalAgentConfigDetectParams 

type SanitizedExternalAgentConfigDetectParams = SanitizedExternalAgentConfigDetectParamsJSON

SanitizedExternalAgentConfigDetectParams is a generated alias for a Codex app-server protocol type.

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"`

	// Maximum age in days for detected sessions. Missing values use the default
	// limit.
	MaxSessionAgeDays SanitizedExternalAgentConfigDetectParamsJSONMaxSessionAgeDays `json:"maxSessionAgeDays,omitempty,omitzero"`

	// Maximum number of sessions to detect. Missing values use the default limit.
	MaxSessions SanitizedExternalAgentConfigDetectParamsJSONMaxSessions `json:"maxSessions,omitempty,omitzero"`

	// Optional migration-source selector. Missing or unrecognized values use the
	// default source.
	MigrationSource SanitizedExternalAgentConfigDetectParamsJSONMigrationSource `json:"migrationSource,omitempty,omitzero"`

	// Deprecated field retained for compatibility. This field is ignored; use
	// `migrationSource` to select the migration source.
	Source SanitizedExternalAgentConfigDetectParamsJSONSource `json:"source,omitempty,omitzero"`
}

SanitizedExternalAgentConfigDetectParamsJSON represents a generated Codex app-server protocol type.

type SanitizedExternalAgentConfigDetectParamsJSONCwds added in v0.144.0 

type SanitizedExternalAgentConfigDetectParamsJSONCwds []string

SanitizedExternalAgentConfigDetectParamsJSONCwds represents a generated Codex app-server protocol type. Zero or more working directories to include for repo-scoped detection.

type SanitizedExternalAgentConfigDetectParamsJSONMaxSessionAgeDays added in v0.147.0 

type SanitizedExternalAgentConfigDetectParamsJSONMaxSessionAgeDays *int

SanitizedExternalAgentConfigDetectParamsJSONMaxSessionAgeDays represents a generated Codex app-server protocol type. Maximum age in days for detected sessions. Missing values use the default limit.

type SanitizedExternalAgentConfigDetectParamsJSONMaxSessions added in v0.147.0 

type SanitizedExternalAgentConfigDetectParamsJSONMaxSessions *int

SanitizedExternalAgentConfigDetectParamsJSONMaxSessions represents a generated Codex app-server protocol type. Maximum number of sessions to detect. Missing values use the default limit.

type SanitizedExternalAgentConfigDetectParamsJSONMigrationSource added in v0.147.0 

type SanitizedExternalAgentConfigDetectParamsJSONMigrationSource *string

SanitizedExternalAgentConfigDetectParamsJSONMigrationSource represents a generated Codex app-server protocol type. Optional migration-source selector. Missing or unrecognized values use the default source.

type SanitizedExternalAgentConfigDetectParamsJSONSource added in v0.147.0 

type SanitizedExternalAgentConfigDetectParamsJSONSource *string

SanitizedExternalAgentConfigDetectParamsJSONSource represents a generated Codex app-server protocol type. Deprecated field retained for compatibility. This field is ignored; use `migrationSource` to select the migration source.

type SanitizedExternalAgentConfigDetectResponse 

type SanitizedExternalAgentConfigDetectResponse = SanitizedExternalAgentConfigDetectResponseJSON

SanitizedExternalAgentConfigDetectResponse is a generated alias for a Codex app-server protocol type.

type SanitizedExternalAgentConfigDetectResponseJSON 

type SanitizedExternalAgentConfigDetectResponseJSON struct {
	// Connectors corresponds to the JSON schema field "connectors".
	Connectors []ExternalAgentDetectedConnectorCandidate `json:"connectors,omitempty,omitzero"`

	// Items corresponds to the JSON schema field "items".
	Items []ExternalAgentConfigMigrationItem `json:"items"`
}

SanitizedExternalAgentConfigDetectResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ExternalAgentConfigDetectResponse.

type SanitizedExternalAgentConfigImportCompletedNotification 

type SanitizedExternalAgentConfigImportCompletedNotification = SanitizedExternalAgentConfigImportCompletedNotificationJSON

SanitizedExternalAgentConfigImportCompletedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedExternalAgentConfigImportCompletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ExternalAgentConfigImportCompletedNotification.

type SanitizedExternalAgentConfigImportHistoriesReadResponse 

type SanitizedExternalAgentConfigImportHistoriesReadResponse = SanitizedExternalAgentConfigImportHistoriesReadResponseJSON

SanitizedExternalAgentConfigImportHistoriesReadResponse is a generated alias for a Codex app-server protocol type.

type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON 

type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON struct {
	// Connectors corresponds to the JSON schema field "connectors".
	Connectors []ExternalAgentImportedConnectorCandidate `json:"connectors"`

	// Data corresponds to the JSON schema field "data".
	Data []ExternalAgentConfigImportHistory `json:"data"`
}

SanitizedExternalAgentConfigImportHistoriesReadResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ExternalAgentConfigImportHistoriesReadResponse.

type SanitizedExternalAgentConfigImportHistoryRecordParams added in v0.147.0 

type SanitizedExternalAgentConfigImportHistoryRecordParams = SanitizedExternalAgentConfigImportHistoryRecordParamsJSON

SanitizedExternalAgentConfigImportHistoryRecordParams is a generated alias for a Codex app-server protocol type.

type SanitizedExternalAgentConfigImportHistoryRecordParamsJSON added in v0.147.0 

type SanitizedExternalAgentConfigImportHistoryRecordParamsJSON struct {
	// Completed results grouped by imported item type.
	ItemTypeResults []ExternalAgentConfigImportHistoryRecordTypeResultParams `json:"itemTypeResults"`

	// Opaque provider identifier for the externally completed import.
	ProviderID string `json:"providerId"`
}

SanitizedExternalAgentConfigImportHistoryRecordParamsJSON represents a generated Codex app-server protocol type.

type SanitizedExternalAgentConfigImportHistoryRecordResponse added in v0.147.0 

type SanitizedExternalAgentConfigImportHistoryRecordResponse = SanitizedExternalAgentConfigImportHistoryRecordResponseJSON

SanitizedExternalAgentConfigImportHistoryRecordResponse is a generated alias for a Codex app-server protocol type.

type SanitizedExternalAgentConfigImportHistoryRecordResponseJSON added in v0.147.0 

type SanitizedExternalAgentConfigImportHistoryRecordResponseJSON struct {
	// ImportID corresponds to the JSON schema field "importId".
	ImportID string `json:"importId"`
}

SanitizedExternalAgentConfigImportHistoryRecordResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ExternalAgentConfigImportHistoryRecordResponse.

type SanitizedExternalAgentConfigImportParams 

type SanitizedExternalAgentConfigImportParams = SanitizedExternalAgentConfigImportParamsJSON

SanitizedExternalAgentConfigImportParams is a generated alias for a Codex app-server protocol type.

type SanitizedExternalAgentConfigImportParamsJSON 

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

	// Migration-source selector used to produce the migration items. Pass the same
	// value to detection and import; missing or unrecognized values use the default
	// source.
	MigrationSource SanitizedExternalAgentConfigImportParamsJSONMigrationSource `json:"migrationSource,omitempty,omitzero"`

	// Opaque provider identifier supplied by the caller for analytics attribution and
	// import history display. This does not select the migration source.
	ProviderID SanitizedExternalAgentConfigImportParamsJSONProviderID `json:"providerId,omitempty,omitzero"`

	// Optional identifier for the product that initiated the import.
	Source SanitizedExternalAgentConfigImportParamsJSONSource `json:"source,omitempty,omitzero"`
}

SanitizedExternalAgentConfigImportParamsJSON represents a generated Codex app-server protocol type.

type SanitizedExternalAgentConfigImportParamsJSONMigrationSource added in v0.147.0 

type SanitizedExternalAgentConfigImportParamsJSONMigrationSource *string

SanitizedExternalAgentConfigImportParamsJSONMigrationSource represents a generated Codex app-server protocol type. Migration-source selector used to produce the migration items. Pass the same value to detection and import; missing or unrecognized values use the default source.

type SanitizedExternalAgentConfigImportParamsJSONProviderID added in v0.147.0 

type SanitizedExternalAgentConfigImportParamsJSONProviderID *string

SanitizedExternalAgentConfigImportParamsJSONProviderID represents a generated Codex app-server protocol type. Opaque provider identifier supplied by the caller for analytics attribution and import history display. This does not select the migration source.

type SanitizedExternalAgentConfigImportParamsJSONSource added in v0.144.0 

type SanitizedExternalAgentConfigImportParamsJSONSource *string

SanitizedExternalAgentConfigImportParamsJSONSource represents a generated Codex app-server protocol type. Optional identifier for the product that initiated the import.

type SanitizedExternalAgentConfigImportProgressNotification 

type SanitizedExternalAgentConfigImportProgressNotification = SanitizedExternalAgentConfigImportProgressNotificationJSON

SanitizedExternalAgentConfigImportProgressNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedExternalAgentConfigImportProgressNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ExternalAgentConfigImportProgressNotification.

type SanitizedExternalAgentConfigImportResponse 

type SanitizedExternalAgentConfigImportResponse = SanitizedExternalAgentConfigImportResponseJSON

SanitizedExternalAgentConfigImportResponse is a generated alias for a Codex app-server protocol type.

type SanitizedExternalAgentConfigImportResponseJSON 

type SanitizedExternalAgentConfigImportResponseJSON struct {
	// ImportID corresponds to the JSON schema field "importId".
	ImportID string `json:"importId"`
}

SanitizedExternalAgentConfigImportResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ExternalAgentConfigImportResponse.

type SanitizedFeedbackUploadParams 

type SanitizedFeedbackUploadParams = SanitizedFeedbackUploadParamsJSON

SanitizedFeedbackUploadParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFeedbackUploadParamsJSON represents a generated Codex app-server protocol type.

type SanitizedFeedbackUploadParamsJSONExtraLogFiles added in v0.144.0 

type SanitizedFeedbackUploadParamsJSONExtraLogFiles []string

SanitizedFeedbackUploadParamsJSONExtraLogFiles represents a generated Codex app-server protocol type.

type SanitizedFeedbackUploadParamsJSONReason added in v0.144.0 

type SanitizedFeedbackUploadParamsJSONReason *string

SanitizedFeedbackUploadParamsJSONReason represents a generated Codex app-server protocol type.

type SanitizedFeedbackUploadParamsJSONTags added in v0.144.0 

type SanitizedFeedbackUploadParamsJSONTags map[string]string

SanitizedFeedbackUploadParamsJSONTags represents a generated Codex app-server protocol type.

type SanitizedFeedbackUploadParamsJSONThreadID added in v0.144.0 

type SanitizedFeedbackUploadParamsJSONThreadID *string

SanitizedFeedbackUploadParamsJSONThreadID represents a generated Codex app-server protocol type.

type SanitizedFeedbackUploadResponse 

type SanitizedFeedbackUploadResponse = SanitizedFeedbackUploadResponseJSON

SanitizedFeedbackUploadResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFeedbackUploadResponseJSON 

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

SanitizedFeedbackUploadResponseJSON represents a generated Codex app-server protocol type. Deprecated: use FeedbackUploadResponse.

type SanitizedFileChangeOutputDeltaNotification 

type SanitizedFileChangeOutputDeltaNotification = SanitizedFileChangeOutputDeltaNotificationJSON

SanitizedFileChangeOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFileChangeOutputDeltaNotificationJSON represents a generated Codex app-server protocol type. Deprecated legacy notification for `apply_patch` textual output.

The server no longer emits this notification. Deprecated: use FileChangeOutputDeltaNotification.

type SanitizedFileChangePatchUpdatedNotification 

type SanitizedFileChangePatchUpdatedNotification = SanitizedFileChangePatchUpdatedNotificationJSON

SanitizedFileChangePatchUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFileChangePatchUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use FileChangePatchUpdatedNotification.

type SanitizedFileChangeRequestApprovalParams 

type SanitizedFileChangeRequestApprovalParams = SanitizedFileChangeRequestApprovalParamsJSON

SanitizedFileChangeRequestApprovalParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFileChangeRequestApprovalParamsJSON represents a generated Codex app-server protocol type.

type SanitizedFileChangeRequestApprovalParamsJSONGrantRoot added in v0.144.0 

type SanitizedFileChangeRequestApprovalParamsJSONGrantRoot *string

SanitizedFileChangeRequestApprovalParamsJSONGrantRoot represents a generated Codex app-server protocol type. [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

SanitizedFileChangeRequestApprovalParamsJSONReason represents a generated Codex app-server protocol type. Optional explanatory reason (e.g. request for extra write access).

type SanitizedFileChangeRequestApprovalResponse 

type SanitizedFileChangeRequestApprovalResponse = SanitizedFileChangeRequestApprovalResponseJSON

SanitizedFileChangeRequestApprovalResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFileChangeRequestApprovalResponseJSON 

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

SanitizedFileChangeRequestApprovalResponseJSON represents a generated Codex app-server protocol type.

type SanitizedFsCopyResponse added in v0.144.0 

type SanitizedFsCopyResponse = SanitizedFsCopyResponseJSON

SanitizedFsCopyResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsCopyResponseJSON added in v0.144.0 

type SanitizedFsCopyResponseJSON map[string]interface{}

SanitizedFsCopyResponseJSON represents a generated Codex app-server protocol type. Successful response for `fs/copy`. Deprecated: use FsCopyResponse.

type SanitizedFsCreateDirectoryResponse added in v0.144.0 

type SanitizedFsCreateDirectoryResponse = SanitizedFsCreateDirectoryResponseJSON

SanitizedFsCreateDirectoryResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsCreateDirectoryResponseJSON added in v0.144.0 

type SanitizedFsCreateDirectoryResponseJSON map[string]interface{}

SanitizedFsCreateDirectoryResponseJSON represents a generated Codex app-server protocol type. Successful response for `fs/createDirectory`. Deprecated: use FsCreateDirectoryResponse.

type SanitizedFsGetMetadataResponse 

type SanitizedFsGetMetadataResponse = SanitizedFsGetMetadataResponseJSON

SanitizedFsGetMetadataResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFsGetMetadataResponseJSON represents a generated Codex app-server protocol type. Metadata returned by `fs/getMetadata`. Deprecated: use FsGetMetadataResponse.

type SanitizedFsReadDirectoryResponse 

type SanitizedFsReadDirectoryResponse = SanitizedFsReadDirectoryResponseJSON

SanitizedFsReadDirectoryResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsReadDirectoryResponseJSON 

type SanitizedFsReadDirectoryResponseJSON struct {
	// Direct child entries in the requested directory.
	Entries []FsReadDirectoryEntry `json:"entries"`
}

SanitizedFsReadDirectoryResponseJSON represents a generated Codex app-server protocol type. Directory entries returned by `fs/readDirectory`. Deprecated: use FsReadDirectoryResponse.

type SanitizedFsReadFileResponse 

type SanitizedFsReadFileResponse = SanitizedFsReadFileResponseJSON

SanitizedFsReadFileResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsReadFileResponseJSON 

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

SanitizedFsReadFileResponseJSON represents a generated Codex app-server protocol type. Base64-encoded file contents returned by `fs/readFile`. Deprecated: use FsReadFileResponse.

type SanitizedFsRemoveResponse added in v0.144.0 

type SanitizedFsRemoveResponse = SanitizedFsRemoveResponseJSON

SanitizedFsRemoveResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsRemoveResponseJSON added in v0.144.0 

type SanitizedFsRemoveResponseJSON map[string]interface{}

SanitizedFsRemoveResponseJSON represents a generated Codex app-server protocol type. Successful response for `fs/remove`. Deprecated: use FsRemoveResponse.

type SanitizedFsUnwatchParams 

type SanitizedFsUnwatchParams = SanitizedFsUnwatchParamsJSON

SanitizedFsUnwatchParams is a generated alias for a Codex app-server protocol type.

type SanitizedFsUnwatchParamsJSON 

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

SanitizedFsUnwatchParamsJSON represents a generated Codex app-server protocol type. Stop filesystem watch notifications for a prior `fs/watch`.

type SanitizedFsUnwatchResponse added in v0.144.0 

type SanitizedFsUnwatchResponse = SanitizedFsUnwatchResponseJSON

SanitizedFsUnwatchResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsUnwatchResponseJSON added in v0.144.0 

type SanitizedFsUnwatchResponseJSON map[string]interface{}

SanitizedFsUnwatchResponseJSON represents a generated Codex app-server protocol type. Successful response for `fs/unwatch`. Deprecated: use FsUnwatchResponse.

type SanitizedFsWriteFileResponse added in v0.144.0 

type SanitizedFsWriteFileResponse = SanitizedFsWriteFileResponseJSON

SanitizedFsWriteFileResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFsWriteFileResponseJSON added in v0.144.0 

type SanitizedFsWriteFileResponseJSON map[string]interface{}

SanitizedFsWriteFileResponseJSON represents a generated Codex app-server protocol type. Successful response for `fs/writeFile`. Deprecated: use FsWriteFileResponse.

type SanitizedFuzzyFileSearchParams 

type SanitizedFuzzyFileSearchParams = SanitizedFuzzyFileSearchParamsJSON

SanitizedFuzzyFileSearchParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFuzzyFileSearchParamsJSON represents a generated Codex app-server protocol type.

type SanitizedFuzzyFileSearchParamsJSONCancellationToken added in v0.144.0 

type SanitizedFuzzyFileSearchParamsJSONCancellationToken *string

SanitizedFuzzyFileSearchParamsJSONCancellationToken represents a generated Codex app-server protocol type.

type SanitizedFuzzyFileSearchResponse 

type SanitizedFuzzyFileSearchResponse = SanitizedFuzzyFileSearchResponseJSON

SanitizedFuzzyFileSearchResponse is a generated alias for a Codex app-server protocol type.

type SanitizedFuzzyFileSearchResponseJSON 

type SanitizedFuzzyFileSearchResponseJSON struct {
	// Files corresponds to the JSON schema field "files".
	Files []FuzzyFileSearchResult `json:"files"`
}

SanitizedFuzzyFileSearchResponseJSON represents a generated Codex app-server protocol type. Deprecated: use FuzzyFileSearchResponse.

type SanitizedFuzzyFileSearchSessionCompletedNotification 

type SanitizedFuzzyFileSearchSessionCompletedNotification = SanitizedFuzzyFileSearchSessionCompletedNotificationJSON

SanitizedFuzzyFileSearchSessionCompletedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON 

type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON struct {
	// SessionID corresponds to the JSON schema field "sessionId".
	SessionID string `json:"sessionId"`
}

SanitizedFuzzyFileSearchSessionCompletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use FuzzyFileSearchSessionCompletedNotification.

type SanitizedFuzzyFileSearchSessionUpdatedNotification 

type SanitizedFuzzyFileSearchSessionUpdatedNotification = SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON

SanitizedFuzzyFileSearchSessionUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use FuzzyFileSearchSessionUpdatedNotification.

type SanitizedGetAccountParams 

type SanitizedGetAccountParams = SanitizedGetAccountParamsJSON

SanitizedGetAccountParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedGetAccountParamsJSON represents a generated Codex app-server protocol type.

type SanitizedGetAccountRateLimitsResponse added in v0.144.0 

type SanitizedGetAccountRateLimitsResponse = SanitizedGetAccountRateLimitsResponseJSON

SanitizedGetAccountRateLimitsResponse is a generated alias for a Codex app-server protocol type.

type SanitizedGetAccountRateLimitsResponseJSON added in v0.144.0 

type SanitizedGetAccountRateLimitsResponseJSON struct {
	// RateLimitResetCredits corresponds to the JSON schema field
	// "rateLimitResetCredits".
	RateLimitResetCredits *RateLimitResetCreditsSummary `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"`
}

SanitizedGetAccountRateLimitsResponseJSON represents a generated Codex app-server protocol type. Deprecated: use GetAccountRateLimitsResponse.

type SanitizedGetAccountRateLimitsResponseJSONRateLimits 

type SanitizedGetAccountRateLimitsResponseJSONRateLimits struct {
	// Credits corresponds to the JSON schema field "credits".
	Credits *CreditsSnapshot `json:"credits,omitempty,omitzero"`

	// IndividualLimit corresponds to the JSON schema field "individualLimit".
	IndividualLimit *SpendControlLimitSnapshot `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 *PlanType `json:"planType,omitempty,omitzero"`

	// Primary corresponds to the JSON schema field "primary".
	Primary *RateLimitWindow `json:"primary,omitempty,omitzero"`

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

	// Secondary corresponds to the JSON schema field "secondary".
	Secondary *RateLimitWindow `json:"secondary,omitempty,omitzero"`

	// Backend-reported spend-control state. `None` is unavailable, not a
	// sparse-update recovery.
	SpendControlReached RateLimitSnapshotSpendControlReached `json:"spendControlReached,omitempty,omitzero"`
}

SanitizedGetAccountRateLimitsResponseJSONRateLimits represents a generated Codex app-server protocol type. Backward-compatible single-bucket view; mirrors the historical payload.

type SanitizedGetAccountRateLimitsResponseJSONRateLimitsByLimitID added in v0.144.0 

type SanitizedGetAccountRateLimitsResponseJSONRateLimitsByLimitID map[string]RateLimitSnapshot

SanitizedGetAccountRateLimitsResponseJSONRateLimitsByLimitID represents a generated Codex app-server protocol type. Multi-bucket view keyed by metered `limit_id` (for example, `codex`).

type SanitizedGetAccountResponse 

type SanitizedGetAccountResponse = SanitizedGetAccountResponseJSON

SanitizedGetAccountResponse is a generated alias for a Codex app-server protocol type.

type SanitizedGetAccountResponseJSON 

type SanitizedGetAccountResponseJSON struct {
	// Account corresponds to the JSON schema field "account".
	Account Account `json:"account,omitempty,omitzero"`

	// RequiresOpenaiAuth corresponds to the JSON schema field "requiresOpenaiAuth".
	RequiresOpenaiAuth bool `json:"requiresOpenaiAuth"`
}

SanitizedGetAccountResponseJSON represents a generated Codex app-server protocol type. Deprecated: use GetAccountResponse.

type SanitizedGetAccountTokenUsageResponse 

type SanitizedGetAccountTokenUsageResponse = SanitizedGetAccountTokenUsageResponseJSON

SanitizedGetAccountTokenUsageResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedGetAccountTokenUsageResponseJSON represents a generated Codex app-server protocol type. Deprecated: use GetAccountTokenUsageResponse.

type SanitizedGetAccountTokenUsageResponseJSONDailyUsageBuckets added in v0.144.0 

type SanitizedGetAccountTokenUsageResponseJSONDailyUsageBuckets []AccountTokenUsageDailyBucket

SanitizedGetAccountTokenUsageResponseJSONDailyUsageBuckets represents a generated Codex app-server protocol type.

type SanitizedGetWorkspaceMessagesResponse 

type SanitizedGetWorkspaceMessagesResponse = SanitizedGetWorkspaceMessagesResponseJSON

SanitizedGetWorkspaceMessagesResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedGetWorkspaceMessagesResponseJSON represents a generated Codex app-server protocol type. Deprecated: use GetWorkspaceMessagesResponse.

type SanitizedGuardianWarningNotification 

type SanitizedGuardianWarningNotification = SanitizedGuardianWarningNotificationJSON

SanitizedGuardianWarningNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedGuardianWarningNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use GuardianWarningNotification.

type SanitizedHooksListParams 

type SanitizedHooksListParams = SanitizedHooksListParamsJSON

SanitizedHooksListParams is a generated alias for a Codex app-server protocol type.

type SanitizedHooksListParamsJSON 

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

SanitizedHooksListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedInitializeParams 

type SanitizedInitializeParams = SanitizedInitializeParamsJSON

SanitizedInitializeParams is a generated alias for a Codex app-server protocol type.

type SanitizedInitializeParamsJSON 

type SanitizedInitializeParamsJSON struct {
	// Capabilities corresponds to the JSON schema field "capabilities".
	Capabilities *InitializeCapabilities `json:"capabilities,omitempty,omitzero"`

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

SanitizedInitializeParamsJSON represents a generated Codex app-server protocol type.

type SanitizedListMCPServerStatusParams 

type SanitizedListMCPServerStatusParams = SanitizedListMCPServerStatusParamsJSON

SanitizedListMCPServerStatusParams is a generated alias for a Codex app-server protocol type.

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 *MCPServerStatusDetail `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"`
}

SanitizedListMCPServerStatusParamsJSON represents a generated Codex app-server protocol type.

type SanitizedListMCPServerStatusParamsJSONCursor added in v0.144.0 

type SanitizedListMCPServerStatusParamsJSONCursor *string

SanitizedListMCPServerStatusParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedListMCPServerStatusParamsJSONLimit added in v0.144.0 

type SanitizedListMCPServerStatusParamsJSONLimit *int

SanitizedListMCPServerStatusParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a server-defined value.

type SanitizedListMCPServerStatusParamsJSONThreadID added in v0.144.0 

type SanitizedListMCPServerStatusParamsJSONThreadID *string

SanitizedListMCPServerStatusParamsJSONThreadID represents a generated Codex app-server protocol type.

type SanitizedListMCPServerStatusResponse 

type SanitizedListMCPServerStatusResponse = SanitizedListMCPServerStatusResponseJSON

SanitizedListMCPServerStatusResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedListMCPServerStatusResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ListMCPServerStatusResponse.

type SanitizedListMCPServerStatusResponseJSONNextCursor added in v0.144.0 

type SanitizedListMCPServerStatusResponseJSONNextCursor *string

SanitizedListMCPServerStatusResponseJSONNextCursor represents a generated Codex app-server protocol type. 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

SanitizedLogoutAccountResponse is a generated alias for a Codex app-server protocol type.

type SanitizedLogoutAccountResponseJSON added in v0.144.0 

type SanitizedLogoutAccountResponseJSON map[string]interface{}

SanitizedLogoutAccountResponseJSON represents a generated Codex app-server protocol type. Deprecated: use LogoutAccountResponse.

type SanitizedMCPResourceReadParams 

type SanitizedMCPResourceReadParams = SanitizedMCPResourceReadParamsJSON

SanitizedMCPResourceReadParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedMCPResourceReadParamsJSON represents a generated Codex app-server protocol type.

type SanitizedMCPResourceReadParamsJSONThreadID added in v0.144.0 

type SanitizedMCPResourceReadParamsJSONThreadID *string

SanitizedMCPResourceReadParamsJSONThreadID represents a generated Codex app-server protocol type.

type SanitizedMCPResourceReadResponse 

type SanitizedMCPResourceReadResponse = SanitizedMCPResourceReadResponseJSON

SanitizedMCPResourceReadResponse is a generated alias for a Codex app-server protocol type.

type SanitizedMCPResourceReadResponseJSON 

type SanitizedMCPResourceReadResponseJSON struct {
	// Contents corresponds to the JSON schema field "contents".
	Contents []ResourceContent `json:"contents"`
}

SanitizedMCPResourceReadResponseJSON represents a generated Codex app-server protocol type. Deprecated: use MCPResourceReadResponse.

type SanitizedMCPServerElicitationRequestResponse 

type SanitizedMCPServerElicitationRequestResponse = SanitizedMCPServerElicitationRequestResponseJSON

SanitizedMCPServerElicitationRequestResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedMCPServerElicitationRequestResponseJSON represents a generated Codex app-server protocol type. Deprecated: use MCPServerElicitationRequestResponse.

type SanitizedMCPServerOAuthLoginCompletedNotification added in v0.147.0 

type SanitizedMCPServerOAuthLoginCompletedNotification = SanitizedMCPServerOAuthLoginCompletedNotificationJSON

SanitizedMCPServerOAuthLoginCompletedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginCompletedNotificationJSON added in v0.147.0 

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"`
}

SanitizedMCPServerOAuthLoginCompletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use MCPServerOAuthLoginCompletedNotification.

type SanitizedMCPServerOAuthLoginCompletedNotificationJSONError added in v0.147.0 

type SanitizedMCPServerOAuthLoginCompletedNotificationJSONError *string

SanitizedMCPServerOAuthLoginCompletedNotificationJSONError represents a generated Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginCompletedNotificationJSONThreadID added in v0.147.0 

type SanitizedMCPServerOAuthLoginCompletedNotificationJSONThreadID *string

SanitizedMCPServerOAuthLoginCompletedNotificationJSONThreadID represents a generated Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginParams added in v0.147.0 

type SanitizedMCPServerOAuthLoginParams = SanitizedMCPServerOAuthLoginParamsJSON

SanitizedMCPServerOAuthLoginParams is a generated alias for a Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginParamsJSON added in v0.147.0 

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"`
}

SanitizedMCPServerOAuthLoginParamsJSON represents a generated Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginParamsJSONScopes added in v0.147.0 

type SanitizedMCPServerOAuthLoginParamsJSONScopes []string

SanitizedMCPServerOAuthLoginParamsJSONScopes represents a generated Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginParamsJSONThreadID added in v0.147.0 

type SanitizedMCPServerOAuthLoginParamsJSONThreadID *string

SanitizedMCPServerOAuthLoginParamsJSONThreadID represents a generated Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginParamsJSONTimeoutSecs added in v0.147.0 

type SanitizedMCPServerOAuthLoginParamsJSONTimeoutSecs *int

SanitizedMCPServerOAuthLoginParamsJSONTimeoutSecs represents a generated Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginResponse added in v0.147.0 

type SanitizedMCPServerOAuthLoginResponse = SanitizedMCPServerOAuthLoginResponseJSON

SanitizedMCPServerOAuthLoginResponse is a generated alias for a Codex app-server protocol type.

type SanitizedMCPServerOAuthLoginResponseJSON added in v0.147.0 

type SanitizedMCPServerOAuthLoginResponseJSON struct {
	// AuthorizationURL corresponds to the JSON schema field "authorizationUrl".
	AuthorizationURL string `json:"authorizationUrl"`
}

SanitizedMCPServerOAuthLoginResponseJSON represents a generated Codex app-server protocol type. Deprecated: use MCPServerOAuthLoginResponse.

type SanitizedMCPServerOauthLoginCompletedNotification deprecated 

type SanitizedMCPServerOauthLoginCompletedNotification = SanitizedMCPServerOAuthLoginCompletedNotification

SanitizedMCPServerOauthLoginCompletedNotification is the former spelling of SanitizedMCPServerOAuthLoginCompletedNotification.

Deprecated: use SanitizedMCPServerOAuthLoginCompletedNotification.

type SanitizedMCPServerOauthLoginCompletedNotificationJSON deprecated 

type SanitizedMCPServerOauthLoginCompletedNotificationJSON = SanitizedMCPServerOAuthLoginCompletedNotificationJSON

SanitizedMCPServerOauthLoginCompletedNotificationJSON is the former spelling of SanitizedMCPServerOAuthLoginCompletedNotificationJSON.

Deprecated: use SanitizedMCPServerOAuthLoginCompletedNotificationJSON.

type SanitizedMCPServerOauthLoginCompletedNotificationJSONError deprecated added in v0.144.0 

type SanitizedMCPServerOauthLoginCompletedNotificationJSONError = SanitizedMCPServerOAuthLoginCompletedNotificationJSONError

SanitizedMCPServerOauthLoginCompletedNotificationJSONError is the former spelling of SanitizedMCPServerOAuthLoginCompletedNotificationJSONError.

Deprecated: use SanitizedMCPServerOAuthLoginCompletedNotificationJSONError.

type SanitizedMCPServerOauthLoginCompletedNotificationJSONThreadID deprecated added in v0.144.0 

type SanitizedMCPServerOauthLoginCompletedNotificationJSONThreadID = SanitizedMCPServerOAuthLoginCompletedNotificationJSONThreadID

SanitizedMCPServerOauthLoginCompletedNotificationJSONThreadID is the former spelling of SanitizedMCPServerOAuthLoginCompletedNotificationJSONThreadID.

Deprecated: use SanitizedMCPServerOAuthLoginCompletedNotificationJSONThreadID.

type SanitizedMCPServerOauthLoginParams deprecated 

type SanitizedMCPServerOauthLoginParams = SanitizedMCPServerOAuthLoginParams

SanitizedMCPServerOauthLoginParams is the former spelling of SanitizedMCPServerOAuthLoginParams.

Deprecated: use SanitizedMCPServerOAuthLoginParams.

type SanitizedMCPServerOauthLoginParamsJSON deprecated 

type SanitizedMCPServerOauthLoginParamsJSON = SanitizedMCPServerOAuthLoginParamsJSON

SanitizedMCPServerOauthLoginParamsJSON is the former spelling of SanitizedMCPServerOAuthLoginParamsJSON.

Deprecated: use SanitizedMCPServerOAuthLoginParamsJSON.

type SanitizedMCPServerOauthLoginParamsJSONScopes deprecated added in v0.144.0 

type SanitizedMCPServerOauthLoginParamsJSONScopes = SanitizedMCPServerOAuthLoginParamsJSONScopes

SanitizedMCPServerOauthLoginParamsJSONScopes is the former spelling of SanitizedMCPServerOAuthLoginParamsJSONScopes.

Deprecated: use SanitizedMCPServerOAuthLoginParamsJSONScopes.

type SanitizedMCPServerOauthLoginParamsJSONThreadID deprecated added in v0.144.0 

type SanitizedMCPServerOauthLoginParamsJSONThreadID = SanitizedMCPServerOAuthLoginParamsJSONThreadID

SanitizedMCPServerOauthLoginParamsJSONThreadID is the former spelling of SanitizedMCPServerOAuthLoginParamsJSONThreadID.

Deprecated: use SanitizedMCPServerOAuthLoginParamsJSONThreadID.

type SanitizedMCPServerOauthLoginParamsJSONTimeoutSecs deprecated added in v0.144.0 

type SanitizedMCPServerOauthLoginParamsJSONTimeoutSecs = SanitizedMCPServerOAuthLoginParamsJSONTimeoutSecs

SanitizedMCPServerOauthLoginParamsJSONTimeoutSecs is the former spelling of SanitizedMCPServerOAuthLoginParamsJSONTimeoutSecs.

Deprecated: use SanitizedMCPServerOAuthLoginParamsJSONTimeoutSecs.

type SanitizedMCPServerOauthLoginResponse deprecated 

type SanitizedMCPServerOauthLoginResponse = SanitizedMCPServerOAuthLoginResponse

SanitizedMCPServerOauthLoginResponse is the former spelling of SanitizedMCPServerOAuthLoginResponse.

Deprecated: use SanitizedMCPServerOAuthLoginResponse.

type SanitizedMCPServerOauthLoginResponseJSON deprecated 

type SanitizedMCPServerOauthLoginResponseJSON = SanitizedMCPServerOAuthLoginResponseJSON

SanitizedMCPServerOauthLoginResponseJSON is the former spelling of SanitizedMCPServerOAuthLoginResponseJSON.

Deprecated: use SanitizedMCPServerOAuthLoginResponseJSON.

type SanitizedMCPServerRefreshResponse added in v0.144.0 

type SanitizedMCPServerRefreshResponse = SanitizedMCPServerRefreshResponseJSON

SanitizedMCPServerRefreshResponse is a generated alias for a Codex app-server protocol type.

type SanitizedMCPServerRefreshResponseJSON added in v0.144.0 

type SanitizedMCPServerRefreshResponseJSON map[string]interface{}

SanitizedMCPServerRefreshResponseJSON represents a generated Codex app-server protocol type. Deprecated: use MCPServerRefreshResponse.

type SanitizedMCPServerStatusUpdatedNotification 

type SanitizedMCPServerStatusUpdatedNotification = SanitizedMCPServerStatusUpdatedNotificationJSON

SanitizedMCPServerStatusUpdatedNotification is a generated alias for a Codex app-server protocol type.

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 *MCPServerStartupFailureReason `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"`
}

SanitizedMCPServerStatusUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use MCPServerStatusUpdatedNotification.

type SanitizedMCPServerStatusUpdatedNotificationJSONError added in v0.144.0 

type SanitizedMCPServerStatusUpdatedNotificationJSONError *string

SanitizedMCPServerStatusUpdatedNotificationJSONError represents a generated Codex app-server protocol type.

type SanitizedMCPServerStatusUpdatedNotificationJSONThreadID added in v0.144.0 

type SanitizedMCPServerStatusUpdatedNotificationJSONThreadID *string

SanitizedMCPServerStatusUpdatedNotificationJSONThreadID represents a generated Codex app-server protocol type.

type SanitizedMCPServerToolCallParams 

type SanitizedMCPServerToolCallParams = SanitizedMCPServerToolCallParamsJSON

SanitizedMCPServerToolCallParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedMCPServerToolCallParamsJSON represents a generated Codex app-server protocol type.

type SanitizedMCPServerToolCallResponse 

type SanitizedMCPServerToolCallResponse = SanitizedMCPServerToolCallResponseJSON

SanitizedMCPServerToolCallResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedMCPServerToolCallResponseJSON represents a generated Codex app-server protocol type. Deprecated: use MCPServerToolCallResponse.

type SanitizedMCPServerToolCallResponseJSONIsError added in v0.144.0 

type SanitizedMCPServerToolCallResponseJSONIsError *bool

SanitizedMCPServerToolCallResponseJSONIsError represents a generated Codex app-server protocol type.

type SanitizedMCPToolCallProgressNotification 

type SanitizedMCPToolCallProgressNotification = SanitizedMCPToolCallProgressNotificationJSON

SanitizedMCPToolCallProgressNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedMCPToolCallProgressNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use MCPToolCallProgressNotification.

type SanitizedMarketplaceAddParams 

type SanitizedMarketplaceAddParams = SanitizedMarketplaceAddParamsJSON

SanitizedMarketplaceAddParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedMarketplaceAddParamsJSON represents a generated Codex app-server protocol type.

type SanitizedMarketplaceAddParamsJSONRefName added in v0.144.0 

type SanitizedMarketplaceAddParamsJSONRefName *string

SanitizedMarketplaceAddParamsJSONRefName represents a generated Codex app-server protocol type.

type SanitizedMarketplaceAddParamsJSONSparsePaths added in v0.144.0 

type SanitizedMarketplaceAddParamsJSONSparsePaths []string

SanitizedMarketplaceAddParamsJSONSparsePaths represents a generated Codex app-server protocol type.

type SanitizedMarketplaceRemoveParams 

type SanitizedMarketplaceRemoveParams = SanitizedMarketplaceRemoveParamsJSON

SanitizedMarketplaceRemoveParams is a generated alias for a Codex app-server protocol type.

type SanitizedMarketplaceRemoveParamsJSON 

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

SanitizedMarketplaceRemoveParamsJSON represents a generated Codex app-server protocol type.

type SanitizedMarketplaceUpgradeParams 

type SanitizedMarketplaceUpgradeParams = SanitizedMarketplaceUpgradeParamsJSON

SanitizedMarketplaceUpgradeParams is a generated alias for a Codex app-server protocol type.

type SanitizedMarketplaceUpgradeParamsJSON 

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

SanitizedMarketplaceUpgradeParamsJSON represents a generated Codex app-server protocol type.

type SanitizedMarketplaceUpgradeParamsJSONMarketplaceName added in v0.144.0 

type SanitizedMarketplaceUpgradeParamsJSONMarketplaceName *string

SanitizedMarketplaceUpgradeParamsJSONMarketplaceName represents a generated Codex app-server protocol type.

type SanitizedModelListParams 

type SanitizedModelListParams = SanitizedModelListParamsJSON

SanitizedModelListParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedModelListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedModelListParamsJSONCursor added in v0.144.0 

type SanitizedModelListParamsJSONCursor *string

SanitizedModelListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedModelListParamsJSONIncludeHidden added in v0.144.0 

type SanitizedModelListParamsJSONIncludeHidden *bool

SanitizedModelListParamsJSONIncludeHidden represents a generated Codex app-server protocol type. When true, include models that are hidden from the default picker list.

type SanitizedModelListParamsJSONLimit added in v0.144.0 

type SanitizedModelListParamsJSONLimit *int

SanitizedModelListParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type SanitizedModelListResponse 

type SanitizedModelListResponse = SanitizedModelListResponseJSON

SanitizedModelListResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedModelListResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ModelListResponse.

type SanitizedModelListResponseJSONNextCursor added in v0.144.0 

type SanitizedModelListResponseJSONNextCursor *string

SanitizedModelListResponseJSONNextCursor represents a generated Codex app-server protocol type. 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

SanitizedModelProviderCapabilitiesReadParams is a generated alias for a Codex app-server protocol type.

type SanitizedModelProviderCapabilitiesReadParamsJSON added in v0.144.0 

type SanitizedModelProviderCapabilitiesReadParamsJSON map[string]interface{}

SanitizedModelProviderCapabilitiesReadParamsJSON represents a generated Codex app-server protocol type.

type SanitizedModelProviderCapabilitiesReadResponse 

type SanitizedModelProviderCapabilitiesReadResponse = SanitizedModelProviderCapabilitiesReadResponseJSON

SanitizedModelProviderCapabilitiesReadResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedModelProviderCapabilitiesReadResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ModelProviderCapabilitiesReadResponse.

type SanitizedModelReroutedNotification 

type SanitizedModelReroutedNotification = SanitizedModelReroutedNotificationJSON

SanitizedModelReroutedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedModelReroutedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ModelReroutedNotification.

type SanitizedModelSafetyBufferingUpdatedNotification 

type SanitizedModelSafetyBufferingUpdatedNotification = SanitizedModelSafetyBufferingUpdatedNotificationJSON

SanitizedModelSafetyBufferingUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedModelSafetyBufferingUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ModelSafetyBufferingUpdatedNotification.

type SanitizedModelSafetyBufferingUpdatedNotificationJSONFasterModel added in v0.144.0 

type SanitizedModelSafetyBufferingUpdatedNotificationJSONFasterModel *string

SanitizedModelSafetyBufferingUpdatedNotificationJSONFasterModel represents a generated Codex app-server protocol type.

type SanitizedModelVerificationNotification 

type SanitizedModelVerificationNotification = SanitizedModelVerificationNotificationJSON

SanitizedModelVerificationNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedModelVerificationNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ModelVerificationNotification.

type SanitizedPermissionProfileListParams 

type SanitizedPermissionProfileListParams = SanitizedPermissionProfileListParamsJSON

SanitizedPermissionProfileListParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPermissionProfileListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPermissionProfileListParamsJSONCursor added in v0.144.0 

type SanitizedPermissionProfileListParamsJSONCursor *string

SanitizedPermissionProfileListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedPermissionProfileListParamsJSONCwd added in v0.144.0 

type SanitizedPermissionProfileListParamsJSONCwd *string

SanitizedPermissionProfileListParamsJSONCwd represents a generated Codex app-server protocol type. Optional working directory to resolve project config layers.

type SanitizedPermissionProfileListParamsJSONLimit added in v0.144.0 

type SanitizedPermissionProfileListParamsJSONLimit *int

SanitizedPermissionProfileListParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to the full result set.

type SanitizedPermissionProfileListResponse 

type SanitizedPermissionProfileListResponse = SanitizedPermissionProfileListResponseJSON

SanitizedPermissionProfileListResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPermissionProfileListResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PermissionProfileListResponse.

type SanitizedPermissionProfileListResponseJSONNextCursor added in v0.144.0 

type SanitizedPermissionProfileListResponseJSONNextCursor *string

SanitizedPermissionProfileListResponseJSONNextCursor represents a generated Codex app-server protocol type. Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.

type SanitizedPermissionsRequestApprovalResponse 

type SanitizedPermissionsRequestApprovalResponse = SanitizedPermissionsRequestApprovalResponseJSON

SanitizedPermissionsRequestApprovalResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPermissionsRequestApprovalResponseJSON represents a generated Codex app-server protocol type.

type SanitizedPermissionsRequestApprovalResponseJSONStrictAutoReview added in v0.144.0 

type SanitizedPermissionsRequestApprovalResponseJSONStrictAutoReview *bool

SanitizedPermissionsRequestApprovalResponseJSONStrictAutoReview represents a generated Codex app-server protocol type. Review every subsequent command in this turn before normal sandboxed execution.

type SanitizedPlanDeltaNotification 

type SanitizedPlanDeltaNotification = SanitizedPlanDeltaNotificationJSON

SanitizedPlanDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPlanDeltaNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content. Deprecated: use PlanDeltaNotification.

type SanitizedPluginInstallResponse 

type SanitizedPluginInstallResponse = SanitizedPluginInstallResponseJSON

SanitizedPluginInstallResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPluginInstallResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PluginInstallResponse.

type SanitizedPluginShareCheckoutParams 

type SanitizedPluginShareCheckoutParams = SanitizedPluginShareCheckoutParamsJSON

SanitizedPluginShareCheckoutParams is a generated alias for a Codex app-server protocol type.

type SanitizedPluginShareCheckoutParamsJSON 

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

SanitizedPluginShareCheckoutParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPluginShareDeleteParams 

type SanitizedPluginShareDeleteParams = SanitizedPluginShareDeleteParamsJSON

SanitizedPluginShareDeleteParams is a generated alias for a Codex app-server protocol type.

type SanitizedPluginShareDeleteParamsJSON 

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

SanitizedPluginShareDeleteParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPluginShareDeleteResponse added in v0.144.0 

type SanitizedPluginShareDeleteResponse = SanitizedPluginShareDeleteResponseJSON

SanitizedPluginShareDeleteResponse is a generated alias for a Codex app-server protocol type.

type SanitizedPluginShareDeleteResponseJSON added in v0.144.0 

type SanitizedPluginShareDeleteResponseJSON map[string]interface{}

SanitizedPluginShareDeleteResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PluginShareDeleteResponse.

type SanitizedPluginShareListParams added in v0.144.0 

type SanitizedPluginShareListParams = SanitizedPluginShareListParamsJSON

SanitizedPluginShareListParams is a generated alias for a Codex app-server protocol type.

type SanitizedPluginShareListParamsJSON added in v0.144.0 

type SanitizedPluginShareListParamsJSON map[string]interface{}

SanitizedPluginShareListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPluginShareSaveResponse 

type SanitizedPluginShareSaveResponse = SanitizedPluginShareSaveResponseJSON

SanitizedPluginShareSaveResponse is a generated alias for a Codex app-server protocol type.

type SanitizedPluginShareSaveResponseJSON 

type SanitizedPluginShareSaveResponseJSON struct {
	// CanPublishToWorkspace corresponds to the JSON schema field
	// "canPublishToWorkspace".
	CanPublishToWorkspace SanitizedPluginShareSaveResponseJSONCanPublishToWorkspace `json:"canPublishToWorkspace,omitempty,omitzero"`

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

	// ShareURL corresponds to the JSON schema field "shareUrl".
	ShareURL string `json:"shareUrl"`
}

SanitizedPluginShareSaveResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PluginShareSaveResponse.

type SanitizedPluginShareSaveResponseJSONCanPublishToWorkspace added in v0.147.0 

type SanitizedPluginShareSaveResponseJSONCanPublishToWorkspace *bool

SanitizedPluginShareSaveResponseJSONCanPublishToWorkspace represents a generated Codex app-server protocol type.

type SanitizedPluginShareUpdateTargetsParams 

type SanitizedPluginShareUpdateTargetsParams = SanitizedPluginShareUpdateTargetsParamsJSON

SanitizedPluginShareUpdateTargetsParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPluginShareUpdateTargetsParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPluginShareUpdateTargetsResponse 

type SanitizedPluginShareUpdateTargetsResponse = SanitizedPluginShareUpdateTargetsResponseJSON

SanitizedPluginShareUpdateTargetsResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPluginShareUpdateTargetsResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PluginShareUpdateTargetsResponse.

type SanitizedPluginSkillReadParams 

type SanitizedPluginSkillReadParams = SanitizedPluginSkillReadParamsJSON

SanitizedPluginSkillReadParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedPluginSkillReadParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPluginSkillReadResponse 

type SanitizedPluginSkillReadResponse = SanitizedPluginSkillReadResponseJSON

SanitizedPluginSkillReadResponse is a generated alias for a Codex app-server protocol type.

type SanitizedPluginSkillReadResponseJSON 

type SanitizedPluginSkillReadResponseJSON struct {
	// Contents corresponds to the JSON schema field "contents".
	Contents SanitizedPluginSkillReadResponseJSONContents `json:"contents,omitempty,omitzero"`
}

SanitizedPluginSkillReadResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PluginSkillReadResponse.

type SanitizedPluginSkillReadResponseJSONContents added in v0.144.0 

type SanitizedPluginSkillReadResponseJSONContents *string

SanitizedPluginSkillReadResponseJSONContents represents a generated Codex app-server protocol type.

type SanitizedPluginUninstallParams 

type SanitizedPluginUninstallParams = SanitizedPluginUninstallParamsJSON

SanitizedPluginUninstallParams is a generated alias for a Codex app-server protocol type.

type SanitizedPluginUninstallParamsJSON 

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

SanitizedPluginUninstallParamsJSON represents a generated Codex app-server protocol type.

type SanitizedPluginUninstallResponse added in v0.144.0 

type SanitizedPluginUninstallResponse = SanitizedPluginUninstallResponseJSON

SanitizedPluginUninstallResponse is a generated alias for a Codex app-server protocol type.

type SanitizedPluginUninstallResponseJSON added in v0.144.0 

type SanitizedPluginUninstallResponseJSON map[string]interface{}

SanitizedPluginUninstallResponseJSON represents a generated Codex app-server protocol type. Deprecated: use PluginUninstallResponse.

type SanitizedProcessExitedNotification 

type SanitizedProcessExitedNotification = SanitizedProcessExitedNotificationJSON

SanitizedProcessExitedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedProcessExitedNotificationJSON represents a generated Codex app-server protocol type. Final process exit notification for `process/spawn`. Deprecated: use ProcessExitedNotification.

type SanitizedProcessOutputDeltaNotification added in v0.144.0 

type SanitizedProcessOutputDeltaNotification = SanitizedProcessOutputDeltaNotificationJSON

SanitizedProcessOutputDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedProcessOutputDeltaNotificationJSON represents a generated Codex app-server protocol type. Base64-encoded output chunk emitted for a streaming `process/spawn` request. Deprecated: use ProcessOutputDeltaNotification.

type SanitizedRawResponseCompletedNotification added in v0.147.0 

type SanitizedRawResponseCompletedNotification = SanitizedRawResponseCompletedNotificationJSON

SanitizedRawResponseCompletedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedRawResponseCompletedNotificationJSON added in v0.147.0 

type SanitizedRawResponseCompletedNotificationJSON struct {
	// ResponseID corresponds to the JSON schema field "responseId".
	ResponseID string `json:"responseId"`

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

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

	// Usage corresponds to the JSON schema field "usage".
	Usage *TokenUsageBreakdown `json:"usage,omitempty,omitzero"`
}

SanitizedRawResponseCompletedNotificationJSON represents a generated Codex app-server protocol type. Internal-only notification containing the exact usage from one upstream Responses API completion. Deprecated: use RawResponseCompletedNotification.

type SanitizedRawResponseItemCompletedNotification 

type SanitizedRawResponseItemCompletedNotification = SanitizedRawResponseItemCompletedNotificationJSON

SanitizedRawResponseItemCompletedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedRawResponseItemCompletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use RawResponseItemCompletedNotification.

type SanitizedReasoningSummaryPartAddedNotification 

type SanitizedReasoningSummaryPartAddedNotification = SanitizedReasoningSummaryPartAddedNotificationJSON

SanitizedReasoningSummaryPartAddedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedReasoningSummaryPartAddedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ReasoningSummaryPartAddedNotification.

type SanitizedReasoningSummaryTextDeltaNotification 

type SanitizedReasoningSummaryTextDeltaNotification = SanitizedReasoningSummaryTextDeltaNotificationJSON

SanitizedReasoningSummaryTextDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedReasoningSummaryTextDeltaNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ReasoningSummaryTextDeltaNotification.

type SanitizedReasoningTextDeltaNotification 

type SanitizedReasoningTextDeltaNotification = SanitizedReasoningTextDeltaNotificationJSON

SanitizedReasoningTextDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedReasoningTextDeltaNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ReasoningTextDeltaNotification.

type SanitizedRemoteControlStatusChangedNotification 

type SanitizedRemoteControlStatusChangedNotification = SanitizedRemoteControlStatusChangedNotificationJSON

SanitizedRemoteControlStatusChangedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedRemoteControlStatusChangedNotificationJSON represents a generated Codex app-server protocol type. Current remote-control connection status and remote identity exposed to clients. Deprecated: use RemoteControlStatusChangedNotification.

type SanitizedRemoteControlStatusChangedNotificationJSONEnvironmentID added in v0.144.0 

type SanitizedRemoteControlStatusChangedNotificationJSONEnvironmentID *string

SanitizedRemoteControlStatusChangedNotificationJSONEnvironmentID represents a generated Codex app-server protocol type.

type SanitizedReviewStartParams 

type SanitizedReviewStartParams = SanitizedReviewStartParamsJSON

SanitizedReviewStartParams is a generated alias for a Codex app-server protocol type.

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 *ReviewDelivery `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"`
}

SanitizedReviewStartParamsJSON represents a generated Codex app-server protocol type.

type SanitizedSendAddCreditsNudgeEmailParams 

type SanitizedSendAddCreditsNudgeEmailParams = SanitizedSendAddCreditsNudgeEmailParamsJSON

SanitizedSendAddCreditsNudgeEmailParams is a generated alias for a Codex app-server protocol type.

type SanitizedSendAddCreditsNudgeEmailParamsJSON 

type SanitizedSendAddCreditsNudgeEmailParamsJSON struct {
	// CreditType corresponds to the JSON schema field "creditType".
	CreditType AddCreditsNudgeCreditType `json:"creditType"`
}

SanitizedSendAddCreditsNudgeEmailParamsJSON represents a generated Codex app-server protocol type.

type SanitizedSendAddCreditsNudgeEmailResponse 

type SanitizedSendAddCreditsNudgeEmailResponse = SanitizedSendAddCreditsNudgeEmailResponseJSON

SanitizedSendAddCreditsNudgeEmailResponse is a generated alias for a Codex app-server protocol type.

type SanitizedSendAddCreditsNudgeEmailResponseJSON 

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

SanitizedSendAddCreditsNudgeEmailResponseJSON represents a generated Codex app-server protocol type. Deprecated: use SendAddCreditsNudgeEmailResponse.

type SanitizedServerRequestResolvedNotification 

type SanitizedServerRequestResolvedNotification = SanitizedServerRequestResolvedNotificationJSON

SanitizedServerRequestResolvedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedServerRequestResolvedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ServerRequestResolvedNotification.

type SanitizedSkillsChangedNotification added in v0.144.0 

type SanitizedSkillsChangedNotification = SanitizedSkillsChangedNotificationJSON

SanitizedSkillsChangedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedSkillsChangedNotificationJSON added in v0.144.0 

type SanitizedSkillsChangedNotificationJSON map[string]interface{}

SanitizedSkillsChangedNotificationJSON represents a generated Codex app-server protocol type. 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. Deprecated: use SkillsChangedNotification.

type SanitizedSkillsConfigWriteResponse 

type SanitizedSkillsConfigWriteResponse = SanitizedSkillsConfigWriteResponseJSON

SanitizedSkillsConfigWriteResponse is a generated alias for a Codex app-server protocol type.

type SanitizedSkillsConfigWriteResponseJSON 

type SanitizedSkillsConfigWriteResponseJSON struct {
	// EffectiveEnabled corresponds to the JSON schema field "effectiveEnabled".
	EffectiveEnabled bool `json:"effectiveEnabled"`
}

SanitizedSkillsConfigWriteResponseJSON represents a generated Codex app-server protocol type. Deprecated: use SkillsConfigWriteResponse.

type SanitizedSkillsExtraRootsSetResponse added in v0.144.0 

type SanitizedSkillsExtraRootsSetResponse = SanitizedSkillsExtraRootsSetResponseJSON

SanitizedSkillsExtraRootsSetResponse is a generated alias for a Codex app-server protocol type.

type SanitizedSkillsExtraRootsSetResponseJSON added in v0.144.0 

type SanitizedSkillsExtraRootsSetResponseJSON map[string]interface{}

SanitizedSkillsExtraRootsSetResponseJSON represents a generated Codex app-server protocol type. Deprecated: use SkillsExtraRootsSetResponse.

type SanitizedSkillsListParams 

type SanitizedSkillsListParams = SanitizedSkillsListParamsJSON

SanitizedSkillsListParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedSkillsListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedTerminalInteractionNotification 

type SanitizedTerminalInteractionNotification = SanitizedTerminalInteractionNotificationJSON

SanitizedTerminalInteractionNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedTerminalInteractionNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use TerminalInteractionNotification.

type SanitizedThreadApproveGuardianDeniedActionParams 

type SanitizedThreadApproveGuardianDeniedActionParams = SanitizedThreadApproveGuardianDeniedActionParamsJSON

SanitizedThreadApproveGuardianDeniedActionParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadApproveGuardianDeniedActionParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadApproveGuardianDeniedActionResponse added in v0.144.0 

type SanitizedThreadApproveGuardianDeniedActionResponse = SanitizedThreadApproveGuardianDeniedActionResponseJSON

SanitizedThreadApproveGuardianDeniedActionResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadApproveGuardianDeniedActionResponseJSON added in v0.144.0 

type SanitizedThreadApproveGuardianDeniedActionResponseJSON map[string]interface{}

SanitizedThreadApproveGuardianDeniedActionResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadApproveGuardianDeniedActionResponse.

type SanitizedThreadArchiveParams 

type SanitizedThreadArchiveParams = SanitizedThreadArchiveParamsJSON

SanitizedThreadArchiveParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadArchiveParamsJSON 

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

SanitizedThreadArchiveParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadArchiveResponse added in v0.144.0 

type SanitizedThreadArchiveResponse = SanitizedThreadArchiveResponseJSON

SanitizedThreadArchiveResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadArchiveResponseJSON added in v0.144.0 

type SanitizedThreadArchiveResponseJSON map[string]interface{}

SanitizedThreadArchiveResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadArchiveResponse.

type SanitizedThreadArchivedNotification 

type SanitizedThreadArchivedNotification = SanitizedThreadArchivedNotificationJSON

SanitizedThreadArchivedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedThreadArchivedNotificationJSON 

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

SanitizedThreadArchivedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadArchivedNotification.

type SanitizedThreadClosedNotification 

type SanitizedThreadClosedNotification = SanitizedThreadClosedNotificationJSON

SanitizedThreadClosedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedThreadClosedNotificationJSON 

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

SanitizedThreadClosedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadClosedNotification.

type SanitizedThreadCompactStartParams 

type SanitizedThreadCompactStartParams = SanitizedThreadCompactStartParamsJSON

SanitizedThreadCompactStartParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadCompactStartParamsJSON 

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

SanitizedThreadCompactStartParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadCompactStartResponse added in v0.144.0 

type SanitizedThreadCompactStartResponse = SanitizedThreadCompactStartResponseJSON

SanitizedThreadCompactStartResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadCompactStartResponseJSON added in v0.144.0 

type SanitizedThreadCompactStartResponseJSON map[string]interface{}

SanitizedThreadCompactStartResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadCompactStartResponse.

type SanitizedThreadDeleteParams 

type SanitizedThreadDeleteParams = SanitizedThreadDeleteParamsJSON

SanitizedThreadDeleteParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadDeleteParamsJSON 

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

SanitizedThreadDeleteParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadDeleteResponse added in v0.144.0 

type SanitizedThreadDeleteResponse = SanitizedThreadDeleteResponseJSON

SanitizedThreadDeleteResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadDeleteResponseJSON added in v0.144.0 

type SanitizedThreadDeleteResponseJSON map[string]interface{}

SanitizedThreadDeleteResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadDeleteResponse.

type SanitizedThreadDeletedNotification 

type SanitizedThreadDeletedNotification = SanitizedThreadDeletedNotificationJSON

SanitizedThreadDeletedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedThreadDeletedNotificationJSON 

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

SanitizedThreadDeletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadDeletedNotification.

type SanitizedThreadGoalClearParams 

type SanitizedThreadGoalClearParams = SanitizedThreadGoalClearParamsJSON

SanitizedThreadGoalClearParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadGoalClearParamsJSON 

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

SanitizedThreadGoalClearParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadGoalClearResponse 

type SanitizedThreadGoalClearResponse = SanitizedThreadGoalClearResponseJSON

SanitizedThreadGoalClearResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadGoalClearResponseJSON 

type SanitizedThreadGoalClearResponseJSON struct {
	// Cleared corresponds to the JSON schema field "cleared".
	Cleared bool `json:"cleared"`
}

SanitizedThreadGoalClearResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadGoalClearResponse.

type SanitizedThreadGoalClearedNotification 

type SanitizedThreadGoalClearedNotification = SanitizedThreadGoalClearedNotificationJSON

SanitizedThreadGoalClearedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedThreadGoalClearedNotificationJSON 

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

SanitizedThreadGoalClearedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadGoalClearedNotification.

type SanitizedThreadGoalGetParams 

type SanitizedThreadGoalGetParams = SanitizedThreadGoalGetParamsJSON

SanitizedThreadGoalGetParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadGoalGetParamsJSON 

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

SanitizedThreadGoalGetParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadGoalSetParams 

type SanitizedThreadGoalSetParams = SanitizedThreadGoalSetParamsJSON

SanitizedThreadGoalSetParams is a generated alias for a Codex app-server protocol type.

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 *ThreadGoalStatus `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"`
}

SanitizedThreadGoalSetParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadGoalSetParamsJSONObjective added in v0.144.0 

type SanitizedThreadGoalSetParamsJSONObjective *string

SanitizedThreadGoalSetParamsJSONObjective represents a generated Codex app-server protocol type.

type SanitizedThreadGoalSetParamsJSONTokenBudget added in v0.144.0 

type SanitizedThreadGoalSetParamsJSONTokenBudget *int

SanitizedThreadGoalSetParamsJSONTokenBudget represents a generated Codex app-server protocol type.

type SanitizedThreadInjectItemsParams 

type SanitizedThreadInjectItemsParams = SanitizedThreadInjectItemsParamsJSON

SanitizedThreadInjectItemsParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadInjectItemsParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadInjectItemsResponse added in v0.144.0 

type SanitizedThreadInjectItemsResponse = SanitizedThreadInjectItemsResponseJSON

SanitizedThreadInjectItemsResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadInjectItemsResponseJSON added in v0.144.0 

type SanitizedThreadInjectItemsResponseJSON map[string]interface{}

SanitizedThreadInjectItemsResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadInjectItemsResponse.

type SanitizedThreadListParams 

type SanitizedThreadListParams = SanitizedThreadListParamsJSON

SanitizedThreadListParams is a generated alias for a Codex app-server protocol type.

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 ThreadListCwdFilter `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"`

	// Omit to include every section, set to `null` for unsectioned threads, or
	// provide a section ID to return only threads in that section.
	SectionID SanitizedThreadListParamsJSONSectionID `json:"sectionId,omitempty,omitzero"`

	// Optional sort direction; defaults to descending (newest first).
	SortDirection *SortDirection `json:"sortDirection,omitempty,omitzero"`

	// Optional sort key; defaults to created_at.
	SortKey *ThreadSortKey `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"`
}

SanitizedThreadListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadListParamsJSONArchived added in v0.144.0 

type SanitizedThreadListParamsJSONArchived *bool

SanitizedThreadListParamsJSONArchived represents a generated Codex app-server protocol type. 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

SanitizedThreadListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedThreadListParamsJSONLimit added in v0.144.0 

type SanitizedThreadListParamsJSONLimit *int

SanitizedThreadListParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type SanitizedThreadListParamsJSONModelProviders added in v0.144.0 

type SanitizedThreadListParamsJSONModelProviders []string

SanitizedThreadListParamsJSONModelProviders represents a generated Codex app-server protocol type. 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

SanitizedThreadListParamsJSONSearchTerm represents a generated Codex app-server protocol type. Optional substring filter for the extracted thread title.

type SanitizedThreadListParamsJSONSectionID added in v0.147.0 

type SanitizedThreadListParamsJSONSectionID *string

SanitizedThreadListParamsJSONSectionID represents a generated Codex app-server protocol type. Omit to include every section, set to `null` for unsectioned threads, or provide a section ID to return only threads in that section.

type SanitizedThreadListParamsJSONSourceKinds added in v0.144.0 

type SanitizedThreadListParamsJSONSourceKinds []ThreadSourceKind

SanitizedThreadListParamsJSONSourceKinds represents a generated Codex app-server protocol type. 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

SanitizedThreadLoadedListParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadLoadedListParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadLoadedListParamsJSONCursor added in v0.144.0 

type SanitizedThreadLoadedListParamsJSONCursor *string

SanitizedThreadLoadedListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedThreadLoadedListParamsJSONLimit added in v0.144.0 

type SanitizedThreadLoadedListParamsJSONLimit *int

SanitizedThreadLoadedListParamsJSONLimit represents a generated Codex app-server protocol type. Optional page size; defaults to no limit.

type SanitizedThreadLoadedListResponse 

type SanitizedThreadLoadedListResponse = SanitizedThreadLoadedListResponseJSON

SanitizedThreadLoadedListResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadLoadedListResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadLoadedListResponse.

type SanitizedThreadLoadedListResponseJSONNextCursor added in v0.144.0 

type SanitizedThreadLoadedListResponseJSONNextCursor *string

SanitizedThreadLoadedListResponseJSONNextCursor represents a generated Codex app-server protocol type. 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

SanitizedThreadMetadataUpdateParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadMetadataUpdateParamsJSON 

type SanitizedThreadMetadataUpdateParamsJSON struct {
	GitInfo *ThreadMetadataGitInfoUpdateParams `json:"gitInfo,omitempty"`
	// IsPinned is retained for source compatibility with Codex versions before
	// 0.147. It is not sent to Codex 0.147, which uses thread sections.
	//
	// Deprecated: use thread/section/move.
	IsPinned SanitizedThreadMetadataUpdateParamsJSONIsPinned `json:"-"`
	ThreadID string                                          `json:"threadId"`
}

SanitizedThreadMetadataUpdateParamsJSON preserves the former sanitized generated spelling while keeping the removed pin field off the 0.147 wire.

type SanitizedThreadMetadataUpdateParamsJSONIsPinned added in v0.147.0 

type SanitizedThreadMetadataUpdateParamsJSONIsPinned *bool

SanitizedThreadMetadataUpdateParamsJSONIsPinned represents a generated Codex app-server protocol type. Deprecated: Codex 0.147 removed this field in favor of thread sections; retained for Go SDK source compatibility.

type SanitizedThreadNameUpdatedNotification 

type SanitizedThreadNameUpdatedNotification = SanitizedThreadNameUpdatedNotificationJSON

SanitizedThreadNameUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadNameUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadNameUpdatedNotification.

type SanitizedThreadNameUpdatedNotificationJSONThreadName added in v0.144.0 

type SanitizedThreadNameUpdatedNotificationJSONThreadName *string

SanitizedThreadNameUpdatedNotificationJSONThreadName represents a generated Codex app-server protocol type.

type SanitizedThreadReadParams 

type SanitizedThreadReadParams = SanitizedThreadReadParamsJSON

SanitizedThreadReadParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadReadParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadRealtimeClosedNotification 

type SanitizedThreadRealtimeClosedNotification = SanitizedThreadRealtimeClosedNotificationJSON

SanitizedThreadRealtimeClosedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeClosedNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - emitted when thread realtime transport closes. Deprecated: use ThreadRealtimeClosedNotification.

type SanitizedThreadRealtimeClosedNotificationJSONReason added in v0.144.0 

type SanitizedThreadRealtimeClosedNotificationJSONReason *string

SanitizedThreadRealtimeClosedNotificationJSONReason represents a generated Codex app-server protocol type.

type SanitizedThreadRealtimeErrorNotification 

type SanitizedThreadRealtimeErrorNotification = SanitizedThreadRealtimeErrorNotificationJSON

SanitizedThreadRealtimeErrorNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeErrorNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - emitted when thread realtime encounters an error. Deprecated: use ThreadRealtimeErrorNotification.

type SanitizedThreadRealtimeItemAddedNotification 

type SanitizedThreadRealtimeItemAddedNotification = SanitizedThreadRealtimeItemAddedNotificationJSON

SanitizedThreadRealtimeItemAddedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeItemAddedNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - raw non-audio thread realtime item emitted by the backend. Deprecated: use ThreadRealtimeItemAddedNotification.

type SanitizedThreadRealtimeOutputAudioDeltaNotification 

type SanitizedThreadRealtimeOutputAudioDeltaNotification = SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON

SanitizedThreadRealtimeOutputAudioDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - streamed output audio emitted by thread realtime. Deprecated: use ThreadRealtimeOutputAudioDeltaNotification.

type SanitizedThreadRealtimeSdpNotification 

type SanitizedThreadRealtimeSdpNotification = SanitizedThreadRealtimeSdpNotificationJSON

SanitizedThreadRealtimeSdpNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeSdpNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - emitted with the remote SDP for a WebRTC realtime session. Deprecated: use ThreadRealtimeSdpNotification.

type SanitizedThreadRealtimeStartedNotification 

type SanitizedThreadRealtimeStartedNotification = SanitizedThreadRealtimeStartedNotificationJSON

SanitizedThreadRealtimeStartedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeStartedNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - emitted when thread realtime startup is accepted. Deprecated: use ThreadRealtimeStartedNotification.

type SanitizedThreadRealtimeStartedNotificationJSONRealtimeSessionID added in v0.144.0 

type SanitizedThreadRealtimeStartedNotificationJSONRealtimeSessionID *string

SanitizedThreadRealtimeStartedNotificationJSONRealtimeSessionID represents a generated Codex app-server protocol type.

type SanitizedThreadRealtimeTranscriptDeltaNotification 

type SanitizedThreadRealtimeTranscriptDeltaNotification = SanitizedThreadRealtimeTranscriptDeltaNotificationJSON

SanitizedThreadRealtimeTranscriptDeltaNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeTranscriptDeltaNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - flat transcript delta emitted whenever realtime transcript text changes. Deprecated: use ThreadRealtimeTranscriptDeltaNotification.

type SanitizedThreadRealtimeTranscriptDoneNotification 

type SanitizedThreadRealtimeTranscriptDoneNotification = SanitizedThreadRealtimeTranscriptDoneNotificationJSON

SanitizedThreadRealtimeTranscriptDoneNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRealtimeTranscriptDoneNotificationJSON represents a generated Codex app-server protocol type. EXPERIMENTAL - final transcript text emitted when realtime completes a transcript part. Deprecated: use ThreadRealtimeTranscriptDoneNotification.

type SanitizedThreadRollbackParams 

type SanitizedThreadRollbackParams = SanitizedThreadRollbackParamsJSON

SanitizedThreadRollbackParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadRollbackParamsJSON represents a generated Codex app-server protocol type. DEPRECATED: `thread/rollback` will be removed soon.

type SanitizedThreadSectionCreateParams added in v0.147.0 

type SanitizedThreadSectionCreateParams = SanitizedThreadSectionCreateParamsJSON

SanitizedThreadSectionCreateParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionCreateParamsJSON added in v0.147.0 

type SanitizedThreadSectionCreateParamsJSON struct {
	// The user-visible name of the section.
	Name string `json:"name"`
}

SanitizedThreadSectionCreateParamsJSON represents a generated Codex app-server protocol type. Parameters for creating an independently persisted thread section.

type SanitizedThreadSectionCreateResponse added in v0.147.0 

type SanitizedThreadSectionCreateResponse = SanitizedThreadSectionCreateResponseJSON

SanitizedThreadSectionCreateResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionCreateResponseJSON added in v0.147.0 

type SanitizedThreadSectionCreateResponseJSON struct {
	// Section corresponds to the JSON schema field "section".
	Section ThreadSection `json:"section"`
}

SanitizedThreadSectionCreateResponseJSON represents a generated Codex app-server protocol type. The independently persisted section created by the server. Deprecated: use ThreadSectionCreateResponse.

type SanitizedThreadSectionDeleteParams added in v0.147.0 

type SanitizedThreadSectionDeleteParams = SanitizedThreadSectionDeleteParamsJSON

SanitizedThreadSectionDeleteParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionDeleteParamsJSON added in v0.147.0 

type SanitizedThreadSectionDeleteParamsJSON struct {
	// The stable, server-generated identity of the section to delete.
	SectionID string `json:"sectionId"`
}

SanitizedThreadSectionDeleteParamsJSON represents a generated Codex app-server protocol type. Parameters for deleting an independently persisted thread section.

type SanitizedThreadSectionDeleteResponse added in v0.147.0 

type SanitizedThreadSectionDeleteResponse = SanitizedThreadSectionDeleteResponseJSON

SanitizedThreadSectionDeleteResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionDeleteResponseJSON added in v0.147.0 

type SanitizedThreadSectionDeleteResponseJSON map[string]interface{}

SanitizedThreadSectionDeleteResponseJSON represents a generated Codex app-server protocol type. Successful deletion does not return additional section data. Deprecated: use ThreadSectionDeleteResponse.

type SanitizedThreadSectionListParams added in v0.147.0 

type SanitizedThreadSectionListParams = SanitizedThreadSectionListParamsJSON

SanitizedThreadSectionListParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionListParamsJSON added in v0.147.0 

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

	// Maximum number of sections to return.
	Limit SanitizedThreadSectionListParamsJSONLimit `json:"limit,omitempty,omitzero"`
}

SanitizedThreadSectionListParamsJSON represents a generated Codex app-server protocol type. Parameters for listing independently persisted thread sections.

type SanitizedThreadSectionListParamsJSONCursor added in v0.147.0 

type SanitizedThreadSectionListParamsJSONCursor *string

SanitizedThreadSectionListParamsJSONCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type SanitizedThreadSectionListParamsJSONLimit added in v0.147.0 

type SanitizedThreadSectionListParamsJSONLimit *int

SanitizedThreadSectionListParamsJSONLimit represents a generated Codex app-server protocol type. Maximum number of sections to return.

type SanitizedThreadSectionListResponse added in v0.147.0 

type SanitizedThreadSectionListResponse = SanitizedThreadSectionListResponseJSON

SanitizedThreadSectionListResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionListResponseJSON added in v0.147.0 

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

	// Opaque cursor for the next page, or `null` when no sections remain.
	NextCursor SanitizedThreadSectionListResponseJSONNextCursor `json:"nextCursor,omitempty,omitzero"`
}

SanitizedThreadSectionListResponseJSON represents a generated Codex app-server protocol type. One page of independently persisted thread sections. Deprecated: use ThreadSectionListResponse.

type SanitizedThreadSectionListResponseJSONNextCursor added in v0.147.0 

type SanitizedThreadSectionListResponseJSONNextCursor *string

SanitizedThreadSectionListResponseJSONNextCursor represents a generated Codex app-server protocol type. Opaque cursor for the next page, or `null` when no sections remain.

type SanitizedThreadSectionMoveParams added in v0.147.0 

type SanitizedThreadSectionMoveParams = SanitizedThreadSectionMoveParamsJSON

SanitizedThreadSectionMoveParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionMoveParamsJSON added in v0.147.0 

type SanitizedThreadSectionMoveParamsJSON struct {
	// Existing thread to insert before; omission or null appends to the section.
	BeforeThreadID SanitizedThreadSectionMoveParamsJSONBeforeThreadID `json:"beforeThreadId,omitempty,omitzero"`

	// Destination section, or `null` to remove the thread from its section.
	SectionID SanitizedThreadSectionMoveParamsJSONSectionID `json:"sectionId"`

	// Thread to move into, within, or out of a section.
	ThreadID string `json:"threadId"`
}

SanitizedThreadSectionMoveParamsJSON represents a generated Codex app-server protocol type. Parameters for moving a thread within a server-owned section ordering.

type SanitizedThreadSectionMoveParamsJSONBeforeThreadID added in v0.147.0 

type SanitizedThreadSectionMoveParamsJSONBeforeThreadID *string

SanitizedThreadSectionMoveParamsJSONBeforeThreadID represents a generated Codex app-server protocol type. Existing thread to insert before; omission or null appends to the section.

type SanitizedThreadSectionMoveParamsJSONSectionID added in v0.147.0 

type SanitizedThreadSectionMoveParamsJSONSectionID *string

SanitizedThreadSectionMoveParamsJSONSectionID represents a generated Codex app-server protocol type. Destination section, or `null` to remove the thread from its section.

type SanitizedThreadSectionMoveResponse added in v0.147.0 

type SanitizedThreadSectionMoveResponse = SanitizedThreadSectionMoveResponseJSON

SanitizedThreadSectionMoveResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionMoveResponseJSON added in v0.147.0 

type SanitizedThreadSectionMoveResponseJSON map[string]interface{}

SanitizedThreadSectionMoveResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadSectionMoveResponse.

type SanitizedThreadSectionUpdateParams added in v0.147.0 

type SanitizedThreadSectionUpdateParams = SanitizedThreadSectionUpdateParamsJSON

SanitizedThreadSectionUpdateParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionUpdateParamsJSON added in v0.147.0 

type SanitizedThreadSectionUpdateParamsJSON struct {
	// The updated user-visible name of the section.
	Name string `json:"name"`

	// The stable, server-generated identity of the section to update.
	SectionID string `json:"sectionId"`
}

SanitizedThreadSectionUpdateParamsJSON represents a generated Codex app-server protocol type. Parameters for updating an independently persisted thread section.

type SanitizedThreadSectionUpdateResponse added in v0.147.0 

type SanitizedThreadSectionUpdateResponse = SanitizedThreadSectionUpdateResponseJSON

SanitizedThreadSectionUpdateResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSectionUpdateResponseJSON added in v0.147.0 

type SanitizedThreadSectionUpdateResponseJSON struct {
	// Section corresponds to the JSON schema field "section".
	Section ThreadSection `json:"section"`
}

SanitizedThreadSectionUpdateResponseJSON represents a generated Codex app-server protocol type. The independently persisted section after its name is updated. Deprecated: use ThreadSectionUpdateResponse.

type SanitizedThreadSetNameParams 

type SanitizedThreadSetNameParams = SanitizedThreadSetNameParamsJSON

SanitizedThreadSetNameParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadSetNameParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadSetNameResponse added in v0.144.0 

type SanitizedThreadSetNameResponse = SanitizedThreadSetNameResponseJSON

SanitizedThreadSetNameResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadSetNameResponseJSON added in v0.144.0 

type SanitizedThreadSetNameResponseJSON map[string]interface{}

SanitizedThreadSetNameResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadSetNameResponse.

type SanitizedThreadShellCommandParams 

type SanitizedThreadShellCommandParams = SanitizedThreadShellCommandParamsJSON

SanitizedThreadShellCommandParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadShellCommandParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadShellCommandResponse added in v0.144.0 

type SanitizedThreadShellCommandResponse = SanitizedThreadShellCommandResponseJSON

SanitizedThreadShellCommandResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadShellCommandResponseJSON added in v0.144.0 

type SanitizedThreadShellCommandResponseJSON map[string]interface{}

SanitizedThreadShellCommandResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadShellCommandResponse.

type SanitizedThreadStatusChangedNotification 

type SanitizedThreadStatusChangedNotification = SanitizedThreadStatusChangedNotificationJSON

SanitizedThreadStatusChangedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadStatusChangedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadStatusChangedNotification.

type SanitizedThreadTokenUsageUpdatedNotification 

type SanitizedThreadTokenUsageUpdatedNotification = SanitizedThreadTokenUsageUpdatedNotificationJSON

SanitizedThreadTokenUsageUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedThreadTokenUsageUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadTokenUsageUpdatedNotification.

type SanitizedThreadUnarchiveParams 

type SanitizedThreadUnarchiveParams = SanitizedThreadUnarchiveParamsJSON

SanitizedThreadUnarchiveParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadUnarchiveParamsJSON 

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

SanitizedThreadUnarchiveParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadUnarchivedNotification 

type SanitizedThreadUnarchivedNotification = SanitizedThreadUnarchivedNotificationJSON

SanitizedThreadUnarchivedNotification is a generated alias for a Codex app-server protocol type.

type SanitizedThreadUnarchivedNotificationJSON 

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

SanitizedThreadUnarchivedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadUnarchivedNotification.

type SanitizedThreadUnsubscribeParams 

type SanitizedThreadUnsubscribeParams = SanitizedThreadUnsubscribeParamsJSON

SanitizedThreadUnsubscribeParams is a generated alias for a Codex app-server protocol type.

type SanitizedThreadUnsubscribeParamsJSON 

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

SanitizedThreadUnsubscribeParamsJSON represents a generated Codex app-server protocol type.

type SanitizedThreadUnsubscribeResponse 

type SanitizedThreadUnsubscribeResponse = SanitizedThreadUnsubscribeResponseJSON

SanitizedThreadUnsubscribeResponse is a generated alias for a Codex app-server protocol type.

type SanitizedThreadUnsubscribeResponseJSON 

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

SanitizedThreadUnsubscribeResponseJSON represents a generated Codex app-server protocol type. Deprecated: use ThreadUnsubscribeResponse.

type SanitizedToolRequestUserInputParams 

type SanitizedToolRequestUserInputParams = SanitizedToolRequestUserInputParamsJSON

SanitizedToolRequestUserInputParams is a generated alias for a Codex app-server protocol type.

type SanitizedToolRequestUserInputParamsJSON 

type SanitizedToolRequestUserInputParamsJSON struct {
	// @deprecated Use `isBlocking` to decide whether the request should block.
	AutoResolutionMs SanitizedToolRequestUserInputParamsJSONAutoResolutionMs `json:"autoResolutionMs,omitempty,omitzero"`

	// IsBlocking corresponds to the JSON schema field "isBlocking".
	IsBlocking bool `json:"isBlocking"`

	// 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"`
}

SanitizedToolRequestUserInputParamsJSON represents a generated Codex app-server protocol type. EXPERIMENTAL. Params sent with a request_user_input event.

type SanitizedToolRequestUserInputParamsJSONAutoResolutionMs added in v0.144.0 

type SanitizedToolRequestUserInputParamsJSONAutoResolutionMs *int

SanitizedToolRequestUserInputParamsJSONAutoResolutionMs represents a generated Codex app-server protocol type. @deprecated Use `isBlocking` to decide whether the request should block.

type SanitizedToolRequestUserInputResponse 

type SanitizedToolRequestUserInputResponse = SanitizedToolRequestUserInputResponseJSON

SanitizedToolRequestUserInputResponse is a generated alias for a Codex app-server protocol type.

type SanitizedToolRequestUserInputResponseJSON 

type SanitizedToolRequestUserInputResponseJSON struct {
	// Answers corresponds to the JSON schema field "answers".
	Answers SanitizedToolRequestUserInputResponseJSONAnswers `json:"answers"`
}

SanitizedToolRequestUserInputResponseJSON represents a generated Codex app-server protocol type. EXPERIMENTAL. Response payload mapping question ids to answers.

type SanitizedToolRequestUserInputResponseJSONAnswers added in v0.144.0 

type SanitizedToolRequestUserInputResponseJSONAnswers map[string]ToolRequestUserInputAnswer

SanitizedToolRequestUserInputResponseJSONAnswers represents a generated Codex app-server protocol type.

type SanitizedTurnDiffUpdatedNotification 

type SanitizedTurnDiffUpdatedNotification = SanitizedTurnDiffUpdatedNotificationJSON

SanitizedTurnDiffUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedTurnDiffUpdatedNotificationJSON represents a generated Codex app-server protocol type. Notification that the turn-level unified diff has changed. Contains the latest aggregated diff across all file changes in the turn. Deprecated: use TurnDiffUpdatedNotification.

type SanitizedTurnInterruptParams 

type SanitizedTurnInterruptParams = SanitizedTurnInterruptParamsJSON

SanitizedTurnInterruptParams is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedTurnInterruptParamsJSON represents a generated Codex app-server protocol type.

type SanitizedTurnInterruptResponse added in v0.144.0 

type SanitizedTurnInterruptResponse = SanitizedTurnInterruptResponseJSON

SanitizedTurnInterruptResponse is a generated alias for a Codex app-server protocol type.

type SanitizedTurnInterruptResponseJSON added in v0.144.0 

type SanitizedTurnInterruptResponseJSON map[string]interface{}

SanitizedTurnInterruptResponseJSON represents a generated Codex app-server protocol type. Deprecated: use TurnInterruptResponse.

type SanitizedTurnModerationMetadataNotification 

type SanitizedTurnModerationMetadataNotification = SanitizedTurnModerationMetadataNotificationJSON

SanitizedTurnModerationMetadataNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedTurnModerationMetadataNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use TurnModerationMetadataNotification.

type SanitizedTurnPlanUpdatedNotification 

type SanitizedTurnPlanUpdatedNotification = SanitizedTurnPlanUpdatedNotificationJSON

SanitizedTurnPlanUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedTurnPlanUpdatedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use TurnPlanUpdatedNotification.

type SanitizedTurnPlanUpdatedNotificationJSONExplanation added in v0.144.0 

type SanitizedTurnPlanUpdatedNotificationJSONExplanation *string

SanitizedTurnPlanUpdatedNotificationJSONExplanation represents a generated Codex app-server protocol type.

type SanitizedTurnSteerResponse 

type SanitizedTurnSteerResponse = SanitizedTurnSteerResponseJSON

SanitizedTurnSteerResponse is a generated alias for a Codex app-server protocol type.

type SanitizedTurnSteerResponseJSON 

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

SanitizedTurnSteerResponseJSON represents a generated Codex app-server protocol type. Deprecated: use TurnSteerResponse.

type SanitizedWarningNotification 

type SanitizedWarningNotification = SanitizedWarningNotificationJSON

SanitizedWarningNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedWarningNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use WarningNotification.

type SanitizedWarningNotificationJSONThreadID added in v0.144.0 

type SanitizedWarningNotificationJSONThreadID *string

SanitizedWarningNotificationJSONThreadID represents a generated Codex app-server protocol type. Optional thread target when the warning applies to a specific thread.

type SanitizedWindowsSandboxReadinessResponse 

type SanitizedWindowsSandboxReadinessResponse = SanitizedWindowsSandboxReadinessResponseJSON

SanitizedWindowsSandboxReadinessResponse is a generated alias for a Codex app-server protocol type.

type SanitizedWindowsSandboxReadinessResponseJSON 

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

SanitizedWindowsSandboxReadinessResponseJSON represents a generated Codex app-server protocol type. Deprecated: use WindowsSandboxReadinessResponse.

type SanitizedWindowsSandboxSetupCompletedNotification 

type SanitizedWindowsSandboxSetupCompletedNotification = SanitizedWindowsSandboxSetupCompletedNotificationJSON

SanitizedWindowsSandboxSetupCompletedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedWindowsSandboxSetupCompletedNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use WindowsSandboxSetupCompletedNotification.

type SanitizedWindowsSandboxSetupCompletedNotificationJSONError added in v0.144.0 

type SanitizedWindowsSandboxSetupCompletedNotificationJSONError *string

SanitizedWindowsSandboxSetupCompletedNotificationJSONError represents a generated Codex app-server protocol type.

type SanitizedWindowsSandboxSetupStartResponse 

type SanitizedWindowsSandboxSetupStartResponse = SanitizedWindowsSandboxSetupStartResponseJSON

SanitizedWindowsSandboxSetupStartResponse is a generated alias for a Codex app-server protocol type.

type SanitizedWindowsSandboxSetupStartResponseJSON 

type SanitizedWindowsSandboxSetupStartResponseJSON struct {
	// Started corresponds to the JSON schema field "started".
	Started bool `json:"started"`
}

SanitizedWindowsSandboxSetupStartResponseJSON represents a generated Codex app-server protocol type. Deprecated: use WindowsSandboxSetupStartResponse.

type SanitizedWindowsWorldWritableWarningNotification 

type SanitizedWindowsWorldWritableWarningNotification = SanitizedWindowsWorldWritableWarningNotificationJSON

SanitizedWindowsWorldWritableWarningNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SanitizedWindowsWorldWritableWarningNotificationJSON represents a generated Codex app-server protocol type. Deprecated: use WindowsWorldWritableWarningNotification.

type ScheduledTaskSchedule added in v0.147.0 

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

ScheduledTaskSchedule preserves the complete JSON payload for a discriminated union.

func NewScheduledTaskSchedule added in v0.147.0 

func NewScheduledTaskSchedule(value any) (ScheduledTaskSchedule, error)

NewScheduledTaskSchedule validates the discriminator and wraps a JSON-marshalable ScheduledTaskSchedule value.

func (ScheduledTaskSchedule) IsKnown added in v0.147.0 

func (value ScheduledTaskSchedule) IsKnown() bool

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

func (ScheduledTaskSchedule) Kind added in v0.147.0 

func (value ScheduledTaskSchedule) Kind() ScheduledTaskScheduleKind

Kind returns the payload discriminator, including unknown future values.

func (ScheduledTaskSchedule) MarshalJSON added in v0.147.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

func (ScheduledTaskSchedule) RawJSON added in v0.147.0 

func (value ScheduledTaskSchedule) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ScheduledTaskSchedule) UnmarshalJSON added in v0.147.0 

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ScheduledTaskScheduleKind added in v0.147.0 

type ScheduledTaskScheduleKind string

ScheduledTaskScheduleKind identifies a known ScheduledTaskSchedule variant. 

const (
	// ScheduledTaskScheduleKindDaily is a generated Codex app-server protocol constant.
	ScheduledTaskScheduleKindDaily ScheduledTaskScheduleKind = "daily"
	// ScheduledTaskScheduleKindHourly is a generated Codex app-server protocol constant.
	ScheduledTaskScheduleKindHourly ScheduledTaskScheduleKind = "hourly"
	// ScheduledTaskScheduleKindWeekdays is a generated Codex app-server protocol constant.
	ScheduledTaskScheduleKindWeekdays ScheduledTaskScheduleKind = "weekdays"
	// ScheduledTaskScheduleKindWeekly is a generated Codex app-server protocol constant.
	ScheduledTaskScheduleKindWeekly ScheduledTaskScheduleKind = "weekly"
)

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"`
}

SelectedCapabilityRoot represents a generated Codex app-server protocol type. 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"`
}

SendAddCreditsNudgeEmailParams represents a generated Codex app-server protocol type.

type SendAddCreditsNudgeEmailResponse 

type SendAddCreditsNudgeEmailResponse = SanitizedSendAddCreditsNudgeEmailResponseJSON

SendAddCreditsNudgeEmailResponse is a generated alias for a Codex app-server protocol type.

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 

func (value ServerNotification) Kind() ServerNotificationKind

Kind returns the payload discriminator, including unknown future values.

func (ServerNotification) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ServerNotificationKind added in v0.145.0 

type ServerNotificationKind string

ServerNotificationKind identifies a known ServerNotification variant. 

const (
	// ServerNotificationKindAccountLoginCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindAccountLoginCompleted ServerNotificationKind = "account/login/completed"
	// ServerNotificationKindAccountRateLimitsUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindAccountRateLimitsUpdated ServerNotificationKind = "account/rateLimits/updated"
	// ServerNotificationKindAccountUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindAccountUpdated ServerNotificationKind = "account/updated"
	// ServerNotificationKindAppListUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindAppListUpdated ServerNotificationKind = "app/list/updated"
	// ServerNotificationKindCommandExecOutputDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindCommandExecOutputDelta ServerNotificationKind = "command/exec/outputDelta"
	// ServerNotificationKindConfigWarning is a generated Codex app-server protocol constant.
	ServerNotificationKindConfigWarning ServerNotificationKind = "configWarning"
	// ServerNotificationKindDeprecationNotice is a generated Codex app-server protocol constant.
	ServerNotificationKindDeprecationNotice ServerNotificationKind = "deprecationNotice"
	// ServerNotificationKindError is a generated Codex app-server protocol constant.
	ServerNotificationKindError ServerNotificationKind = "error"
	// ServerNotificationKindExternalAgentConfigImportCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindExternalAgentConfigImportCompleted ServerNotificationKind = "externalAgentConfig/import/completed"
	// ServerNotificationKindExternalAgentConfigImportProgress is a generated Codex app-server protocol constant.
	ServerNotificationKindExternalAgentConfigImportProgress ServerNotificationKind = "externalAgentConfig/import/progress"
	// ServerNotificationKindFsChanged is a generated Codex app-server protocol constant.
	ServerNotificationKindFsChanged ServerNotificationKind = "fs/changed"
	// ServerNotificationKindFuzzyFileSearchSessionCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindFuzzyFileSearchSessionCompleted ServerNotificationKind = "fuzzyFileSearch/sessionCompleted"
	// ServerNotificationKindFuzzyFileSearchSessionUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindFuzzyFileSearchSessionUpdated ServerNotificationKind = "fuzzyFileSearch/sessionUpdated"
	// ServerNotificationKindGuardianWarning is a generated Codex app-server protocol constant.
	ServerNotificationKindGuardianWarning ServerNotificationKind = "guardianWarning"
	// ServerNotificationKindHookCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindHookCompleted ServerNotificationKind = "hook/completed"
	// ServerNotificationKindHookStarted is a generated Codex app-server protocol constant.
	ServerNotificationKindHookStarted ServerNotificationKind = "hook/started"
	// ServerNotificationKindItemAgentMessageDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindItemAgentMessageDelta ServerNotificationKind = "item/agentMessage/delta"
	// ServerNotificationKindItemAutoApprovalReviewCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindItemAutoApprovalReviewCompleted ServerNotificationKind = "item/autoApprovalReview/completed"
	// ServerNotificationKindItemAutoApprovalReviewStarted is a generated Codex app-server protocol constant.
	ServerNotificationKindItemAutoApprovalReviewStarted ServerNotificationKind = "item/autoApprovalReview/started"
	// ServerNotificationKindItemCommandExecutionOutputDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindItemCommandExecutionOutputDelta ServerNotificationKind = "item/commandExecution/outputDelta"
	// ServerNotificationKindItemCommandExecutionTerminalInteraction is a generated Codex app-server protocol constant.
	ServerNotificationKindItemCommandExecutionTerminalInteraction ServerNotificationKind = "item/commandExecution/terminalInteraction"
	// ServerNotificationKindItemCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindItemCompleted ServerNotificationKind = "item/completed"
	// ServerNotificationKindItemFileChangeOutputDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindItemFileChangeOutputDelta ServerNotificationKind = "item/fileChange/outputDelta"
	// ServerNotificationKindItemFileChangePatchUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindItemFileChangePatchUpdated ServerNotificationKind = "item/fileChange/patchUpdated"
	// ServerNotificationKindItemMCPToolCallProgress is a generated Codex app-server protocol constant.
	ServerNotificationKindItemMCPToolCallProgress ServerNotificationKind = "item/mcpToolCall/progress"
	// ServerNotificationKindItemPlanDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindItemPlanDelta ServerNotificationKind = "item/plan/delta"
	// ServerNotificationKindItemReasoningSummaryPartAdded is a generated Codex app-server protocol constant.
	ServerNotificationKindItemReasoningSummaryPartAdded ServerNotificationKind = "item/reasoning/summaryPartAdded"
	// ServerNotificationKindItemReasoningSummaryTextDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindItemReasoningSummaryTextDelta ServerNotificationKind = "item/reasoning/summaryTextDelta"
	// ServerNotificationKindItemReasoningTextDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindItemReasoningTextDelta ServerNotificationKind = "item/reasoning/textDelta"
	// ServerNotificationKindItemStarted is a generated Codex app-server protocol constant.
	ServerNotificationKindItemStarted ServerNotificationKind = "item/started"
	// ServerNotificationKindMCPServerOAuthLoginCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindMCPServerOAuthLoginCompleted ServerNotificationKind = "mcpServer/oauthLogin/completed"
	// ServerNotificationKindMCPServerStartupStatusUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindMCPServerStartupStatusUpdated ServerNotificationKind = "mcpServer/startupStatus/updated"
	// ServerNotificationKindModelRerouted is a generated Codex app-server protocol constant.
	ServerNotificationKindModelRerouted ServerNotificationKind = "model/rerouted"
	// ServerNotificationKindModelSafetyBufferingUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindModelSafetyBufferingUpdated ServerNotificationKind = "model/safetyBuffering/updated"
	// ServerNotificationKindModelVerification is a generated Codex app-server protocol constant.
	ServerNotificationKindModelVerification ServerNotificationKind = "model/verification"
	// ServerNotificationKindProcessExited is a generated Codex app-server protocol constant.
	ServerNotificationKindProcessExited ServerNotificationKind = "process/exited"
	// ServerNotificationKindProcessOutputDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindProcessOutputDelta ServerNotificationKind = "process/outputDelta"
	// ServerNotificationKindRemoteControlStatusChanged is a generated Codex app-server protocol constant.
	ServerNotificationKindRemoteControlStatusChanged ServerNotificationKind = "remoteControl/status/changed"
	// ServerNotificationKindServerRequestResolved is a generated Codex app-server protocol constant.
	ServerNotificationKindServerRequestResolved ServerNotificationKind = "serverRequest/resolved"
	// ServerNotificationKindSkillsChanged is a generated Codex app-server protocol constant.
	ServerNotificationKindSkillsChanged ServerNotificationKind = "skills/changed"
	// ServerNotificationKindThreadArchived is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadArchived ServerNotificationKind = "thread/archived"
	// ServerNotificationKindThreadClosed is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadClosed ServerNotificationKind = "thread/closed"
	// ServerNotificationKindThreadCompacted is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadCompacted ServerNotificationKind = "thread/compacted"
	// ServerNotificationKindThreadDeleted is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadDeleted ServerNotificationKind = "thread/deleted"
	// ServerNotificationKindThreadEnvironmentConnected is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadEnvironmentConnected ServerNotificationKind = "thread/environment/connected"
	// ServerNotificationKindThreadEnvironmentDisconnected is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadEnvironmentDisconnected ServerNotificationKind = "thread/environment/disconnected"
	// ServerNotificationKindThreadGoalCleared is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadGoalCleared ServerNotificationKind = "thread/goal/cleared"
	// ServerNotificationKindThreadGoalUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadGoalUpdated ServerNotificationKind = "thread/goal/updated"
	// ServerNotificationKindThreadNameUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadNameUpdated ServerNotificationKind = "thread/name/updated"
	// ServerNotificationKindThreadRealtimeClosed is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeClosed ServerNotificationKind = "thread/realtime/closed"
	// ServerNotificationKindThreadRealtimeError is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeError ServerNotificationKind = "thread/realtime/error"
	// ServerNotificationKindThreadRealtimeItemAdded is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeItemAdded ServerNotificationKind = "thread/realtime/itemAdded"
	// ServerNotificationKindThreadRealtimeOutputAudioDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeOutputAudioDelta ServerNotificationKind = "thread/realtime/outputAudio/delta"
	// ServerNotificationKindThreadRealtimeSdp is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeSdp ServerNotificationKind = "thread/realtime/sdp"
	// ServerNotificationKindThreadRealtimeStarted is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeStarted ServerNotificationKind = "thread/realtime/started"
	// ServerNotificationKindThreadRealtimeTranscriptDelta is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeTranscriptDelta ServerNotificationKind = "thread/realtime/transcript/delta"
	// ServerNotificationKindThreadRealtimeTranscriptDone is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadRealtimeTranscriptDone ServerNotificationKind = "thread/realtime/transcript/done"
	// ServerNotificationKindThreadSettingsUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadSettingsUpdated ServerNotificationKind = "thread/settings/updated"
	// ServerNotificationKindThreadStarted is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadStarted ServerNotificationKind = "thread/started"
	// ServerNotificationKindThreadStatusChanged is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadStatusChanged ServerNotificationKind = "thread/status/changed"
	// ServerNotificationKindThreadTokenUsageUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadTokenUsageUpdated ServerNotificationKind = "thread/tokenUsage/updated"
	// ServerNotificationKindThreadUnarchived is a generated Codex app-server protocol constant.
	ServerNotificationKindThreadUnarchived ServerNotificationKind = "thread/unarchived"
	// ServerNotificationKindTurnCompleted is a generated Codex app-server protocol constant.
	ServerNotificationKindTurnCompleted ServerNotificationKind = "turn/completed"
	// ServerNotificationKindTurnDiffUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindTurnDiffUpdated ServerNotificationKind = "turn/diff/updated"
	// ServerNotificationKindTurnModerationMetadata is a generated Codex app-server protocol constant.
	ServerNotificationKindTurnModerationMetadata ServerNotificationKind = "turn/moderationMetadata"
	// ServerNotificationKindTurnPlanUpdated is a generated Codex app-server protocol constant.
	ServerNotificationKindTurnPlanUpdated ServerNotificationKind = "turn/plan/updated"
	// ServerNotificationKindTurnStarted is a generated Codex app-server protocol constant.
	ServerNotificationKindTurnStarted ServerNotificationKind = "turn/started"
	// ServerNotificationKindWarning is a generated Codex app-server protocol constant.
	ServerNotificationKindWarning ServerNotificationKind = "warning"
	// ServerNotificationKindWindowsWorldWritableWarning is a generated Codex app-server protocol constant.
	ServerNotificationKindWindowsWorldWritableWarning ServerNotificationKind = "windows/worldWritableWarning"
	// ServerNotificationKindWindowsSandboxSetupCompleted is a generated Codex app-server protocol constant.
	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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ServerRequestKind added in v0.145.0 

type ServerRequestKind string

ServerRequestKind identifies a known ServerRequest variant. 

const (
	// ServerRequestKindAccountChatgptAuthTokensRefresh is a generated Codex app-server protocol constant.
	ServerRequestKindAccountChatgptAuthTokensRefresh ServerRequestKind = "account/chatgptAuthTokens/refresh"
	// ServerRequestKindApplyPatchApproval is a generated Codex app-server protocol constant.
	ServerRequestKindApplyPatchApproval ServerRequestKind = "applyPatchApproval"
	// ServerRequestKindAttestationGenerate is a generated Codex app-server protocol constant.
	ServerRequestKindAttestationGenerate ServerRequestKind = "attestation/generate"
	// ServerRequestKindExecCommandApproval is a generated Codex app-server protocol constant.
	ServerRequestKindExecCommandApproval ServerRequestKind = "execCommandApproval"
	// ServerRequestKindItemCommandExecutionRequestApproval is a generated Codex app-server protocol constant.
	ServerRequestKindItemCommandExecutionRequestApproval ServerRequestKind = "item/commandExecution/requestApproval"
	// ServerRequestKindItemFileChangeRequestApproval is a generated Codex app-server protocol constant.
	ServerRequestKindItemFileChangeRequestApproval ServerRequestKind = "item/fileChange/requestApproval"
	// ServerRequestKindItemPermissionsRequestApproval is a generated Codex app-server protocol constant.
	ServerRequestKindItemPermissionsRequestApproval ServerRequestKind = "item/permissions/requestApproval"
	// ServerRequestKindItemToolCall is a generated Codex app-server protocol constant.
	ServerRequestKindItemToolCall ServerRequestKind = "item/tool/call"
	// ServerRequestKindItemToolRequestUserInput is a generated Codex app-server protocol constant.
	ServerRequestKindItemToolRequestUserInput ServerRequestKind = "item/tool/requestUserInput"
	// ServerRequestKindMCPServerElicitationRequest is a generated Codex app-server protocol constant.
	ServerRequestKindMCPServerElicitationRequest ServerRequestKind = "mcpServer/elicitation/request"
)

type ServerRequestResolvedNotification 

type ServerRequestResolvedNotification = SanitizedServerRequestResolvedNotificationJSON

ServerRequestResolvedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

SessionMigration represents a generated Codex app-server protocol type.

type SessionMigrationTitle added in v0.144.0 

type SessionMigrationTitle *string

SessionMigrationTitle represents a generated Codex app-server protocol type.

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 *ReasoningEffort `json:"reasoning_effort,omitempty,omitzero"`
}

Settings for a collaboration mode.

type SettingsDeveloperInstructions added in v0.144.0 

type SettingsDeveloperInstructions *string

SettingsDeveloperInstructions represents a generated Codex app-server protocol type.

type SkillMigration 

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

SkillMigration represents a generated Codex app-server protocol type.

type SkillsChangedNotification 

type SkillsChangedNotification = SanitizedSkillsChangedNotificationJSON

SkillsChangedNotification is a generated alias for a Codex app-server protocol type.

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 *AbsolutePathBuf `json:"path,omitempty,omitzero"`
}

SkillsConfigWriteParams represents a generated Codex app-server protocol type.

type SkillsConfigWriteParamsName added in v0.144.0 

type SkillsConfigWriteParamsName *string

SkillsConfigWriteParamsName represents a generated Codex app-server protocol type. Name-based selector.

type SkillsConfigWriteResponse 

type SkillsConfigWriteResponse = SanitizedSkillsConfigWriteResponseJSON

SkillsConfigWriteResponse is a generated alias for a Codex app-server protocol type.

type SkillsExtraRootsSetParams 

type SkillsExtraRootsSetParams struct {
	// ExtraRoots corresponds to the JSON schema field "extraRoots".
	ExtraRoots []AbsolutePathBuf `json:"extraRoots"`
}

SkillsExtraRootsSetParams represents a generated Codex app-server protocol type.

type SkillsExtraRootsSetResponse 

type SkillsExtraRootsSetResponse = SanitizedSkillsExtraRootsSetResponseJSON

SkillsExtraRootsSetResponse is a generated alias for a Codex app-server protocol type.

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"`
}

SkillsListParams represents a generated Codex app-server protocol type.

type SkillsListResponse 

type SkillsListResponse interface{}

SkillsListResponse represents a generated Codex app-server protocol type.

type SortDirection 

type SortDirection string

SortDirection represents a generated Codex app-server protocol type. 

const SortDirectionAsc SortDirection = "asc"

SortDirectionAsc is a generated Codex app-server protocol constant. 

const SortDirectionDesc SortDirection = "desc"

SortDirectionDesc is a generated Codex app-server protocol constant.

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"`
}

SpendControlLimitSnapshot represents a generated Codex app-server protocol type.

type SubagentMigration 

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

SubagentMigration represents a generated Codex app-server protocol type.

type TerminalInteractionNotification 

type TerminalInteractionNotification = SanitizedTerminalInteractionNotificationJSON

TerminalInteractionNotification is a generated alias for a Codex app-server protocol type.

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"`
}

TextElement represents a generated Codex app-server protocol type.

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"`
}

TextElementByteRange represents a generated Codex app-server protocol type. Byte range in the parent `text` buffer that this element occupies.

type TextElementPlaceholder added in v0.144.0 

type TextElementPlaceholder *string

TextElementPlaceholder represents a generated Codex app-server protocol type. 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"`
}

TextPosition represents a generated Codex app-server protocol type.

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"`
}

TextRange represents a generated Codex app-server protocol type.

type Thread 

type Thread struct {
	ID             string       `json:"id"`
	Extra          *ThreadExtra `json:"extra,omitempty"`
	SessionID      string       `json:"sessionId"`
	ForkedFromID   *string      `json:"forkedFromId,omitempty"`
	ParentThreadID *string      `json:"parentThreadId,omitempty"`
	Preview        string       `json:"preview"`
	Ephemeral      bool         `json:"ephemeral"`
	// IsPinned is retained for source compatibility with Codex versions before
	// 0.147. Codex 0.147 replaces pinned-thread organization with sections.
	//
	// Deprecated: use Section and section-aware thread listing.
	IsPinned         bool              `json:"isPinned,omitempty"`
	HistoryMode      ThreadHistoryMode `json:"historyMode,omitempty"`
	ModelProvider    string            `json:"modelProvider"`
	CreatedAt        int64             `json:"createdAt"`
	UpdatedAt        int64             `json:"updatedAt"`
	RecencyAt        *int64            `json:"recencyAt,omitempty"`
	Status           ThreadStatus      `json:"status"`
	Path             *string           `json:"path,omitempty"`
	Cwd              string            `json:"cwd"`
	CLIVersion       string            `json:"cliVersion"`
	Source           json.RawMessage   `json:"source"`
	ThreadSource     *ThreadSource     `json:"threadSource,omitempty"`
	AgentNickname    *string           `json:"agentNickname,omitempty"`
	AgentRole        *string           `json:"agentRole,omitempty"`
	GitInfo          *GitInfo          `json:"gitInfo,omitempty"`
	Name             *string           `json:"name,omitempty"`
	Section          *ThreadSection    `json:"section,omitempty"`
	SectionEnteredAt *int64            `json:"sectionEnteredAt,omitempty"`
	Turns            []Turn            `json:"turns"`
}

Thread represents the complete thread summary returned by the app-server.

type ThreadActiveFlag 

type ThreadActiveFlag string

ThreadActiveFlag represents a generated Codex app-server protocol type. 

const ThreadActiveFlagWaitingOnApproval ThreadActiveFlag = "waitingOnApproval"

ThreadActiveFlagWaitingOnApproval is a generated Codex app-server protocol constant. 

const ThreadActiveFlagWaitingOnUserInput ThreadActiveFlag = "waitingOnUserInput"

ThreadActiveFlagWaitingOnUserInput is a generated Codex app-server protocol constant.

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"`
}

ThreadApproveGuardianDeniedActionParams represents a generated Codex app-server protocol type.

type ThreadApproveGuardianDeniedActionResponse 

type ThreadApproveGuardianDeniedActionResponse = SanitizedThreadApproveGuardianDeniedActionResponseJSON

ThreadApproveGuardianDeniedActionResponse is a generated alias for a Codex app-server protocol type.

type ThreadArchiveParams 

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

ThreadArchiveParams represents a generated Codex app-server protocol type.

type ThreadArchiveResponse 

type ThreadArchiveResponse = SanitizedThreadArchiveResponseJSON

ThreadArchiveResponse is a generated alias for a Codex app-server protocol type.

type ThreadArchivedNotification 

type ThreadArchivedNotification = SanitizedThreadArchivedNotificationJSON

ThreadArchivedNotification is a generated alias for a Codex app-server protocol type.

type ThreadClosedNotification 

type ThreadClosedNotification = SanitizedThreadClosedNotificationJSON

ThreadClosedNotification is a generated alias for a Codex app-server protocol type.

type ThreadCompactStartParams 

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

ThreadCompactStartParams represents a generated Codex app-server protocol type.

type ThreadCompactStartResponse 

type ThreadCompactStartResponse = SanitizedThreadCompactStartResponseJSON

ThreadCompactStartResponse is a generated alias for a Codex app-server protocol type.

type ThreadDeleteParams 

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

ThreadDeleteParams represents a generated Codex app-server protocol type.

type ThreadDeleteResponse 

type ThreadDeleteResponse = SanitizedThreadDeleteResponseJSON

ThreadDeleteResponse is a generated alias for a Codex app-server protocol type.

type ThreadDeletedNotification 

type ThreadDeletedNotification = SanitizedThreadDeletedNotificationJSON

ThreadDeletedNotification is a generated alias for a Codex app-server protocol type.

type ThreadExtra added in v0.147.0 

type ThreadExtra map[string]json.RawMessage

ThreadExtra preserves implementation-specific thread metadata.

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"`
	ApprovalsReviewer     *ApprovalsReviewer `json:"approvalsReviewer,omitempty"`
	Sandbox               json.RawMessage    `json:"sandbox,omitempty"`
	Config                *map[string]any    `json:"config,omitempty"`
	BaseInstructions      *string            `json:"baseInstructions,omitempty"`
	DeveloperInstructions *string            `json:"developerInstructions,omitempty"`
	ThreadSource          *ThreadSource      `json:"threadSource,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

ThreadForkParamsBaseInstructions represents a generated Codex app-server protocol type.

type ThreadForkParamsConfig added in v0.144.0 

type ThreadForkParamsConfig map[string]interface{}

ThreadForkParamsConfig represents a generated Codex app-server protocol type.

type ThreadForkParamsCwd added in v0.144.0 

type ThreadForkParamsCwd *string

ThreadForkParamsCwd represents a generated Codex app-server protocol type.

type ThreadForkParamsDeveloperInstructions added in v0.144.0 

type ThreadForkParamsDeveloperInstructions *string

ThreadForkParamsDeveloperInstructions represents a generated Codex app-server protocol type.

type ThreadForkParamsLastTurnID added in v0.144.0 

type ThreadForkParamsLastTurnID *string

ThreadForkParamsLastTurnID represents a generated Codex app-server protocol type. 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

ThreadForkParamsModel represents a generated Codex app-server protocol type. Configuration overrides for the forked thread, if any.

type ThreadForkParamsModelProvider added in v0.144.0 

type ThreadForkParamsModelProvider *string

ThreadForkParamsModelProvider represents a generated Codex app-server protocol type.

type ThreadForkParamsServiceTier added in v0.144.0 

type ThreadForkParamsServiceTier *string

ThreadForkParamsServiceTier represents a generated Codex app-server protocol type.

type ThreadForkResponse 

type ThreadForkResponse struct {
	ThreadID                string           `json:"threadId,omitempty"`
	Thread                  *Thread          `json:"thread"`
	Model                   string           `json:"model"`
	ModelProvider           string           `json:"modelProvider"`
	ServiceTier             *string          `json:"serviceTier,omitempty"`
	Cwd                     string           `json:"cwd"`
	RuntimeWorkspaceRoots   []string         `json:"runtimeWorkspaceRoots,omitempty"`
	InstructionSources      []string         `json:"instructionSources,omitempty"`
	ApprovalPolicy          json.RawMessage  `json:"approvalPolicy"`
	ApprovalsReviewer       json.RawMessage  `json:"approvalsReviewer"`
	Sandbox                 SandboxPolicy    `json:"sandbox"`
	ActivePermissionProfile json.RawMessage  `json:"activePermissionProfile,omitempty"`
	ReasoningEffort         *ReasoningEffort `json:"reasoningEffort,omitempty"`
	MultiAgentMode          json.RawMessage  `json:"multiAgentMode,omitempty"`
}

ThreadForkResponse is the response payload for thread/fork.

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"`
}

ThreadGoalClearParams represents a generated Codex app-server protocol type.

type ThreadGoalClearResponse 

type ThreadGoalClearResponse = SanitizedThreadGoalClearResponseJSON

ThreadGoalClearResponse is a generated alias for a Codex app-server protocol type.

type ThreadGoalClearedNotification 

type ThreadGoalClearedNotification = SanitizedThreadGoalClearedNotificationJSON

ThreadGoalClearedNotification is a generated alias for a Codex app-server protocol type.

type ThreadGoalGetParams 

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

ThreadGoalGetParams represents a generated Codex app-server protocol type.

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 *ThreadGoalStatus `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"`
}

ThreadGoalSetParams represents a generated Codex app-server protocol type.

type ThreadGoalSetParamsObjective added in v0.144.0 

type ThreadGoalSetParamsObjective *string

ThreadGoalSetParamsObjective represents a generated Codex app-server protocol type.

type ThreadGoalSetParamsTokenBudget added in v0.144.0 

type ThreadGoalSetParamsTokenBudget *int

ThreadGoalSetParamsTokenBudget represents a generated Codex app-server protocol type.

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

ThreadGoalStatus represents a generated Codex app-server protocol type. 

const ThreadGoalStatusActive ThreadGoalStatus = "active"

ThreadGoalStatusActive is a generated Codex app-server protocol constant. 

const ThreadGoalStatusBlocked ThreadGoalStatus = "blocked"

ThreadGoalStatusBlocked is a generated Codex app-server protocol constant. 

const ThreadGoalStatusBudgetLimited ThreadGoalStatus = "budgetLimited"

ThreadGoalStatusBudgetLimited is a generated Codex app-server protocol constant. 

const ThreadGoalStatusComplete ThreadGoalStatus = "complete"

ThreadGoalStatusComplete is a generated Codex app-server protocol constant. 

const ThreadGoalStatusPaused ThreadGoalStatus = "paused"

ThreadGoalStatusPaused is a generated Codex app-server protocol constant. 

const ThreadGoalStatusUsageLimited ThreadGoalStatus = "usageLimited"

ThreadGoalStatusUsageLimited is a generated Codex app-server protocol constant.

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

ThreadHistoryMode represents a generated Codex app-server protocol type. 

const ThreadHistoryModeLegacy ThreadHistoryMode = "legacy"

ThreadHistoryModeLegacy is a generated Codex app-server protocol constant. 

const ThreadHistoryModePaginated ThreadHistoryMode = "paginated"

ThreadHistoryModePaginated is a generated Codex app-server protocol constant.

type ThreadID 

type ThreadID string

ThreadID represents a generated Codex app-server protocol type.

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"`
}

ThreadInjectItemsParams represents a generated Codex app-server protocol type.

type ThreadInjectItemsResponse 

type ThreadInjectItemsResponse = SanitizedThreadInjectItemsResponseJSON

ThreadInjectItemsResponse is a generated alias for a Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ThreadItemKind added in v0.145.0 

type ThreadItemKind string

ThreadItemKind identifies a known ThreadItem variant. 

const (
	// ThreadItemKindAgentMessage is a generated Codex app-server protocol constant.
	ThreadItemKindAgentMessage ThreadItemKind = "agentMessage"
	// ThreadItemKindCollabAgentToolCall is a generated Codex app-server protocol constant.
	ThreadItemKindCollabAgentToolCall ThreadItemKind = "collabAgentToolCall"
	// ThreadItemKindCommandExecution is a generated Codex app-server protocol constant.
	ThreadItemKindCommandExecution ThreadItemKind = "commandExecution"
	// ThreadItemKindContextCompaction is a generated Codex app-server protocol constant.
	ThreadItemKindContextCompaction ThreadItemKind = "contextCompaction"
	// ThreadItemKindDynamicToolCall is a generated Codex app-server protocol constant.
	ThreadItemKindDynamicToolCall ThreadItemKind = "dynamicToolCall"
	// ThreadItemKindEnteredReviewMode is a generated Codex app-server protocol constant.
	ThreadItemKindEnteredReviewMode ThreadItemKind = "enteredReviewMode"
	// ThreadItemKindExitedReviewMode is a generated Codex app-server protocol constant.
	ThreadItemKindExitedReviewMode ThreadItemKind = "exitedReviewMode"
	// ThreadItemKindFileChange is a generated Codex app-server protocol constant.
	ThreadItemKindFileChange ThreadItemKind = "fileChange"
	// ThreadItemKindHookPrompt is a generated Codex app-server protocol constant.
	ThreadItemKindHookPrompt ThreadItemKind = "hookPrompt"
	// ThreadItemKindImageGeneration is a generated Codex app-server protocol constant.
	ThreadItemKindImageGeneration ThreadItemKind = "imageGeneration"
	// ThreadItemKindImageView is a generated Codex app-server protocol constant.
	ThreadItemKindImageView ThreadItemKind = "imageView"
	// ThreadItemKindMCPToolCall is a generated Codex app-server protocol constant.
	ThreadItemKindMCPToolCall ThreadItemKind = "mcpToolCall"
	// ThreadItemKindPlan is a generated Codex app-server protocol constant.
	ThreadItemKindPlan ThreadItemKind = "plan"
	// ThreadItemKindReasoning is a generated Codex app-server protocol constant.
	ThreadItemKindReasoning ThreadItemKind = "reasoning"
	// ThreadItemKindSleep is a generated Codex app-server protocol constant.
	ThreadItemKindSleep ThreadItemKind = "sleep"
	// ThreadItemKindSubAgentActivity is a generated Codex app-server protocol constant.
	ThreadItemKindSubAgentActivity ThreadItemKind = "subAgentActivity"
	// ThreadItemKindUserMessage is a generated Codex app-server protocol constant.
	ThreadItemKindUserMessage ThreadItemKind = "userMessage"
	// ThreadItemKindWebSearch is a generated Codex app-server protocol constant.
	ThreadItemKindWebSearch ThreadItemKind = "webSearch"
)

type ThreadListCwdFilter 

type ThreadListCwdFilter interface{}

ThreadListCwdFilter represents a generated Codex app-server protocol type.

type ThreadListParams 

type ThreadListParams struct {
	Archived *bool   `json:"archived,omitempty"`
	Cursor   *string `json:"cursor,omitempty"`
	Cwd      any     `json:"cwd,omitempty"`
	// IsPinned is retained for source compatibility with Codex versions before
	// 0.147. Codex 0.147 ignores this filter and uses SectionID instead.
	//
	// Deprecated: use SectionID.
	IsPinned       *bool                           `json:"-"`
	Limit          *int                            `json:"limit,omitempty"`
	ModelProviders *ThreadListParamsModelProviders `json:"modelProviders,omitempty"`
	SearchTerm     *string                         `json:"searchTerm,omitempty"`
	// SectionID distinguishes omitted (all sections), pointer-to-nil
	// (unsectioned), and pointer-to-string (one section).
	SectionID      **string                     `json:"sectionId,omitempty"`
	SortDirection  SortDirection                `json:"sortDirection,omitempty"`
	SortKey        ThreadSortKey                `json:"sortKey,omitempty"`
	SourceKinds    *ThreadListParamsSourceKinds `json:"sourceKinds,omitempty"`
	UseStateDbOnly *bool                        `json:"useStateDbOnly,omitempty"`
}

ThreadListParams configures thread/list using typed sort values.

type ThreadListParamsArchived added in v0.144.0 

type ThreadListParamsArchived *bool

ThreadListParamsArchived represents a generated Codex app-server protocol type. 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

ThreadListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type ThreadListParamsLimit added in v0.144.0 

type ThreadListParamsLimit *int

ThreadListParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to a reasonable server-side value.

type ThreadListParamsModelProviders added in v0.144.0 

type ThreadListParamsModelProviders []string

ThreadListParamsModelProviders represents a generated Codex app-server protocol type. 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

ThreadListParamsSearchTerm represents a generated Codex app-server protocol type. Optional substring filter for the extracted thread title.

type ThreadListParamsSectionID added in v0.147.0 

type ThreadListParamsSectionID *string

ThreadListParamsSectionID represents a generated Codex app-server protocol type. Omit to include every section, set to `null` for unsectioned threads, or provide a section ID to return only threads in that section.

type ThreadListParamsSourceKinds added in v0.144.0 

type ThreadListParamsSourceKinds []ThreadSourceKind

ThreadListParamsSourceKinds represents a generated Codex app-server protocol type. 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 struct {
	Data            []Thread `json:"data"`
	NextCursor      *string  `json:"nextCursor,omitempty"`
	BackwardsCursor *string  `json:"backwardsCursor,omitempty"`
}

ThreadListResponse is a page of persisted threads.

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"`
}

ThreadLoadedListParams represents a generated Codex app-server protocol type.

type ThreadLoadedListParamsCursor added in v0.144.0 

type ThreadLoadedListParamsCursor *string

ThreadLoadedListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type ThreadLoadedListParamsLimit added in v0.144.0 

type ThreadLoadedListParamsLimit *int

ThreadLoadedListParamsLimit represents a generated Codex app-server protocol type. Optional page size; defaults to no limit.

type ThreadLoadedListResponse 

type ThreadLoadedListResponse = SanitizedThreadLoadedListResponseJSON

ThreadLoadedListResponse is a generated alias for a Codex app-server protocol type.

type ThreadMemoryMode added in v0.144.0 

type ThreadMemoryMode string

ThreadMemoryMode represents a generated Codex app-server protocol type. 

const ThreadMemoryModeDisabled ThreadMemoryMode = "disabled"

ThreadMemoryModeDisabled is a generated Codex app-server protocol constant. 

const ThreadMemoryModeEnabled ThreadMemoryMode = "enabled"

ThreadMemoryModeEnabled is a generated Codex app-server protocol constant.

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"`
}

ThreadMetadataGitInfoUpdateParams represents a generated Codex app-server protocol type.

type ThreadMetadataGitInfoUpdateParamsBranch added in v0.144.0 

type ThreadMetadataGitInfoUpdateParamsBranch *string

ThreadMetadataGitInfoUpdateParamsBranch represents a generated Codex app-server protocol type. 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

ThreadMetadataGitInfoUpdateParamsOriginURL represents a generated Codex app-server protocol type. 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

ThreadMetadataGitInfoUpdateParamsSha represents a generated Codex app-server protocol type. 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 {
	GitInfo *ThreadMetadataGitInfoUpdateParams `json:"gitInfo,omitempty"`
	// IsPinned is retained for source compatibility with Codex versions before
	// 0.147. It is not sent to Codex 0.147, which uses thread sections.
	//
	// Deprecated: use thread/section/move.
	IsPinned ThreadMetadataUpdateParamsIsPinned `json:"-"`
	ThreadID string                             `json:"threadId"`
}

ThreadMetadataUpdateParams updates supported thread metadata.

type ThreadMetadataUpdateParamsIsPinned added in v0.147.0 

type ThreadMetadataUpdateParamsIsPinned *bool

ThreadMetadataUpdateParamsIsPinned represents a generated Codex app-server protocol type. Deprecated: Codex 0.147 removed this field in favor of thread sections; retained for Go SDK source compatibility.

type ThreadMetadataUpdateResponse 

type ThreadMetadataUpdateResponse interface{}

ThreadMetadataUpdateResponse represents a generated Codex app-server protocol type.

type ThreadNameUpdatedNotification 

type ThreadNameUpdatedNotification = SanitizedThreadNameUpdatedNotificationJSON

ThreadNameUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
}

ThreadReadParams represents a generated Codex app-server protocol type.

type ThreadReadResponse 

type ThreadReadResponse struct {
	Thread Thread `json:"thread"`
}

ThreadReadResponse is the response payload for thread/read.

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"`
}

ThreadRealtimeAudioChunk represents a generated Codex app-server protocol type. EXPERIMENTAL - thread realtime audio chunk.

type ThreadRealtimeAudioChunkItemID added in v0.144.0 

type ThreadRealtimeAudioChunkItemID *string

ThreadRealtimeAudioChunkItemID represents a generated Codex app-server protocol type.

type ThreadRealtimeAudioChunkSamplesPerChannel added in v0.144.0 

type ThreadRealtimeAudioChunkSamplesPerChannel *int

ThreadRealtimeAudioChunkSamplesPerChannel represents a generated Codex app-server protocol type.

type ThreadRealtimeClosedNotification 

type ThreadRealtimeClosedNotification = SanitizedThreadRealtimeClosedNotificationJSON

ThreadRealtimeClosedNotification is a generated alias for a Codex app-server protocol type.

type ThreadRealtimeErrorNotification 

type ThreadRealtimeErrorNotification = SanitizedThreadRealtimeErrorNotificationJSON

ThreadRealtimeErrorNotification is a generated alias for a Codex app-server protocol type.

type ThreadRealtimeInitialItem added in v0.147.0 

type ThreadRealtimeInitialItem struct {
	// Role corresponds to the JSON schema field "role".
	Role ConversationTextRole `json:"role"`

	// Text corresponds to the JSON schema field "text".
	Text string `json:"text"`
}

ThreadRealtimeInitialItem represents a generated Codex app-server protocol type. EXPERIMENTAL - role-bearing text item included when a realtime V3 session starts.

type ThreadRealtimeItemAddedNotification 

type ThreadRealtimeItemAddedNotification = SanitizedThreadRealtimeItemAddedNotificationJSON

ThreadRealtimeItemAddedNotification is a generated alias for a Codex app-server protocol type.

type ThreadRealtimeOutputAudioDeltaNotification 

type ThreadRealtimeOutputAudioDeltaNotification = SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON

ThreadRealtimeOutputAudioDeltaNotification is a generated alias for a Codex app-server protocol type.

type ThreadRealtimeSdpNotification 

type ThreadRealtimeSdpNotification = SanitizedThreadRealtimeSdpNotificationJSON

ThreadRealtimeSdpNotification is a generated alias for a Codex app-server protocol type.

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 

func (value ThreadRealtimeStartTransport) Kind() ThreadRealtimeStartTransportKind

Kind returns the payload discriminator, including unknown future values.

func (ThreadRealtimeStartTransport) MarshalJSON added in v0.145.0 

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

MarshalJSON implements generated Codex app-server protocol behavior.

func (ThreadRealtimeStartTransport) RawJSON added in v0.145.0 

func (value ThreadRealtimeStartTransport) RawJSON() json.RawMessage

RawJSON returns a copy of the complete union payload.

func (*ThreadRealtimeStartTransport) UnmarshalJSON added in v0.145.0 

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ThreadRealtimeStartTransportKind added in v0.145.0 

type ThreadRealtimeStartTransportKind string

ThreadRealtimeStartTransportKind identifies a known ThreadRealtimeStartTransport variant. 

const (
	// ThreadRealtimeStartTransportKindWebrtc is a generated Codex app-server protocol constant.
	ThreadRealtimeStartTransportKindWebrtc ThreadRealtimeStartTransportKind = "webrtc"
	// ThreadRealtimeStartTransportKindWebsocket is a generated Codex app-server protocol constant.
	ThreadRealtimeStartTransportKindWebsocket ThreadRealtimeStartTransportKind = "websocket"
)

type ThreadRealtimeStartedNotification 

type ThreadRealtimeStartedNotification = SanitizedThreadRealtimeStartedNotificationJSON

ThreadRealtimeStartedNotification is a generated alias for a Codex app-server protocol type.

type ThreadRealtimeTranscriptDeltaNotification 

type ThreadRealtimeTranscriptDeltaNotification = SanitizedThreadRealtimeTranscriptDeltaNotificationJSON

ThreadRealtimeTranscriptDeltaNotification is a generated alias for a Codex app-server protocol type.

type ThreadRealtimeTranscriptDoneNotification 

type ThreadRealtimeTranscriptDoneNotification = SanitizedThreadRealtimeTranscriptDoneNotificationJSON

ThreadRealtimeTranscriptDoneNotification is a generated alias for a Codex app-server protocol type.

type ThreadResponse deprecated 

type ThreadResponse = ThreadStartResponse

ThreadResponse is the former shared lifecycle response shape.

Deprecated: use the method-specific ThreadStartResponse, ThreadResumeResponse, or ThreadForkResponse.

type ThreadResumeInitialTurnsPageParams added in v0.144.0 

type ThreadResumeInitialTurnsPageParams struct {
	// How much item detail to include for each returned turn; defaults to summary.
	ItemsView TurnItemsView `json:"itemsView,omitempty,omitzero"`

	// Optional turn page size.
	Limit ThreadResumeInitialTurnsPageParamsLimit `json:"limit,omitempty,omitzero"`

	// Optional turn pagination direction; defaults to descending.
	SortDirection *SortDirection `json:"sortDirection,omitempty,omitzero"`
}

ThreadResumeInitialTurnsPageParams represents a generated Codex app-server protocol type.

type ThreadResumeInitialTurnsPageParamsLimit added in v0.144.0 

type ThreadResumeInitialTurnsPageParamsLimit *int

ThreadResumeInitialTurnsPageParamsLimit represents a generated Codex app-server protocol type. 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"`
	ApprovalsReviewer     *ApprovalsReviewer `json:"approvalsReviewer,omitempty"`
	Sandbox               json.RawMessage    `json:"sandbox,omitempty"`
	Config                *map[string]any    `json:"config,omitempty"`
	BaseInstructions      *string            `json:"baseInstructions,omitempty"`
	DeveloperInstructions *string            `json:"developerInstructions,omitempty"`
	Personality           *Personality       `json:"personality,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

ThreadResumeParamsBaseInstructions represents a generated Codex app-server protocol type.

type ThreadResumeParamsConfig added in v0.144.0 

type ThreadResumeParamsConfig map[string]interface{}

ThreadResumeParamsConfig represents a generated Codex app-server protocol type.

type ThreadResumeParamsCwd added in v0.144.0 

type ThreadResumeParamsCwd *string

ThreadResumeParamsCwd represents a generated Codex app-server protocol type.

type ThreadResumeParamsDeveloperInstructions added in v0.144.0 

type ThreadResumeParamsDeveloperInstructions *string

ThreadResumeParamsDeveloperInstructions represents a generated Codex app-server protocol type.

type ThreadResumeParamsModel added in v0.144.0 

type ThreadResumeParamsModel *string

ThreadResumeParamsModel represents a generated Codex app-server protocol type. Configuration overrides for the resumed thread, if any.

type ThreadResumeParamsModelProvider added in v0.144.0 

type ThreadResumeParamsModelProvider *string

ThreadResumeParamsModelProvider represents a generated Codex app-server protocol type.

type ThreadResumeParamsServiceTier added in v0.144.0 

type ThreadResumeParamsServiceTier *string

ThreadResumeParamsServiceTier represents a generated Codex app-server protocol type.

type ThreadResumeResponse 

type ThreadResumeResponse struct {
	ThreadID                string           `json:"threadId,omitempty"`
	Thread                  *Thread          `json:"thread"`
	Model                   string           `json:"model"`
	ModelProvider           string           `json:"modelProvider"`
	ServiceTier             *string          `json:"serviceTier,omitempty"`
	Cwd                     string           `json:"cwd"`
	RuntimeWorkspaceRoots   []string         `json:"runtimeWorkspaceRoots,omitempty"`
	InstructionSources      []string         `json:"instructionSources,omitempty"`
	ApprovalPolicy          json.RawMessage  `json:"approvalPolicy"`
	ApprovalsReviewer       json.RawMessage  `json:"approvalsReviewer"`
	Sandbox                 SandboxPolicy    `json:"sandbox"`
	ActivePermissionProfile json.RawMessage  `json:"activePermissionProfile,omitempty"`
	ReasoningEffort         *ReasoningEffort `json:"reasoningEffort,omitempty"`
	MultiAgentMode          json.RawMessage  `json:"multiAgentMode,omitempty"`
	InitialTurnsPage        *TurnsPage       `json:"initialTurnsPage,omitempty"`
}

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"`
}

ThreadRollbackParams represents a generated Codex app-server protocol type. DEPRECATED: `thread/rollback` will be removed soon.

type ThreadRollbackResponse 

type ThreadRollbackResponse interface{}

ThreadRollbackResponse represents a generated Codex app-server protocol type.

type ThreadSearchSortKey added in v0.147.0 

type ThreadSearchSortKey string

ThreadSearchSortKey represents a generated Codex app-server protocol type. 

const ThreadSearchSortKeyCreatedAt ThreadSearchSortKey = "created_at"

ThreadSearchSortKeyCreatedAt is a generated Codex app-server protocol constant. 

const ThreadSearchSortKeyRecencyAt ThreadSearchSortKey = "recency_at"

ThreadSearchSortKeyRecencyAt is a generated Codex app-server protocol constant. 

const ThreadSearchSortKeyUpdatedAt ThreadSearchSortKey = "updated_at"

ThreadSearchSortKeyUpdatedAt is a generated Codex app-server protocol constant.

type ThreadSection added in v0.147.0 

type ThreadSection struct {
	// Opaque UUIDv7 identity that remains stable when the section is renamed.
	ID string `json:"id"`

	// The current user-visible section name.
	Name string `json:"name"`
}

ThreadSection represents a generated Codex app-server protocol type. An independently persisted, user-visible thread section.

type ThreadSectionCreateParams added in v0.147.0 

type ThreadSectionCreateParams struct {
	// The user-visible name of the section.
	Name string `json:"name"`
}

ThreadSectionCreateParams represents a generated Codex app-server protocol type. Parameters for creating an independently persisted thread section.

type ThreadSectionCreateResponse added in v0.147.0 

type ThreadSectionCreateResponse = SanitizedThreadSectionCreateResponseJSON

ThreadSectionCreateResponse is a generated alias for a Codex app-server protocol type.

type ThreadSectionDeleteParams added in v0.147.0 

type ThreadSectionDeleteParams struct {
	// The stable, server-generated identity of the section to delete.
	SectionID string `json:"sectionId"`
}

ThreadSectionDeleteParams represents a generated Codex app-server protocol type. Parameters for deleting an independently persisted thread section.

type ThreadSectionDeleteResponse added in v0.147.0 

type ThreadSectionDeleteResponse = SanitizedThreadSectionDeleteResponseJSON

ThreadSectionDeleteResponse is a generated alias for a Codex app-server protocol type.

type ThreadSectionListParams added in v0.147.0 

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

	// Maximum number of sections to return.
	Limit ThreadSectionListParamsLimit `json:"limit,omitempty,omitzero"`
}

ThreadSectionListParams represents a generated Codex app-server protocol type. Parameters for listing independently persisted thread sections.

type ThreadSectionListParamsCursor added in v0.147.0 

type ThreadSectionListParamsCursor *string

ThreadSectionListParamsCursor represents a generated Codex app-server protocol type. Opaque pagination cursor returned by a previous call.

type ThreadSectionListParamsLimit added in v0.147.0 

type ThreadSectionListParamsLimit *int

ThreadSectionListParamsLimit represents a generated Codex app-server protocol type. Maximum number of sections to return.

type ThreadSectionListResponse added in v0.147.0 

type ThreadSectionListResponse = SanitizedThreadSectionListResponseJSON

ThreadSectionListResponse is a generated alias for a Codex app-server protocol type.

type ThreadSectionMoveParams added in v0.147.0 

type ThreadSectionMoveParams struct {
	// Existing thread to insert before; omission or null appends to the section.
	BeforeThreadID ThreadSectionMoveParamsBeforeThreadID `json:"beforeThreadId,omitempty,omitzero"`

	// Destination section, or `null` to remove the thread from its section.
	SectionID ThreadSectionMoveParamsSectionID `json:"sectionId"`

	// Thread to move into, within, or out of a section.
	ThreadID string `json:"threadId"`
}

ThreadSectionMoveParams represents a generated Codex app-server protocol type. Parameters for moving a thread within a server-owned section ordering.

type ThreadSectionMoveParamsBeforeThreadID added in v0.147.0 

type ThreadSectionMoveParamsBeforeThreadID *string

ThreadSectionMoveParamsBeforeThreadID represents a generated Codex app-server protocol type. Existing thread to insert before; omission or null appends to the section.

type ThreadSectionMoveParamsSectionID added in v0.147.0 

type ThreadSectionMoveParamsSectionID *string

ThreadSectionMoveParamsSectionID represents a generated Codex app-server protocol type. Destination section, or `null` to remove the thread from its section.

type ThreadSectionMoveResponse added in v0.147.0 

type ThreadSectionMoveResponse = SanitizedThreadSectionMoveResponseJSON

ThreadSectionMoveResponse is a generated alias for a Codex app-server protocol type.

type ThreadSectionUpdateParams added in v0.147.0 

type ThreadSectionUpdateParams struct {
	// The updated user-visible name of the section.
	Name string `json:"name"`

	// The stable, server-generated identity of the section to update.
	SectionID string `json:"sectionId"`
}

ThreadSectionUpdateParams represents a generated Codex app-server protocol type. Parameters for updating an independently persisted thread section.

type ThreadSectionUpdateResponse added in v0.147.0 

type ThreadSectionUpdateResponse = SanitizedThreadSectionUpdateResponseJSON

ThreadSectionUpdateResponse is a generated alias for a Codex app-server protocol type.

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"`
}

ThreadSetNameParams represents a generated Codex app-server protocol type.

type ThreadSetNameResponse 

type ThreadSetNameResponse = SanitizedThreadSetNameResponseJSON

ThreadSetNameResponse is a generated alias for a Codex app-server protocol type.

type ThreadSettingsUpdatedNotification 

type ThreadSettingsUpdatedNotification interface{}

ThreadSettingsUpdatedNotification represents a generated Codex app-server protocol type.

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"`
}

ThreadShellCommandParams represents a generated Codex app-server protocol type.

type ThreadShellCommandResponse 

type ThreadShellCommandResponse = SanitizedThreadShellCommandResponseJSON

ThreadShellCommandResponse is a generated alias for a Codex app-server protocol type.

type ThreadSortKey 

type ThreadSortKey string

ThreadSortKey represents a generated Codex app-server protocol type. 

const ThreadSortKeyCreatedAt ThreadSortKey = "created_at"

ThreadSortKeyCreatedAt is a generated Codex app-server protocol constant. 

const ThreadSortKeyRecencyAt ThreadSortKey = "recency_at"

ThreadSortKeyRecencyAt is a generated Codex app-server protocol constant. 

const ThreadSortKeySectionPosition ThreadSortKey = "section_position"

ThreadSortKeySectionPosition is a generated Codex app-server protocol constant. 

const ThreadSortKeyUpdatedAt ThreadSortKey = "updated_at"

ThreadSortKeyUpdatedAt is a generated Codex app-server protocol constant.

type ThreadSource added in v0.144.0 

type ThreadSource string

ThreadSource represents a generated Codex app-server protocol type.

type ThreadSourceKind 

type ThreadSourceKind string

ThreadSourceKind represents a generated Codex app-server protocol type. 

const ThreadSourceKindAppServer ThreadSourceKind = "appServer"

ThreadSourceKindAppServer is a generated Codex app-server protocol constant. 

const ThreadSourceKindCli ThreadSourceKind = "cli"

ThreadSourceKindCli is a generated Codex app-server protocol constant. 

const ThreadSourceKindExec ThreadSourceKind = "exec"

ThreadSourceKindExec is a generated Codex app-server protocol constant. 

const ThreadSourceKindSubAgent ThreadSourceKind = "subAgent"

ThreadSourceKindSubAgent is a generated Codex app-server protocol constant. 

const ThreadSourceKindSubAgentCompact ThreadSourceKind = "subAgentCompact"

ThreadSourceKindSubAgentCompact is a generated Codex app-server protocol constant. 

const ThreadSourceKindSubAgentOther ThreadSourceKind = "subAgentOther"

ThreadSourceKindSubAgentOther is a generated Codex app-server protocol constant. 

const ThreadSourceKindSubAgentReview ThreadSourceKind = "subAgentReview"

ThreadSourceKindSubAgentReview is a generated Codex app-server protocol constant. 

const ThreadSourceKindSubAgentThreadSpawn ThreadSourceKind = "subAgentThreadSpawn"

ThreadSourceKindSubAgentThreadSpawn is a generated Codex app-server protocol constant. 

const ThreadSourceKindUnknown ThreadSourceKind = "unknown"

ThreadSourceKindUnknown is a generated Codex app-server protocol constant. 

const ThreadSourceKindVscode ThreadSourceKind = "vscode"

ThreadSourceKindVscode is a generated Codex app-server protocol constant.

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"`
	ApprovalsReviewer     *ApprovalsReviewer `json:"approvalsReviewer,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"`
	Personality           *Personality       `json:"personality,omitempty"`
	SessionStartSource    *ThreadStartSource `json:"sessionStartSource,omitempty"`
	ThreadSource          *ThreadSource      `json:"threadSource,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

ThreadStartParamsBaseInstructions represents a generated Codex app-server protocol type.

type ThreadStartParamsConfig added in v0.144.0 

type ThreadStartParamsConfig map[string]interface{}

ThreadStartParamsConfig represents a generated Codex app-server protocol type.

type ThreadStartParamsCwd added in v0.144.0 

type ThreadStartParamsCwd *string

ThreadStartParamsCwd represents a generated Codex app-server protocol type.

type ThreadStartParamsDeveloperInstructions added in v0.144.0 

type ThreadStartParamsDeveloperInstructions *string

ThreadStartParamsDeveloperInstructions represents a generated Codex app-server protocol type.

type ThreadStartParamsEphemeral added in v0.144.0 

type ThreadStartParamsEphemeral *bool

ThreadStartParamsEphemeral represents a generated Codex app-server protocol type.

type ThreadStartParamsModel added in v0.144.0 

type ThreadStartParamsModel *string

ThreadStartParamsModel represents a generated Codex app-server protocol type.

type ThreadStartParamsModelProvider added in v0.144.0 

type ThreadStartParamsModelProvider *string

ThreadStartParamsModelProvider represents a generated Codex app-server protocol type.

type ThreadStartParamsServiceName added in v0.144.0 

type ThreadStartParamsServiceName *string

ThreadStartParamsServiceName represents a generated Codex app-server protocol type.

type ThreadStartParamsServiceTier added in v0.144.0 

type ThreadStartParamsServiceTier *string

ThreadStartParamsServiceTier represents a generated Codex app-server protocol type.

type ThreadStartResponse 

type ThreadStartResponse struct {
	ThreadID                string           `json:"threadId,omitempty"`
	Thread                  *Thread          `json:"thread"`
	Model                   string           `json:"model"`
	ModelProvider           string           `json:"modelProvider"`
	ServiceTier             *string          `json:"serviceTier,omitempty"`
	Cwd                     string           `json:"cwd"`
	RuntimeWorkspaceRoots   []string         `json:"runtimeWorkspaceRoots,omitempty"`
	InstructionSources      []string         `json:"instructionSources,omitempty"`
	ApprovalPolicy          json.RawMessage  `json:"approvalPolicy"`
	ApprovalsReviewer       json.RawMessage  `json:"approvalsReviewer"`
	Sandbox                 SandboxPolicy    `json:"sandbox"`
	ActivePermissionProfile json.RawMessage  `json:"activePermissionProfile,omitempty"`
	ReasoningEffort         *ReasoningEffort `json:"reasoningEffort,omitempty"`
	MultiAgentMode          json.RawMessage  `json:"multiAgentMode,omitempty"`
}

ThreadStartResponse is the response payload for thread/start.

type ThreadStartSource added in v0.144.0 

type ThreadStartSource string

ThreadStartSource represents a generated Codex app-server protocol type. 

const ThreadStartSourceClear ThreadStartSource = "clear"

ThreadStartSourceClear is a generated Codex app-server protocol constant. 

const ThreadStartSourceStartup ThreadStartSource = "startup"

ThreadStartSourceStartup is a generated Codex app-server protocol constant.

type ThreadStartedNotification 

type ThreadStartedNotification interface{}

ThreadStartedNotification represents a generated Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type ThreadStatusChangedNotification 

type ThreadStatusChangedNotification = SanitizedThreadStatusChangedNotificationJSON

ThreadStatusChangedNotification is a generated alias for a Codex app-server protocol type.

type ThreadStatusKind added in v0.145.0 

type ThreadStatusKind string

ThreadStatusKind identifies a known ThreadStatus variant. 

const (
	// ThreadStatusKindActive is a generated Codex app-server protocol constant.
	ThreadStatusKindActive ThreadStatusKind = "active"
	// ThreadStatusKindIdle is a generated Codex app-server protocol constant.
	ThreadStatusKindIdle ThreadStatusKind = "idle"
	// ThreadStatusKindNotLoaded is a generated Codex app-server protocol constant.
	ThreadStatusKindNotLoaded ThreadStatusKind = "notLoaded"
	// ThreadStatusKindSystemError is a generated Codex app-server protocol constant.
	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"`
}

ThreadTokenUsage represents a generated Codex app-server protocol type.

type ThreadTokenUsageModelContextWindow added in v0.144.0 

type ThreadTokenUsageModelContextWindow *int

ThreadTokenUsageModelContextWindow represents a generated Codex app-server protocol type.

type ThreadTokenUsageUpdatedNotification 

type ThreadTokenUsageUpdatedNotification = SanitizedThreadTokenUsageUpdatedNotificationJSON

ThreadTokenUsageUpdatedNotification is a generated alias for a Codex app-server protocol type.

type ThreadUnarchiveParams 

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

ThreadUnarchiveParams represents a generated Codex app-server protocol type.

type ThreadUnarchiveResponse 

type ThreadUnarchiveResponse struct {
	Thread Thread `json:"thread"`
}

ThreadUnarchiveResponse is the response payload for thread/unarchive.

type ThreadUnarchivedNotification 

type ThreadUnarchivedNotification = SanitizedThreadUnarchivedNotificationJSON

ThreadUnarchivedNotification is a generated alias for a Codex app-server protocol type.

type ThreadUnsubscribeParams 

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

ThreadUnsubscribeParams represents a generated Codex app-server protocol type.

type ThreadUnsubscribeResponse 

type ThreadUnsubscribeResponse = SanitizedThreadUnsubscribeResponseJSON

ThreadUnsubscribeResponse is a generated alias for a Codex app-server protocol type.

type ThreadUnsubscribeStatus 

type ThreadUnsubscribeStatus string

ThreadUnsubscribeStatus represents a generated Codex app-server protocol type. 

const ThreadUnsubscribeStatusNotLoaded ThreadUnsubscribeStatus = "notLoaded"

ThreadUnsubscribeStatusNotLoaded is a generated Codex app-server protocol constant. 

const ThreadUnsubscribeStatusNotSubscribed ThreadUnsubscribeStatus = "notSubscribed"

ThreadUnsubscribeStatusNotSubscribed is a generated Codex app-server protocol constant. 

const ThreadUnsubscribeStatusUnsubscribed ThreadUnsubscribeStatus = "unsubscribed"

ThreadUnsubscribeStatusUnsubscribed is a generated Codex app-server protocol constant.

type TokenUsageBreakdown 

type TokenUsageBreakdown struct {
	// CacheWriteInputTokens corresponds to the JSON schema field
	// "cacheWriteInputTokens".
	CacheWriteInputTokens int `json:"cacheWriteInputTokens,omitempty,omitzero"`

	// 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"`
}

TokenUsageBreakdown represents a generated Codex app-server protocol type.

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"`
}

Tool represents a generated Codex app-server protocol type. Definition for a tool the client can call.

type ToolDescription added in v0.144.0 

type ToolDescription *string

ToolDescription represents a generated Codex app-server protocol type.

type ToolIcons added in v0.144.0 

type ToolIcons []interface{}

ToolIcons represents a generated Codex app-server protocol type.

type ToolRequestUserInputAnswer 

type ToolRequestUserInputAnswer struct {
	// Answers corresponds to the JSON schema field "answers".
	Answers []string `json:"answers"`
}

ToolRequestUserInputAnswer represents a generated Codex app-server protocol type. 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"`
}

ToolRequestUserInputOption represents a generated Codex app-server protocol type. 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"`
}

ToolRequestUserInputQuestion represents a generated Codex app-server protocol type. EXPERIMENTAL. Represents one request_user_input question and its required options.

type ToolRequestUserInputQuestionOptions added in v0.144.0 

type ToolRequestUserInputQuestionOptions []ToolRequestUserInputOption

ToolRequestUserInputQuestionOptions represents a generated Codex app-server protocol type.

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

ToolTitle represents a generated Codex app-server protocol type.

type Turn added in v0.147.0 

type Turn struct {
	ID          string        `json:"id"`
	Items       []ThreadItem  `json:"items"`
	ItemsView   TurnItemsView `json:"itemsView,omitempty"`
	Status      TurnStatus    `json:"status"`
	Error       *TurnError    `json:"error,omitempty"`
	StartedAt   *int64        `json:"startedAt,omitempty"`
	CompletedAt *int64        `json:"completedAt,omitempty"`
	DurationMs  *int64        `json:"durationMs,omitempty"`
}

Turn is the complete turn summary returned inside thread payloads.

type TurnCompletedNotification 

type TurnCompletedNotification = TurnNotification

TurnCompletedNotification is the payload for turn/completed.

type TurnDiffUpdatedNotification 

type TurnDiffUpdatedNotification = SanitizedTurnDiffUpdatedNotificationJSON

TurnDiffUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`

	// Environment-native runtime workspace roots. Omitted defaults to `cwd`.
	RuntimeWorkspaceRoots *TurnEnvironmentParamsRuntimeWorkspaceRoots `json:"runtimeWorkspaceRoots,omitempty,omitzero"`
}

TurnEnvironmentParams represents a generated Codex app-server protocol type.

type TurnEnvironmentParamsRuntimeWorkspaceRoots added in v0.147.0 

type TurnEnvironmentParamsRuntimeWorkspaceRoots []LegacyAppPathString

TurnEnvironmentParamsRuntimeWorkspaceRoots represents a generated Codex app-server protocol type. Environment-native runtime workspace roots. Omitted defaults to `cwd`.

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 CodexErrorInfo `json:"codexErrorInfo,omitempty,omitzero"`

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

TurnError represents a generated Codex app-server protocol type.

type TurnErrorAdditionalDetails added in v0.144.0 

type TurnErrorAdditionalDetails *string

TurnErrorAdditionalDetails represents a generated Codex app-server protocol type.

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"`
}

TurnInterruptParams represents a generated Codex app-server protocol type.

type TurnInterruptResponse 

type TurnInterruptResponse = SanitizedTurnInterruptResponseJSON

TurnInterruptResponse is a generated alias for a Codex app-server protocol type.

type TurnItemsView added in v0.144.0 

type TurnItemsView string

TurnItemsView describes how much of a turn's item history is present. 

const (
	TurnItemsViewNotLoaded TurnItemsView = "notLoaded"
	TurnItemsViewSummary   TurnItemsView = "summary"
	TurnItemsViewFull      TurnItemsView = "full"
)

type TurnModerationMetadataNotification 

type TurnModerationMetadataNotification = SanitizedTurnModerationMetadataNotificationJSON

TurnModerationMetadataNotification is a generated alias for a Codex app-server protocol type.

type TurnNotification 

type TurnNotification struct {
	ThreadID string `json:"threadId,omitempty"`
	Turn     *Turn  `json:"turn,omitempty"`
}

TurnNotification describes turn/started and turn/completed notifications.

type TurnNotificationError deprecated 

type TurnNotificationError = TurnError

TurnNotificationError is the former name of TurnError.

Deprecated: use TurnError.

type TurnNotificationTurn deprecated 

type TurnNotificationTurn = Turn

TurnNotificationTurn is the former name of Turn.

Deprecated: use Turn.

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"`
}

TurnPlanStep represents a generated Codex app-server protocol type.

type TurnPlanStepStatus 

type TurnPlanStepStatus string

TurnPlanStepStatus represents a generated Codex app-server protocol type. 

const TurnPlanStepStatusCompleted TurnPlanStepStatus = "completed"

TurnPlanStepStatusCompleted is a generated Codex app-server protocol constant. 

const TurnPlanStepStatusInProgress TurnPlanStepStatus = "inProgress"

TurnPlanStepStatusInProgress is a generated Codex app-server protocol constant. 

const TurnPlanStepStatusPending TurnPlanStepStatus = "pending"

TurnPlanStepStatusPending is a generated Codex app-server protocol constant.

type TurnPlanUpdatedNotification 

type TurnPlanUpdatedNotification = SanitizedTurnPlanUpdatedNotificationJSON

TurnPlanUpdatedNotification is a generated alias for a Codex app-server protocol type.

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"`
	ApprovalsReviewer   *ApprovalsReviewer         `json:"approvalsReviewer,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"`
	Personality         *Personality               `json:"personality,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

TurnStartParamsClientUserMessageID represents a generated Codex app-server protocol type.

type TurnStartParamsCwd added in v0.144.0 

type TurnStartParamsCwd *string

TurnStartParamsCwd represents a generated Codex app-server protocol type. 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

TurnStartParamsModel represents a generated Codex app-server protocol type. Override the model for this turn and subsequent turns.

type TurnStartParamsServiceTier added in v0.144.0 

type TurnStartParamsServiceTier *string

TurnStartParamsServiceTier represents a generated Codex app-server protocol type. Override the service tier for this turn and subsequent turns.

type TurnStartResponse 

type TurnStartResponse struct {
	Turn Turn `json:"turn"`
}

TurnStartResponse is the response payload for turn/start.

type TurnStartedNotification 

type TurnStartedNotification = TurnNotification

TurnStartedNotification is the payload for turn/started.

type TurnStatus added in v0.147.0 

type TurnStatus string

TurnStatus describes the current state of a turn. 

const (
	TurnStatusCompleted   TurnStatus = "completed"
	TurnStatusInterrupted TurnStatus = "interrupted"
	TurnStatusFailed      TurnStatus = "failed"
	TurnStatusInProgress  TurnStatus = "inProgress"
)

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"`
}

TurnSteerParams represents a generated Codex app-server protocol type.

type TurnSteerParamsClientUserMessageID added in v0.144.0 

type TurnSteerParamsClientUserMessageID *string

TurnSteerParamsClientUserMessageID represents a generated Codex app-server protocol type.

type TurnSteerParamsInputElem 

type TurnSteerParamsInputElem = UserInput

TurnSteerParamsInputElem is retained for source compatibility.

type TurnSteerResponse 

type TurnSteerResponse = SanitizedTurnSteerResponseJSON

TurnSteerResponse is a generated alias for a Codex app-server protocol type.

type TurnsPage added in v0.147.0 

type TurnsPage struct {
	Data            []Turn  `json:"data"`
	NextCursor      *string `json:"nextCursor,omitempty"`
	BackwardsCursor *string `json:"backwardsCursor,omitempty"`
}

TurnsPage is a typed page of turns returned while resuming a thread.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type UserInputKind added in v0.145.0 

type UserInputKind string

UserInputKind identifies a known UserInput variant. 

const (
	// UserInputKindAudio is a generated Codex app-server protocol constant.
	UserInputKindAudio UserInputKind = "audio"
	// UserInputKindImage is a generated Codex app-server protocol constant.
	UserInputKindImage UserInputKind = "image"
	// UserInputKindLocalAudio is a generated Codex app-server protocol constant.
	UserInputKindLocalAudio UserInputKind = "localAudio"
	// UserInputKindLocalImage is a generated Codex app-server protocol constant.
	UserInputKindLocalImage UserInputKind = "localImage"
	// UserInputKindMention is a generated Codex app-server protocol constant.
	UserInputKindMention UserInputKind = "mention"
	// UserInputKindSkill is a generated Codex app-server protocol constant.
	UserInputKindSkill UserInputKind = "skill"
	// UserInputKindText is a generated Codex app-server protocol constant.
	UserInputKindText UserInputKind = "text"
)

type WarningNotification 

type WarningNotification = SanitizedWarningNotificationJSON

WarningNotification is a generated alias for a Codex app-server protocol type.

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)

MarshalJSON implements generated Codex app-server protocol behavior.

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

UnmarshalJSON implements generated Codex app-server protocol behavior.

type WebSearchActionKind added in v0.145.0 

type WebSearchActionKind string

WebSearchActionKind identifies a known WebSearchAction variant. 

const (
	// WebSearchActionKindFindInPage is a generated Codex app-server protocol constant.
	WebSearchActionKindFindInPage WebSearchActionKind = "findInPage"
	// WebSearchActionKindOpenPage is a generated Codex app-server protocol constant.
	WebSearchActionKindOpenPage WebSearchActionKind = "openPage"
	// WebSearchActionKindOther is a generated Codex app-server protocol constant.
	WebSearchActionKindOther WebSearchActionKind = "other"
	// WebSearchActionKindSearch is a generated Codex app-server protocol constant.
	WebSearchActionKindSearch WebSearchActionKind = "search"
)

type WebSearchMode 

type WebSearchMode string

WebSearchMode represents a generated Codex app-server protocol type. 

const WebSearchModeCached WebSearchMode = "cached"

WebSearchModeCached is a generated Codex app-server protocol constant. 

const WebSearchModeDisabled WebSearchMode = "disabled"

WebSearchModeDisabled is a generated Codex app-server protocol constant. 

const WebSearchModeIndexed WebSearchMode = "indexed"

WebSearchModeIndexed is a generated Codex app-server protocol constant. 

const WebSearchModeLive WebSearchMode = "live"

WebSearchModeLive is a generated Codex app-server protocol constant.

type WindowsSandboxReadiness 

type WindowsSandboxReadiness string

WindowsSandboxReadiness represents a generated Codex app-server protocol type. 

const WindowsSandboxReadinessNotConfigured WindowsSandboxReadiness = "notConfigured"

WindowsSandboxReadinessNotConfigured is a generated Codex app-server protocol constant. 

const WindowsSandboxReadinessReady WindowsSandboxReadiness = "ready"

WindowsSandboxReadinessReady is a generated Codex app-server protocol constant. 

const WindowsSandboxReadinessUpdateRequired WindowsSandboxReadiness = "updateRequired"

WindowsSandboxReadinessUpdateRequired is a generated Codex app-server protocol constant.

type WindowsSandboxReadinessResponse 

type WindowsSandboxReadinessResponse = SanitizedWindowsSandboxReadinessResponseJSON

WindowsSandboxReadinessResponse is a generated alias for a Codex app-server protocol type.

type WindowsSandboxSetupCompletedNotification 

type WindowsSandboxSetupCompletedNotification = SanitizedWindowsSandboxSetupCompletedNotificationJSON

WindowsSandboxSetupCompletedNotification is a generated alias for a Codex app-server protocol type.

type WindowsSandboxSetupMode 

type WindowsSandboxSetupMode string

WindowsSandboxSetupMode represents a generated Codex app-server protocol type. 

const WindowsSandboxSetupModeElevated WindowsSandboxSetupMode = "elevated"

WindowsSandboxSetupModeElevated is a generated Codex app-server protocol constant. 

const WindowsSandboxSetupModeUnelevated WindowsSandboxSetupMode = "unelevated"

WindowsSandboxSetupModeUnelevated is a generated Codex app-server protocol constant.

type WindowsSandboxSetupStartParams 

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

	// Mode corresponds to the JSON schema field "mode".
	Mode WindowsSandboxSetupMode `json:"mode"`
}

WindowsSandboxSetupStartParams represents a generated Codex app-server protocol type.

type WindowsSandboxSetupStartResponse 

type WindowsSandboxSetupStartResponse = SanitizedWindowsSandboxSetupStartResponseJSON

WindowsSandboxSetupStartResponse is a generated alias for a Codex app-server protocol type.

type WindowsWorldWritableWarningNotification 

type WindowsWorldWritableWarningNotification = SanitizedWindowsWorldWritableWarningNotificationJSON

WindowsWorldWritableWarningNotification is a generated alias for a Codex app-server protocol type.

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"`
}

WorkspaceMessage represents a generated Codex app-server protocol type.

type WorkspaceMessageArchivedAt added in v0.144.0 

type WorkspaceMessageArchivedAt *int

WorkspaceMessageArchivedAt represents a generated Codex app-server protocol type. Unix timestamp (in seconds) when the message was archived.

type WorkspaceMessageCreatedAt added in v0.144.0 

type WorkspaceMessageCreatedAt *int

WorkspaceMessageCreatedAt represents a generated Codex app-server protocol type. Unix timestamp (in seconds) when the message was created.

type WorkspaceMessageType 

type WorkspaceMessageType string

WorkspaceMessageType represents a generated Codex app-server protocol type. 

const WorkspaceMessageTypeAnnouncement WorkspaceMessageType = "announcement"

WorkspaceMessageTypeAnnouncement is a generated Codex app-server protocol constant. 

const WorkspaceMessageTypeHeadline WorkspaceMessageType = "headline"

WorkspaceMessageTypeHeadline is a generated Codex app-server protocol constant. 

const WorkspaceMessageTypeUnknown WorkspaceMessageType = "unknown"

WorkspaceMessageTypeUnknown is a generated Codex app-server protocol constant.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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