protocol

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(value any) (Account, error)

func (value Account) IsKnown() bool

func (value Account) Kind() AccountKind

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

func (value Account) RawJSON() json.RawMessage

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

type AccountKind ¶ added in v0.145.0

type AccountKind string

AccountKind identifies a known Account variant.

const (
	// AccountKindAmazonBedrock 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"

const AddCreditsNudgeCreditTypeUsageLimit AddCreditsNudgeCreditType = "usage_limit"

type AddCreditsNudgeEmailStatus ¶

type AddCreditsNudgeEmailStatus string

AddCreditsNudgeEmailStatus represents a generated Codex app-server protocol type.

const AddCreditsNudgeEmailStatusCooldownActive AddCreditsNudgeEmailStatus = "cooldown_active"

const AddCreditsNudgeEmailStatusSent AddCreditsNudgeEmailStatus = "sent"

type AdditionalContextEntry ¶

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

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

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"

const AdditionalContextKindUntrusted AdditionalContextKind = "untrusted"

type AdditionalFileSystemPermissions ¶

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

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

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

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

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(value any) (AgentMessageInputContent, error)

func (value AgentMessageInputContent) IsKnown() bool

func (value AgentMessageInputContent) Kind() AgentMessageInputContentKind

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

func (value AgentMessageInputContent) RawJSON() json.RawMessage

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

type AgentMessageInputContentKind ¶ added in v0.145.0

type AgentMessageInputContentKind string

AgentMessageInputContentKind identifies a known AgentMessageInputContent variant.

const (
	// AgentMessageInputContentKindEncryptedContent 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 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"

const ApprovalsReviewerGuardianSubagent ApprovalsReviewer = "guardian_subagent"

const ApprovalsReviewerUser ApprovalsReviewer = "user"

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"

const CancelLoginAccountStatusNotFound CancelLoginAccountStatus = "notFound"

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(value any) (ClientRequest, error)

func (value ClientRequest) IsKnown() bool

func (value ClientRequest) Kind() ClientRequestKind

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

func (value ClientRequest) RawJSON() json.RawMessage

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

type ClientRequestKind ¶ added in v0.145.0

type ClientRequestKind string

ClientRequestKind identifies a known ClientRequest variant.

const (
	// ClientRequestKindAccountLoginCancel 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"

const CodexResponseHandoffModeCommentary CodexResponseHandoffMode = "commentary"

const CodexResponseHandoffModeThinking CodexResponseHandoffMode = "thinking"

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(value any) (CommandAction, error)

func (value CommandAction) IsKnown() bool

func (value CommandAction) Kind() CommandActionKind

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

func (value CommandAction) RawJSON() json.RawMessage

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

type CommandActionKind ¶ added in v0.145.0

type CommandActionKind string

CommandActionKind identifies a known CommandAction variant.

const (
	// CommandActionKindListFiles 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(value any) CommandExecutionApprovalDecision

func NewCommandExecutionApprovalDecision(value any) (CommandExecutionApprovalDecision, error)

func (d CommandExecutionApprovalDecision) IsKnown() bool

func (d CommandExecutionApprovalDecision) Kind() CommandExecutionApprovalDecisionKind

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

func (d CommandExecutionApprovalDecision) RawJSON() json.RawMessage

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(value any) (ConfigLayerSource, error)

func (value ConfigLayerSource) IsKnown() bool

func (value ConfigLayerSource) Kind() ConfigLayerSourceKind

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

func (value ConfigLayerSource) RawJSON() json.RawMessage

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

type ConfigLayerSourceKind ¶ added in v0.145.0

type ConfigLayerSourceKind string

ConfigLayerSourceKind identifies a known ConfigLayerSource variant.

const (
	// ConfigLayerSourceKindEnterpriseManaged 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(value any) (ConfiguredHookHandler, error)

func (value ConfiguredHookHandler) IsKnown() bool

func (value ConfiguredHookHandler) Kind() ConfiguredHookHandlerKind

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

func (value ConfiguredHookHandler) RawJSON() json.RawMessage

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

type ConfiguredHookHandlerKind ¶ added in v0.145.0

type ConfiguredHookHandlerKind string

ConfiguredHookHandlerKind identifies a known ConfiguredHookHandler variant.

const (
	// ConfiguredHookHandlerKindAgent 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(value any) (ContentItem, error)

func (value ContentItem) IsKnown() bool

func (value ContentItem) Kind() ContentItemKind

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

func (value ContentItem) RawJSON() json.RawMessage

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

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"

const ConversationTextRoleDeveloper ConversationTextRole = "developer"

const ConversationTextRoleUser ConversationTextRole = "user"

type CreditsSnapshot ¶

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

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

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

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"

type DynamicToolCallOutputContentItem ¶

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

DynamicToolCallOutputContentItem preserves the complete JSON payload for a discriminated union.

func NewDynamicToolCallOutputContentItem(value any) (DynamicToolCallOutputContentItem, error)

func (value DynamicToolCallOutputContentItem) IsKnown() bool

func (value DynamicToolCallOutputContentItem) Kind() DynamicToolCallOutputContentItemKind

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

func (value DynamicToolCallOutputContentItem) RawJSON() json.RawMessage

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

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(value any) (DynamicToolSpec, error)

func (value DynamicToolSpec) IsKnown() bool

func (value DynamicToolSpec) Kind() DynamicToolSpecKind

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

func (value DynamicToolSpec) RawJSON() json.RawMessage

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

type DynamicToolSpecKind ¶ added in v0.145.0

type DynamicToolSpecKind string

DynamicToolSpecKind identifies a known DynamicToolSpec variant.

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