Documentation
¶
Index ¶
- Constants
- type AbsolutePathBuf
- type Account
- type AccountLoginCompletedNotification
- type AccountRateLimitsUpdatedNotification
- type AccountTokenUsageDailyBucket
- type AccountTokenUsageSummary
- type AccountUpdatedNotification
- type AddCreditsNudgeCreditType
- type AddCreditsNudgeEmailStatus
- type AdditionalContextEntry
- type AdditionalContextKind
- type AdditionalFileSystemPermissions
- type AdditionalNetworkPermissions
- type AgentMessageDeltaNotification
- type AgentMessageInputContent
- type AmazonBedrockCredentialSource
- type AppBranding
- type AppInfo
- type AppListUpdatedNotification
- type AppMetadata
- type AppReview
- type AppScreenshot
- type AppSummary
- type ApplyPatchApprovalParams
- type ApplyPatchApprovalResponse
- type ApprovalsReviewer
- type AppsListParams
- type AppsListResponse
- type AskForApproval
- type AttestationGenerateParams
- type AttestationGenerateResponse
- type AuthMode
- type ByteRange
- type CancelLoginAccountParams
- type CancelLoginAccountResponse
- type CancelLoginAccountStatus
- type CapabilityRootLocation
- type ChatgptAuthTokensRefreshParams
- type ChatgptAuthTokensRefreshReason
- type ChatgptAuthTokensRefreshResponse
- type ClientInfo
- type ClientNotification
- type ClientRequest
- type CodexAppServerProtocolV2
- type CodexErrorInfo
- type CollaborationMode
- type CommandExecOutputDeltaNotification
- type CommandExecOutputStream
- type CommandExecParams
- type CommandExecResizeParams
- type CommandExecResizeParamsSize
- type CommandExecResizeResponse
- type CommandExecResponse
- type CommandExecTerminalSize
- type CommandExecTerminateParams
- type CommandExecTerminateResponse
- type CommandExecWriteParams
- type CommandExecWriteResponse
- type CommandExecutionApprovalDecision
- type CommandExecutionOutputDeltaNotification
- type CommandExecutionRequestApprovalParams
- type CommandExecutionRequestApprovalResponse
- type CommandMigration
- type ComputerUseRequirements
- type ConfigBatchWriteParams
- type ConfigEdit
- type ConfigReadParams
- type ConfigReadResponse
- type ConfigRequirements
- type ConfigRequirementsAllowedApprovalPoliciesElem
- type ConfigRequirementsReadResponse
- type ConfigValueWriteParams
- type ConfigWarningNotification
- type ConfigWriteResponse
- type ConfiguredHookHandler
- type ConfiguredHookMatcherGroup
- type ConfiguredHookMatcherGroupHooksElem
- type ConsumeAccountRateLimitResetCreditOutcome
- type ConsumeAccountRateLimitResetCreditParams
- type ConsumeAccountRateLimitResetCreditResponse
- type ContentItem
- type ContextCompactedNotification
- type ConversationTextRole
- type CreditsSnapshot
- type DeprecationNoticeNotification
- type DynamicToolCallOutputContentItem
- type DynamicToolCallParams
- type DynamicToolCallResponse
- type DynamicToolNamespaceTool
- type DynamicToolSpec
- type ErrorNotification
- type ExecCommandApprovalParams
- type ExecCommandApprovalResponse
- type ExperimentalFeatureEnablementSetParams
- type ExperimentalFeatureEnablementSetResponse
- type ExperimentalFeatureListParams
- type ExperimentalFeatureListResponse
- type ExternalAgentConfigDetectParams
- type ExternalAgentConfigDetectResponse
- type ExternalAgentConfigImportCompletedNotification
- type ExternalAgentConfigImportHistoriesReadResponse
- type ExternalAgentConfigImportHistory
- type ExternalAgentConfigImportItemTypeFailure
- type ExternalAgentConfigImportItemTypeSuccess
- type ExternalAgentConfigImportParams
- type ExternalAgentConfigImportProgressNotification
- type ExternalAgentConfigImportResponse
- type ExternalAgentConfigImportTypeResult
- type ExternalAgentConfigMigrationItem
- type ExternalAgentConfigMigrationItemType
- type FeedbackUploadParams
- type FeedbackUploadResponse
- type FileChange
- type FileChangeApprovalDecision
- type FileChangeOutputDeltaNotification
- type FileChangePatchUpdatedNotification
- type FileChangeRequestApprovalParams
- type FileChangeRequestApprovalResponse
- type FileSystemAccessMode
- type FileSystemPath
- type FileSystemSandboxEntry
- type FileSystemSandboxEntryPath
- type FileSystemSpecialPath
- type FileUpdateChange
- type FileUpdateChangeKind
- type FsChangedNotification
- type FsCopyParams
- type FsCopyResponse
- type FsCreateDirectoryParams
- type FsCreateDirectoryResponse
- type FsGetMetadataParams
- type FsGetMetadataResponse
- type FsReadDirectoryEntry
- type FsReadDirectoryParams
- type FsReadDirectoryResponse
- type FsReadFileParams
- type FsReadFileResponse
- type FsRemoveParams
- type FsRemoveResponse
- type FsUnwatchParams
- type FsUnwatchResponse
- type FsWatchParams
- type FsWatchResponse
- type FsWriteFileParams
- type FsWriteFileResponse
- type FunctionCallOutputBody
- type FunctionCallOutputContentItem
- type FuzzyFileSearchMatchType
- type FuzzyFileSearchParams
- type FuzzyFileSearchResponse
- type FuzzyFileSearchResult
- type FuzzyFileSearchSessionCompletedNotification
- type FuzzyFileSearchSessionUpdatedNotification
- type GetAccountParams
- type GetAccountRateLimitsResponse
- type GetAccountResponse
- type GetAccountTokenUsageResponse
- type GetWorkspaceMessagesResponse
- type GrantedPermissionProfile
- type GuardianWarningNotification
- type HookCompletedNotification
- type HookMigration
- type HookStartedNotification
- type HooksListParams
- type HooksListResponse
- type ImageDetail
- type InitializeCapabilities
- type InitializeParams
- type InitializeResponse
- type InputModality
- type InternalChatMessageMetadataPassthrough
- type ItemCompletedNotification
- type ItemGuardianApprovalReviewCompletedNotification
- type ItemGuardianApprovalReviewStartedNotification
- type ItemStartedNotification
- type LegacyAppPathString
- type ListMCPServerStatusParams
- type ListMcpServerStatusParams
- type ListMcpServerStatusResponse
- type LocalShellAction
- type LocalShellStatus
- type LoginAccountParams
- type LoginAccountResponse
- type LogoutAccountResponse
- type MCPAuthStatus
- type MCPElicitationArrayType
- type MCPElicitationBooleanSchema
- type MCPElicitationBooleanType
- type MCPElicitationConstOption
- type MCPElicitationEnumSchema
- type MCPElicitationLegacyTitledEnumSchema
- type MCPElicitationMultiSelectEnumSchema
- type MCPElicitationNumberSchema
- type MCPElicitationNumberType
- type MCPElicitationObjectType
- type MCPElicitationPrimitiveSchema
- type MCPElicitationSchema
- type MCPElicitationSingleSelectEnumSchema
- type MCPElicitationStringFormat
- type MCPElicitationStringSchema
- type MCPElicitationStringType
- type MCPResourceReadParams
- type MCPServerElicitationAction
- type MCPServerInfo
- type MCPServerMigration
- type MCPServerOauthLoginParams
- type MCPServerStartupFailureReason
- type MCPServerStartupState
- type MCPServerStatus
- type MCPServerStatusDetail
- type MCPServerToolCallParams
- type ManagedHooksRequirements
- type MarketplaceAddParams
- type MarketplaceAddResponse
- type MarketplaceRemoveParams
- type MarketplaceRemoveResponse
- type MarketplaceUpgradeParams
- type MarketplaceUpgradeResponse
- type McpResourceReadParams
- type McpResourceReadResponse
- type McpServerElicitationRequestParams
- type McpServerElicitationRequestResponse
- type McpServerOauthLoginCompletedNotification
- type McpServerOauthLoginParams
- type McpServerOauthLoginResponse
- type McpServerRefreshResponse
- type McpServerStatusUpdatedNotification
- type McpServerToolCallParams
- type McpServerToolCallResponse
- type McpToolCallProgressNotification
- type MergeStrategy
- type MessagePhase
- type MigrationDetails
- type ModeKind
- type Model
- type ModelAvailabilityNux
- type ModelInputModalitiesElem
- type ModelListParams
- type ModelListResponse
- type ModelProviderCapabilitiesReadParams
- type ModelProviderCapabilitiesReadResponse
- type ModelRerouteReason
- type ModelReroutedNotification
- type ModelSafetyBufferingUpdatedNotification
- type ModelServiceTier
- type ModelUpgradeInfo
- type ModelVerification
- type ModelVerificationNotification
- type ModelsRequirements
- type MultiAgentMode
- type NetworkAccess
- type NetworkDomainPermission
- type NetworkPolicyAmendment
- type NetworkPolicyRuleAction
- type NetworkRequirements
- type NetworkUnixSocketPermission
- type NewThreadModelDefaults
- type NonSteerableTurnKind
- type ParsedCommand
- type PatchChangeKind
- type PermissionGrantScope
- type PermissionProfileListParams
- type PermissionProfileListResponse
- type PermissionProfileSummary
- type PermissionsRequestApprovalParams
- type PermissionsRequestApprovalResponse
- type Personality
- type PlanDeltaNotification
- type PlanType
- type PluginAuthPolicy
- type PluginInstallParams
- type PluginInstallResponse
- type PluginInstalledParams
- type PluginInstalledResponse
- type PluginListMarketplaceKind
- type PluginListParams
- type PluginListResponse
- type PluginReadParams
- type PluginReadResponse
- type PluginShareCheckoutParams
- type PluginShareCheckoutResponse
- type PluginShareDeleteParams
- type PluginShareDeleteResponse
- type PluginShareDiscoverability
- type PluginShareListParams
- type PluginShareListResponse
- type PluginSharePrincipal
- type PluginSharePrincipalRole
- type PluginSharePrincipalType
- type PluginShareSaveParams
- type PluginShareSaveResponse
- type PluginShareTarget
- type PluginShareTargetRole
- type PluginShareUpdateDiscoverability
- type PluginShareUpdateTargetsParams
- type PluginShareUpdateTargetsResponse
- type PluginSkillReadParams
- type PluginSkillReadResponse
- type PluginUninstallParams
- type PluginUninstallResponse
- type PluginsMigration
- type ProcessExitedNotification
- type ProcessOutputDeltaNotification
- type ProcessOutputStream
- type ProcessTerminalSize
- type RateLimitReachedType
- type RateLimitResetCredit
- type RateLimitResetCreditStatus
- type RateLimitResetCreditsSummary
- type RateLimitResetType
- type RateLimitSnapshot
- type RateLimitWindow
- type RawResponseItemCompletedNotification
- type RealtimeConversationVersion
- type RealtimeOutputModality
- type RealtimeVoice
- type ReasoningEffort
- type ReasoningEffortOption
- type ReasoningItemContent
- type ReasoningItemReasoningSummary
- type ReasoningSummary
- type ReasoningSummaryPartAddedNotification
- type ReasoningSummaryTextDeltaNotification
- type ReasoningTextDeltaNotification
- type RemoteControlConnectionStatus
- type RemoteControlDisableParams
- type RemoteControlEnableParams
- type RemoteControlStatusChangedNotification
- type RequestID
- type ResidencyRequirement
- type Resource
- type ResourceContent
- type ResourceTemplate
- type ResponseItem
- type ResponsesApiWebSearchAction
- type ReviewDecision
- type ReviewDelivery
- type ReviewStartParams
- type ReviewStartParamsTarget
- type ReviewStartResponse
- type ReviewTarget
- type SandboxMode
- type SandboxPolicy
- type SanitizedAccountLoginCompletedNotification
- type SanitizedAccountLoginCompletedNotificationJSON
- type SanitizedAccountRateLimitsUpdatedNotification
- type SanitizedAccountRateLimitsUpdatedNotificationJSON
- type SanitizedAccountUpdatedNotification
- type SanitizedAccountUpdatedNotificationJSON
- type SanitizedAgentMessageDeltaNotification
- type SanitizedAgentMessageDeltaNotificationJSON
- type SanitizedAppListUpdatedNotification
- type SanitizedAppListUpdatedNotificationJSON
- type SanitizedApplyPatchApprovalParams
- type SanitizedApplyPatchApprovalParamsJSON
- type SanitizedApplyPatchApprovalResponse
- type SanitizedApplyPatchApprovalResponseJSON
- type SanitizedApplyPatchApprovalResponseJSONDecision
- type SanitizedAppsListParams
- type SanitizedAppsListParamsJSON
- type SanitizedAppsListResponse
- type SanitizedAppsListResponseJSON
- type SanitizedAttestationGenerateResponse
- type SanitizedAttestationGenerateResponseJSON
- type SanitizedCancelLoginAccountParams
- type SanitizedCancelLoginAccountParamsJSON
- type SanitizedCancelLoginAccountResponse
- type SanitizedCancelLoginAccountResponseJSON
- type SanitizedChatgptAuthTokensRefreshParams
- type SanitizedChatgptAuthTokensRefreshParamsJSON
- type SanitizedChatgptAuthTokensRefreshParamsJSONReason
- type SanitizedChatgptAuthTokensRefreshResponse
- type SanitizedChatgptAuthTokensRefreshResponseJSON
- type SanitizedCommandExecResponse
- type SanitizedCommandExecResponseJSON
- type SanitizedCommandExecTerminateParams
- type SanitizedCommandExecTerminateParamsJSON
- type SanitizedCommandExecWriteParams
- type SanitizedCommandExecWriteParamsJSON
- type SanitizedCommandExecutionOutputDeltaNotification
- type SanitizedCommandExecutionOutputDeltaNotificationJSON
- type SanitizedCommandExecutionRequestApprovalResponse
- type SanitizedCommandExecutionRequestApprovalResponseJSON
- type SanitizedCommandExecutionRequestApprovalResponseJSONDecision
- type SanitizedConfigBatchWriteParams
- type SanitizedConfigBatchWriteParamsJSON
- type SanitizedConfigReadParams
- type SanitizedConfigReadParamsJSON
- type SanitizedConfigRequirementsReadResponse
- type SanitizedConfigRequirementsReadResponseJSON
- type SanitizedConfigValueWriteParams
- type SanitizedConfigValueWriteParamsJSON
- type SanitizedConfigWarningNotification
- type SanitizedConfigWarningNotificationJSON
- type SanitizedConsumeAccountRateLimitResetCreditParams
- type SanitizedConsumeAccountRateLimitResetCreditParamsJSON
- type SanitizedConsumeAccountRateLimitResetCreditResponse
- type SanitizedConsumeAccountRateLimitResetCreditResponseJSON
- type SanitizedConsumeAccountRateLimitResetCreditResponseJSONOutcome
- type SanitizedContextCompactedNotification
- type SanitizedContextCompactedNotificationJSONdeprecated
- type SanitizedDeprecationNoticeNotification
- type SanitizedDeprecationNoticeNotificationJSON
- type SanitizedDynamicToolCallParams
- type SanitizedDynamicToolCallParamsJSON
- type SanitizedDynamicToolCallResponse
- type SanitizedDynamicToolCallResponseJSON
- type SanitizedDynamicToolCallResponseJSONContentItemsElem
- type SanitizedErrorNotification
- type SanitizedErrorNotificationJSON
- type SanitizedExecCommandApprovalParams
- type SanitizedExecCommandApprovalParamsJSON
- type SanitizedExecCommandApprovalParamsJSONParsedCmdElem
- type SanitizedExecCommandApprovalResponse
- type SanitizedExecCommandApprovalResponseJSON
- type SanitizedExecCommandApprovalResponseJSONDecision
- type SanitizedExperimentalFeatureEnablementSetParams
- type SanitizedExperimentalFeatureEnablementSetParamsJSON
- type SanitizedExperimentalFeatureEnablementSetResponse
- type SanitizedExperimentalFeatureEnablementSetResponseJSON
- type SanitizedExperimentalFeatureListParams
- type SanitizedExperimentalFeatureListParamsJSON
- type SanitizedExternalAgentConfigDetectParams
- type SanitizedExternalAgentConfigDetectParamsJSON
- type SanitizedExternalAgentConfigDetectResponse
- type SanitizedExternalAgentConfigDetectResponseJSON
- type SanitizedExternalAgentConfigImportCompletedNotification
- type SanitizedExternalAgentConfigImportCompletedNotificationJSON
- type SanitizedExternalAgentConfigImportHistoriesReadResponse
- type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON
- type SanitizedExternalAgentConfigImportParams
- type SanitizedExternalAgentConfigImportParamsJSON
- type SanitizedExternalAgentConfigImportProgressNotification
- type SanitizedExternalAgentConfigImportProgressNotificationJSON
- type SanitizedExternalAgentConfigImportResponse
- type SanitizedExternalAgentConfigImportResponseJSON
- type SanitizedFeedbackUploadParams
- type SanitizedFeedbackUploadParamsJSON
- type SanitizedFeedbackUploadResponse
- type SanitizedFeedbackUploadResponseJSON
- type SanitizedFileChangeOutputDeltaNotification
- type SanitizedFileChangeOutputDeltaNotificationJSON
- type SanitizedFileChangePatchUpdatedNotification
- type SanitizedFileChangePatchUpdatedNotificationJSON
- type SanitizedFileChangeRequestApprovalParams
- type SanitizedFileChangeRequestApprovalParamsJSON
- type SanitizedFileChangeRequestApprovalResponse
- type SanitizedFileChangeRequestApprovalResponseJSON
- type SanitizedFileChangeRequestApprovalResponseJSONDecision
- type SanitizedFsGetMetadataResponse
- type SanitizedFsGetMetadataResponseJSON
- type SanitizedFsReadDirectoryResponse
- type SanitizedFsReadDirectoryResponseJSON
- type SanitizedFsReadFileResponse
- type SanitizedFsReadFileResponseJSON
- type SanitizedFsUnwatchParams
- type SanitizedFsUnwatchParamsJSON
- type SanitizedFuzzyFileSearchParams
- type SanitizedFuzzyFileSearchParamsJSON
- type SanitizedFuzzyFileSearchResponse
- type SanitizedFuzzyFileSearchResponseJSON
- type SanitizedFuzzyFileSearchSessionCompletedNotification
- type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON
- type SanitizedFuzzyFileSearchSessionUpdatedNotification
- type SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON
- type SanitizedGetAccountParams
- type SanitizedGetAccountParamsJSON
- type SanitizedGetAccountRateLimitsResponseJSONRateLimits
- type SanitizedGetAccountResponse
- type SanitizedGetAccountResponseJSON
- type SanitizedGetAccountTokenUsageResponse
- type SanitizedGetAccountTokenUsageResponseJSON
- type SanitizedGetWorkspaceMessagesResponse
- type SanitizedGetWorkspaceMessagesResponseJSON
- type SanitizedGuardianWarningNotification
- type SanitizedGuardianWarningNotificationJSON
- type SanitizedHooksListParams
- type SanitizedHooksListParamsJSON
- type SanitizedInitializeParams
- type SanitizedInitializeParamsJSON
- type SanitizedListMCPServerStatusParams
- type SanitizedListMCPServerStatusParamsJSON
- type SanitizedListMCPServerStatusResponse
- type SanitizedListMCPServerStatusResponseJSON
- type SanitizedMCPResourceReadParams
- type SanitizedMCPResourceReadParamsJSON
- type SanitizedMCPResourceReadResponse
- type SanitizedMCPResourceReadResponseJSON
- type SanitizedMCPResourceReadResponseJSONContentsElem
- type SanitizedMCPServerElicitationRequestResponse
- type SanitizedMCPServerElicitationRequestResponseJSON
- type SanitizedMCPServerOauthLoginCompletedNotification
- type SanitizedMCPServerOauthLoginCompletedNotificationJSON
- type SanitizedMCPServerOauthLoginParams
- type SanitizedMCPServerOauthLoginParamsJSON
- type SanitizedMCPServerOauthLoginResponse
- type SanitizedMCPServerOauthLoginResponseJSON
- type SanitizedMCPServerStatusUpdatedNotification
- type SanitizedMCPServerStatusUpdatedNotificationJSON
- type SanitizedMCPServerToolCallParams
- type SanitizedMCPServerToolCallParamsJSON
- type SanitizedMCPServerToolCallResponse
- type SanitizedMCPServerToolCallResponseJSON
- type SanitizedMCPToolCallProgressNotification
- type SanitizedMCPToolCallProgressNotificationJSON
- type SanitizedMarketplaceAddParams
- type SanitizedMarketplaceAddParamsJSON
- type SanitizedMarketplaceRemoveParams
- type SanitizedMarketplaceRemoveParamsJSON
- type SanitizedMarketplaceUpgradeParams
- type SanitizedMarketplaceUpgradeParamsJSON
- type SanitizedModelListParams
- type SanitizedModelListParamsJSON
- type SanitizedModelListResponse
- type SanitizedModelListResponseJSON
- type SanitizedModelProviderCapabilitiesReadResponse
- type SanitizedModelProviderCapabilitiesReadResponseJSON
- type SanitizedModelReroutedNotification
- type SanitizedModelReroutedNotificationJSON
- type SanitizedModelSafetyBufferingUpdatedNotification
- type SanitizedModelSafetyBufferingUpdatedNotificationJSON
- type SanitizedModelVerificationNotification
- type SanitizedModelVerificationNotificationJSON
- type SanitizedPermissionProfileListParams
- type SanitizedPermissionProfileListParamsJSON
- type SanitizedPermissionProfileListResponse
- type SanitizedPermissionProfileListResponseJSON
- type SanitizedPermissionsRequestApprovalResponse
- type SanitizedPermissionsRequestApprovalResponseJSON
- type SanitizedPlanDeltaNotification
- type SanitizedPlanDeltaNotificationJSON
- type SanitizedPluginInstallResponse
- type SanitizedPluginInstallResponseJSON
- type SanitizedPluginShareCheckoutParams
- type SanitizedPluginShareCheckoutParamsJSON
- type SanitizedPluginShareDeleteParams
- type SanitizedPluginShareDeleteParamsJSON
- type SanitizedPluginShareSaveResponse
- type SanitizedPluginShareSaveResponseJSON
- type SanitizedPluginShareUpdateTargetsParams
- type SanitizedPluginShareUpdateTargetsParamsJSON
- type SanitizedPluginShareUpdateTargetsResponse
- type SanitizedPluginShareUpdateTargetsResponseJSON
- type SanitizedPluginSkillReadParams
- type SanitizedPluginSkillReadParamsJSON
- type SanitizedPluginSkillReadResponse
- type SanitizedPluginSkillReadResponseJSON
- type SanitizedPluginUninstallParams
- type SanitizedPluginUninstallParamsJSON
- type SanitizedProcessExitedNotification
- type SanitizedProcessExitedNotificationJSON
- type SanitizedRawResponseItemCompletedNotification
- type SanitizedRawResponseItemCompletedNotificationJSON
- type SanitizedRawResponseItemCompletedNotificationJSONItem
- type SanitizedReasoningSummaryPartAddedNotification
- type SanitizedReasoningSummaryPartAddedNotificationJSON
- type SanitizedReasoningSummaryTextDeltaNotification
- type SanitizedReasoningSummaryTextDeltaNotificationJSON
- type SanitizedReasoningTextDeltaNotification
- type SanitizedReasoningTextDeltaNotificationJSON
- type SanitizedRemoteControlStatusChangedNotification
- type SanitizedRemoteControlStatusChangedNotificationJSON
- type SanitizedReviewStartParams
- type SanitizedReviewStartParamsJSON
- type SanitizedReviewStartParamsJSONTarget
- type SanitizedSendAddCreditsNudgeEmailParams
- type SanitizedSendAddCreditsNudgeEmailParamsJSON
- type SanitizedSendAddCreditsNudgeEmailResponse
- type SanitizedSendAddCreditsNudgeEmailResponseJSON
- type SanitizedServerRequestResolvedNotification
- type SanitizedServerRequestResolvedNotificationJSON
- type SanitizedServerRequestResolvedNotificationJSONRequestID
- type SanitizedSkillsConfigWriteResponse
- type SanitizedSkillsConfigWriteResponseJSON
- type SanitizedSkillsListParams
- type SanitizedSkillsListParamsJSON
- type SanitizedTerminalInteractionNotification
- type SanitizedTerminalInteractionNotificationJSON
- type SanitizedThreadApproveGuardianDeniedActionParams
- type SanitizedThreadApproveGuardianDeniedActionParamsJSON
- type SanitizedThreadArchiveParams
- type SanitizedThreadArchiveParamsJSON
- type SanitizedThreadArchivedNotification
- type SanitizedThreadArchivedNotificationJSON
- type SanitizedThreadClosedNotification
- type SanitizedThreadClosedNotificationJSON
- type SanitizedThreadCompactStartParams
- type SanitizedThreadCompactStartParamsJSON
- type SanitizedThreadDeleteParams
- type SanitizedThreadDeleteParamsJSON
- type SanitizedThreadDeletedNotification
- type SanitizedThreadDeletedNotificationJSON
- type SanitizedThreadGoalClearParams
- type SanitizedThreadGoalClearParamsJSON
- type SanitizedThreadGoalClearResponse
- type SanitizedThreadGoalClearResponseJSON
- type SanitizedThreadGoalClearedNotification
- type SanitizedThreadGoalClearedNotificationJSON
- type SanitizedThreadGoalGetParams
- type SanitizedThreadGoalGetParamsJSON
- type SanitizedThreadGoalGetResponse
- type SanitizedThreadGoalGetResponseJSON
- type SanitizedThreadGoalSetParams
- type SanitizedThreadGoalSetParamsJSON
- type SanitizedThreadGoalSetResponse
- type SanitizedThreadGoalSetResponseJSON
- type SanitizedThreadGoalUpdatedNotification
- type SanitizedThreadGoalUpdatedNotificationJSON
- type SanitizedThreadInjectItemsParams
- type SanitizedThreadInjectItemsParamsJSON
- type SanitizedThreadListParams
- type SanitizedThreadListParamsJSON
- type SanitizedThreadLoadedListParams
- type SanitizedThreadLoadedListParamsJSON
- type SanitizedThreadLoadedListResponse
- type SanitizedThreadLoadedListResponseJSON
- type SanitizedThreadMetadataUpdateParams
- type SanitizedThreadMetadataUpdateParamsJSON
- type SanitizedThreadNameUpdatedNotification
- type SanitizedThreadNameUpdatedNotificationJSON
- type SanitizedThreadReadParams
- type SanitizedThreadReadParamsJSON
- type SanitizedThreadRealtimeClosedNotification
- type SanitizedThreadRealtimeClosedNotificationJSON
- type SanitizedThreadRealtimeErrorNotification
- type SanitizedThreadRealtimeErrorNotificationJSON
- type SanitizedThreadRealtimeItemAddedNotification
- type SanitizedThreadRealtimeItemAddedNotificationJSON
- type SanitizedThreadRealtimeOutputAudioDeltaNotification
- type SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON
- type SanitizedThreadRealtimeSdpNotification
- type SanitizedThreadRealtimeSdpNotificationJSON
- type SanitizedThreadRealtimeStartedNotification
- type SanitizedThreadRealtimeStartedNotificationJSON
- type SanitizedThreadRealtimeTranscriptDeltaNotification
- type SanitizedThreadRealtimeTranscriptDeltaNotificationJSON
- type SanitizedThreadRealtimeTranscriptDoneNotification
- type SanitizedThreadRealtimeTranscriptDoneNotificationJSON
- type SanitizedThreadRollbackParams
- type SanitizedThreadRollbackParamsJSON
- type SanitizedThreadSetNameParams
- type SanitizedThreadSetNameParamsJSON
- type SanitizedThreadShellCommandParams
- type SanitizedThreadShellCommandParamsJSON
- type SanitizedThreadStatusChangedNotification
- type SanitizedThreadStatusChangedNotificationJSON
- type SanitizedThreadStatusChangedNotificationJSONStatus
- type SanitizedThreadTokenUsageUpdatedNotification
- type SanitizedThreadTokenUsageUpdatedNotificationJSON
- type SanitizedThreadUnarchiveParams
- type SanitizedThreadUnarchiveParamsJSON
- type SanitizedThreadUnarchivedNotification
- type SanitizedThreadUnarchivedNotificationJSON
- type SanitizedThreadUnsubscribeParams
- type SanitizedThreadUnsubscribeParamsJSON
- type SanitizedThreadUnsubscribeResponse
- type SanitizedThreadUnsubscribeResponseJSON
- type SanitizedToolRequestUserInputParams
- type SanitizedToolRequestUserInputParamsJSON
- type SanitizedToolRequestUserInputResponse
- type SanitizedToolRequestUserInputResponseJSON
- type SanitizedTurnDiffUpdatedNotification
- type SanitizedTurnDiffUpdatedNotificationJSON
- type SanitizedTurnInterruptParams
- type SanitizedTurnInterruptParamsJSON
- type SanitizedTurnModerationMetadataNotification
- type SanitizedTurnModerationMetadataNotificationJSON
- type SanitizedTurnPlanUpdatedNotification
- type SanitizedTurnPlanUpdatedNotificationJSON
- type SanitizedTurnSteerParams
- type SanitizedTurnSteerParamsJSON
- type SanitizedTurnSteerParamsJSONInputElem
- type SanitizedTurnSteerResponse
- type SanitizedTurnSteerResponseJSON
- type SanitizedWarningNotification
- type SanitizedWarningNotificationJSON
- type SanitizedWindowsSandboxReadinessResponse
- type SanitizedWindowsSandboxReadinessResponseJSON
- type SanitizedWindowsSandboxSetupCompletedNotification
- type SanitizedWindowsSandboxSetupCompletedNotificationJSON
- type SanitizedWindowsSandboxSetupStartResponse
- type SanitizedWindowsSandboxSetupStartResponseJSON
- type SanitizedWindowsWorldWritableWarningNotification
- type SanitizedWindowsWorldWritableWarningNotificationJSON
- type SendAddCreditsNudgeEmailParams
- type SendAddCreditsNudgeEmailResponse
- type ServerNotification
- type ServerRequest
- type ServerRequestResolvedNotification
- type SessionMigration
- type Settings
- type SkillMigration
- type SkillsChangedNotification
- type SkillsConfigWriteParams
- type SkillsConfigWriteResponse
- type SkillsExtraRootsSetParams
- type SkillsExtraRootsSetResponse
- type SkillsListParams
- type SkillsListResponse
- type SortDirection
- type SpendControlLimitSnapshot
- type SubagentMigration
- type TerminalInteractionNotification
- type TextElement
- type TextElementByteRange
- type TextPosition
- type TextRange
- type Thread
- type ThreadActiveFlag
- type ThreadApproveGuardianDeniedActionParams
- type ThreadApproveGuardianDeniedActionResponse
- type ThreadArchiveParams
- type ThreadArchiveResponse
- type ThreadArchivedNotification
- type ThreadClosedNotification
- type ThreadCompactStartParams
- type ThreadCompactStartResponse
- type ThreadDeleteParams
- type ThreadDeleteResponse
- type ThreadDeletedNotification
- type ThreadForkParams
- type ThreadForkResponse
- type ThreadGoal
- type ThreadGoalClearParams
- type ThreadGoalClearResponse
- type ThreadGoalClearedNotification
- type ThreadGoalGetParams
- type ThreadGoalGetResponse
- type ThreadGoalSetParams
- type ThreadGoalSetResponse
- type ThreadGoalStatus
- type ThreadGoalUpdatedNotification
- type ThreadID
- type ThreadInjectItemsParams
- type ThreadInjectItemsResponse
- type ThreadListCwdFilter
- type ThreadListParams
- type ThreadListResponse
- type ThreadLoadedListParams
- type ThreadLoadedListResponse
- type ThreadMetadataGitInfoUpdateParams
- type ThreadMetadataUpdateParams
- type ThreadMetadataUpdateResponse
- type ThreadNameUpdatedNotification
- type ThreadReadParams
- type ThreadReadResponse
- type ThreadRealtimeAudioChunk
- type ThreadRealtimeClosedNotification
- type ThreadRealtimeErrorNotification
- type ThreadRealtimeItemAddedNotification
- type ThreadRealtimeOutputAudioDeltaNotification
- type ThreadRealtimeSdpNotification
- type ThreadRealtimeStartedNotification
- type ThreadRealtimeTranscriptDeltaNotification
- type ThreadRealtimeTranscriptDoneNotification
- type ThreadResponse
- type ThreadResumeParams
- type ThreadResumeResponse
- type ThreadRollbackParams
- type ThreadRollbackResponse
- type ThreadSetNameParams
- type ThreadSetNameResponse
- type ThreadSettingsUpdatedNotification
- type ThreadShellCommandParams
- type ThreadShellCommandResponse
- type ThreadSortKey
- type ThreadSourceKind
- type ThreadStartParams
- type ThreadStartResponse
- type ThreadStartedNotification
- type ThreadStatus
- type ThreadStatusChangedNotification
- type ThreadTokenUsage
- type ThreadTokenUsageUpdatedNotification
- type ThreadUnarchiveParams
- type ThreadUnarchiveResponse
- type ThreadUnarchivedNotification
- type ThreadUnsubscribeParams
- type ThreadUnsubscribeResponse
- type ThreadUnsubscribeStatus
- type TokenUsageBreakdown
- type Tool
- type ToolRequestUserInputAnswer
- type ToolRequestUserInputOption
- type ToolRequestUserInputParams
- type ToolRequestUserInputQuestion
- type ToolRequestUserInputResponse
- type TurnCompletedNotification
- type TurnDiffUpdatedNotification
- type TurnError
- type TurnInterruptParams
- type TurnInterruptResponse
- type TurnModerationMetadataNotification
- type TurnNotification
- type TurnNotificationError
- type TurnNotificationTurn
- type TurnPlanStep
- type TurnPlanStepStatus
- type TurnPlanUpdatedNotification
- type TurnStartParams
- type TurnStartParamsInputElem
- type TurnStartResponse
- type TurnStartedNotification
- type TurnSteerParams
- type TurnSteerParamsInputElem
- type TurnSteerResponse
- type UserInput
- type WarningNotification
- type WebSearchMode
- type WindowsSandboxReadiness
- type WindowsSandboxReadinessResponse
- type WindowsSandboxSetupCompletedNotification
- type WindowsSandboxSetupMode
- type WindowsSandboxSetupStartParams
- type WindowsSandboxSetupStartResponse
- type WindowsWorldWritableWarningNotification
- type WorkspaceMessage
- type WorkspaceMessageType
Constants ¶
const GeneratedCodexCommit = "c4d748f586a84a3ed5b6aceb82e9a1db4abb1cda"
GeneratedCodexCommit is the Codex source commit used to generate this protocol package.
const GeneratedCodexVersion = "0.143.0"
GeneratedCodexVersion is the Codex package version used to generate this protocol package.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AbsolutePathBuf ¶
type AbsolutePathBuf string
A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).
IMPORTANT: When deserializing an `AbsolutePathBuf`, a base path must be set using [AbsolutePathBufGuard::new]. If no base path is set, the deserialization will fail unless the path being deserialized is already absolute.
type AccountLoginCompletedNotification ¶
type AccountLoginCompletedNotification = SanitizedAccountLoginCompletedNotificationJSON
Fallback types for schemas that failed to generate.
type AccountRateLimitsUpdatedNotification ¶
type AccountRateLimitsUpdatedNotification = SanitizedAccountRateLimitsUpdatedNotificationJSON
type AccountTokenUsageSummary ¶
type AccountTokenUsageSummary struct {
// CurrentStreakDays corresponds to the JSON schema field "currentStreakDays".
CurrentStreakDays *int `json:"currentStreakDays,omitempty"`
// LifetimeTokens corresponds to the JSON schema field "lifetimeTokens".
LifetimeTokens *int `json:"lifetimeTokens,omitempty"`
// LongestRunningTurnSec corresponds to the JSON schema field
// "longestRunningTurnSec".
LongestRunningTurnSec *int `json:"longestRunningTurnSec,omitempty"`
// LongestStreakDays corresponds to the JSON schema field "longestStreakDays".
LongestStreakDays *int `json:"longestStreakDays,omitempty"`
// PeakDailyTokens corresponds to the JSON schema field "peakDailyTokens".
PeakDailyTokens *int `json:"peakDailyTokens,omitempty"`
}
type AccountUpdatedNotification ¶
type AccountUpdatedNotification = SanitizedAccountUpdatedNotificationJSON
type AddCreditsNudgeCreditType ¶
type AddCreditsNudgeCreditType string
const AddCreditsNudgeCreditTypeCredits AddCreditsNudgeCreditType = "credits"
const AddCreditsNudgeCreditTypeUsageLimit AddCreditsNudgeCreditType = "usage_limit"
type AddCreditsNudgeEmailStatus ¶
type AddCreditsNudgeEmailStatus string
const AddCreditsNudgeEmailStatusCooldownActive AddCreditsNudgeEmailStatus = "cooldown_active"
const AddCreditsNudgeEmailStatusSent AddCreditsNudgeEmailStatus = "sent"
type AdditionalContextEntry ¶
type AdditionalContextEntry struct {
// Kind corresponds to the JSON schema field "kind".
Kind AdditionalContextKind `json:"kind"`
// Value corresponds to the JSON schema field "value".
Value string `json:"value"`
}
type AdditionalContextKind ¶
type AdditionalContextKind string
const AdditionalContextKindApplication AdditionalContextKind = "application"
const AdditionalContextKindUntrusted AdditionalContextKind = "untrusted"
type AdditionalFileSystemPermissions ¶
type AdditionalFileSystemPermissions struct {
// Entries corresponds to the JSON schema field "entries".
Entries []FileSystemSandboxEntry `json:"entries,omitempty"`
// GlobScanMaxDepth corresponds to the JSON schema field "globScanMaxDepth".
GlobScanMaxDepth *int `json:"globScanMaxDepth,omitempty"`
// This will be removed in favor of `entries`.
Read []LegacyAppPathString `json:"read,omitempty"`
// This will be removed in favor of `entries`.
Write []LegacyAppPathString `json:"write,omitempty"`
}
type AdditionalNetworkPermissions ¶
type AdditionalNetworkPermissions struct {
// Enabled corresponds to the JSON schema field "enabled".
Enabled *bool `json:"enabled,omitempty"`
}
type AgentMessageDeltaNotification ¶
type AgentMessageDeltaNotification = SanitizedAgentMessageDeltaNotificationJSON
type AgentMessageInputContent ¶
type AgentMessageInputContent interface{}
type AmazonBedrockCredentialSource ¶
type AmazonBedrockCredentialSource string
const AmazonBedrockCredentialSourceAwsManaged AmazonBedrockCredentialSource = "awsManaged"
const AmazonBedrockCredentialSourceCodexManaged AmazonBedrockCredentialSource = "codexManaged"
type AppBranding ¶
type AppBranding struct {
// Category corresponds to the JSON schema field "category".
Category *string `json:"category,omitempty"`
// Developer corresponds to the JSON schema field "developer".
Developer *string `json:"developer,omitempty"`
// IsDiscoverableApp corresponds to the JSON schema field "isDiscoverableApp".
IsDiscoverableApp bool `json:"isDiscoverableApp"`
// PrivacyPolicy corresponds to the JSON schema field "privacyPolicy".
PrivacyPolicy *string `json:"privacyPolicy,omitempty"`
// TermsOfService corresponds to the JSON schema field "termsOfService".
TermsOfService *string `json:"termsOfService,omitempty"`
// Website corresponds to the JSON schema field "website".
Website *string `json:"website,omitempty"`
}
EXPERIMENTAL - app metadata returned by app-list APIs.
type AppInfo ¶
type AppInfo struct {
// AppMetadata corresponds to the JSON schema field "appMetadata".
AppMetadata interface{} `json:"appMetadata,omitempty"`
// Branding corresponds to the JSON schema field "branding".
Branding interface{} `json:"branding,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// DistributionChannel corresponds to the JSON schema field "distributionChannel".
DistributionChannel *string `json:"distributionChannel,omitempty"`
// IconAssets corresponds to the JSON schema field "iconAssets".
IconAssets *map[string]string `json:"iconAssets,omitempty"`
// IconDarkAssets corresponds to the JSON schema field "iconDarkAssets".
IconDarkAssets *map[string]string `json:"iconDarkAssets,omitempty"`
// ID corresponds to the JSON schema field "id".
ID string `json:"id"`
// InstallURL corresponds to the JSON schema field "installUrl".
InstallURL *string `json:"installUrl,omitempty"`
// IsAccessible corresponds to the JSON schema field "isAccessible".
IsAccessible bool `json:"isAccessible,omitempty"`
// Whether this app is enabled in config.toml. Example: “`toml [apps.bad_app]
// enabled = false “`
IsEnabled bool `json:"isEnabled,omitempty"`
// Labels corresponds to the JSON schema field "labels".
Labels *map[string]string `json:"labels,omitempty"`
// LogoURL corresponds to the JSON schema field "logoUrl".
LogoURL *string `json:"logoUrl,omitempty"`
// LogoURLDark corresponds to the JSON schema field "logoUrlDark".
LogoURLDark *string `json:"logoUrlDark,omitempty"`
// 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"`
}
EXPERIMENTAL - app metadata returned by app-list APIs.
type AppListUpdatedNotification ¶
type AppListUpdatedNotification = SanitizedAppListUpdatedNotificationJSON
type AppMetadata ¶
type AppMetadata struct {
// Categories corresponds to the JSON schema field "categories".
Categories []string `json:"categories,omitempty"`
// Developer corresponds to the JSON schema field "developer".
Developer *string `json:"developer,omitempty"`
// FirstPartyRequiresInstall corresponds to the JSON schema field
// "firstPartyRequiresInstall".
FirstPartyRequiresInstall *bool `json:"firstPartyRequiresInstall,omitempty"`
// FirstPartyType corresponds to the JSON schema field "firstPartyType".
FirstPartyType *string `json:"firstPartyType,omitempty"`
// Review corresponds to the JSON schema field "review".
Review interface{} `json:"review,omitempty"`
// Screenshots corresponds to the JSON schema field "screenshots".
Screenshots []AppScreenshot `json:"screenshots,omitempty"`
// SeoDescription corresponds to the JSON schema field "seoDescription".
SeoDescription *string `json:"seoDescription,omitempty"`
// ShowInComposerWhenUnlinked corresponds to the JSON schema field
// "showInComposerWhenUnlinked".
ShowInComposerWhenUnlinked *bool `json:"showInComposerWhenUnlinked,omitempty"`
// SubCategories corresponds to the JSON schema field "subCategories".
SubCategories []string `json:"subCategories,omitempty"`
// Version corresponds to the JSON schema field "version".
Version *string `json:"version,omitempty"`
// VersionID corresponds to the JSON schema field "versionId".
VersionID *string `json:"versionId,omitempty"`
// VersionNotes corresponds to the JSON schema field "versionNotes".
VersionNotes *string `json:"versionNotes,omitempty"`
}
type AppReview ¶
type AppReview struct {
// Status corresponds to the JSON schema field "status".
Status string `json:"status"`
}
type AppScreenshot ¶
type AppScreenshot struct {
// FileID corresponds to the JSON schema field "fileId".
FileID *string `json:"fileId,omitempty"`
// URL corresponds to the JSON schema field "url".
URL *string `json:"url,omitempty"`
// UserPrompt corresponds to the JSON schema field "userPrompt".
UserPrompt string `json:"userPrompt"`
}
type AppSummary ¶
type AppSummary struct {
// Category corresponds to the JSON schema field "category".
Category *string `json:"category,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// ID corresponds to the JSON schema field "id".
ID string `json:"id"`
// InstallURL corresponds to the JSON schema field "installUrl".
InstallURL *string `json:"installUrl,omitempty"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
}
EXPERIMENTAL - app metadata summary for plugin responses.
type ApplyPatchApprovalParams ¶
type ApplyPatchApprovalParams = SanitizedApplyPatchApprovalParams
ApplyPatchApprovalParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type ApplyPatchApprovalResponse ¶
type ApplyPatchApprovalResponse = SanitizedApplyPatchApprovalResponse
ApplyPatchApprovalResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type ApprovalsReviewer ¶
type ApprovalsReviewer string
const ApprovalsReviewerAutoReview ApprovalsReviewer = "auto_review"
const ApprovalsReviewerGuardianSubagent ApprovalsReviewer = "guardian_subagent"
const ApprovalsReviewerUser ApprovalsReviewer = "user"
type AppsListParams ¶
type AppsListParams struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// When true, bypass app caches and fetch the latest data from sources.
ForceRefetch *bool `json:"forceRefetch,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
// Optional thread id used to evaluate app feature gating from that thread's
// config.
ThreadID *string `json:"threadId,omitempty"`
}
EXPERIMENTAL - list available apps/connectors.
type AppsListResponse ¶
type AppsListResponse = SanitizedAppsListResponseJSON
type AskForApproval ¶
type AskForApproval interface{}
type AttestationGenerateParams ¶
type AttestationGenerateParams interface{}
type AttestationGenerateResponse ¶
type AttestationGenerateResponse = SanitizedAttestationGenerateResponseJSON
type CancelLoginAccountParams ¶
type CancelLoginAccountParams struct {
// LoginID corresponds to the JSON schema field "loginId".
LoginID string `json:"loginId"`
}
type CancelLoginAccountResponse ¶
type CancelLoginAccountResponse = SanitizedCancelLoginAccountResponseJSON
type CancelLoginAccountStatus ¶
type CancelLoginAccountStatus string
const CancelLoginAccountStatusCanceled CancelLoginAccountStatus = "canceled"
const CancelLoginAccountStatusNotFound CancelLoginAccountStatus = "notFound"
type CapabilityRootLocation ¶
type CapabilityRootLocation interface{}
Location used to resolve a selected capability root.
type ChatgptAuthTokensRefreshParams ¶
type ChatgptAuthTokensRefreshParams = SanitizedChatgptAuthTokensRefreshParamsJSON
type ChatgptAuthTokensRefreshReason ¶
type ChatgptAuthTokensRefreshReason interface{}
type ChatgptAuthTokensRefreshResponse ¶
type ChatgptAuthTokensRefreshResponse = SanitizedChatgptAuthTokensRefreshResponseJSON
type ClientInfo ¶
type ClientNotification ¶
type ClientNotification interface{}
type ClientRequest ¶
type ClientRequest interface{}
type CodexAppServerProtocolV2 ¶
type CodexAppServerProtocolV2 interface{}
type CodexErrorInfo ¶
type CodexErrorInfo interface{}
This translation layer make sure that we expose codex error code in camel case.
When an upstream HTTP status is available (for example, from the Responses API or a provider), it is forwarded in `httpStatusCode` on the relevant `codexErrorInfo` variant.
type CollaborationMode ¶
type CollaborationMode struct {
// Mode corresponds to the JSON schema field "mode".
Mode ModeKind `json:"mode"`
// Settings corresponds to the JSON schema field "settings".
Settings Settings `json:"settings"`
}
Collaboration mode for a Codex session.
type CommandExecOutputDeltaNotification ¶
type CommandExecOutputDeltaNotification interface{}
type CommandExecOutputStream ¶
type CommandExecOutputStream interface{}
Stream label for `command/exec/outputDelta` notifications.
type CommandExecParams ¶
type CommandExecParams struct {
// Command argv vector. Empty arrays are rejected.
Command []string `json:"command"`
// Optional working directory. Defaults to the server cwd.
Cwd *string `json:"cwd,omitempty"`
// Disable stdout/stderr capture truncation for this request.
//
// Cannot be combined with `outputBytesCap`.
DisableOutputCap *bool `json:"disableOutputCap,omitempty"`
// Disable the timeout entirely for this request.
//
// Cannot be combined with `timeoutMs`.
DisableTimeout *bool `json:"disableTimeout,omitempty"`
// 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 *map[string]*string `json:"env,omitempty"`
// Optional per-stream stdout/stderr capture cap in bytes.
//
// When omitted, the server default applies. Cannot be combined with
// `disableOutputCap`.
OutputBytesCap *int `json:"outputBytesCap,omitempty"`
// 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 *string `json:"processId,omitempty"`
// Optional sandbox policy for this command.
//
// Uses the same shape as thread/turn execution sandbox configuration and defaults
// to the user's configured policy when omitted. Cannot be combined with
// `permissionProfile`.
SandboxPolicy interface{} `json:"sandboxPolicy,omitempty"`
// Optional initial PTY size in character cells. Only valid when `tty` is true.
Size interface{} `json:"size,omitempty"`
// Allow follow-up `command/exec/write` requests to write stdin bytes.
//
// Requires a client-supplied `processId`.
StreamStdin *bool `json:"streamStdin,omitempty"`
// 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"`
// Optional timeout in milliseconds.
//
// When omitted, the server default applies. Cannot be combined with
// `disableTimeout`.
TimeoutMs *int `json:"timeoutMs,omitempty"`
// Enable PTY mode.
//
// This implies `streamStdin` and `streamStdoutStderr`.
Tty *bool `json:"tty,omitempty"`
}
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 CommandExecResizeParams ¶
type CommandExecResizeParams struct {
// Client-supplied, connection-scoped `processId` from the original `command/exec`
// request.
ProcessID string `json:"processId"`
// New PTY size in character cells.
Size CommandExecResizeParamsSize `json:"size"`
}
Resize a running PTY-backed `command/exec` session.
type CommandExecResizeParamsSize ¶
type CommandExecResizeParamsSize struct {
// Terminal width in character cells.
Cols int `json:"cols"`
// Terminal height in character cells.
Rows int `json:"rows"`
}
PTY size in character cells for `command/exec` PTY sessions.
type CommandExecResizeResponse ¶
type CommandExecResizeResponse interface{}
type CommandExecResponse ¶
type CommandExecResponse = SanitizedCommandExecResponseJSON
type CommandExecTerminalSize ¶
type CommandExecTerminalSize struct {
// Terminal width in character cells.
Cols int `json:"cols"`
// Terminal height in character cells.
Rows int `json:"rows"`
}
PTY size in character cells for `command/exec` PTY sessions.
type CommandExecTerminateParams ¶
type CommandExecTerminateParams struct {
// Client-supplied, connection-scoped `processId` from the original `command/exec`
// request.
ProcessID string `json:"processId"`
}
Terminate a running `command/exec` session.
type CommandExecTerminateResponse ¶
type CommandExecTerminateResponse interface{}
type CommandExecWriteParams ¶
type CommandExecWriteParams struct {
// Close stdin after writing `deltaBase64`, if present.
CloseStdin *bool `json:"closeStdin,omitempty"`
// Optional base64-encoded stdin bytes to write.
DeltaBase64 *string `json:"deltaBase64,omitempty"`
// Client-supplied, connection-scoped `processId` from the original `command/exec`
// request.
ProcessID string `json:"processId"`
}
Write stdin bytes to a running `command/exec` session, close stdin, or both.
type CommandExecWriteResponse ¶
type CommandExecWriteResponse interface{}
type CommandExecutionApprovalDecision ¶
type CommandExecutionApprovalDecision interface{}
type CommandExecutionOutputDeltaNotification ¶
type CommandExecutionOutputDeltaNotification = SanitizedCommandExecutionOutputDeltaNotificationJSON
type CommandExecutionRequestApprovalParams ¶
type CommandExecutionRequestApprovalParams struct {
ThreadID string `json:"threadId"`
TurnID string `json:"turnId"`
ItemID string `json:"itemId"`
ApprovalID *string `json:"approvalId,omitempty"`
Reason *string `json:"reason,omitempty"`
NetworkApprovalContext interface{} `json:"networkApprovalContext,omitempty"`
Command *string `json:"command,omitempty"`
Cwd *string `json:"cwd,omitempty"`
CommandActions []interface{} `json:"commandActions,omitempty"`
AdditionalPermissions interface{} `json:"additionalPermissions,omitempty"`
ProposedExecpolicyAmendment []string `json:"proposedExecpolicyAmendment,omitempty"`
ProposedNetworkPolicyAmendments []NetworkPolicyAmendment `json:"proposedNetworkPolicyAmendments,omitempty"`
AvailableDecisions []CommandExecutionApprovalDecision `json:"availableDecisions,omitempty"`
}
CommandExecutionRequestApprovalParams is maintained manually because the raw schema uses nested unions that the generator does not currently emit.
type CommandExecutionRequestApprovalResponse ¶
type CommandExecutionRequestApprovalResponse struct {
Decision CommandExecutionApprovalDecision `json:"decision"`
}
CommandExecutionRequestApprovalResponse is maintained manually because the raw schema uses nested unions that the generator does not currently emit.
type CommandMigration ¶
type CommandMigration struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
}
type ComputerUseRequirements ¶
type ComputerUseRequirements struct {
// AllowLockedComputerUse corresponds to the JSON schema field
// "allowLockedComputerUse".
AllowLockedComputerUse *bool `json:"allowLockedComputerUse,omitempty"`
}
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 *string `json:"expectedVersion,omitempty"`
// Path to the config file to write; defaults to the user's `config.toml` when
// omitted.
FilePath *string `json:"filePath,omitempty"`
// When true, hot-reload the updated user config into all loaded threads after
// writing.
ReloadUserConfig *bool `json:"reloadUserConfig,omitempty"`
}
type ConfigEdit ¶
type ConfigEdit struct {
// KeyPath corresponds to the JSON schema field "keyPath".
KeyPath string `json:"keyPath"`
// MergeStrategy corresponds to the JSON schema field "mergeStrategy".
MergeStrategy MergeStrategy `json:"mergeStrategy"`
// Value corresponds to the JSON schema field "value".
Value interface{} `json:"value"`
}
type 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 *string `json:"cwd,omitempty"`
// IncludeLayers corresponds to the JSON schema field "includeLayers".
IncludeLayers *bool `json:"includeLayers,omitempty"`
}
type ConfigReadResponse ¶
type ConfigReadResponse interface{}
type ConfigRequirements ¶
type ConfigRequirements struct {
// AllowAppshots corresponds to the JSON schema field "allowAppshots".
AllowAppshots *bool `json:"allowAppshots,omitempty"`
// AllowManagedHooksOnly corresponds to the JSON schema field
// "allowManagedHooksOnly".
AllowManagedHooksOnly *bool `json:"allowManagedHooksOnly,omitempty"`
// AllowRemoteControl corresponds to the JSON schema field "allowRemoteControl".
AllowRemoteControl *bool `json:"allowRemoteControl,omitempty"`
// AllowedApprovalPolicies corresponds to the JSON schema field
// "allowedApprovalPolicies".
AllowedApprovalPolicies []ConfigRequirementsAllowedApprovalPoliciesElem `json:"allowedApprovalPolicies,omitempty"`
// AllowedPermissionProfiles corresponds to the JSON schema field
// "allowedPermissionProfiles".
AllowedPermissionProfiles *map[string]bool `json:"allowedPermissionProfiles,omitempty"`
// AllowedSandboxModes corresponds to the JSON schema field "allowedSandboxModes".
AllowedSandboxModes []SandboxMode `json:"allowedSandboxModes,omitempty"`
// AllowedWebSearchModes corresponds to the JSON schema field
// "allowedWebSearchModes".
AllowedWebSearchModes []WebSearchMode `json:"allowedWebSearchModes,omitempty"`
// AllowedWindowsSandboxImplementations corresponds to the JSON schema field
// "allowedWindowsSandboxImplementations".
AllowedWindowsSandboxImplementations []WindowsSandboxSetupMode `json:"allowedWindowsSandboxImplementations,omitempty"`
// ComputerUse corresponds to the JSON schema field "computerUse".
ComputerUse interface{} `json:"computerUse,omitempty"`
// DefaultPermissions corresponds to the JSON schema field "defaultPermissions".
DefaultPermissions *string `json:"defaultPermissions,omitempty"`
// EnforceResidency corresponds to the JSON schema field "enforceResidency".
EnforceResidency interface{} `json:"enforceResidency,omitempty"`
// FeatureRequirements corresponds to the JSON schema field "featureRequirements".
FeatureRequirements *map[string]bool `json:"featureRequirements,omitempty"`
// Models corresponds to the JSON schema field "models".
Models interface{} `json:"models,omitempty"`
}
type ConfigRequirementsAllowedApprovalPoliciesElem ¶
type ConfigRequirementsAllowedApprovalPoliciesElem interface{}
type ConfigRequirementsReadResponse ¶
type ConfigRequirementsReadResponse = SanitizedConfigRequirementsReadResponseJSON
type ConfigValueWriteParams ¶
type ConfigValueWriteParams struct {
// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
ExpectedVersion *string `json:"expectedVersion,omitempty"`
// Path to the config file to write; defaults to the user's `config.toml` when
// omitted.
FilePath *string `json:"filePath,omitempty"`
// KeyPath corresponds to the JSON schema field "keyPath".
KeyPath string `json:"keyPath"`
// MergeStrategy corresponds to the JSON schema field "mergeStrategy".
MergeStrategy MergeStrategy `json:"mergeStrategy"`
// Value corresponds to the JSON schema field "value".
Value interface{} `json:"value"`
}
type ConfigWarningNotification ¶
type ConfigWarningNotification = SanitizedConfigWarningNotificationJSON
type ConfigWriteResponse ¶
type ConfigWriteResponse interface{}
type ConfiguredHookHandler ¶
type ConfiguredHookHandler interface{}
type ConfiguredHookMatcherGroup ¶
type ConfiguredHookMatcherGroup struct {
// Hooks corresponds to the JSON schema field "hooks".
Hooks []ConfiguredHookMatcherGroupHooksElem `json:"hooks"`
// Matcher corresponds to the JSON schema field "matcher".
Matcher *string `json:"matcher,omitempty"`
}
type ConfiguredHookMatcherGroupHooksElem ¶
type ConfiguredHookMatcherGroupHooksElem interface{}
type ConsumeAccountRateLimitResetCreditOutcome ¶
type ConsumeAccountRateLimitResetCreditOutcome interface{}
type ConsumeAccountRateLimitResetCreditParams ¶
type ConsumeAccountRateLimitResetCreditParams struct {
// Opaque reset-credit identifier to redeem. When omitted, the backend selects the
// next available credit.
CreditID *string `json:"creditId,omitempty"`
// Identifies one logical reset attempt. A UUID is recommended; reuse the same
// value when retrying that attempt.
IdempotencyKey string `json:"idempotencyKey"`
}
type ConsumeAccountRateLimitResetCreditResponse ¶
type ConsumeAccountRateLimitResetCreditResponse = SanitizedConsumeAccountRateLimitResetCreditResponseJSON
type ContentItem ¶
type ContentItem interface{}
type ContextCompactedNotification ¶
type ContextCompactedNotification = SanitizedContextCompactedNotificationJSON
type ConversationTextRole ¶
type ConversationTextRole string
const ConversationTextRoleAssistant ConversationTextRole = "assistant"
const ConversationTextRoleDeveloper ConversationTextRole = "developer"
const ConversationTextRoleUser ConversationTextRole = "user"
type CreditsSnapshot ¶
type CreditsSnapshot struct {
// Balance corresponds to the JSON schema field "balance".
Balance *string `json:"balance,omitempty"`
// HasCredits corresponds to the JSON schema field "hasCredits".
HasCredits bool `json:"hasCredits"`
// Unlimited corresponds to the JSON schema field "unlimited".
Unlimited bool `json:"unlimited"`
}
type DeprecationNoticeNotification ¶
type DeprecationNoticeNotification = SanitizedDeprecationNoticeNotificationJSON
type DynamicToolCallOutputContentItem ¶
type DynamicToolCallOutputContentItem interface{}
type DynamicToolCallParams ¶
type DynamicToolCallParams = SanitizedDynamicToolCallParamsJSON
type DynamicToolCallResponse ¶
type DynamicToolCallResponse = SanitizedDynamicToolCallResponseJSON
type DynamicToolNamespaceTool ¶
type DynamicToolNamespaceTool interface{}
type DynamicToolSpec ¶
type DynamicToolSpec interface{}
type ErrorNotification ¶
type ErrorNotification struct {
ThreadID string `json:"threadId,omitempty"`
WillRetry *bool `json:"willRetry,omitempty"`
Error *TurnNotificationError `json:"error,omitempty"`
}
ErrorNotification is the payload for error notifications.
type ExecCommandApprovalParams ¶
type ExecCommandApprovalParams = SanitizedExecCommandApprovalParams
ExecCommandApprovalParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type ExecCommandApprovalResponse ¶
type ExecCommandApprovalResponse = SanitizedExecCommandApprovalResponse
ExecCommandApprovalResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type ExperimentalFeatureEnablementSetResponse ¶
type ExperimentalFeatureEnablementSetResponse = SanitizedExperimentalFeatureEnablementSetResponseJSON
type ExperimentalFeatureListParams ¶
type ExperimentalFeatureListParams struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
// 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 *string `json:"threadId,omitempty"`
}
type ExperimentalFeatureListResponse ¶
type ExperimentalFeatureListResponse interface{}
type ExternalAgentConfigDetectResponse ¶
type ExternalAgentConfigDetectResponse = SanitizedExternalAgentConfigDetectResponseJSON
type ExternalAgentConfigImportCompletedNotification ¶
type ExternalAgentConfigImportCompletedNotification = SanitizedExternalAgentConfigImportCompletedNotificationJSON
type ExternalAgentConfigImportHistoriesReadResponse ¶
type ExternalAgentConfigImportHistoriesReadResponse = SanitizedExternalAgentConfigImportHistoriesReadResponseJSON
type ExternalAgentConfigImportHistory ¶
type ExternalAgentConfigImportHistory struct {
// CompletedAtMs corresponds to the JSON schema field "completedAtMs".
CompletedAtMs int `json:"completedAtMs"`
// Failures corresponds to the JSON schema field "failures".
Failures []ExternalAgentConfigImportItemTypeFailure `json:"failures"`
// ImportID corresponds to the JSON schema field "importId".
ImportID string `json:"importId"`
// Successes corresponds to the JSON schema field "successes".
Successes []ExternalAgentConfigImportItemTypeSuccess `json:"successes"`
}
type ExternalAgentConfigImportItemTypeFailure ¶
type ExternalAgentConfigImportItemTypeFailure struct {
// Cwd corresponds to the JSON schema field "cwd".
Cwd *string `json:"cwd,omitempty"`
// ErrorType corresponds to the JSON schema field "errorType".
ErrorType *string `json:"errorType,omitempty"`
// FailureStage corresponds to the JSON schema field "failureStage".
FailureStage string `json:"failureStage"`
// ItemType corresponds to the JSON schema field "itemType".
ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`
// Message corresponds to the JSON schema field "message".
Message string `json:"message"`
// Source corresponds to the JSON schema field "source".
Source *string `json:"source,omitempty"`
}
type ExternalAgentConfigImportItemTypeSuccess ¶
type ExternalAgentConfigImportItemTypeSuccess struct {
// Cwd corresponds to the JSON schema field "cwd".
Cwd *string `json:"cwd,omitempty"`
// ItemType corresponds to the JSON schema field "itemType".
ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`
// Source corresponds to the JSON schema field "source".
Source *string `json:"source,omitempty"`
// Target corresponds to the JSON schema field "target".
Target *string `json:"target,omitempty"`
}
type ExternalAgentConfigImportParams ¶
type ExternalAgentConfigImportParams struct {
// MigrationItems corresponds to the JSON schema field "migrationItems".
MigrationItems []ExternalAgentConfigMigrationItem `json:"migrationItems"`
// Source product that produced the migration items. Missing means unspecified.
Source *string `json:"source,omitempty"`
}
type ExternalAgentConfigImportProgressNotification ¶
type ExternalAgentConfigImportProgressNotification = SanitizedExternalAgentConfigImportProgressNotificationJSON
type ExternalAgentConfigImportResponse ¶
type ExternalAgentConfigImportResponse = SanitizedExternalAgentConfigImportResponseJSON
type ExternalAgentConfigImportTypeResult ¶
type ExternalAgentConfigImportTypeResult struct {
// Failures corresponds to the JSON schema field "failures".
Failures []ExternalAgentConfigImportItemTypeFailure `json:"failures"`
// ItemType corresponds to the JSON schema field "itemType".
ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`
// Successes corresponds to the JSON schema field "successes".
Successes []ExternalAgentConfigImportItemTypeSuccess `json:"successes"`
}
type ExternalAgentConfigMigrationItem ¶
type ExternalAgentConfigMigrationItem struct {
// Null or empty means home-scoped migration; non-empty means repo-scoped
// migration.
Cwd *string `json:"cwd,omitempty"`
// Description corresponds to the JSON schema field "description".
Description string `json:"description"`
// Details corresponds to the JSON schema field "details".
Details interface{} `json:"details,omitempty"`
// ItemType corresponds to the JSON schema field "itemType".
ItemType ExternalAgentConfigMigrationItemType `json:"itemType"`
}
type ExternalAgentConfigMigrationItemType ¶
type ExternalAgentConfigMigrationItemType string
const ExternalAgentConfigMigrationItemTypeAGENTSMD ExternalAgentConfigMigrationItemType = "AGENTS_MD"
const ExternalAgentConfigMigrationItemTypeCOMMANDS ExternalAgentConfigMigrationItemType = "COMMANDS"
const ExternalAgentConfigMigrationItemTypeCONFIG ExternalAgentConfigMigrationItemType = "CONFIG"
const ExternalAgentConfigMigrationItemTypeHOOKS ExternalAgentConfigMigrationItemType = "HOOKS"
const ExternalAgentConfigMigrationItemTypeMCPSERVERCONFIG ExternalAgentConfigMigrationItemType = "MCP_SERVER_CONFIG"
const ExternalAgentConfigMigrationItemTypePLUGINS ExternalAgentConfigMigrationItemType = "PLUGINS"
const ExternalAgentConfigMigrationItemTypeSESSIONS ExternalAgentConfigMigrationItemType = "SESSIONS"
const ExternalAgentConfigMigrationItemTypeSKILLS ExternalAgentConfigMigrationItemType = "SKILLS"
const ExternalAgentConfigMigrationItemTypeSUBAGENTS ExternalAgentConfigMigrationItemType = "SUBAGENTS"
type FeedbackUploadParams ¶
type FeedbackUploadParams struct {
// Classification corresponds to the JSON schema field "classification".
Classification string `json:"classification"`
// ExtraLogFiles corresponds to the JSON schema field "extraLogFiles".
ExtraLogFiles []string `json:"extraLogFiles,omitempty"`
// IncludeLogs corresponds to the JSON schema field "includeLogs".
IncludeLogs *bool `json:"includeLogs,omitempty"`
// Reason corresponds to the JSON schema field "reason".
Reason *string `json:"reason,omitempty"`
// Tags corresponds to the JSON schema field "tags".
Tags *map[string]string `json:"tags,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
}
type FeedbackUploadResponse ¶
type FeedbackUploadResponse = SanitizedFeedbackUploadResponseJSON
type FileChange ¶
type FileChange interface{}
type FileChangeApprovalDecision ¶
type FileChangeApprovalDecision interface{}
type FileChangeOutputDeltaNotification ¶
type FileChangeOutputDeltaNotification = SanitizedFileChangeOutputDeltaNotificationJSON
type FileChangePatchUpdatedNotification ¶
type FileChangePatchUpdatedNotification = SanitizedFileChangePatchUpdatedNotificationJSON
type FileChangeRequestApprovalParams ¶
type FileChangeRequestApprovalParams = SanitizedFileChangeRequestApprovalParams
FileChangeRequestApprovalParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type FileChangeRequestApprovalResponse ¶
type FileChangeRequestApprovalResponse = SanitizedFileChangeRequestApprovalResponse
FileChangeRequestApprovalResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type FileSystemAccessMode ¶
type FileSystemAccessMode string
const FileSystemAccessModeDeny FileSystemAccessMode = "deny"
const FileSystemAccessModeRead FileSystemAccessMode = "read"
const FileSystemAccessModeWrite FileSystemAccessMode = "write"
type FileSystemPath ¶
type FileSystemPath interface{}
type FileSystemSandboxEntry ¶
type FileSystemSandboxEntry struct {
// Access corresponds to the JSON schema field "access".
Access FileSystemAccessMode `json:"access"`
// Path corresponds to the JSON schema field "path".
Path FileSystemSandboxEntryPath `json:"path"`
}
type FileSystemSandboxEntryPath ¶
type FileSystemSandboxEntryPath interface{}
type FileSystemSpecialPath ¶
type FileSystemSpecialPath interface{}
type FileUpdateChange ¶
type FileUpdateChange struct {
// Diff corresponds to the JSON schema field "diff".
Diff string `json:"diff"`
// Kind corresponds to the JSON schema field "kind".
Kind FileUpdateChangeKind `json:"kind"`
// Path corresponds to the JSON schema field "path".
Path string `json:"path"`
}
type FileUpdateChangeKind ¶
type FileUpdateChangeKind interface{}
type FsChangedNotification ¶
type FsChangedNotification interface{}
type FsCopyParams ¶
type FsCopyParams struct {
// Absolute destination path.
DestinationPath interface{} `json:"destinationPath"`
// Required for directory copies; ignored for file copies.
Recursive *bool `json:"recursive,omitempty"`
// Absolute source path.
SourcePath interface{} `json:"sourcePath"`
}
Copy a file or directory tree on the host filesystem.
type FsCopyResponse ¶
type FsCopyResponse interface{}
type FsCreateDirectoryParams ¶
type FsCreateDirectoryParams struct {
// Absolute directory path to create.
Path interface{} `json:"path"`
// Whether parent directories should also be created. Defaults to `true`.
Recursive *bool `json:"recursive,omitempty"`
}
Create a directory on the host filesystem.
type FsCreateDirectoryResponse ¶
type FsCreateDirectoryResponse interface{}
type FsGetMetadataParams ¶
type FsGetMetadataParams struct {
// Absolute path to inspect.
Path interface{} `json:"path"`
}
Request metadata for an absolute path.
type FsGetMetadataResponse ¶
type FsGetMetadataResponse = SanitizedFsGetMetadataResponseJSON
type FsReadDirectoryEntry ¶
type FsReadDirectoryEntry struct {
// Direct child entry name only, not an absolute or relative path.
FileName string `json:"fileName"`
// Whether this entry resolves to a directory.
IsDirectory bool `json:"isDirectory"`
// Whether this entry resolves to a regular file.
IsFile bool `json:"isFile"`
}
A directory entry returned by `fs/readDirectory`.
type FsReadDirectoryParams ¶
type FsReadDirectoryParams struct {
// Absolute directory path to read.
Path interface{} `json:"path"`
}
List direct child names for a directory.
type FsReadDirectoryResponse ¶
type FsReadDirectoryResponse = SanitizedFsReadDirectoryResponseJSON
type FsReadFileParams ¶
type FsReadFileParams struct {
// Absolute path to read.
Path interface{} `json:"path"`
}
Read a file from the host filesystem.
type FsReadFileResponse ¶
type FsReadFileResponse = SanitizedFsReadFileResponseJSON
type FsRemoveParams ¶
type FsRemoveParams struct {
// Whether missing paths should be ignored. Defaults to `true`.
Force *bool `json:"force,omitempty"`
// Absolute path to remove.
Path interface{} `json:"path"`
// Whether directory removal should recurse. Defaults to `true`.
Recursive *bool `json:"recursive,omitempty"`
}
Remove a file or directory tree from the host filesystem.
type FsRemoveResponse ¶
type FsRemoveResponse interface{}
type FsUnwatchParams ¶
type FsUnwatchParams struct {
// Watch identifier previously provided to `fs/watch`.
WatchID string `json:"watchId"`
}
Stop filesystem watch notifications for a prior `fs/watch`.
type FsUnwatchResponse ¶
type FsUnwatchResponse interface{}
type FsWatchParams ¶
type FsWatchParams struct {
// Absolute file or directory path to watch.
Path interface{} `json:"path"`
// Connection-scoped watch identifier used for `fs/unwatch` and `fs/changed`.
WatchID string `json:"watchId"`
}
Start filesystem watch notifications for an absolute path.
type FsWatchResponse ¶
type FsWatchResponse interface{}
type FsWriteFileParams ¶
type FsWriteFileParams struct {
// File contents encoded as base64.
DataBase64 string `json:"dataBase64"`
// Absolute path to write.
Path interface{} `json:"path"`
}
Write a file on the host filesystem.
type FsWriteFileResponse ¶
type FsWriteFileResponse interface{}
type FunctionCallOutputBody ¶
type FunctionCallOutputBody interface{}
type FunctionCallOutputContentItem ¶
type FunctionCallOutputContentItem interface{}
Responses API compatible content items that can be returned by a tool call. This is a subset of ContentItem with the types we support as function call outputs.
type FuzzyFileSearchMatchType ¶
type FuzzyFileSearchMatchType string
const FuzzyFileSearchMatchTypeDirectory FuzzyFileSearchMatchType = "directory"
const FuzzyFileSearchMatchTypeFile FuzzyFileSearchMatchType = "file"
type FuzzyFileSearchParams ¶
type FuzzyFileSearchParams struct {
// CancellationToken corresponds to the JSON schema field "cancellationToken".
CancellationToken *string `json:"cancellationToken,omitempty"`
// Query corresponds to the JSON schema field "query".
Query string `json:"query"`
// Roots corresponds to the JSON schema field "roots".
Roots []string `json:"roots"`
}
type FuzzyFileSearchResponse ¶
type FuzzyFileSearchResponse = SanitizedFuzzyFileSearchResponseJSON
type FuzzyFileSearchResult ¶
type FuzzyFileSearchResult struct {
// FileName corresponds to the JSON schema field "file_name".
FileName string `json:"file_name"`
// Indices corresponds to the JSON schema field "indices".
Indices []int `json:"indices,omitempty"`
// MatchType corresponds to the JSON schema field "match_type".
MatchType FuzzyFileSearchMatchType `json:"match_type"`
// Path corresponds to the JSON schema field "path".
Path string `json:"path"`
// Root corresponds to the JSON schema field "root".
Root string `json:"root"`
// Score corresponds to the JSON schema field "score".
Score int `json:"score"`
}
Superset of [`codex_file_search::FileMatch`]
type FuzzyFileSearchSessionCompletedNotification ¶
type FuzzyFileSearchSessionCompletedNotification = SanitizedFuzzyFileSearchSessionCompletedNotificationJSON
type FuzzyFileSearchSessionUpdatedNotification ¶
type FuzzyFileSearchSessionUpdatedNotification = SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON
type GetAccountParams ¶
type GetAccountParams struct {
// When `true`, requests a proactive token refresh before returning.
//
// In managed auth mode this triggers the normal refresh-token flow. In external
// auth mode this flag is ignored. Clients should refresh tokens themselves and
// call `account/login/start` with `chatgptAuthTokens`.
RefreshToken *bool `json:"refreshToken,omitempty"`
}
type GetAccountRateLimitsResponse ¶
type GetAccountRateLimitsResponse interface{}
type GetAccountResponse ¶
type GetAccountResponse = SanitizedGetAccountResponseJSON
type GetAccountTokenUsageResponse ¶
type GetAccountTokenUsageResponse = SanitizedGetAccountTokenUsageResponseJSON
type GetWorkspaceMessagesResponse ¶
type GetWorkspaceMessagesResponse = SanitizedGetWorkspaceMessagesResponseJSON
type GrantedPermissionProfile ¶
type GrantedPermissionProfile struct {
// FileSystem corresponds to the JSON schema field "fileSystem".
FileSystem interface{} `json:"fileSystem,omitempty"`
// Network corresponds to the JSON schema field "network".
Network interface{} `json:"network,omitempty"`
}
type GuardianWarningNotification ¶
type GuardianWarningNotification = SanitizedGuardianWarningNotificationJSON
type HookCompletedNotification ¶
type HookCompletedNotification interface{}
type HookMigration ¶
type HookMigration struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
}
type HookStartedNotification ¶
type HookStartedNotification interface{}
type HooksListParams ¶
type HooksListParams struct {
// When empty, defaults to the current session working directory.
Cwds []string `json:"cwds,omitempty"`
}
type HooksListResponse ¶
type HooksListResponse interface{}
type ImageDetail ¶
type ImageDetail string
const ImageDetailAuto ImageDetail = "auto"
const ImageDetailHigh ImageDetail = "high"
const ImageDetailLow ImageDetail = "low"
const ImageDetailOriginal ImageDetail = "original"
type InitializeCapabilities ¶
type InitializeCapabilities struct {
// Opt into receiving experimental API methods and fields.
ExperimentalApi bool `json:"experimentalApi,omitempty"`
// Allow downstream MCP servers to request OpenAI extended form elicitations.
MCPServerOpenaiFormElicitation *bool `json:"mcpServerOpenaiFormElicitation,omitempty"`
// Exact notification method names that should be suppressed for this connection
// (for example `thread/started`).
OptOutNotificationMethods []string `json:"optOutNotificationMethods,omitempty"`
// Opt into `attestation/generate` requests for upstream `x-oai-attestation`.
RequestAttestation bool `json:"requestAttestation,omitempty"`
}
Client-declared capabilities negotiated during initialize.
type InitializeParams ¶
type InitializeParams struct {
// Capabilities corresponds to the JSON schema field "capabilities".
Capabilities interface{} `json:"capabilities,omitempty"`
// ClientInfo corresponds to the JSON schema field "clientInfo".
ClientInfo ClientInfo `json:"clientInfo"`
}
type InitializeResponse ¶
type InitializeResponse interface{}
type InputModality ¶
type InputModality interface{}
Canonical user-input modality tags advertised by a model.
type InternalChatMessageMetadataPassthrough ¶
type InternalChatMessageMetadataPassthrough struct {
// TurnID corresponds to the JSON schema field "turn_id".
TurnID *string `json:"turn_id,omitempty"`
}
Internal Responses API passthrough metadata copied into underlying chat messages.
Responses API strongly types this payload. Do not modify it without first getting API approval and making the corresponding Responses API change.
type ItemCompletedNotification ¶
type ItemCompletedNotification struct {
ThreadID string `json:"threadId,omitempty"`
Item json.RawMessage `json:"item,omitempty"`
}
ItemCompletedNotification is the payload for item/completed.
type ItemGuardianApprovalReviewCompletedNotification ¶
type ItemGuardianApprovalReviewCompletedNotification interface{}
type ItemGuardianApprovalReviewStartedNotification ¶
type ItemGuardianApprovalReviewStartedNotification interface{}
type ItemStartedNotification ¶
type ItemStartedNotification interface{}
type LegacyAppPathString ¶
type LegacyAppPathString string
type ListMCPServerStatusParams ¶
type ListMCPServerStatusParams struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Controls how much MCP inventory data to fetch for each server. Defaults to
// `Full` when omitted.
Detail interface{} `json:"detail,omitempty"`
// Optional page size; defaults to a server-defined value.
Limit *int `json:"limit,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
}
type ListMcpServerStatusParams ¶
type ListMcpServerStatusParams interface{}
type ListMcpServerStatusResponse ¶
type ListMcpServerStatusResponse interface{}
type LocalShellAction ¶
type LocalShellAction interface{}
type LocalShellStatus ¶
type LocalShellStatus string
const LocalShellStatusCompleted LocalShellStatus = "completed"
const LocalShellStatusInProgress LocalShellStatus = "in_progress"
const LocalShellStatusIncomplete LocalShellStatus = "incomplete"
type LoginAccountParams ¶
type LoginAccountParams interface{}
type LoginAccountResponse ¶
type LoginAccountResponse interface{}
type LogoutAccountResponse ¶
type LogoutAccountResponse interface{}
type MCPAuthStatus ¶
type MCPAuthStatus string
const MCPAuthStatusBearerToken MCPAuthStatus = "bearerToken"
const MCPAuthStatusNotLoggedIn MCPAuthStatus = "notLoggedIn"
const MCPAuthStatusOAuth MCPAuthStatus = "oAuth"
const MCPAuthStatusUnsupported MCPAuthStatus = "unsupported"
type MCPElicitationArrayType ¶
type MCPElicitationArrayType string
const MCPElicitationArrayTypeArray MCPElicitationArrayType = "array"
type MCPElicitationBooleanSchema ¶
type MCPElicitationBooleanSchema struct {
// Default corresponds to the JSON schema field "default".
Default *bool `json:"default,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// Type corresponds to the JSON schema field "type".
Type MCPElicitationBooleanType `json:"type"`
}
type MCPElicitationBooleanType ¶
type MCPElicitationBooleanType string
const MCPElicitationBooleanTypeBoolean MCPElicitationBooleanType = "boolean"
type MCPElicitationEnumSchema ¶
type MCPElicitationEnumSchema interface{}
type MCPElicitationLegacyTitledEnumSchema ¶
type MCPElicitationLegacyTitledEnumSchema struct {
// Default corresponds to the JSON schema field "default".
Default *string `json:"default,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Enum corresponds to the JSON schema field "enum".
Enum []string `json:"enum"`
// EnumNames corresponds to the JSON schema field "enumNames".
EnumNames []string `json:"enumNames,omitempty"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// Type corresponds to the JSON schema field "type".
Type MCPElicitationStringType `json:"type"`
}
type MCPElicitationMultiSelectEnumSchema ¶
type MCPElicitationMultiSelectEnumSchema interface{}
type MCPElicitationNumberSchema ¶
type MCPElicitationNumberSchema struct {
// Default corresponds to the JSON schema field "default".
Default *float64 `json:"default,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Maximum corresponds to the JSON schema field "maximum".
Maximum *float64 `json:"maximum,omitempty"`
// Minimum corresponds to the JSON schema field "minimum".
Minimum *float64 `json:"minimum,omitempty"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// Type corresponds to the JSON schema field "type".
Type MCPElicitationNumberType `json:"type"`
}
type MCPElicitationNumberType ¶
type MCPElicitationNumberType string
const MCPElicitationNumberTypeInteger MCPElicitationNumberType = "integer"
const MCPElicitationNumberTypeNumber MCPElicitationNumberType = "number"
type MCPElicitationObjectType ¶
type MCPElicitationObjectType string
const MCPElicitationObjectTypeObject MCPElicitationObjectType = "object"
type MCPElicitationPrimitiveSchema ¶
type MCPElicitationPrimitiveSchema interface{}
type MCPElicitationSchema ¶
type MCPElicitationSchema struct {
// Schema corresponds to the JSON schema field "$schema".
Schema *string `json:"$schema,omitempty"`
// Properties corresponds to the JSON schema field "properties".
Properties map[string]interface{} `json:"properties"`
// Required corresponds to the JSON schema field "required".
Required []string `json:"required,omitempty"`
// Type corresponds to the JSON schema field "type".
Type MCPElicitationObjectType `json:"type"`
}
Typed form schema for MCP `elicitation/create` requests.
This matches the `requestedSchema` shape from the MCP 2025-11-25 `ElicitRequestFormParams` schema.
type MCPElicitationSingleSelectEnumSchema ¶
type MCPElicitationSingleSelectEnumSchema interface{}
type MCPElicitationStringFormat ¶
type MCPElicitationStringFormat string
const MCPElicitationStringFormatDate MCPElicitationStringFormat = "date"
const MCPElicitationStringFormatDateTime MCPElicitationStringFormat = "date-time"
const MCPElicitationStringFormatEmail MCPElicitationStringFormat = "email"
const MCPElicitationStringFormatUri MCPElicitationStringFormat = "uri"
type MCPElicitationStringSchema ¶
type MCPElicitationStringSchema struct {
// Default corresponds to the JSON schema field "default".
Default *string `json:"default,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Format corresponds to the JSON schema field "format".
Format interface{} `json:"format,omitempty"`
// MaxLength corresponds to the JSON schema field "maxLength".
MaxLength *int `json:"maxLength,omitempty"`
// MinLength corresponds to the JSON schema field "minLength".
MinLength *int `json:"minLength,omitempty"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// Type corresponds to the JSON schema field "type".
Type MCPElicitationStringType `json:"type"`
}
type MCPElicitationStringType ¶
type MCPElicitationStringType string
const MCPElicitationStringTypeString MCPElicitationStringType = "string"
type MCPResourceReadParams ¶
type MCPResourceReadParams struct {
// Server corresponds to the JSON schema field "server".
Server string `json:"server"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
// Uri corresponds to the JSON schema field "uri".
Uri string `json:"uri"`
}
type MCPServerElicitationAction ¶
type MCPServerElicitationAction string
const MCPServerElicitationActionAccept MCPServerElicitationAction = "accept"
const MCPServerElicitationActionCancel MCPServerElicitationAction = "cancel"
const MCPServerElicitationActionDecline MCPServerElicitationAction = "decline"
type MCPServerInfo ¶
type MCPServerInfo struct {
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Icons corresponds to the JSON schema field "icons".
Icons []interface{} `json:"icons,omitempty"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// Version corresponds to the JSON schema field "version".
Version string `json:"version"`
// WebsiteURL corresponds to the JSON schema field "websiteUrl".
WebsiteURL *string `json:"websiteUrl,omitempty"`
}
Presentation metadata advertised by an initialized MCP server.
type MCPServerMigration ¶
type MCPServerMigration struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
}
type MCPServerOauthLoginParams ¶
type MCPServerOauthLoginParams struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Scopes corresponds to the JSON schema field "scopes".
Scopes []string `json:"scopes,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
// TimeoutSecs corresponds to the JSON schema field "timeoutSecs".
TimeoutSecs *int `json:"timeoutSecs,omitempty"`
}
type MCPServerStartupFailureReason ¶
type MCPServerStartupFailureReason string
const MCPServerStartupFailureReasonReauthenticationRequired MCPServerStartupFailureReason = "reauthenticationRequired"
type MCPServerStartupState ¶
type MCPServerStartupState string
const MCPServerStartupStateCancelled MCPServerStartupState = "cancelled"
const MCPServerStartupStateFailed MCPServerStartupState = "failed"
const MCPServerStartupStateReady MCPServerStartupState = "ready"
const MCPServerStartupStateStarting MCPServerStartupState = "starting"
type MCPServerStatus ¶
type MCPServerStatus struct {
// AuthStatus corresponds to the JSON schema field "authStatus".
AuthStatus MCPAuthStatus `json:"authStatus"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// ResourceTemplates corresponds to the JSON schema field "resourceTemplates".
ResourceTemplates []ResourceTemplate `json:"resourceTemplates"`
// Resources corresponds to the JSON schema field "resources".
Resources []Resource `json:"resources"`
// ServerInfo corresponds to the JSON schema field "serverInfo".
ServerInfo interface{} `json:"serverInfo,omitempty"`
// Tools corresponds to the JSON schema field "tools".
Tools map[string]Tool `json:"tools"`
}
type MCPServerStatusDetail ¶
type MCPServerStatusDetail string
const MCPServerStatusDetailFull MCPServerStatusDetail = "full"
const MCPServerStatusDetailToolsAndAuthOnly MCPServerStatusDetail = "toolsAndAuthOnly"
type MCPServerToolCallParams ¶
type MCPServerToolCallParams struct {
// Meta corresponds to the JSON schema field "_meta".
Meta interface{} `json:"_meta,omitempty"`
// Arguments corresponds to the JSON schema field "arguments".
Arguments interface{} `json:"arguments,omitempty"`
// Server corresponds to the JSON schema field "server".
Server string `json:"server"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// Tool corresponds to the JSON schema field "tool".
Tool string `json:"tool"`
}
type ManagedHooksRequirements ¶
type ManagedHooksRequirements struct {
// PermissionRequest corresponds to the JSON schema field "PermissionRequest".
PermissionRequest []ConfiguredHookMatcherGroup `json:"PermissionRequest"`
// PostCompact corresponds to the JSON schema field "PostCompact".
PostCompact []ConfiguredHookMatcherGroup `json:"PostCompact"`
// PostToolUse corresponds to the JSON schema field "PostToolUse".
PostToolUse []ConfiguredHookMatcherGroup `json:"PostToolUse"`
// PreCompact corresponds to the JSON schema field "PreCompact".
PreCompact []ConfiguredHookMatcherGroup `json:"PreCompact"`
// PreToolUse corresponds to the JSON schema field "PreToolUse".
PreToolUse []ConfiguredHookMatcherGroup `json:"PreToolUse"`
// SessionStart corresponds to the JSON schema field "SessionStart".
SessionStart []ConfiguredHookMatcherGroup `json:"SessionStart"`
// Stop corresponds to the JSON schema field "Stop".
Stop []ConfiguredHookMatcherGroup `json:"Stop"`
// SubagentStart corresponds to the JSON schema field "SubagentStart".
SubagentStart []ConfiguredHookMatcherGroup `json:"SubagentStart"`
// SubagentStop corresponds to the JSON schema field "SubagentStop".
SubagentStop []ConfiguredHookMatcherGroup `json:"SubagentStop"`
// UserPromptSubmit corresponds to the JSON schema field "UserPromptSubmit".
UserPromptSubmit []ConfiguredHookMatcherGroup `json:"UserPromptSubmit"`
// ManagedDir corresponds to the JSON schema field "managedDir".
ManagedDir *string `json:"managedDir,omitempty"`
// WindowsManagedDir corresponds to the JSON schema field "windowsManagedDir".
WindowsManagedDir *string `json:"windowsManagedDir,omitempty"`
}
type MarketplaceAddParams ¶
type MarketplaceAddParams struct {
// RefName corresponds to the JSON schema field "refName".
RefName *string `json:"refName,omitempty"`
// Source corresponds to the JSON schema field "source".
Source string `json:"source"`
// SparsePaths corresponds to the JSON schema field "sparsePaths".
SparsePaths []string `json:"sparsePaths,omitempty"`
}
type MarketplaceAddResponse ¶
type MarketplaceAddResponse interface{}
type MarketplaceRemoveParams ¶
type MarketplaceRemoveParams struct {
// MarketplaceName corresponds to the JSON schema field "marketplaceName".
MarketplaceName string `json:"marketplaceName"`
}
type MarketplaceRemoveResponse ¶
type MarketplaceRemoveResponse interface{}
type MarketplaceUpgradeParams ¶
type MarketplaceUpgradeParams struct {
// MarketplaceName corresponds to the JSON schema field "marketplaceName".
MarketplaceName *string `json:"marketplaceName,omitempty"`
}
type MarketplaceUpgradeResponse ¶
type MarketplaceUpgradeResponse interface{}
type McpResourceReadParams ¶
type McpResourceReadParams interface{}
type McpResourceReadResponse ¶
type McpResourceReadResponse interface{}
type McpServerElicitationRequestParams ¶
type McpServerElicitationRequestParams interface{}
type McpServerElicitationRequestResponse ¶
type McpServerElicitationRequestResponse interface{}
type McpServerOauthLoginCompletedNotification ¶
type McpServerOauthLoginCompletedNotification interface{}
type McpServerOauthLoginParams ¶
type McpServerOauthLoginParams interface{}
type McpServerOauthLoginResponse ¶
type McpServerOauthLoginResponse interface{}
type McpServerRefreshResponse ¶
type McpServerRefreshResponse interface{}
type McpServerStatusUpdatedNotification ¶
type McpServerStatusUpdatedNotification interface{}
type McpServerToolCallParams ¶
type McpServerToolCallParams interface{}
type McpServerToolCallResponse ¶
type McpServerToolCallResponse interface{}
type McpToolCallProgressNotification ¶
type McpToolCallProgressNotification interface{}
type MergeStrategy ¶
type MergeStrategy string
const MergeStrategyReplace MergeStrategy = "replace"
const MergeStrategyUpsert MergeStrategy = "upsert"
type MessagePhase ¶
type MessagePhase interface{}
Classifies an assistant message as interim commentary or final answer text.
Providers do not emit this consistently, so callers must treat `None` as "phase unknown" and keep compatibility behavior for legacy models.
type MigrationDetails ¶
type MigrationDetails struct {
// Commands corresponds to the JSON schema field "commands".
Commands []CommandMigration `json:"commands,omitempty"`
// Hooks corresponds to the JSON schema field "hooks".
Hooks []HookMigration `json:"hooks,omitempty"`
// MCPServers corresponds to the JSON schema field "mcpServers".
MCPServers []MCPServerMigration `json:"mcpServers,omitempty"`
// Plugins corresponds to the JSON schema field "plugins".
Plugins []PluginsMigration `json:"plugins,omitempty"`
// Sessions corresponds to the JSON schema field "sessions".
Sessions []SessionMigration `json:"sessions,omitempty"`
// Skills corresponds to the JSON schema field "skills".
Skills []SkillMigration `json:"skills,omitempty"`
// Subagents corresponds to the JSON schema field "subagents".
Subagents []SubagentMigration `json:"subagents,omitempty"`
}
type ModeKind ¶
type ModeKind string
const ModeKindDefault ModeKind = "default"
const ModeKindPlan ModeKind = "plan"
type Model ¶
type Model struct {
// Deprecated: use `serviceTiers` instead.
AdditionalSpeedTiers []string `json:"additionalSpeedTiers,omitempty"`
// AvailabilityNux corresponds to the JSON schema field "availabilityNux".
AvailabilityNux interface{} `json:"availabilityNux,omitempty"`
// DefaultReasoningEffort corresponds to the JSON schema field
// "defaultReasoningEffort".
DefaultReasoningEffort ReasoningEffort `json:"defaultReasoningEffort"`
// Catalog default service tier id for this model, when one is configured.
DefaultServiceTier *string `json:"defaultServiceTier,omitempty"`
// Description corresponds to the JSON schema field "description".
Description string `json:"description"`
// DisplayName corresponds to the JSON schema field "displayName".
DisplayName string `json:"displayName"`
// Hidden corresponds to the JSON schema field "hidden".
Hidden bool `json:"hidden"`
// ID corresponds to the JSON schema field "id".
ID string `json:"id"`
// InputModalities corresponds to the JSON schema field "inputModalities".
InputModalities []ModelInputModalitiesElem `json:"inputModalities,omitempty"`
// IsDefault corresponds to the JSON schema field "isDefault".
IsDefault bool `json:"isDefault"`
// Model corresponds to the JSON schema field "model".
Model string `json:"model"`
// ServiceTiers corresponds to the JSON schema field "serviceTiers".
ServiceTiers []ModelServiceTier `json:"serviceTiers,omitempty"`
// SupportedReasoningEfforts corresponds to the JSON schema field
// "supportedReasoningEfforts".
SupportedReasoningEfforts []ReasoningEffortOption `json:"supportedReasoningEfforts"`
// SupportsPersonality corresponds to the JSON schema field "supportsPersonality".
SupportsPersonality bool `json:"supportsPersonality,omitempty"`
// Upgrade corresponds to the JSON schema field "upgrade".
Upgrade *string `json:"upgrade,omitempty"`
// UpgradeInfo corresponds to the JSON schema field "upgradeInfo".
UpgradeInfo interface{} `json:"upgradeInfo,omitempty"`
}
type ModelAvailabilityNux ¶
type ModelAvailabilityNux struct {
// Message corresponds to the JSON schema field "message".
Message string `json:"message"`
}
type ModelInputModalitiesElem ¶
type ModelInputModalitiesElem interface{}
type ModelListParams ¶
type ModelListParams struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// When true, include models that are hidden from the default picker list.
IncludeHidden *bool `json:"includeHidden,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
}
type ModelListResponse ¶
type ModelListResponse = SanitizedModelListResponseJSON
type ModelProviderCapabilitiesReadParams ¶
type ModelProviderCapabilitiesReadParams interface{}
type ModelProviderCapabilitiesReadResponse ¶
type ModelProviderCapabilitiesReadResponse = SanitizedModelProviderCapabilitiesReadResponseJSON
type ModelRerouteReason ¶
type ModelRerouteReason string
const ModelRerouteReasonHighRiskCyberActivity ModelRerouteReason = "highRiskCyberActivity"
type ModelReroutedNotification ¶
type ModelReroutedNotification = SanitizedModelReroutedNotificationJSON
type ModelSafetyBufferingUpdatedNotification ¶
type ModelSafetyBufferingUpdatedNotification = SanitizedModelSafetyBufferingUpdatedNotificationJSON
type ModelServiceTier ¶
type ModelUpgradeInfo ¶
type ModelUpgradeInfo struct {
// MigrationMarkdown corresponds to the JSON schema field "migrationMarkdown".
MigrationMarkdown *string `json:"migrationMarkdown,omitempty"`
// Model corresponds to the JSON schema field "model".
Model string `json:"model"`
// ModelLink corresponds to the JSON schema field "modelLink".
ModelLink *string `json:"modelLink,omitempty"`
// UpgradeCopy corresponds to the JSON schema field "upgradeCopy".
UpgradeCopy *string `json:"upgradeCopy,omitempty"`
}
type ModelVerification ¶
type ModelVerification string
const ModelVerificationTrustedAccessForCyber ModelVerification = "trustedAccessForCyber"
type ModelVerificationNotification ¶
type ModelVerificationNotification = SanitizedModelVerificationNotificationJSON
type ModelsRequirements ¶
type ModelsRequirements struct {
// NewThread corresponds to the JSON schema field "newThread".
NewThread interface{} `json:"newThread,omitempty"`
}
type MultiAgentMode ¶
type MultiAgentMode interface{}
Controls the effective multi-agent delegation instructions for a turn. `custom` means the configured mode hint defines the policy instead of a built-in policy.
type NetworkAccess ¶
type NetworkAccess string
const NetworkAccessEnabled NetworkAccess = "enabled"
const NetworkAccessRestricted NetworkAccess = "restricted"
type NetworkDomainPermission ¶
type NetworkDomainPermission string
const NetworkDomainPermissionAllow NetworkDomainPermission = "allow"
const NetworkDomainPermissionDeny NetworkDomainPermission = "deny"
type NetworkPolicyAmendment ¶
type NetworkPolicyAmendment struct {
// Action corresponds to the JSON schema field "action".
Action NetworkPolicyRuleAction `json:"action"`
// Host corresponds to the JSON schema field "host".
Host string `json:"host"`
}
type NetworkPolicyRuleAction ¶
type NetworkPolicyRuleAction string
const NetworkPolicyRuleActionAllow NetworkPolicyRuleAction = "allow"
const NetworkPolicyRuleActionDeny NetworkPolicyRuleAction = "deny"
type NetworkRequirements ¶
type NetworkRequirements struct {
// AllowLocalBinding corresponds to the JSON schema field "allowLocalBinding".
AllowLocalBinding *bool `json:"allowLocalBinding,omitempty"`
// Legacy compatibility view derived from `unix_sockets`.
AllowUnixSockets []string `json:"allowUnixSockets,omitempty"`
// AllowUpstreamProxy corresponds to the JSON schema field "allowUpstreamProxy".
AllowUpstreamProxy *bool `json:"allowUpstreamProxy,omitempty"`
// Legacy compatibility view derived from `domains`.
AllowedDomains []string `json:"allowedDomains,omitempty"`
// DangerouslyAllowAllUnixSockets corresponds to the JSON schema field
// "dangerouslyAllowAllUnixSockets".
DangerouslyAllowAllUnixSockets *bool `json:"dangerouslyAllowAllUnixSockets,omitempty"`
// DangerouslyAllowNonLoopbackProxy corresponds to the JSON schema field
// "dangerouslyAllowNonLoopbackProxy".
DangerouslyAllowNonLoopbackProxy *bool `json:"dangerouslyAllowNonLoopbackProxy,omitempty"`
// Legacy compatibility view derived from `domains`.
DeniedDomains []string `json:"deniedDomains,omitempty"`
// Canonical network permission map for `experimental_network`.
Domains *map[string]NetworkDomainPermission `json:"domains,omitempty"`
// Enabled corresponds to the JSON schema field "enabled".
Enabled *bool `json:"enabled,omitempty"`
// HTTPPort corresponds to the JSON schema field "httpPort".
HTTPPort *int `json:"httpPort,omitempty"`
// When true, only managed allowlist entries are respected while managed network
// enforcement is active.
ManagedAllowedDomainsOnly *bool `json:"managedAllowedDomainsOnly,omitempty"`
// SocksPort corresponds to the JSON schema field "socksPort".
SocksPort *int `json:"socksPort,omitempty"`
// Canonical unix socket permission map for `experimental_network`.
UnixSockets *map[string]NetworkUnixSocketPermission `json:"unixSockets,omitempty"`
}
type NetworkUnixSocketPermission ¶
type NetworkUnixSocketPermission string
const NetworkUnixSocketPermissionAllow NetworkUnixSocketPermission = "allow"
const NetworkUnixSocketPermissionDeny NetworkUnixSocketPermission = "deny"
type NewThreadModelDefaults ¶
type NewThreadModelDefaults struct {
// Model corresponds to the JSON schema field "model".
Model *string `json:"model,omitempty"`
// ModelReasoningEffort corresponds to the JSON schema field
// "modelReasoningEffort".
ModelReasoningEffort interface{} `json:"modelReasoningEffort,omitempty"`
// ServiceTier corresponds to the JSON schema field "serviceTier".
ServiceTier *string `json:"serviceTier,omitempty"`
}
type NonSteerableTurnKind ¶
type NonSteerableTurnKind string
const NonSteerableTurnKindCompact NonSteerableTurnKind = "compact"
const NonSteerableTurnKindReview NonSteerableTurnKind = "review"
type ParsedCommand ¶
type ParsedCommand interface{}
type PatchChangeKind ¶
type PatchChangeKind interface{}
type PermissionGrantScope ¶
type PermissionGrantScope string
const PermissionGrantScopeSession PermissionGrantScope = "session"
const PermissionGrantScopeTurn PermissionGrantScope = "turn"
type PermissionProfileListParams ¶
type PermissionProfileListParams struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Optional working directory to resolve project config layers.
Cwd *string `json:"cwd,omitempty"`
// Optional page size; defaults to the full result set.
Limit *int `json:"limit,omitempty"`
}
type PermissionProfileListResponse ¶
type PermissionProfileListResponse = SanitizedPermissionProfileListResponseJSON
type PermissionProfileSummary ¶
type PermissionProfileSummary struct {
// Whether the effective requirements allow selecting this profile.
Allowed bool `json:"allowed"`
// Optional user-facing description for display in clients.
Description *string `json:"description,omitempty"`
// Available permission profile identifier.
ID string `json:"id"`
}
type PermissionsRequestApprovalParams ¶
type PermissionsRequestApprovalParams struct {
ThreadID string `json:"threadId"`
TurnID string `json:"turnId"`
ItemID string `json:"itemId"`
Reason *string `json:"reason,omitempty"`
Permissions interface{} `json:"permissions"`
}
PermissionsRequestApprovalParams is maintained manually because the raw schema uses nested unions that the generator does not currently emit.
type PermissionsRequestApprovalResponse ¶
type PermissionsRequestApprovalResponse struct {
Permissions interface{} `json:"permissions"`
Scope interface{} `json:"scope,omitempty"`
}
PermissionsRequestApprovalResponse is maintained manually because the raw schema uses nested unions that the generator does not currently emit.
type Personality ¶
type Personality string
const PersonalityFriendly Personality = "friendly"
const PersonalityNone Personality = "none"
const PersonalityPragmatic Personality = "pragmatic"
type PlanDeltaNotification ¶
type PlanDeltaNotification = SanitizedPlanDeltaNotificationJSON
type PlanType ¶
type PlanType string
const PlanTypeBusiness PlanType = "business"
const PlanTypeEdu PlanType = "edu"
const PlanTypeEnterprise PlanType = "enterprise"
const PlanTypeEnterpriseCbpUsageBased PlanType = "enterprise_cbp_usage_based"
const PlanTypeFree PlanType = "free"
const PlanTypeGo PlanType = "go"
const PlanTypePlus PlanType = "plus"
const PlanTypePro PlanType = "pro"
const PlanTypeProlite PlanType = "prolite"
const PlanTypeSelfServeBusinessUsageBased PlanType = "self_serve_business_usage_based"
const PlanTypeTeam PlanType = "team"
const PlanTypeUnknown PlanType = "unknown"
type PluginAuthPolicy ¶
type PluginAuthPolicy string
const PluginAuthPolicyONINSTALL PluginAuthPolicy = "ON_INSTALL"
const PluginAuthPolicyONUSE PluginAuthPolicy = "ON_USE"
type PluginInstallParams ¶
type PluginInstallParams struct {
// MarketplacePath corresponds to the JSON schema field "marketplacePath".
MarketplacePath interface{} `json:"marketplacePath,omitempty"`
// PluginName corresponds to the JSON schema field "pluginName".
PluginName string `json:"pluginName"`
// RemoteMarketplaceName corresponds to the JSON schema field
// "remoteMarketplaceName".
RemoteMarketplaceName *string `json:"remoteMarketplaceName,omitempty"`
}
type PluginInstallResponse ¶
type PluginInstallResponse = SanitizedPluginInstallResponseJSON
type PluginInstalledParams ¶
type PluginInstalledParams struct {
// Optional working directories used to discover repo marketplaces.
Cwds []AbsolutePathBuf `json:"cwds,omitempty"`
// Additional uninstalled plugin names that should be returned when present
// locally. This is used by mention surfaces that intentionally expose install
// entrypoints.
InstallSuggestionPluginNames []string `json:"installSuggestionPluginNames,omitempty"`
}
type PluginInstalledResponse ¶
type PluginInstalledResponse interface{}
type PluginListMarketplaceKind ¶
type PluginListMarketplaceKind string
const PluginListMarketplaceKindCreatedByMeRemote PluginListMarketplaceKind = "created-by-me-remote"
const PluginListMarketplaceKindLocal PluginListMarketplaceKind = "local"
const PluginListMarketplaceKindVertical PluginListMarketplaceKind = "vertical"
const PluginListMarketplaceKindWorkspaceDirectory PluginListMarketplaceKind = "workspace-directory"
type PluginListParams ¶
type PluginListParams struct {
// Optional working directories used to discover repo marketplaces. When omitted,
// only home-scoped marketplaces and the official curated marketplace are
// considered.
Cwds []AbsolutePathBuf `json:"cwds,omitempty"`
// Optional marketplace kind filter. When omitted, only local marketplaces are
// queried, plus the default remote catalog when enabled by feature flag.
MarketplaceKinds []PluginListMarketplaceKind `json:"marketplaceKinds,omitempty"`
}
type PluginListResponse ¶
type PluginListResponse interface{}
type PluginReadParams ¶
type PluginReadParams struct {
// MarketplacePath corresponds to the JSON schema field "marketplacePath".
MarketplacePath interface{} `json:"marketplacePath,omitempty"`
// PluginName corresponds to the JSON schema field "pluginName".
PluginName string `json:"pluginName"`
// RemoteMarketplaceName corresponds to the JSON schema field
// "remoteMarketplaceName".
RemoteMarketplaceName *string `json:"remoteMarketplaceName,omitempty"`
}
type PluginReadResponse ¶
type PluginReadResponse interface{}
type PluginShareCheckoutParams ¶
type PluginShareCheckoutParams struct {
RemotePluginID string `json:"remotePluginId"`
}
type PluginShareCheckoutResponse ¶
type PluginShareCheckoutResponse interface{}
type PluginShareDeleteParams ¶
type PluginShareDeleteParams struct {
RemotePluginID string `json:"remotePluginId"`
}
type PluginShareDeleteResponse ¶
type PluginShareDeleteResponse interface{}
type PluginShareListParams ¶
type PluginShareListParams interface{}
type PluginShareListResponse ¶
type PluginShareListResponse interface{}
type PluginSharePrincipal ¶
type PluginSharePrincipal struct {
Name string `json:"name"`
PrincipalID string `json:"principalId"`
PrincipalType PluginSharePrincipalType `json:"principalType"`
Role PluginSharePrincipalRole `json:"role"`
}
type PluginShareSaveParams ¶
type PluginShareSaveParams struct {
Discoverability interface{} `json:"discoverability,omitempty"`
PluginPath AbsolutePathBuf `json:"pluginPath"`
RemotePluginID *string `json:"remotePluginId,omitempty"`
ShareTargets []PluginShareTarget `json:"shareTargets,omitempty"`
}
type PluginShareSaveResponse ¶
type PluginShareSaveResponse = SanitizedPluginShareSaveResponseJSON
type PluginShareTarget ¶
type PluginShareTarget struct {
PrincipalID string `json:"principalId"`
PrincipalType PluginSharePrincipalType `json:"principalType"`
Role PluginShareTargetRole `json:"role"`
}
type PluginShareUpdateTargetsParams ¶
type PluginShareUpdateTargetsParams struct {
Discoverability PluginShareUpdateDiscoverability `json:"discoverability"`
RemotePluginID string `json:"remotePluginId"`
ShareTargets []PluginShareTarget `json:"shareTargets"`
}
type PluginShareUpdateTargetsResponse ¶
type PluginShareUpdateTargetsResponse = SanitizedPluginShareUpdateTargetsResponseJSON
type PluginSkillReadParams ¶
type PluginSkillReadParams struct {
// RemoteMarketplaceName corresponds to the JSON schema field
// "remoteMarketplaceName".
RemoteMarketplaceName string `json:"remoteMarketplaceName"`
// RemotePluginID corresponds to the JSON schema field "remotePluginId".
RemotePluginID string `json:"remotePluginId"`
// SkillName corresponds to the JSON schema field "skillName".
SkillName string `json:"skillName"`
}
type PluginSkillReadResponse ¶
type PluginSkillReadResponse = SanitizedPluginSkillReadResponseJSON
type PluginUninstallParams ¶
type PluginUninstallParams struct {
// PluginID corresponds to the JSON schema field "pluginId".
PluginID string `json:"pluginId"`
}
type PluginUninstallResponse ¶
type PluginUninstallResponse interface{}
type PluginsMigration ¶
type ProcessExitedNotification ¶
type ProcessExitedNotification = SanitizedProcessExitedNotificationJSON
type ProcessOutputDeltaNotification ¶
type ProcessOutputDeltaNotification interface{}
type ProcessOutputStream ¶
type ProcessOutputStream interface{}
Stream label for `process/outputDelta` notifications.
type ProcessTerminalSize ¶
type ProcessTerminalSize struct {
// Terminal width in character cells.
Cols int `json:"cols"`
// Terminal height in character cells.
Rows int `json:"rows"`
}
PTY size in character cells for `process/spawn` PTY sessions.
type RateLimitReachedType ¶
type RateLimitReachedType string
const RateLimitReachedTypeRateLimitReached RateLimitReachedType = "rate_limit_reached"
const RateLimitReachedTypeWorkspaceMemberCreditsDepleted RateLimitReachedType = "workspace_member_credits_depleted"
const RateLimitReachedTypeWorkspaceMemberUsageLimitReached RateLimitReachedType = "workspace_member_usage_limit_reached"
const RateLimitReachedTypeWorkspaceOwnerCreditsDepleted RateLimitReachedType = "workspace_owner_credits_depleted"
const RateLimitReachedTypeWorkspaceOwnerUsageLimitReached RateLimitReachedType = "workspace_owner_usage_limit_reached"
type RateLimitResetCredit ¶
type RateLimitResetCredit struct {
// Backend-provided display description for this credit, or `null` when
// unavailable.
Description *string `json:"description,omitempty"`
// Unix timestamp in seconds when the credit expires, or `null` if it does not
// expire.
ExpiresAt *int `json:"expiresAt,omitempty"`
// Unix timestamp in seconds when the credit was granted.
GrantedAt int `json:"grantedAt"`
// Opaque backend identifier for this reset credit.
ID string `json:"id"`
// ResetType corresponds to the JSON schema field "resetType".
ResetType RateLimitResetType `json:"resetType"`
// Status corresponds to the JSON schema field "status".
Status RateLimitResetCreditStatus `json:"status"`
// Backend-provided display title for this credit, or `null` when unavailable.
Title *string `json:"title,omitempty"`
}
type RateLimitResetCreditStatus ¶
type RateLimitResetCreditStatus string
const RateLimitResetCreditStatusAvailable RateLimitResetCreditStatus = "available"
const RateLimitResetCreditStatusRedeemed RateLimitResetCreditStatus = "redeemed"
const RateLimitResetCreditStatusRedeeming RateLimitResetCreditStatus = "redeeming"
const RateLimitResetCreditStatusUnknown RateLimitResetCreditStatus = "unknown"
type RateLimitResetCreditsSummary ¶
type RateLimitResetCreditsSummary struct {
// AvailableCount corresponds to the JSON schema field "availableCount".
AvailableCount int `json:"availableCount"`
// Detail rows for available reset credits, when the backend provides them.
//
// `null` means only `availableCount` is known, while an empty array means details
// were fetched and no available credits were returned. The backend may cap this
// list, so its length can be less than `availableCount`.
Credits []RateLimitResetCredit `json:"credits,omitempty"`
}
type RateLimitResetType ¶
type RateLimitResetType string
const RateLimitResetTypeCodexRateLimits RateLimitResetType = "codexRateLimits"
const RateLimitResetTypeUnknown RateLimitResetType = "unknown"
type RateLimitSnapshot ¶
type RateLimitSnapshot struct {
// Credits corresponds to the JSON schema field "credits".
Credits interface{} `json:"credits,omitempty"`
// IndividualLimit corresponds to the JSON schema field "individualLimit".
IndividualLimit interface{} `json:"individualLimit,omitempty"`
// LimitID corresponds to the JSON schema field "limitId".
LimitID *string `json:"limitId,omitempty"`
// LimitName corresponds to the JSON schema field "limitName".
LimitName *string `json:"limitName,omitempty"`
// PlanType corresponds to the JSON schema field "planType".
PlanType interface{} `json:"planType,omitempty"`
// Primary corresponds to the JSON schema field "primary".
Primary interface{} `json:"primary,omitempty"`
// RateLimitReachedType corresponds to the JSON schema field
// "rateLimitReachedType".
RateLimitReachedType interface{} `json:"rateLimitReachedType,omitempty"`
// Secondary corresponds to the JSON schema field "secondary".
Secondary interface{} `json:"secondary,omitempty"`
}
type RateLimitWindow ¶
type RateLimitWindow struct {
// ResetsAt corresponds to the JSON schema field "resetsAt".
ResetsAt *int `json:"resetsAt,omitempty"`
// UsedPercent corresponds to the JSON schema field "usedPercent".
UsedPercent int `json:"usedPercent"`
// WindowDurationMins corresponds to the JSON schema field "windowDurationMins".
WindowDurationMins *int `json:"windowDurationMins,omitempty"`
}
type RawResponseItemCompletedNotification ¶
type RawResponseItemCompletedNotification = SanitizedRawResponseItemCompletedNotificationJSON
type RealtimeConversationVersion ¶
type RealtimeConversationVersion string
const RealtimeConversationVersionV1 RealtimeConversationVersion = "v1"
const RealtimeConversationVersionV2 RealtimeConversationVersion = "v2"
type RealtimeOutputModality ¶
type RealtimeOutputModality string
const RealtimeOutputModalityAudio RealtimeOutputModality = "audio"
const RealtimeOutputModalityText RealtimeOutputModality = "text"
type RealtimeVoice ¶
type RealtimeVoice string
const RealtimeVoiceAlloy RealtimeVoice = "alloy"
const RealtimeVoiceArbor RealtimeVoice = "arbor"
const RealtimeVoiceAsh RealtimeVoice = "ash"
const RealtimeVoiceBallad RealtimeVoice = "ballad"
const RealtimeVoiceBreeze RealtimeVoice = "breeze"
const RealtimeVoiceCedar RealtimeVoice = "cedar"
const RealtimeVoiceCoral RealtimeVoice = "coral"
const RealtimeVoiceCove RealtimeVoice = "cove"
const RealtimeVoiceEcho RealtimeVoice = "echo"
const RealtimeVoiceEmber RealtimeVoice = "ember"
const RealtimeVoiceJuniper RealtimeVoice = "juniper"
const RealtimeVoiceMaple RealtimeVoice = "maple"
const RealtimeVoiceMarin RealtimeVoice = "marin"
const RealtimeVoiceSage RealtimeVoice = "sage"
const RealtimeVoiceShimmer RealtimeVoice = "shimmer"
const RealtimeVoiceSol RealtimeVoice = "sol"
const RealtimeVoiceSpruce RealtimeVoice = "spruce"
const RealtimeVoiceVale RealtimeVoice = "vale"
const RealtimeVoiceVerse RealtimeVoice = "verse"
type ReasoningEffort ¶
type ReasoningEffort string
A non-empty reasoning effort value advertised by the model.
type ReasoningEffortOption ¶
type ReasoningEffortOption struct {
// Description corresponds to the JSON schema field "description".
Description string `json:"description"`
// ReasoningEffort corresponds to the JSON schema field "reasoningEffort".
ReasoningEffort ReasoningEffort `json:"reasoningEffort"`
}
type ReasoningItemContent ¶
type ReasoningItemContent interface{}
type ReasoningItemReasoningSummary ¶
type ReasoningItemReasoningSummary interface{}
type ReasoningSummary ¶
type ReasoningSummary interface{}
A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#reasoning-summaries
type ReasoningSummaryPartAddedNotification ¶
type ReasoningSummaryPartAddedNotification = SanitizedReasoningSummaryPartAddedNotificationJSON
type ReasoningSummaryTextDeltaNotification ¶
type ReasoningSummaryTextDeltaNotification = SanitizedReasoningSummaryTextDeltaNotificationJSON
type ReasoningTextDeltaNotification ¶
type ReasoningTextDeltaNotification = SanitizedReasoningTextDeltaNotificationJSON
type RemoteControlConnectionStatus ¶
type RemoteControlConnectionStatus string
const RemoteControlConnectionStatusConnected RemoteControlConnectionStatus = "connected"
const RemoteControlConnectionStatusConnecting RemoteControlConnectionStatus = "connecting"
const RemoteControlConnectionStatusDisabled RemoteControlConnectionStatus = "disabled"
const RemoteControlConnectionStatusErrored RemoteControlConnectionStatus = "errored"
type RemoteControlDisableParams ¶
type RemoteControlDisableParams struct {
// Ephemeral corresponds to the JSON schema field "ephemeral".
Ephemeral *bool `json:"ephemeral,omitempty"`
}
type RemoteControlEnableParams ¶
type RemoteControlEnableParams struct {
// Ephemeral corresponds to the JSON schema field "ephemeral".
Ephemeral *bool `json:"ephemeral,omitempty"`
}
type RemoteControlStatusChangedNotification ¶
type RemoteControlStatusChangedNotification = SanitizedRemoteControlStatusChangedNotificationJSON
type ResidencyRequirement ¶
type ResidencyRequirement string
const ResidencyRequirementUs ResidencyRequirement = "us"
type Resource ¶
type Resource struct {
// Meta corresponds to the JSON schema field "_meta".
Meta interface{} `json:"_meta,omitempty"`
// Annotations corresponds to the JSON schema field "annotations".
Annotations interface{} `json:"annotations,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Icons corresponds to the JSON schema field "icons".
Icons []interface{} `json:"icons,omitempty"`
// MimeType corresponds to the JSON schema field "mimeType".
MimeType *string `json:"mimeType,omitempty"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Size corresponds to the JSON schema field "size".
Size *int `json:"size,omitempty"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// Uri corresponds to the JSON schema field "uri".
Uri string `json:"uri"`
}
A known resource that the server is capable of reading.
type ResourceContent ¶
type ResourceContent interface{}
Contents returned when reading a resource from an MCP server.
type ResourceTemplate ¶
type ResourceTemplate struct {
// Annotations corresponds to the JSON schema field "annotations".
Annotations interface{} `json:"annotations,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// MimeType corresponds to the JSON schema field "mimeType".
MimeType *string `json:"mimeType,omitempty"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
// UriTemplate corresponds to the JSON schema field "uriTemplate".
UriTemplate string `json:"uriTemplate"`
}
A template description for resources available on the server.
type ResponseItem ¶
type ResponseItem interface{}
type ResponsesApiWebSearchAction ¶
type ResponsesApiWebSearchAction interface{}
type ReviewDecision ¶
type ReviewDecision interface{}
User's decision in response to an ExecApprovalRequest.
type ReviewDelivery ¶
type ReviewDelivery string
const ReviewDeliveryDetached ReviewDelivery = "detached"
const ReviewDeliveryInline ReviewDelivery = "inline"
type ReviewStartParams ¶
type ReviewStartParams struct {
// Where to run the review: inline (default) on the current thread or detached on
// a new thread (returned in `reviewThreadId`).
Delivery interface{} `json:"delivery,omitempty"`
// Target corresponds to the JSON schema field "target".
Target ReviewStartParamsTarget `json:"target"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type ReviewStartParamsTarget ¶
type ReviewStartParamsTarget interface{}
type ReviewStartResponse ¶
type ReviewStartResponse interface{}
type ReviewTarget ¶
type ReviewTarget interface{}
type SandboxMode ¶
type SandboxMode string
const SandboxModeDangerFullAccess SandboxMode = "danger-full-access"
const SandboxModeReadOnly SandboxMode = "read-only"
const SandboxModeWorkspaceWrite SandboxMode = "workspace-write"
type SandboxPolicy ¶
type SandboxPolicy interface{}
type SanitizedAccountLoginCompletedNotification ¶
type SanitizedAccountLoginCompletedNotification = SanitizedAccountLoginCompletedNotificationJSON
Aliases for JSON-suffixed schema types.
type SanitizedAccountLoginCompletedNotificationJSON ¶
type SanitizedAccountLoginCompletedNotificationJSON struct {
// Error corresponds to the JSON schema field "error".
Error *string `json:"error,omitempty"`
// LoginID corresponds to the JSON schema field "loginId".
LoginID *string `json:"loginId,omitempty"`
// Success corresponds to the JSON schema field "success".
Success bool `json:"success"`
}
type SanitizedAccountRateLimitsUpdatedNotification ¶
type SanitizedAccountRateLimitsUpdatedNotification = SanitizedAccountRateLimitsUpdatedNotificationJSON
type SanitizedAccountRateLimitsUpdatedNotificationJSON ¶
type SanitizedAccountRateLimitsUpdatedNotificationJSON struct {
// RateLimits corresponds to the JSON schema field "rateLimits".
RateLimits RateLimitSnapshot `json:"rateLimits"`
}
Sparse rolling rate-limit update.
Clients should merge available values into the most recent `account/rateLimits/read` response or refetch that snapshot. Nullable account metadata may be unavailable in a rolling update and does not clear a previously observed value.
type SanitizedAccountUpdatedNotification ¶
type SanitizedAccountUpdatedNotification = SanitizedAccountUpdatedNotificationJSON
type SanitizedAccountUpdatedNotificationJSON ¶
type SanitizedAccountUpdatedNotificationJSON struct {
// AuthMode corresponds to the JSON schema field "authMode".
AuthMode interface{} `json:"authMode,omitempty"`
// PlanType corresponds to the JSON schema field "planType".
PlanType interface{} `json:"planType,omitempty"`
}
type SanitizedAgentMessageDeltaNotification ¶
type SanitizedAgentMessageDeltaNotification = SanitizedAgentMessageDeltaNotificationJSON
type SanitizedAgentMessageDeltaNotificationJSON ¶
type SanitizedAgentMessageDeltaNotificationJSON struct {
// Delta corresponds to the JSON schema field "delta".
Delta string `json:"delta"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedAppListUpdatedNotification ¶
type SanitizedAppListUpdatedNotification = SanitizedAppListUpdatedNotificationJSON
type SanitizedAppListUpdatedNotificationJSON ¶
type SanitizedAppListUpdatedNotificationJSON struct {
// Data corresponds to the JSON schema field "data".
Data []AppInfo `json:"data"`
}
EXPERIMENTAL - notification emitted when the app list changes.
type SanitizedApplyPatchApprovalParams ¶
type SanitizedApplyPatchApprovalParams = SanitizedApplyPatchApprovalParamsJSON
type SanitizedApplyPatchApprovalParamsJSON ¶
type SanitizedApplyPatchApprovalParamsJSON struct {
// Use to correlate this with [codex_protocol::protocol::PatchApplyBeginEvent] and
// [codex_protocol::protocol::PatchApplyEndEvent].
CallID string `json:"callId"`
// ConversationID corresponds to the JSON schema field "conversationId".
ConversationID ThreadID `json:"conversationId"`
// FileChanges corresponds to the JSON schema field "fileChanges".
FileChanges map[string]interface{} `json:"fileChanges"`
// When set, the agent is asking the user to allow writes under this root for the
// remainder of the session (unclear if this is honored today).
GrantRoot *string `json:"grantRoot,omitempty"`
// Optional explanatory reason (e.g. request for extra write access).
Reason *string `json:"reason,omitempty"`
}
type SanitizedApplyPatchApprovalResponse ¶
type SanitizedApplyPatchApprovalResponse = SanitizedApplyPatchApprovalResponseJSON
type SanitizedApplyPatchApprovalResponseJSON ¶
type SanitizedApplyPatchApprovalResponseJSON struct {
// Decision corresponds to the JSON schema field "decision".
Decision SanitizedApplyPatchApprovalResponseJSONDecision `json:"decision"`
}
type SanitizedApplyPatchApprovalResponseJSONDecision ¶
type SanitizedApplyPatchApprovalResponseJSONDecision interface{}
type SanitizedAppsListParams ¶
type SanitizedAppsListParams = SanitizedAppsListParamsJSON
type SanitizedAppsListParamsJSON ¶
type SanitizedAppsListParamsJSON struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// When true, bypass app caches and fetch the latest data from sources.
ForceRefetch *bool `json:"forceRefetch,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
// Optional thread id used to evaluate app feature gating from that thread's
// config.
ThreadID *string `json:"threadId,omitempty"`
}
EXPERIMENTAL - list available apps/connectors.
type SanitizedAppsListResponse ¶
type SanitizedAppsListResponse = SanitizedAppsListResponseJSON
type SanitizedAppsListResponseJSON ¶
type SanitizedAppsListResponseJSON struct {
// Data corresponds to the JSON schema field "data".
Data []AppInfo `json:"data"`
// Opaque cursor to pass to the next call to continue after the last item. If
// None, there are no more items to return.
NextCursor *string `json:"nextCursor,omitempty"`
}
EXPERIMENTAL - app list response.
type SanitizedAttestationGenerateResponse ¶
type SanitizedAttestationGenerateResponse = SanitizedAttestationGenerateResponseJSON
type SanitizedAttestationGenerateResponseJSON ¶
type SanitizedAttestationGenerateResponseJSON struct {
// Opaque client attestation token.
Token string `json:"token"`
}
type SanitizedCancelLoginAccountParams ¶
type SanitizedCancelLoginAccountParams = SanitizedCancelLoginAccountParamsJSON
type SanitizedCancelLoginAccountParamsJSON ¶
type SanitizedCancelLoginAccountParamsJSON struct {
// LoginID corresponds to the JSON schema field "loginId".
LoginID string `json:"loginId"`
}
type SanitizedCancelLoginAccountResponse ¶
type SanitizedCancelLoginAccountResponse = SanitizedCancelLoginAccountResponseJSON
type SanitizedCancelLoginAccountResponseJSON ¶
type SanitizedCancelLoginAccountResponseJSON struct {
// Status corresponds to the JSON schema field "status".
Status CancelLoginAccountStatus `json:"status"`
}
type SanitizedChatgptAuthTokensRefreshParams ¶
type SanitizedChatgptAuthTokensRefreshParams = SanitizedChatgptAuthTokensRefreshParamsJSON
type SanitizedChatgptAuthTokensRefreshParamsJSON ¶
type SanitizedChatgptAuthTokensRefreshParamsJSON struct {
// Workspace/account identifier that Codex was previously using.
//
// Clients that manage multiple accounts/workspaces can use this as a hint to
// refresh the token for the correct workspace.
//
// This may be `null` when the prior auth state did not include a workspace
// identifier (`chatgpt_account_id`).
PreviousAccountID *string `json:"previousAccountId,omitempty"`
// Reason corresponds to the JSON schema field "reason".
Reason SanitizedChatgptAuthTokensRefreshParamsJSONReason `json:"reason"`
}
type SanitizedChatgptAuthTokensRefreshParamsJSONReason ¶
type SanitizedChatgptAuthTokensRefreshParamsJSONReason interface{}
type SanitizedChatgptAuthTokensRefreshResponse ¶
type SanitizedChatgptAuthTokensRefreshResponse = SanitizedChatgptAuthTokensRefreshResponseJSON
type SanitizedChatgptAuthTokensRefreshResponseJSON ¶
type SanitizedChatgptAuthTokensRefreshResponseJSON struct {
// AccessToken corresponds to the JSON schema field "accessToken".
AccessToken string `json:"accessToken"`
// ChatgptAccountID corresponds to the JSON schema field "chatgptAccountId".
ChatgptAccountID string `json:"chatgptAccountId"`
// ChatgptPlanType corresponds to the JSON schema field "chatgptPlanType".
ChatgptPlanType *string `json:"chatgptPlanType,omitempty"`
}
type SanitizedCommandExecResponse ¶
type SanitizedCommandExecResponse = SanitizedCommandExecResponseJSON
type SanitizedCommandExecResponseJSON ¶
type SanitizedCommandExecResponseJSON struct {
// Process exit code.
ExitCode int `json:"exitCode"`
// Buffered stderr capture.
//
// Empty when stderr was streamed via `command/exec/outputDelta`.
Stderr string `json:"stderr"`
// Buffered stdout capture.
//
// Empty when stdout was streamed via `command/exec/outputDelta`.
Stdout string `json:"stdout"`
}
Final buffered result for `command/exec`.
type SanitizedCommandExecTerminateParams ¶
type SanitizedCommandExecTerminateParams = SanitizedCommandExecTerminateParamsJSON
type SanitizedCommandExecTerminateParamsJSON ¶
type SanitizedCommandExecTerminateParamsJSON struct {
// Client-supplied, connection-scoped `processId` from the original `command/exec`
// request.
ProcessID string `json:"processId"`
}
Terminate a running `command/exec` session.
type SanitizedCommandExecWriteParams ¶
type SanitizedCommandExecWriteParams = SanitizedCommandExecWriteParamsJSON
type SanitizedCommandExecWriteParamsJSON ¶
type SanitizedCommandExecWriteParamsJSON struct {
// Close stdin after writing `deltaBase64`, if present.
CloseStdin *bool `json:"closeStdin,omitempty"`
// Optional base64-encoded stdin bytes to write.
DeltaBase64 *string `json:"deltaBase64,omitempty"`
// Client-supplied, connection-scoped `processId` from the original `command/exec`
// request.
ProcessID string `json:"processId"`
}
Write stdin bytes to a running `command/exec` session, close stdin, or both.
type SanitizedCommandExecutionOutputDeltaNotification ¶
type SanitizedCommandExecutionOutputDeltaNotification = SanitizedCommandExecutionOutputDeltaNotificationJSON
type SanitizedCommandExecutionOutputDeltaNotificationJSON ¶
type SanitizedCommandExecutionOutputDeltaNotificationJSON struct {
// Delta corresponds to the JSON schema field "delta".
Delta string `json:"delta"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedCommandExecutionRequestApprovalResponse ¶
type SanitizedCommandExecutionRequestApprovalResponse = SanitizedCommandExecutionRequestApprovalResponseJSON
type SanitizedCommandExecutionRequestApprovalResponseJSON ¶
type SanitizedCommandExecutionRequestApprovalResponseJSON struct {
// Decision corresponds to the JSON schema field "decision".
Decision SanitizedCommandExecutionRequestApprovalResponseJSONDecision `json:"decision"`
}
type SanitizedCommandExecutionRequestApprovalResponseJSONDecision ¶
type SanitizedCommandExecutionRequestApprovalResponseJSONDecision interface{}
type SanitizedConfigBatchWriteParams ¶
type SanitizedConfigBatchWriteParams = SanitizedConfigBatchWriteParamsJSON
type SanitizedConfigBatchWriteParamsJSON ¶
type SanitizedConfigBatchWriteParamsJSON struct {
// Edits corresponds to the JSON schema field "edits".
Edits []ConfigEdit `json:"edits"`
// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
ExpectedVersion *string `json:"expectedVersion,omitempty"`
// Path to the config file to write; defaults to the user's `config.toml` when
// omitted.
FilePath *string `json:"filePath,omitempty"`
// When true, hot-reload the updated user config into all loaded threads after
// writing.
ReloadUserConfig *bool `json:"reloadUserConfig,omitempty"`
}
type SanitizedConfigReadParams ¶
type SanitizedConfigReadParams = SanitizedConfigReadParamsJSON
type SanitizedConfigReadParamsJSON ¶
type SanitizedConfigReadParamsJSON struct {
// Optional working directory to resolve project config layers. If specified,
// return the effective config as seen from that directory (i.e., including any
// project layers between `cwd` and the project/repo root).
Cwd *string `json:"cwd,omitempty"`
// IncludeLayers corresponds to the JSON schema field "includeLayers".
IncludeLayers *bool `json:"includeLayers,omitempty"`
}
type SanitizedConfigRequirementsReadResponse ¶
type SanitizedConfigRequirementsReadResponse = SanitizedConfigRequirementsReadResponseJSON
type SanitizedConfigRequirementsReadResponseJSON ¶
type SanitizedConfigRequirementsReadResponseJSON struct {
// Null if no requirements are configured (e.g. no requirements.toml/MDM entries).
Requirements interface{} `json:"requirements,omitempty"`
}
type SanitizedConfigValueWriteParams ¶
type SanitizedConfigValueWriteParams = SanitizedConfigValueWriteParamsJSON
type SanitizedConfigValueWriteParamsJSON ¶
type SanitizedConfigValueWriteParamsJSON struct {
// ExpectedVersion corresponds to the JSON schema field "expectedVersion".
ExpectedVersion *string `json:"expectedVersion,omitempty"`
// Path to the config file to write; defaults to the user's `config.toml` when
// omitted.
FilePath *string `json:"filePath,omitempty"`
// KeyPath corresponds to the JSON schema field "keyPath".
KeyPath string `json:"keyPath"`
// MergeStrategy corresponds to the JSON schema field "mergeStrategy".
MergeStrategy MergeStrategy `json:"mergeStrategy"`
// Value corresponds to the JSON schema field "value".
Value interface{} `json:"value"`
}
type SanitizedConfigWarningNotification ¶
type SanitizedConfigWarningNotification = SanitizedConfigWarningNotificationJSON
type SanitizedConfigWarningNotificationJSON ¶
type SanitizedConfigWarningNotificationJSON struct {
// Optional extra guidance or error details.
Details *string `json:"details,omitempty"`
// Optional path to the config file that triggered the warning.
Path *string `json:"path,omitempty"`
// Optional range for the error location inside the config file.
Range interface{} `json:"range,omitempty"`
// Concise summary of the warning.
Summary string `json:"summary"`
}
type SanitizedConsumeAccountRateLimitResetCreditParams ¶
type SanitizedConsumeAccountRateLimitResetCreditParams = SanitizedConsumeAccountRateLimitResetCreditParamsJSON
type SanitizedConsumeAccountRateLimitResetCreditParamsJSON ¶
type SanitizedConsumeAccountRateLimitResetCreditParamsJSON struct {
// Opaque reset-credit identifier to redeem. When omitted, the backend selects the
// next available credit.
CreditID *string `json:"creditId,omitempty"`
// Identifies one logical reset attempt. A UUID is recommended; reuse the same
// value when retrying that attempt.
IdempotencyKey string `json:"idempotencyKey"`
}
type SanitizedConsumeAccountRateLimitResetCreditResponse ¶
type SanitizedConsumeAccountRateLimitResetCreditResponse = SanitizedConsumeAccountRateLimitResetCreditResponseJSON
type SanitizedConsumeAccountRateLimitResetCreditResponseJSON ¶
type SanitizedConsumeAccountRateLimitResetCreditResponseJSON struct {
// Outcome corresponds to the JSON schema field "outcome".
Outcome SanitizedConsumeAccountRateLimitResetCreditResponseJSONOutcome `json:"outcome"`
}
type SanitizedConsumeAccountRateLimitResetCreditResponseJSONOutcome ¶
type SanitizedConsumeAccountRateLimitResetCreditResponseJSONOutcome interface{}
type SanitizedContextCompactedNotification ¶
type SanitizedContextCompactedNotification = SanitizedContextCompactedNotificationJSON
type SanitizedContextCompactedNotificationJSON
deprecated
type SanitizedDeprecationNoticeNotification ¶
type SanitizedDeprecationNoticeNotification = SanitizedDeprecationNoticeNotificationJSON
type SanitizedDynamicToolCallParams ¶
type SanitizedDynamicToolCallParams = SanitizedDynamicToolCallParamsJSON
type SanitizedDynamicToolCallParamsJSON ¶
type SanitizedDynamicToolCallParamsJSON struct {
// Arguments corresponds to the JSON schema field "arguments".
Arguments interface{} `json:"arguments"`
// CallID corresponds to the JSON schema field "callId".
CallID string `json:"callId"`
// Namespace corresponds to the JSON schema field "namespace".
Namespace *string `json:"namespace,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// Tool corresponds to the JSON schema field "tool".
Tool string `json:"tool"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedDynamicToolCallResponse ¶
type SanitizedDynamicToolCallResponse = SanitizedDynamicToolCallResponseJSON
type SanitizedDynamicToolCallResponseJSON ¶
type SanitizedDynamicToolCallResponseJSON struct {
// ContentItems corresponds to the JSON schema field "contentItems".
ContentItems []SanitizedDynamicToolCallResponseJSONContentItemsElem `json:"contentItems"`
// Success corresponds to the JSON schema field "success".
Success bool `json:"success"`
}
type SanitizedDynamicToolCallResponseJSONContentItemsElem ¶
type SanitizedDynamicToolCallResponseJSONContentItemsElem interface{}
type SanitizedErrorNotification ¶
type SanitizedErrorNotification = SanitizedErrorNotificationJSON
type SanitizedErrorNotificationJSON ¶
type SanitizedErrorNotificationJSON struct {
// Error corresponds to the JSON schema field "error".
Error TurnError `json:"error"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
// WillRetry corresponds to the JSON schema field "willRetry".
WillRetry bool `json:"willRetry"`
}
type SanitizedExecCommandApprovalParams ¶
type SanitizedExecCommandApprovalParams = SanitizedExecCommandApprovalParamsJSON
type SanitizedExecCommandApprovalParamsJSON ¶
type SanitizedExecCommandApprovalParamsJSON struct {
// Identifier for this specific approval callback.
ApprovalID *string `json:"approvalId,omitempty"`
// Use to correlate this with [codex_protocol::protocol::ExecCommandBeginEvent]
// and [codex_protocol::protocol::ExecCommandEndEvent].
CallID string `json:"callId"`
// Command corresponds to the JSON schema field "command".
Command []string `json:"command"`
// ConversationID corresponds to the JSON schema field "conversationId".
ConversationID ThreadID `json:"conversationId"`
// Cwd corresponds to the JSON schema field "cwd".
Cwd string `json:"cwd"`
// ParsedCmd corresponds to the JSON schema field "parsedCmd".
ParsedCmd []SanitizedExecCommandApprovalParamsJSONParsedCmdElem `json:"parsedCmd"`
// Reason corresponds to the JSON schema field "reason".
Reason *string `json:"reason,omitempty"`
}
type SanitizedExecCommandApprovalParamsJSONParsedCmdElem ¶
type SanitizedExecCommandApprovalParamsJSONParsedCmdElem interface{}
type SanitizedExecCommandApprovalResponse ¶
type SanitizedExecCommandApprovalResponse = SanitizedExecCommandApprovalResponseJSON
type SanitizedExecCommandApprovalResponseJSON ¶
type SanitizedExecCommandApprovalResponseJSON struct {
// Decision corresponds to the JSON schema field "decision".
Decision SanitizedExecCommandApprovalResponseJSONDecision `json:"decision"`
}
type SanitizedExecCommandApprovalResponseJSONDecision ¶
type SanitizedExecCommandApprovalResponseJSONDecision interface{}
type SanitizedExperimentalFeatureEnablementSetParams ¶
type SanitizedExperimentalFeatureEnablementSetParams = SanitizedExperimentalFeatureEnablementSetParamsJSON
type SanitizedExperimentalFeatureEnablementSetParamsJSON ¶
type SanitizedExperimentalFeatureEnablementSetParamsJSON struct {
// Process-wide runtime feature enablement keyed by canonical feature name.
//
// Only named features are updated. Omitted features are left unchanged. Send an
// empty map for a no-op.
Enablement map[string]bool `json:"enablement"`
}
type SanitizedExperimentalFeatureEnablementSetResponse ¶
type SanitizedExperimentalFeatureEnablementSetResponse = SanitizedExperimentalFeatureEnablementSetResponseJSON
type SanitizedExperimentalFeatureListParams ¶
type SanitizedExperimentalFeatureListParams = SanitizedExperimentalFeatureListParamsJSON
type SanitizedExperimentalFeatureListParamsJSON ¶
type SanitizedExperimentalFeatureListParamsJSON struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
// 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 *string `json:"threadId,omitempty"`
}
type SanitizedExternalAgentConfigDetectParams ¶
type SanitizedExternalAgentConfigDetectParams = SanitizedExternalAgentConfigDetectParamsJSON
type SanitizedExternalAgentConfigDetectResponse ¶
type SanitizedExternalAgentConfigDetectResponse = SanitizedExternalAgentConfigDetectResponseJSON
type SanitizedExternalAgentConfigDetectResponseJSON ¶
type SanitizedExternalAgentConfigDetectResponseJSON struct {
// Items corresponds to the JSON schema field "items".
Items []ExternalAgentConfigMigrationItem `json:"items"`
}
type SanitizedExternalAgentConfigImportCompletedNotification ¶
type SanitizedExternalAgentConfigImportCompletedNotification = SanitizedExternalAgentConfigImportCompletedNotificationJSON
type SanitizedExternalAgentConfigImportCompletedNotificationJSON ¶
type SanitizedExternalAgentConfigImportCompletedNotificationJSON struct {
// ImportID corresponds to the JSON schema field "importId".
ImportID string `json:"importId"`
// ItemTypeResults corresponds to the JSON schema field "itemTypeResults".
ItemTypeResults []ExternalAgentConfigImportTypeResult `json:"itemTypeResults"`
}
type SanitizedExternalAgentConfigImportHistoriesReadResponse ¶
type SanitizedExternalAgentConfigImportHistoriesReadResponse = SanitizedExternalAgentConfigImportHistoriesReadResponseJSON
type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON ¶
type SanitizedExternalAgentConfigImportHistoriesReadResponseJSON struct {
// Data corresponds to the JSON schema field "data".
Data []ExternalAgentConfigImportHistory `json:"data"`
}
type SanitizedExternalAgentConfigImportParams ¶
type SanitizedExternalAgentConfigImportParams = SanitizedExternalAgentConfigImportParamsJSON
type SanitizedExternalAgentConfigImportParamsJSON ¶
type SanitizedExternalAgentConfigImportParamsJSON struct {
// MigrationItems corresponds to the JSON schema field "migrationItems".
MigrationItems []ExternalAgentConfigMigrationItem `json:"migrationItems"`
// Source product that produced the migration items. Missing means unspecified.
Source *string `json:"source,omitempty"`
}
type SanitizedExternalAgentConfigImportProgressNotification ¶
type SanitizedExternalAgentConfigImportProgressNotification = SanitizedExternalAgentConfigImportProgressNotificationJSON
type SanitizedExternalAgentConfigImportProgressNotificationJSON ¶
type SanitizedExternalAgentConfigImportProgressNotificationJSON struct {
// ImportID corresponds to the JSON schema field "importId".
ImportID string `json:"importId"`
// ItemTypeResults corresponds to the JSON schema field "itemTypeResults".
ItemTypeResults []ExternalAgentConfigImportTypeResult `json:"itemTypeResults"`
}
type SanitizedExternalAgentConfigImportResponse ¶
type SanitizedExternalAgentConfigImportResponse = SanitizedExternalAgentConfigImportResponseJSON
type SanitizedExternalAgentConfigImportResponseJSON ¶
type SanitizedExternalAgentConfigImportResponseJSON struct {
// ImportID corresponds to the JSON schema field "importId".
ImportID string `json:"importId"`
}
type SanitizedFeedbackUploadParams ¶
type SanitizedFeedbackUploadParams = SanitizedFeedbackUploadParamsJSON
type SanitizedFeedbackUploadParamsJSON ¶
type SanitizedFeedbackUploadParamsJSON struct {
// Classification corresponds to the JSON schema field "classification".
Classification string `json:"classification"`
// ExtraLogFiles corresponds to the JSON schema field "extraLogFiles".
ExtraLogFiles []string `json:"extraLogFiles,omitempty"`
// IncludeLogs corresponds to the JSON schema field "includeLogs".
IncludeLogs *bool `json:"includeLogs,omitempty"`
// Reason corresponds to the JSON schema field "reason".
Reason *string `json:"reason,omitempty"`
// Tags corresponds to the JSON schema field "tags".
Tags *map[string]string `json:"tags,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
}
type SanitizedFeedbackUploadResponse ¶
type SanitizedFeedbackUploadResponse = SanitizedFeedbackUploadResponseJSON
type SanitizedFeedbackUploadResponseJSON ¶
type SanitizedFeedbackUploadResponseJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedFileChangeOutputDeltaNotification ¶
type SanitizedFileChangeOutputDeltaNotification = SanitizedFileChangeOutputDeltaNotificationJSON
type SanitizedFileChangeOutputDeltaNotificationJSON ¶
type SanitizedFileChangeOutputDeltaNotificationJSON struct {
// Delta corresponds to the JSON schema field "delta".
Delta string `json:"delta"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
Deprecated legacy notification for `apply_patch` textual output.
The server no longer emits this notification.
type SanitizedFileChangePatchUpdatedNotification ¶
type SanitizedFileChangePatchUpdatedNotification = SanitizedFileChangePatchUpdatedNotificationJSON
type SanitizedFileChangePatchUpdatedNotificationJSON ¶
type SanitizedFileChangePatchUpdatedNotificationJSON struct {
// Changes corresponds to the JSON schema field "changes".
Changes []FileUpdateChange `json:"changes"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedFileChangeRequestApprovalParams ¶
type SanitizedFileChangeRequestApprovalParams = SanitizedFileChangeRequestApprovalParamsJSON
type SanitizedFileChangeRequestApprovalParamsJSON ¶
type SanitizedFileChangeRequestApprovalParamsJSON struct {
// [UNSTABLE] When set, the agent is asking the user to allow writes under this
// root for the remainder of the session (unclear if this is honored today).
GrantRoot *string `json:"grantRoot,omitempty"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// Optional explanatory reason (e.g. request for extra write access).
Reason *string `json:"reason,omitempty"`
// Unix timestamp (in milliseconds) when this approval request started.
StartedAtMs int `json:"startedAtMs"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedFileChangeRequestApprovalResponse ¶
type SanitizedFileChangeRequestApprovalResponse = SanitizedFileChangeRequestApprovalResponseJSON
type SanitizedFileChangeRequestApprovalResponseJSON ¶
type SanitizedFileChangeRequestApprovalResponseJSON struct {
// Decision corresponds to the JSON schema field "decision".
Decision SanitizedFileChangeRequestApprovalResponseJSONDecision `json:"decision"`
}
type SanitizedFileChangeRequestApprovalResponseJSONDecision ¶
type SanitizedFileChangeRequestApprovalResponseJSONDecision interface{}
type SanitizedFsGetMetadataResponse ¶
type SanitizedFsGetMetadataResponse = SanitizedFsGetMetadataResponseJSON
type SanitizedFsGetMetadataResponseJSON ¶
type SanitizedFsGetMetadataResponseJSON struct {
// File creation time in Unix milliseconds when available, otherwise `0`.
CreatedAtMs int `json:"createdAtMs"`
// Whether the path resolves to a directory.
IsDirectory bool `json:"isDirectory"`
// Whether the path resolves to a regular file.
IsFile bool `json:"isFile"`
// Whether the path itself is a symbolic link.
IsSymlink bool `json:"isSymlink"`
// File modification time in Unix milliseconds when available, otherwise `0`.
ModifiedAtMs int `json:"modifiedAtMs"`
}
Metadata returned by `fs/getMetadata`.
type SanitizedFsReadDirectoryResponse ¶
type SanitizedFsReadDirectoryResponse = SanitizedFsReadDirectoryResponseJSON
type SanitizedFsReadDirectoryResponseJSON ¶
type SanitizedFsReadDirectoryResponseJSON struct {
// Direct child entries in the requested directory.
Entries []FsReadDirectoryEntry `json:"entries"`
}
Directory entries returned by `fs/readDirectory`.
type SanitizedFsReadFileResponse ¶
type SanitizedFsReadFileResponse = SanitizedFsReadFileResponseJSON
type SanitizedFsReadFileResponseJSON ¶
type SanitizedFsReadFileResponseJSON struct {
// File contents encoded as base64.
DataBase64 string `json:"dataBase64"`
}
Base64-encoded file contents returned by `fs/readFile`.
type SanitizedFsUnwatchParams ¶
type SanitizedFsUnwatchParams = SanitizedFsUnwatchParamsJSON
type SanitizedFsUnwatchParamsJSON ¶
type SanitizedFsUnwatchParamsJSON struct {
// Watch identifier previously provided to `fs/watch`.
WatchID string `json:"watchId"`
}
Stop filesystem watch notifications for a prior `fs/watch`.
type SanitizedFuzzyFileSearchParams ¶
type SanitizedFuzzyFileSearchParams = SanitizedFuzzyFileSearchParamsJSON
type SanitizedFuzzyFileSearchParamsJSON ¶
type SanitizedFuzzyFileSearchParamsJSON struct {
// CancellationToken corresponds to the JSON schema field "cancellationToken".
CancellationToken *string `json:"cancellationToken,omitempty"`
// Query corresponds to the JSON schema field "query".
Query string `json:"query"`
// Roots corresponds to the JSON schema field "roots".
Roots []string `json:"roots"`
}
type SanitizedFuzzyFileSearchResponse ¶
type SanitizedFuzzyFileSearchResponse = SanitizedFuzzyFileSearchResponseJSON
type SanitizedFuzzyFileSearchResponseJSON ¶
type SanitizedFuzzyFileSearchResponseJSON struct {
// Files corresponds to the JSON schema field "files".
Files []FuzzyFileSearchResult `json:"files"`
}
type SanitizedFuzzyFileSearchSessionCompletedNotification ¶
type SanitizedFuzzyFileSearchSessionCompletedNotification = SanitizedFuzzyFileSearchSessionCompletedNotificationJSON
type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON ¶
type SanitizedFuzzyFileSearchSessionCompletedNotificationJSON struct {
// SessionID corresponds to the JSON schema field "sessionId".
SessionID string `json:"sessionId"`
}
type SanitizedFuzzyFileSearchSessionUpdatedNotification ¶
type SanitizedFuzzyFileSearchSessionUpdatedNotification = SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON
type SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON ¶
type SanitizedFuzzyFileSearchSessionUpdatedNotificationJSON struct {
// Files corresponds to the JSON schema field "files".
Files []FuzzyFileSearchResult `json:"files"`
// Query corresponds to the JSON schema field "query".
Query string `json:"query"`
// SessionID corresponds to the JSON schema field "sessionId".
SessionID string `json:"sessionId"`
}
type SanitizedGetAccountParams ¶
type SanitizedGetAccountParams = SanitizedGetAccountParamsJSON
type SanitizedGetAccountParamsJSON ¶
type SanitizedGetAccountParamsJSON struct {
// When `true`, requests a proactive token refresh before returning.
//
// In managed auth mode this triggers the normal refresh-token flow. In external
// auth mode this flag is ignored. Clients should refresh tokens themselves and
// call `account/login/start` with `chatgptAuthTokens`.
RefreshToken *bool `json:"refreshToken,omitempty"`
}
type SanitizedGetAccountRateLimitsResponseJSONRateLimits ¶
type SanitizedGetAccountRateLimitsResponseJSONRateLimits struct {
// Credits corresponds to the JSON schema field "credits".
Credits interface{} `json:"credits,omitempty"`
// IndividualLimit corresponds to the JSON schema field "individualLimit".
IndividualLimit interface{} `json:"individualLimit,omitempty"`
// LimitID corresponds to the JSON schema field "limitId".
LimitID *string `json:"limitId,omitempty"`
// LimitName corresponds to the JSON schema field "limitName".
LimitName *string `json:"limitName,omitempty"`
// PlanType corresponds to the JSON schema field "planType".
PlanType interface{} `json:"planType,omitempty"`
// Primary corresponds to the JSON schema field "primary".
Primary interface{} `json:"primary,omitempty"`
// RateLimitReachedType corresponds to the JSON schema field
// "rateLimitReachedType".
RateLimitReachedType interface{} `json:"rateLimitReachedType,omitempty"`
// Secondary corresponds to the JSON schema field "secondary".
Secondary interface{} `json:"secondary,omitempty"`
}
type SanitizedGetAccountResponse ¶
type SanitizedGetAccountResponse = SanitizedGetAccountResponseJSON
type SanitizedGetAccountResponseJSON ¶
type SanitizedGetAccountResponseJSON struct {
// Account corresponds to the JSON schema field "account".
Account interface{} `json:"account,omitempty"`
// RequiresOpenaiAuth corresponds to the JSON schema field "requiresOpenaiAuth".
RequiresOpenaiAuth bool `json:"requiresOpenaiAuth"`
}
type SanitizedGetAccountTokenUsageResponse ¶
type SanitizedGetAccountTokenUsageResponse = SanitizedGetAccountTokenUsageResponseJSON
type SanitizedGetAccountTokenUsageResponseJSON ¶
type SanitizedGetAccountTokenUsageResponseJSON struct {
// DailyUsageBuckets corresponds to the JSON schema field "dailyUsageBuckets".
DailyUsageBuckets []AccountTokenUsageDailyBucket `json:"dailyUsageBuckets,omitempty"`
// Summary corresponds to the JSON schema field "summary".
Summary AccountTokenUsageSummary `json:"summary"`
}
type SanitizedGetWorkspaceMessagesResponse ¶
type SanitizedGetWorkspaceMessagesResponse = SanitizedGetWorkspaceMessagesResponseJSON
type SanitizedGetWorkspaceMessagesResponseJSON ¶
type SanitizedGetWorkspaceMessagesResponseJSON struct {
// Whether the workspace-message backend route is available for this client.
FeatureEnabled bool `json:"featureEnabled"`
// Active workspace messages returned by the backend.
Messages []WorkspaceMessage `json:"messages"`
}
type SanitizedGuardianWarningNotification ¶
type SanitizedGuardianWarningNotification = SanitizedGuardianWarningNotificationJSON
type SanitizedHooksListParams ¶
type SanitizedHooksListParams = SanitizedHooksListParamsJSON
type SanitizedHooksListParamsJSON ¶
type SanitizedHooksListParamsJSON struct {
// When empty, defaults to the current session working directory.
Cwds []string `json:"cwds,omitempty"`
}
type SanitizedInitializeParams ¶
type SanitizedInitializeParams = SanitizedInitializeParamsJSON
type SanitizedInitializeParamsJSON ¶
type SanitizedInitializeParamsJSON struct {
// Capabilities corresponds to the JSON schema field "capabilities".
Capabilities interface{} `json:"capabilities,omitempty"`
// ClientInfo corresponds to the JSON schema field "clientInfo".
ClientInfo ClientInfo `json:"clientInfo"`
}
type SanitizedListMCPServerStatusParams ¶
type SanitizedListMCPServerStatusParams = SanitizedListMCPServerStatusParamsJSON
type SanitizedListMCPServerStatusParamsJSON ¶
type SanitizedListMCPServerStatusParamsJSON struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Controls how much MCP inventory data to fetch for each server. Defaults to
// `Full` when omitted.
Detail interface{} `json:"detail,omitempty"`
// Optional page size; defaults to a server-defined value.
Limit *int `json:"limit,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
}
type SanitizedListMCPServerStatusResponse ¶
type SanitizedListMCPServerStatusResponse = SanitizedListMCPServerStatusResponseJSON
type SanitizedListMCPServerStatusResponseJSON ¶
type SanitizedListMCPServerStatusResponseJSON struct {
// Data corresponds to the JSON schema field "data".
Data []MCPServerStatus `json:"data"`
// Opaque cursor to pass to the next call to continue after the last item. If
// None, there are no more items to return.
NextCursor *string `json:"nextCursor,omitempty"`
}
type SanitizedMCPResourceReadParams ¶
type SanitizedMCPResourceReadParams = SanitizedMCPResourceReadParamsJSON
type SanitizedMCPResourceReadParamsJSON ¶
type SanitizedMCPResourceReadParamsJSON struct {
// Server corresponds to the JSON schema field "server".
Server string `json:"server"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
// Uri corresponds to the JSON schema field "uri".
Uri string `json:"uri"`
}
type SanitizedMCPResourceReadResponse ¶
type SanitizedMCPResourceReadResponse = SanitizedMCPResourceReadResponseJSON
type SanitizedMCPResourceReadResponseJSON ¶
type SanitizedMCPResourceReadResponseJSON struct {
// Contents corresponds to the JSON schema field "contents".
Contents []SanitizedMCPResourceReadResponseJSONContentsElem `json:"contents"`
}
type SanitizedMCPResourceReadResponseJSONContentsElem ¶
type SanitizedMCPResourceReadResponseJSONContentsElem interface{}
type SanitizedMCPServerElicitationRequestResponse ¶
type SanitizedMCPServerElicitationRequestResponse = SanitizedMCPServerElicitationRequestResponseJSON
type SanitizedMCPServerElicitationRequestResponseJSON ¶
type SanitizedMCPServerElicitationRequestResponseJSON struct {
// Optional client metadata for form-mode action handling.
Meta interface{} `json:"_meta,omitempty"`
// Action corresponds to the JSON schema field "action".
Action MCPServerElicitationAction `json:"action"`
// Structured user input for accepted elicitations, mirroring RMCP
// `CreateElicitationResult`.
//
// This is nullable because decline/cancel responses have no content.
Content interface{} `json:"content,omitempty"`
}
type SanitizedMCPServerOauthLoginCompletedNotification ¶
type SanitizedMCPServerOauthLoginCompletedNotification = SanitizedMCPServerOauthLoginCompletedNotificationJSON
type SanitizedMCPServerOauthLoginCompletedNotificationJSON ¶
type SanitizedMCPServerOauthLoginCompletedNotificationJSON struct {
// Error corresponds to the JSON schema field "error".
Error *string `json:"error,omitempty"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Success corresponds to the JSON schema field "success".
Success bool `json:"success"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
}
type SanitizedMCPServerOauthLoginParams ¶
type SanitizedMCPServerOauthLoginParams = SanitizedMCPServerOauthLoginParamsJSON
type SanitizedMCPServerOauthLoginParamsJSON ¶
type SanitizedMCPServerOauthLoginParamsJSON struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Scopes corresponds to the JSON schema field "scopes".
Scopes []string `json:"scopes,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
// TimeoutSecs corresponds to the JSON schema field "timeoutSecs".
TimeoutSecs *int `json:"timeoutSecs,omitempty"`
}
type SanitizedMCPServerOauthLoginResponse ¶
type SanitizedMCPServerOauthLoginResponse = SanitizedMCPServerOauthLoginResponseJSON
type SanitizedMCPServerOauthLoginResponseJSON ¶
type SanitizedMCPServerOauthLoginResponseJSON struct {
// AuthorizationURL corresponds to the JSON schema field "authorizationUrl".
AuthorizationURL string `json:"authorizationUrl"`
}
type SanitizedMCPServerStatusUpdatedNotification ¶
type SanitizedMCPServerStatusUpdatedNotification = SanitizedMCPServerStatusUpdatedNotificationJSON
type SanitizedMCPServerStatusUpdatedNotificationJSON ¶
type SanitizedMCPServerStatusUpdatedNotificationJSON struct {
// Error corresponds to the JSON schema field "error".
Error *string `json:"error,omitempty"`
// FailureReason corresponds to the JSON schema field "failureReason".
FailureReason interface{} `json:"failureReason,omitempty"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// Status corresponds to the JSON schema field "status".
Status MCPServerStartupState `json:"status"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID *string `json:"threadId,omitempty"`
}
type SanitizedMCPServerToolCallParams ¶
type SanitizedMCPServerToolCallParams = SanitizedMCPServerToolCallParamsJSON
type SanitizedMCPServerToolCallParamsJSON ¶
type SanitizedMCPServerToolCallParamsJSON struct {
// Meta corresponds to the JSON schema field "_meta".
Meta interface{} `json:"_meta,omitempty"`
// Arguments corresponds to the JSON schema field "arguments".
Arguments interface{} `json:"arguments,omitempty"`
// Server corresponds to the JSON schema field "server".
Server string `json:"server"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// Tool corresponds to the JSON schema field "tool".
Tool string `json:"tool"`
}
type SanitizedMCPServerToolCallResponse ¶
type SanitizedMCPServerToolCallResponse = SanitizedMCPServerToolCallResponseJSON
type SanitizedMCPServerToolCallResponseJSON ¶
type SanitizedMCPServerToolCallResponseJSON struct {
// Meta corresponds to the JSON schema field "_meta".
Meta interface{} `json:"_meta,omitempty"`
// Content corresponds to the JSON schema field "content".
Content []interface{} `json:"content"`
// IsError corresponds to the JSON schema field "isError".
IsError *bool `json:"isError,omitempty"`
// StructuredContent corresponds to the JSON schema field "structuredContent".
StructuredContent interface{} `json:"structuredContent,omitempty"`
}
type SanitizedMCPToolCallProgressNotification ¶
type SanitizedMCPToolCallProgressNotification = SanitizedMCPToolCallProgressNotificationJSON
type SanitizedMCPToolCallProgressNotificationJSON ¶
type SanitizedMCPToolCallProgressNotificationJSON struct {
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// Message corresponds to the JSON schema field "message".
Message string `json:"message"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedMarketplaceAddParams ¶
type SanitizedMarketplaceAddParams = SanitizedMarketplaceAddParamsJSON
type SanitizedMarketplaceAddParamsJSON ¶
type SanitizedMarketplaceAddParamsJSON struct {
// RefName corresponds to the JSON schema field "refName".
RefName *string `json:"refName,omitempty"`
// Source corresponds to the JSON schema field "source".
Source string `json:"source"`
// SparsePaths corresponds to the JSON schema field "sparsePaths".
SparsePaths []string `json:"sparsePaths,omitempty"`
}
type SanitizedMarketplaceRemoveParams ¶
type SanitizedMarketplaceRemoveParams = SanitizedMarketplaceRemoveParamsJSON
type SanitizedMarketplaceRemoveParamsJSON ¶
type SanitizedMarketplaceRemoveParamsJSON struct {
// MarketplaceName corresponds to the JSON schema field "marketplaceName".
MarketplaceName string `json:"marketplaceName"`
}
type SanitizedMarketplaceUpgradeParams ¶
type SanitizedMarketplaceUpgradeParams = SanitizedMarketplaceUpgradeParamsJSON
type SanitizedMarketplaceUpgradeParamsJSON ¶
type SanitizedMarketplaceUpgradeParamsJSON struct {
// MarketplaceName corresponds to the JSON schema field "marketplaceName".
MarketplaceName *string `json:"marketplaceName,omitempty"`
}
type SanitizedModelListParams ¶
type SanitizedModelListParams = SanitizedModelListParamsJSON
type SanitizedModelListParamsJSON ¶
type SanitizedModelListParamsJSON struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// When true, include models that are hidden from the default picker list.
IncludeHidden *bool `json:"includeHidden,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
}
type SanitizedModelListResponse ¶
type SanitizedModelListResponse = SanitizedModelListResponseJSON
type SanitizedModelProviderCapabilitiesReadResponse ¶
type SanitizedModelProviderCapabilitiesReadResponse = SanitizedModelProviderCapabilitiesReadResponseJSON
type SanitizedModelProviderCapabilitiesReadResponseJSON ¶
type SanitizedModelProviderCapabilitiesReadResponseJSON struct {
// ImageGeneration corresponds to the JSON schema field "imageGeneration".
ImageGeneration bool `json:"imageGeneration"`
// NamespaceTools corresponds to the JSON schema field "namespaceTools".
NamespaceTools bool `json:"namespaceTools"`
// WebSearch corresponds to the JSON schema field "webSearch".
WebSearch bool `json:"webSearch"`
}
type SanitizedModelReroutedNotification ¶
type SanitizedModelReroutedNotification = SanitizedModelReroutedNotificationJSON
type SanitizedModelReroutedNotificationJSON ¶
type SanitizedModelReroutedNotificationJSON struct {
// FromModel corresponds to the JSON schema field "fromModel".
FromModel string `json:"fromModel"`
// Reason corresponds to the JSON schema field "reason".
Reason ModelRerouteReason `json:"reason"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// ToModel corresponds to the JSON schema field "toModel".
ToModel string `json:"toModel"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedModelSafetyBufferingUpdatedNotification ¶
type SanitizedModelSafetyBufferingUpdatedNotification = SanitizedModelSafetyBufferingUpdatedNotificationJSON
type SanitizedModelSafetyBufferingUpdatedNotificationJSON ¶
type SanitizedModelSafetyBufferingUpdatedNotificationJSON struct {
// FasterModel corresponds to the JSON schema field "fasterModel".
FasterModel *string `json:"fasterModel,omitempty"`
// Model corresponds to the JSON schema field "model".
Model string `json:"model"`
// Reasons corresponds to the JSON schema field "reasons".
Reasons []string `json:"reasons"`
// ShowBufferingUi corresponds to the JSON schema field "showBufferingUi".
ShowBufferingUi bool `json:"showBufferingUi"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
// UseCases corresponds to the JSON schema field "useCases".
UseCases []string `json:"useCases"`
}
type SanitizedModelVerificationNotification ¶
type SanitizedModelVerificationNotification = SanitizedModelVerificationNotificationJSON
type SanitizedModelVerificationNotificationJSON ¶
type SanitizedModelVerificationNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
// Verifications corresponds to the JSON schema field "verifications".
Verifications []ModelVerification `json:"verifications"`
}
type SanitizedPermissionProfileListParams ¶
type SanitizedPermissionProfileListParams = SanitizedPermissionProfileListParamsJSON
type SanitizedPermissionProfileListParamsJSON ¶
type SanitizedPermissionProfileListParamsJSON struct {
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Optional working directory to resolve project config layers.
Cwd *string `json:"cwd,omitempty"`
// Optional page size; defaults to the full result set.
Limit *int `json:"limit,omitempty"`
}
type SanitizedPermissionProfileListResponse ¶
type SanitizedPermissionProfileListResponse = SanitizedPermissionProfileListResponseJSON
type SanitizedPermissionProfileListResponseJSON ¶
type SanitizedPermissionProfileListResponseJSON struct {
// Data corresponds to the JSON schema field "data".
Data []PermissionProfileSummary `json:"data"`
// Opaque cursor to pass to the next call to continue after the last item. If
// None, there are no more items to return.
NextCursor *string `json:"nextCursor,omitempty"`
}
type SanitizedPermissionsRequestApprovalResponse ¶
type SanitizedPermissionsRequestApprovalResponse = SanitizedPermissionsRequestApprovalResponseJSON
type SanitizedPermissionsRequestApprovalResponseJSON ¶
type SanitizedPermissionsRequestApprovalResponseJSON struct {
// Permissions corresponds to the JSON schema field "permissions".
Permissions GrantedPermissionProfile `json:"permissions"`
// Scope corresponds to the JSON schema field "scope".
Scope interface{} `json:"scope,omitempty"`
// Review every subsequent command in this turn before normal sandboxed execution.
StrictAutoReview *bool `json:"strictAutoReview,omitempty"`
}
type SanitizedPlanDeltaNotification ¶
type SanitizedPlanDeltaNotification = SanitizedPlanDeltaNotificationJSON
type SanitizedPlanDeltaNotificationJSON ¶
type SanitizedPlanDeltaNotificationJSON struct {
// Delta corresponds to the JSON schema field "delta".
Delta string `json:"delta"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content.
type SanitizedPluginInstallResponse ¶
type SanitizedPluginInstallResponse = SanitizedPluginInstallResponseJSON
type SanitizedPluginInstallResponseJSON ¶
type SanitizedPluginInstallResponseJSON struct {
// AppsNeedingAuth corresponds to the JSON schema field "appsNeedingAuth".
AppsNeedingAuth []AppSummary `json:"appsNeedingAuth"`
// AuthPolicy corresponds to the JSON schema field "authPolicy".
AuthPolicy PluginAuthPolicy `json:"authPolicy"`
}
type SanitizedPluginShareCheckoutParams ¶
type SanitizedPluginShareCheckoutParams = SanitizedPluginShareCheckoutParamsJSON
type SanitizedPluginShareCheckoutParamsJSON ¶
type SanitizedPluginShareCheckoutParamsJSON struct {
RemotePluginID string `json:"remotePluginId"`
}
type SanitizedPluginShareDeleteParams ¶
type SanitizedPluginShareDeleteParams = SanitizedPluginShareDeleteParamsJSON
type SanitizedPluginShareDeleteParamsJSON ¶
type SanitizedPluginShareDeleteParamsJSON struct {
RemotePluginID string `json:"remotePluginId"`
}
type SanitizedPluginShareSaveResponse ¶
type SanitizedPluginShareSaveResponse = SanitizedPluginShareSaveResponseJSON
type SanitizedPluginShareUpdateTargetsParams ¶
type SanitizedPluginShareUpdateTargetsParams = SanitizedPluginShareUpdateTargetsParamsJSON
type SanitizedPluginShareUpdateTargetsParamsJSON ¶
type SanitizedPluginShareUpdateTargetsParamsJSON struct {
Discoverability PluginShareUpdateDiscoverability `json:"discoverability"`
RemotePluginID string `json:"remotePluginId"`
ShareTargets []PluginShareTarget `json:"shareTargets"`
}
type SanitizedPluginShareUpdateTargetsResponse ¶
type SanitizedPluginShareUpdateTargetsResponse = SanitizedPluginShareUpdateTargetsResponseJSON
type SanitizedPluginShareUpdateTargetsResponseJSON ¶
type SanitizedPluginShareUpdateTargetsResponseJSON struct {
Discoverability PluginShareDiscoverability `json:"discoverability"`
Principals []PluginSharePrincipal `json:"principals"`
}
type SanitizedPluginSkillReadParams ¶
type SanitizedPluginSkillReadParams = SanitizedPluginSkillReadParamsJSON
type SanitizedPluginSkillReadParamsJSON ¶
type SanitizedPluginSkillReadParamsJSON struct {
// RemoteMarketplaceName corresponds to the JSON schema field
// "remoteMarketplaceName".
RemoteMarketplaceName string `json:"remoteMarketplaceName"`
// RemotePluginID corresponds to the JSON schema field "remotePluginId".
RemotePluginID string `json:"remotePluginId"`
// SkillName corresponds to the JSON schema field "skillName".
SkillName string `json:"skillName"`
}
type SanitizedPluginSkillReadResponse ¶
type SanitizedPluginSkillReadResponse = SanitizedPluginSkillReadResponseJSON
type SanitizedPluginSkillReadResponseJSON ¶
type SanitizedPluginSkillReadResponseJSON struct {
// Contents corresponds to the JSON schema field "contents".
Contents *string `json:"contents,omitempty"`
}
type SanitizedPluginUninstallParams ¶
type SanitizedPluginUninstallParams = SanitizedPluginUninstallParamsJSON
type SanitizedPluginUninstallParamsJSON ¶
type SanitizedPluginUninstallParamsJSON struct {
// PluginID corresponds to the JSON schema field "pluginId".
PluginID string `json:"pluginId"`
}
type SanitizedProcessExitedNotification ¶
type SanitizedProcessExitedNotification = SanitizedProcessExitedNotificationJSON
type SanitizedProcessExitedNotificationJSON ¶
type SanitizedProcessExitedNotificationJSON struct {
// Process exit code.
ExitCode int `json:"exitCode"`
// Client-supplied, connection-scoped `processHandle` from `process/spawn`.
ProcessHandle string `json:"processHandle"`
// Buffered stderr capture.
//
// Empty when stderr was streamed via `process/outputDelta`.
Stderr string `json:"stderr"`
// Whether stderr reached `outputBytesCap`.
//
// In streaming mode, stderr is empty and cap state is also reported on the final
// stderr `process/outputDelta` notification.
StderrCapReached bool `json:"stderrCapReached"`
// Buffered stdout capture.
//
// Empty when stdout was streamed via `process/outputDelta`.
Stdout string `json:"stdout"`
// Whether stdout reached `outputBytesCap`.
//
// In streaming mode, stdout is empty and cap state is also reported on the final
// stdout `process/outputDelta` notification.
StdoutCapReached bool `json:"stdoutCapReached"`
}
Final process exit notification for `process/spawn`.
type SanitizedRawResponseItemCompletedNotification ¶
type SanitizedRawResponseItemCompletedNotification = SanitizedRawResponseItemCompletedNotificationJSON
type SanitizedRawResponseItemCompletedNotificationJSON ¶
type SanitizedRawResponseItemCompletedNotificationJSON struct {
// Item corresponds to the JSON schema field "item".
Item SanitizedRawResponseItemCompletedNotificationJSONItem `json:"item"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedRawResponseItemCompletedNotificationJSONItem ¶
type SanitizedRawResponseItemCompletedNotificationJSONItem interface{}
type SanitizedReasoningSummaryPartAddedNotification ¶
type SanitizedReasoningSummaryPartAddedNotification = SanitizedReasoningSummaryPartAddedNotificationJSON
type SanitizedReasoningSummaryPartAddedNotificationJSON ¶
type SanitizedReasoningSummaryPartAddedNotificationJSON struct {
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// SummaryIndex corresponds to the JSON schema field "summaryIndex".
SummaryIndex int `json:"summaryIndex"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedReasoningSummaryTextDeltaNotification ¶
type SanitizedReasoningSummaryTextDeltaNotification = SanitizedReasoningSummaryTextDeltaNotificationJSON
type SanitizedReasoningSummaryTextDeltaNotificationJSON ¶
type SanitizedReasoningSummaryTextDeltaNotificationJSON struct {
// Delta corresponds to the JSON schema field "delta".
Delta string `json:"delta"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// SummaryIndex corresponds to the JSON schema field "summaryIndex".
SummaryIndex int `json:"summaryIndex"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedReasoningTextDeltaNotification ¶
type SanitizedReasoningTextDeltaNotification = SanitizedReasoningTextDeltaNotificationJSON
type SanitizedReasoningTextDeltaNotificationJSON ¶
type SanitizedReasoningTextDeltaNotificationJSON struct {
// ContentIndex corresponds to the JSON schema field "contentIndex".
ContentIndex int `json:"contentIndex"`
// Delta corresponds to the JSON schema field "delta".
Delta string `json:"delta"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedRemoteControlStatusChangedNotification ¶
type SanitizedRemoteControlStatusChangedNotification = SanitizedRemoteControlStatusChangedNotificationJSON
type SanitizedRemoteControlStatusChangedNotificationJSON ¶
type SanitizedRemoteControlStatusChangedNotificationJSON struct {
// EnvironmentID corresponds to the JSON schema field "environmentId".
EnvironmentID *string `json:"environmentId,omitempty"`
// InstallationID corresponds to the JSON schema field "installationId".
InstallationID string `json:"installationId"`
// ServerName corresponds to the JSON schema field "serverName".
ServerName string `json:"serverName"`
// Status corresponds to the JSON schema field "status".
Status RemoteControlConnectionStatus `json:"status"`
}
Current remote-control connection status and remote identity exposed to clients.
type SanitizedReviewStartParams ¶
type SanitizedReviewStartParams = SanitizedReviewStartParamsJSON
type SanitizedReviewStartParamsJSON ¶
type SanitizedReviewStartParamsJSON struct {
// Where to run the review: inline (default) on the current thread or detached on
// a new thread (returned in `reviewThreadId`).
Delivery interface{} `json:"delivery,omitempty"`
// Target corresponds to the JSON schema field "target".
Target SanitizedReviewStartParamsJSONTarget `json:"target"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedReviewStartParamsJSONTarget ¶
type SanitizedReviewStartParamsJSONTarget interface{}
type SanitizedSendAddCreditsNudgeEmailParams ¶
type SanitizedSendAddCreditsNudgeEmailParams = SanitizedSendAddCreditsNudgeEmailParamsJSON
type SanitizedSendAddCreditsNudgeEmailParamsJSON ¶
type SanitizedSendAddCreditsNudgeEmailParamsJSON struct {
// CreditType corresponds to the JSON schema field "creditType".
CreditType AddCreditsNudgeCreditType `json:"creditType"`
}
type SanitizedSendAddCreditsNudgeEmailResponse ¶
type SanitizedSendAddCreditsNudgeEmailResponse = SanitizedSendAddCreditsNudgeEmailResponseJSON
type SanitizedSendAddCreditsNudgeEmailResponseJSON ¶
type SanitizedSendAddCreditsNudgeEmailResponseJSON struct {
// Status corresponds to the JSON schema field "status".
Status AddCreditsNudgeEmailStatus `json:"status"`
}
type SanitizedServerRequestResolvedNotification ¶
type SanitizedServerRequestResolvedNotification = SanitizedServerRequestResolvedNotificationJSON
type SanitizedServerRequestResolvedNotificationJSON ¶
type SanitizedServerRequestResolvedNotificationJSON struct {
// RequestID corresponds to the JSON schema field "requestId".
RequestID SanitizedServerRequestResolvedNotificationJSONRequestID `json:"requestId"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedServerRequestResolvedNotificationJSONRequestID ¶
type SanitizedServerRequestResolvedNotificationJSONRequestID interface{}
type SanitizedSkillsConfigWriteResponse ¶
type SanitizedSkillsConfigWriteResponse = SanitizedSkillsConfigWriteResponseJSON
type SanitizedSkillsConfigWriteResponseJSON ¶
type SanitizedSkillsConfigWriteResponseJSON struct {
// EffectiveEnabled corresponds to the JSON schema field "effectiveEnabled".
EffectiveEnabled bool `json:"effectiveEnabled"`
}
type SanitizedSkillsListParams ¶
type SanitizedSkillsListParams = SanitizedSkillsListParamsJSON
type SanitizedTerminalInteractionNotification ¶
type SanitizedTerminalInteractionNotification = SanitizedTerminalInteractionNotificationJSON
type SanitizedTerminalInteractionNotificationJSON ¶
type SanitizedTerminalInteractionNotificationJSON struct {
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// ProcessID corresponds to the JSON schema field "processId".
ProcessID string `json:"processId"`
// Stdin corresponds to the JSON schema field "stdin".
Stdin string `json:"stdin"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedThreadApproveGuardianDeniedActionParams ¶
type SanitizedThreadApproveGuardianDeniedActionParams = SanitizedThreadApproveGuardianDeniedActionParamsJSON
type SanitizedThreadApproveGuardianDeniedActionParamsJSON ¶
type SanitizedThreadApproveGuardianDeniedActionParamsJSON struct {
// Serialized `codex_protocol::protocol::GuardianAssessmentEvent`.
Event interface{} `json:"event"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadArchiveParams ¶
type SanitizedThreadArchiveParams = SanitizedThreadArchiveParamsJSON
type SanitizedThreadArchiveParamsJSON ¶
type SanitizedThreadArchiveParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadArchivedNotification ¶
type SanitizedThreadArchivedNotification = SanitizedThreadArchivedNotificationJSON
type SanitizedThreadArchivedNotificationJSON ¶
type SanitizedThreadArchivedNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadClosedNotification ¶
type SanitizedThreadClosedNotification = SanitizedThreadClosedNotificationJSON
type SanitizedThreadClosedNotificationJSON ¶
type SanitizedThreadClosedNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadCompactStartParams ¶
type SanitizedThreadCompactStartParams = SanitizedThreadCompactStartParamsJSON
type SanitizedThreadCompactStartParamsJSON ¶
type SanitizedThreadCompactStartParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadDeleteParams ¶
type SanitizedThreadDeleteParams = SanitizedThreadDeleteParamsJSON
type SanitizedThreadDeleteParamsJSON ¶
type SanitizedThreadDeleteParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadDeletedNotification ¶
type SanitizedThreadDeletedNotification = SanitizedThreadDeletedNotificationJSON
type SanitizedThreadDeletedNotificationJSON ¶
type SanitizedThreadDeletedNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadGoalClearParams ¶
type SanitizedThreadGoalClearParams = SanitizedThreadGoalClearParamsJSON
type SanitizedThreadGoalClearParamsJSON ¶
type SanitizedThreadGoalClearParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadGoalClearResponse ¶
type SanitizedThreadGoalClearResponse = SanitizedThreadGoalClearResponseJSON
type SanitizedThreadGoalClearResponseJSON ¶
type SanitizedThreadGoalClearResponseJSON struct {
// Cleared corresponds to the JSON schema field "cleared".
Cleared bool `json:"cleared"`
}
type SanitizedThreadGoalClearedNotification ¶
type SanitizedThreadGoalClearedNotification = SanitizedThreadGoalClearedNotificationJSON
type SanitizedThreadGoalClearedNotificationJSON ¶
type SanitizedThreadGoalClearedNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadGoalGetParams ¶
type SanitizedThreadGoalGetParams = SanitizedThreadGoalGetParamsJSON
type SanitizedThreadGoalGetParamsJSON ¶
type SanitizedThreadGoalGetParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadGoalGetResponse ¶
type SanitizedThreadGoalGetResponse = SanitizedThreadGoalGetResponseJSON
type SanitizedThreadGoalGetResponseJSON ¶
type SanitizedThreadGoalGetResponseJSON struct {
// Goal corresponds to the JSON schema field "goal".
Goal interface{} `json:"goal,omitempty"`
}
type SanitizedThreadGoalSetParams ¶
type SanitizedThreadGoalSetParams = SanitizedThreadGoalSetParamsJSON
type SanitizedThreadGoalSetParamsJSON ¶
type SanitizedThreadGoalSetParamsJSON struct {
// Objective corresponds to the JSON schema field "objective".
Objective *string `json:"objective,omitempty"`
// Status corresponds to the JSON schema field "status".
Status interface{} `json:"status,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TokenBudget corresponds to the JSON schema field "tokenBudget".
TokenBudget *int `json:"tokenBudget,omitempty"`
}
type SanitizedThreadGoalSetResponse ¶
type SanitizedThreadGoalSetResponse = SanitizedThreadGoalSetResponseJSON
type SanitizedThreadGoalSetResponseJSON ¶
type SanitizedThreadGoalSetResponseJSON struct {
// Goal corresponds to the JSON schema field "goal".
Goal ThreadGoal `json:"goal"`
}
type SanitizedThreadGoalUpdatedNotification ¶
type SanitizedThreadGoalUpdatedNotification = SanitizedThreadGoalUpdatedNotificationJSON
type SanitizedThreadGoalUpdatedNotificationJSON ¶
type SanitizedThreadGoalUpdatedNotificationJSON struct {
// Goal corresponds to the JSON schema field "goal".
Goal ThreadGoal `json:"goal"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID *string `json:"turnId,omitempty"`
}
type SanitizedThreadInjectItemsParams ¶
type SanitizedThreadInjectItemsParams = SanitizedThreadInjectItemsParamsJSON
type SanitizedThreadInjectItemsParamsJSON ¶
type SanitizedThreadInjectItemsParamsJSON struct {
// Raw Responses API items to append to the thread's model-visible history.
Items []interface{} `json:"items"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadListParams ¶
type SanitizedThreadListParams = SanitizedThreadListParamsJSON
type SanitizedThreadListParamsJSON ¶
type SanitizedThreadListParamsJSON struct {
// Optional archived filter; when set to true, only archived threads are returned.
// If false or null, only non-archived threads are returned.
Archived *bool `json:"archived,omitempty"`
// Opaque pagination cursor returned by a previous call.
Cursor *string `json:"cursor,omitempty"`
// Optional cwd filter or filters; when set, only threads whose session cwd
// exactly matches one of these paths are returned.
Cwd interface{} `json:"cwd,omitempty"`
// Optional page size; defaults to a reasonable server-side value.
Limit *int `json:"limit,omitempty"`
// Optional provider filter; when set, only sessions recorded under these
// providers are returned. When present but empty, includes all providers.
ModelProviders []string `json:"modelProviders,omitempty"`
// Optional substring filter for the extracted thread title.
SearchTerm *string `json:"searchTerm,omitempty"`
// Optional sort direction; defaults to descending (newest first).
SortDirection interface{} `json:"sortDirection,omitempty"`
// Optional sort key; defaults to created_at.
SortKey interface{} `json:"sortKey,omitempty"`
// Optional source filter; when set, only sessions from these source kinds are
// returned. When omitted or empty, defaults to interactive sources.
SourceKinds []ThreadSourceKind `json:"sourceKinds,omitempty"`
// If true, return from the state DB without scanning JSONL rollouts to repair
// thread metadata. Omitted or false preserves scan-and-repair behavior.
UseStateDbOnly *bool `json:"useStateDbOnly,omitempty"`
}
type SanitizedThreadLoadedListParams ¶
type SanitizedThreadLoadedListParams = SanitizedThreadLoadedListParamsJSON
type SanitizedThreadLoadedListResponse ¶
type SanitizedThreadLoadedListResponse = SanitizedThreadLoadedListResponseJSON
type SanitizedThreadLoadedListResponseJSON ¶
type SanitizedThreadLoadedListResponseJSON struct {
// Thread ids for sessions currently loaded in memory.
Data []string `json:"data"`
// Opaque cursor to pass to the next call to continue after the last item. if
// None, there are no more items to return.
NextCursor *string `json:"nextCursor,omitempty"`
}
type SanitizedThreadMetadataUpdateParams ¶
type SanitizedThreadMetadataUpdateParams = SanitizedThreadMetadataUpdateParamsJSON
type SanitizedThreadMetadataUpdateParamsJSON ¶
type SanitizedThreadMetadataUpdateParamsJSON struct {
// Patch the stored Git metadata for this thread. Omit a field to leave it
// unchanged, set it to `null` to clear it, or provide a string to replace the
// stored value.
GitInfo interface{} `json:"gitInfo,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadNameUpdatedNotification ¶
type SanitizedThreadNameUpdatedNotification = SanitizedThreadNameUpdatedNotificationJSON
type SanitizedThreadReadParams ¶
type SanitizedThreadReadParams = SanitizedThreadReadParamsJSON
type SanitizedThreadRealtimeClosedNotification ¶
type SanitizedThreadRealtimeClosedNotification = SanitizedThreadRealtimeClosedNotificationJSON
type SanitizedThreadRealtimeClosedNotificationJSON ¶
type SanitizedThreadRealtimeClosedNotificationJSON struct {
// Reason corresponds to the JSON schema field "reason".
Reason *string `json:"reason,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - emitted when thread realtime transport closes.
type SanitizedThreadRealtimeErrorNotification ¶
type SanitizedThreadRealtimeErrorNotification = SanitizedThreadRealtimeErrorNotificationJSON
type SanitizedThreadRealtimeErrorNotificationJSON ¶
type SanitizedThreadRealtimeErrorNotificationJSON struct {
// Message corresponds to the JSON schema field "message".
Message string `json:"message"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - emitted when thread realtime encounters an error.
type SanitizedThreadRealtimeItemAddedNotification ¶
type SanitizedThreadRealtimeItemAddedNotification = SanitizedThreadRealtimeItemAddedNotificationJSON
type SanitizedThreadRealtimeItemAddedNotificationJSON ¶
type SanitizedThreadRealtimeItemAddedNotificationJSON struct {
// Item corresponds to the JSON schema field "item".
Item interface{} `json:"item"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - raw non-audio thread realtime item emitted by the backend.
type SanitizedThreadRealtimeOutputAudioDeltaNotification ¶
type SanitizedThreadRealtimeOutputAudioDeltaNotification = SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON
type SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON ¶
type SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON struct {
// Audio corresponds to the JSON schema field "audio".
Audio ThreadRealtimeAudioChunk `json:"audio"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - streamed output audio emitted by thread realtime.
type SanitizedThreadRealtimeSdpNotification ¶
type SanitizedThreadRealtimeSdpNotification = SanitizedThreadRealtimeSdpNotificationJSON
type SanitizedThreadRealtimeSdpNotificationJSON ¶
type SanitizedThreadRealtimeSdpNotificationJSON struct {
// Sdp corresponds to the JSON schema field "sdp".
Sdp string `json:"sdp"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - emitted with the remote SDP for a WebRTC realtime session.
type SanitizedThreadRealtimeStartedNotification ¶
type SanitizedThreadRealtimeStartedNotification = SanitizedThreadRealtimeStartedNotificationJSON
type SanitizedThreadRealtimeStartedNotificationJSON ¶
type SanitizedThreadRealtimeStartedNotificationJSON struct {
// RealtimeSessionID corresponds to the JSON schema field "realtimeSessionId".
RealtimeSessionID *string `json:"realtimeSessionId,omitempty"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// Version corresponds to the JSON schema field "version".
Version RealtimeConversationVersion `json:"version"`
}
EXPERIMENTAL - emitted when thread realtime startup is accepted.
type SanitizedThreadRealtimeTranscriptDeltaNotification ¶
type SanitizedThreadRealtimeTranscriptDeltaNotification = SanitizedThreadRealtimeTranscriptDeltaNotificationJSON
type SanitizedThreadRealtimeTranscriptDeltaNotificationJSON ¶
type SanitizedThreadRealtimeTranscriptDeltaNotificationJSON struct {
// Live transcript delta from the realtime event.
Delta string `json:"delta"`
// Role corresponds to the JSON schema field "role".
Role string `json:"role"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - flat transcript delta emitted whenever realtime transcript text changes.
type SanitizedThreadRealtimeTranscriptDoneNotification ¶
type SanitizedThreadRealtimeTranscriptDoneNotification = SanitizedThreadRealtimeTranscriptDoneNotificationJSON
type SanitizedThreadRealtimeTranscriptDoneNotificationJSON ¶
type SanitizedThreadRealtimeTranscriptDoneNotificationJSON struct {
// Role corresponds to the JSON schema field "role".
Role string `json:"role"`
// Final complete text for the transcript part.
Text string `json:"text"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
EXPERIMENTAL - final transcript text emitted when realtime completes a transcript part.
type SanitizedThreadRollbackParams ¶
type SanitizedThreadRollbackParams = SanitizedThreadRollbackParamsJSON
type SanitizedThreadRollbackParamsJSON ¶
type SanitizedThreadRollbackParamsJSON struct {
// The number of turns to drop from the end of the thread. Must be >= 1.
//
// This only modifies the thread's history and does not revert local file changes
// that have been made by the agent. Clients are responsible for reverting these
// changes.
NumTurns int `json:"numTurns"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
DEPRECATED: `thread/rollback` will be removed soon.
type SanitizedThreadSetNameParams ¶
type SanitizedThreadSetNameParams = SanitizedThreadSetNameParamsJSON
type SanitizedThreadShellCommandParams ¶
type SanitizedThreadShellCommandParams = SanitizedThreadShellCommandParamsJSON
type SanitizedThreadShellCommandParamsJSON ¶
type SanitizedThreadShellCommandParamsJSON struct {
// Shell command string evaluated by the thread's configured shell. Unlike
// `command/exec`, this intentionally preserves shell syntax such as pipes,
// redirects, and quoting. This runs unsandboxed with full access rather than
// inheriting the thread sandbox policy.
Command string `json:"command"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadStatusChangedNotification ¶
type SanitizedThreadStatusChangedNotification = SanitizedThreadStatusChangedNotificationJSON
type SanitizedThreadStatusChangedNotificationJSON ¶
type SanitizedThreadStatusChangedNotificationJSON struct {
// Status corresponds to the JSON schema field "status".
Status SanitizedThreadStatusChangedNotificationJSONStatus `json:"status"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadStatusChangedNotificationJSONStatus ¶
type SanitizedThreadStatusChangedNotificationJSONStatus interface{}
type SanitizedThreadTokenUsageUpdatedNotification ¶
type SanitizedThreadTokenUsageUpdatedNotification = SanitizedThreadTokenUsageUpdatedNotificationJSON
type SanitizedThreadTokenUsageUpdatedNotificationJSON ¶
type SanitizedThreadTokenUsageUpdatedNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TokenUsage corresponds to the JSON schema field "tokenUsage".
TokenUsage ThreadTokenUsage `json:"tokenUsage"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedThreadUnarchiveParams ¶
type SanitizedThreadUnarchiveParams = SanitizedThreadUnarchiveParamsJSON
type SanitizedThreadUnarchiveParamsJSON ¶
type SanitizedThreadUnarchiveParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadUnarchivedNotification ¶
type SanitizedThreadUnarchivedNotification = SanitizedThreadUnarchivedNotificationJSON
type SanitizedThreadUnarchivedNotificationJSON ¶
type SanitizedThreadUnarchivedNotificationJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadUnsubscribeParams ¶
type SanitizedThreadUnsubscribeParams = SanitizedThreadUnsubscribeParamsJSON
type SanitizedThreadUnsubscribeParamsJSON ¶
type SanitizedThreadUnsubscribeParamsJSON struct {
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedThreadUnsubscribeResponse ¶
type SanitizedThreadUnsubscribeResponse = SanitizedThreadUnsubscribeResponseJSON
type SanitizedThreadUnsubscribeResponseJSON ¶
type SanitizedThreadUnsubscribeResponseJSON struct {
// Status corresponds to the JSON schema field "status".
Status ThreadUnsubscribeStatus `json:"status"`
}
type SanitizedToolRequestUserInputParams ¶
type SanitizedToolRequestUserInputParams = SanitizedToolRequestUserInputParamsJSON
type SanitizedToolRequestUserInputParamsJSON ¶
type SanitizedToolRequestUserInputParamsJSON struct {
// AutoResolutionMs corresponds to the JSON schema field "autoResolutionMs".
AutoResolutionMs *int `json:"autoResolutionMs,omitempty"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID string `json:"itemId"`
// Questions corresponds to the JSON schema field "questions".
Questions []ToolRequestUserInputQuestion `json:"questions"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
EXPERIMENTAL. Params sent with a request_user_input event.
type SanitizedToolRequestUserInputResponse ¶
type SanitizedToolRequestUserInputResponse = SanitizedToolRequestUserInputResponseJSON
type SanitizedToolRequestUserInputResponseJSON ¶
type SanitizedToolRequestUserInputResponseJSON struct {
// Answers corresponds to the JSON schema field "answers".
Answers map[string]ToolRequestUserInputAnswer `json:"answers"`
}
EXPERIMENTAL. Response payload mapping question ids to answers.
type SanitizedTurnDiffUpdatedNotification ¶
type SanitizedTurnDiffUpdatedNotification = SanitizedTurnDiffUpdatedNotificationJSON
type SanitizedTurnDiffUpdatedNotificationJSON ¶
type SanitizedTurnDiffUpdatedNotificationJSON struct {
// Diff corresponds to the JSON schema field "diff".
Diff string `json:"diff"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
Notification that the turn-level unified diff has changed. Contains the latest aggregated diff across all file changes in the turn.
type SanitizedTurnInterruptParams ¶
type SanitizedTurnInterruptParams = SanitizedTurnInterruptParamsJSON
type SanitizedTurnModerationMetadataNotification ¶
type SanitizedTurnModerationMetadataNotification = SanitizedTurnModerationMetadataNotificationJSON
type SanitizedTurnModerationMetadataNotificationJSON ¶
type SanitizedTurnModerationMetadataNotificationJSON struct {
// Metadata corresponds to the JSON schema field "metadata".
Metadata interface{} `json:"metadata"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedTurnPlanUpdatedNotification ¶
type SanitizedTurnPlanUpdatedNotification = SanitizedTurnPlanUpdatedNotificationJSON
type SanitizedTurnPlanUpdatedNotificationJSON ¶
type SanitizedTurnPlanUpdatedNotificationJSON struct {
// Explanation corresponds to the JSON schema field "explanation".
Explanation *string `json:"explanation,omitempty"`
// Plan corresponds to the JSON schema field "plan".
Plan []TurnPlanStep `json:"plan"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedTurnSteerParams ¶
type SanitizedTurnSteerParams = SanitizedTurnSteerParamsJSON
type SanitizedTurnSteerParamsJSON ¶
type SanitizedTurnSteerParamsJSON struct {
// ClientUserMessageID corresponds to the JSON schema field "clientUserMessageId".
ClientUserMessageID *string `json:"clientUserMessageId,omitempty"`
// Required active turn id precondition. The request fails when it does not match
// the currently active turn.
ExpectedTurnID string `json:"expectedTurnId"`
// Input corresponds to the JSON schema field "input".
Input []SanitizedTurnSteerParamsJSONInputElem `json:"input"`
// ThreadID corresponds to the JSON schema field "threadId".
ThreadID string `json:"threadId"`
}
type SanitizedTurnSteerParamsJSONInputElem ¶
type SanitizedTurnSteerParamsJSONInputElem interface{}
type SanitizedTurnSteerResponse ¶
type SanitizedTurnSteerResponse = SanitizedTurnSteerResponseJSON
type SanitizedTurnSteerResponseJSON ¶
type SanitizedTurnSteerResponseJSON struct {
// TurnID corresponds to the JSON schema field "turnId".
TurnID string `json:"turnId"`
}
type SanitizedWarningNotification ¶
type SanitizedWarningNotification = SanitizedWarningNotificationJSON
type SanitizedWindowsSandboxReadinessResponse ¶
type SanitizedWindowsSandboxReadinessResponse = SanitizedWindowsSandboxReadinessResponseJSON
type SanitizedWindowsSandboxReadinessResponseJSON ¶
type SanitizedWindowsSandboxReadinessResponseJSON struct {
// Status corresponds to the JSON schema field "status".
Status WindowsSandboxReadiness `json:"status"`
}
type SanitizedWindowsSandboxSetupCompletedNotification ¶
type SanitizedWindowsSandboxSetupCompletedNotification = SanitizedWindowsSandboxSetupCompletedNotificationJSON
type SanitizedWindowsSandboxSetupCompletedNotificationJSON ¶
type SanitizedWindowsSandboxSetupCompletedNotificationJSON struct {
// Error corresponds to the JSON schema field "error".
Error *string `json:"error,omitempty"`
// Mode corresponds to the JSON schema field "mode".
Mode WindowsSandboxSetupMode `json:"mode"`
// Success corresponds to the JSON schema field "success".
Success bool `json:"success"`
}
type SanitizedWindowsSandboxSetupStartResponse ¶
type SanitizedWindowsSandboxSetupStartResponse = SanitizedWindowsSandboxSetupStartResponseJSON
type SanitizedWindowsSandboxSetupStartResponseJSON ¶
type SanitizedWindowsSandboxSetupStartResponseJSON struct {
// Started corresponds to the JSON schema field "started".
Started bool `json:"started"`
}
type SanitizedWindowsWorldWritableWarningNotification ¶
type SanitizedWindowsWorldWritableWarningNotification = SanitizedWindowsWorldWritableWarningNotificationJSON
type SanitizedWindowsWorldWritableWarningNotificationJSON ¶
type SanitizedWindowsWorldWritableWarningNotificationJSON struct {
// ExtraCount corresponds to the JSON schema field "extraCount".
ExtraCount int `json:"extraCount"`
// FailedScan corresponds to the JSON schema field "failedScan".
FailedScan bool `json:"failedScan"`
// SamplePaths corresponds to the JSON schema field "samplePaths".
SamplePaths []string `json:"samplePaths"`
}
type SendAddCreditsNudgeEmailParams ¶
type SendAddCreditsNudgeEmailParams = SanitizedSendAddCreditsNudgeEmailParamsJSON
type SendAddCreditsNudgeEmailResponse ¶
type SendAddCreditsNudgeEmailResponse = SanitizedSendAddCreditsNudgeEmailResponseJSON
type ServerNotification ¶
type ServerNotification interface{}
type ServerRequest ¶
type ServerRequest interface{}
type ServerRequestResolvedNotification ¶
type ServerRequestResolvedNotification = SanitizedServerRequestResolvedNotificationJSON
type SessionMigration ¶
type Settings ¶
type Settings struct {
// DeveloperInstructions corresponds to the JSON schema field
// "developer_instructions".
DeveloperInstructions *string `json:"developer_instructions,omitempty"`
// Model corresponds to the JSON schema field "model".
Model string `json:"model"`
// ReasoningEffort corresponds to the JSON schema field "reasoning_effort".
ReasoningEffort interface{} `json:"reasoning_effort,omitempty"`
}
Settings for a collaboration mode.
type SkillMigration ¶
type SkillMigration struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
}
type SkillsChangedNotification ¶
type SkillsChangedNotification interface{}
type SkillsConfigWriteParams ¶
type SkillsConfigWriteParams interface{}
type SkillsConfigWriteResponse ¶
type SkillsConfigWriteResponse = SanitizedSkillsConfigWriteResponseJSON
type SkillsExtraRootsSetParams ¶
type SkillsExtraRootsSetParams interface{}
type SkillsExtraRootsSetResponse ¶
type SkillsExtraRootsSetResponse interface{}
type SkillsListParams ¶
type SkillsListParams = SanitizedSkillsListParamsJSON
type SkillsListResponse ¶
type SkillsListResponse interface{}
type SortDirection ¶
type SortDirection string
const SortDirectionAsc SortDirection = "asc"
const SortDirectionDesc SortDirection = "desc"
type SpendControlLimitSnapshot ¶
type SpendControlLimitSnapshot struct {
// Limit corresponds to the JSON schema field "limit".
Limit string `json:"limit"`
// RemainingPercent corresponds to the JSON schema field "remainingPercent".
RemainingPercent int `json:"remainingPercent"`
// ResetsAt corresponds to the JSON schema field "resetsAt".
ResetsAt int `json:"resetsAt"`
// Used corresponds to the JSON schema field "used".
Used string `json:"used"`
}
type SubagentMigration ¶
type SubagentMigration struct {
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
}
type TerminalInteractionNotification ¶
type TerminalInteractionNotification = SanitizedTerminalInteractionNotificationJSON
type TextElement ¶
type TextElement struct {
// Byte range in the parent `text` buffer that this element occupies.
ByteRange TextElementByteRange `json:"byteRange"`
// Optional human-readable placeholder for the element, displayed in the UI.
Placeholder *string `json:"placeholder,omitempty"`
}
type TextElementByteRange ¶
type TextPosition ¶
type TextRange ¶
type TextRange struct {
// End corresponds to the JSON schema field "end".
End TextPosition `json:"end"`
// Start corresponds to the JSON schema field "start".
Start TextPosition `json:"start"`
}
type Thread ¶
type Thread struct {
ID string `json:"id,omitempty"`
}
Thread represents a minimal thread descriptor used in thread responses.
type ThreadActiveFlag ¶
type ThreadActiveFlag string
const ThreadActiveFlagWaitingOnApproval ThreadActiveFlag = "waitingOnApproval"
const ThreadActiveFlagWaitingOnUserInput ThreadActiveFlag = "waitingOnUserInput"
type ThreadApproveGuardianDeniedActionParams ¶
type ThreadApproveGuardianDeniedActionParams = SanitizedThreadApproveGuardianDeniedActionParamsJSON
type ThreadApproveGuardianDeniedActionResponse ¶
type ThreadApproveGuardianDeniedActionResponse interface{}
type ThreadArchiveParams ¶
type ThreadArchiveParams = SanitizedThreadArchiveParamsJSON
type ThreadArchiveResponse ¶
type ThreadArchiveResponse interface{}
type ThreadArchivedNotification ¶
type ThreadArchivedNotification = SanitizedThreadArchivedNotificationJSON
type ThreadClosedNotification ¶
type ThreadClosedNotification = SanitizedThreadClosedNotificationJSON
type ThreadCompactStartParams ¶
type ThreadCompactStartParams = SanitizedThreadCompactStartParamsJSON
type ThreadCompactStartResponse ¶
type ThreadCompactStartResponse interface{}
type ThreadDeleteParams ¶
type ThreadDeleteParams = SanitizedThreadDeleteParamsJSON
type ThreadDeleteResponse ¶
type ThreadDeleteResponse interface{}
type ThreadDeletedNotification ¶
type ThreadDeletedNotification = SanitizedThreadDeletedNotificationJSON
type ThreadForkParams ¶
type ThreadForkParams struct {
ThreadID string `json:"threadId"`
Ephemeral *bool `json:"ephemeral,omitempty"`
Model *string `json:"model,omitempty"`
ModelProvider *string `json:"modelProvider,omitempty"`
Cwd *string `json:"cwd,omitempty"`
ApprovalPolicy json.RawMessage `json:"approvalPolicy,omitempty"`
Sandbox json.RawMessage `json:"sandbox,omitempty"`
Config *map[string]any `json:"config,omitempty"`
BaseInstructions *string `json:"baseInstructions,omitempty"`
DeveloperInstructions *string `json:"developerInstructions,omitempty"`
}
ThreadForkParams is maintained manually because the raw schema currently exceeds the generator's capabilities.
type ThreadForkResponse ¶
type ThreadForkResponse interface{}
type ThreadGoal ¶
type ThreadGoal struct {
ThreadID string `json:"threadId"`
Objective string `json:"objective"`
Status ThreadGoalStatus `json:"status"`
TokenBudget *int64 `json:"tokenBudget"`
TokensUsed int64 `json:"tokensUsed"`
TimeUsedSeconds int64 `json:"timeUsedSeconds"`
CreatedAt int64 `json:"createdAt"`
UpdatedAt int64 `json:"updatedAt"`
}
ThreadGoal describes persisted long-running goal metadata for a thread.
type ThreadGoalClearParams ¶
type ThreadGoalClearParams = SanitizedThreadGoalClearParamsJSON
type ThreadGoalClearResponse ¶
type ThreadGoalClearResponse = SanitizedThreadGoalClearResponseJSON
type ThreadGoalClearedNotification ¶
type ThreadGoalClearedNotification = SanitizedThreadGoalClearedNotificationJSON
type ThreadGoalGetParams ¶
type ThreadGoalGetParams = SanitizedThreadGoalGetParamsJSON
type ThreadGoalGetResponse ¶
type ThreadGoalGetResponse = SanitizedThreadGoalGetResponseJSON
type ThreadGoalSetParams ¶
type ThreadGoalSetParams = SanitizedThreadGoalSetParamsJSON
type ThreadGoalSetResponse ¶
type ThreadGoalSetResponse = SanitizedThreadGoalSetResponseJSON
type ThreadGoalStatus ¶
type ThreadGoalStatus string
const ThreadGoalStatusActive ThreadGoalStatus = "active"
const ThreadGoalStatusBlocked ThreadGoalStatus = "blocked"
const ThreadGoalStatusBudgetLimited ThreadGoalStatus = "budgetLimited"
const ThreadGoalStatusComplete ThreadGoalStatus = "complete"
const ThreadGoalStatusPaused ThreadGoalStatus = "paused"
const ThreadGoalStatusUsageLimited ThreadGoalStatus = "usageLimited"
type ThreadGoalUpdatedNotification ¶
type ThreadGoalUpdatedNotification struct {
ThreadID string `json:"threadId"`
TurnID *string `json:"turnId"`
Goal ThreadGoal `json:"goal"`
}
ThreadGoalUpdatedNotification is the payload for thread/goal/updated.
type ThreadInjectItemsParams ¶
type ThreadInjectItemsParams = SanitizedThreadInjectItemsParamsJSON
type ThreadInjectItemsResponse ¶
type ThreadInjectItemsResponse interface{}
type ThreadListCwdFilter ¶
type ThreadListCwdFilter interface{}
type ThreadListParams ¶
type ThreadListParams = SanitizedThreadListParamsJSON
type ThreadListResponse ¶
type ThreadListResponse interface{}
type ThreadLoadedListParams ¶
type ThreadLoadedListParams = SanitizedThreadLoadedListParamsJSON
type ThreadLoadedListResponse ¶
type ThreadLoadedListResponse = SanitizedThreadLoadedListResponseJSON
type ThreadMetadataGitInfoUpdateParams ¶
type ThreadMetadataGitInfoUpdateParams struct {
// Omit to leave the stored branch unchanged, set to `null` to clear it, or
// provide a non-empty string to replace it.
Branch *string `json:"branch,omitempty"`
// Omit to leave the stored origin URL unchanged, set to `null` to clear it, or
// provide a non-empty string to replace it.
OriginURL *string `json:"originUrl,omitempty"`
// Omit to leave the stored commit unchanged, set to `null` to clear it, or
// provide a non-empty string to replace it.
Sha *string `json:"sha,omitempty"`
}
type ThreadMetadataUpdateParams ¶
type ThreadMetadataUpdateParams = SanitizedThreadMetadataUpdateParamsJSON
type ThreadMetadataUpdateResponse ¶
type ThreadMetadataUpdateResponse interface{}
type ThreadNameUpdatedNotification ¶
type ThreadNameUpdatedNotification = SanitizedThreadNameUpdatedNotificationJSON
type ThreadReadParams ¶
type ThreadReadParams = SanitizedThreadReadParamsJSON
type ThreadReadResponse ¶
type ThreadReadResponse interface{}
type ThreadRealtimeAudioChunk ¶
type ThreadRealtimeAudioChunk struct {
// Data corresponds to the JSON schema field "data".
Data string `json:"data"`
// ItemID corresponds to the JSON schema field "itemId".
ItemID *string `json:"itemId,omitempty"`
// NumChannels corresponds to the JSON schema field "numChannels".
NumChannels int `json:"numChannels"`
// SampleRate corresponds to the JSON schema field "sampleRate".
SampleRate int `json:"sampleRate"`
// SamplesPerChannel corresponds to the JSON schema field "samplesPerChannel".
SamplesPerChannel *int `json:"samplesPerChannel,omitempty"`
}
EXPERIMENTAL - thread realtime audio chunk.
type ThreadRealtimeClosedNotification ¶
type ThreadRealtimeClosedNotification = SanitizedThreadRealtimeClosedNotificationJSON
type ThreadRealtimeErrorNotification ¶
type ThreadRealtimeErrorNotification = SanitizedThreadRealtimeErrorNotificationJSON
type ThreadRealtimeItemAddedNotification ¶
type ThreadRealtimeItemAddedNotification = SanitizedThreadRealtimeItemAddedNotificationJSON
type ThreadRealtimeOutputAudioDeltaNotification ¶
type ThreadRealtimeOutputAudioDeltaNotification = SanitizedThreadRealtimeOutputAudioDeltaNotificationJSON
type ThreadRealtimeSdpNotification ¶
type ThreadRealtimeSdpNotification = SanitizedThreadRealtimeSdpNotificationJSON
type ThreadRealtimeStartedNotification ¶
type ThreadRealtimeStartedNotification = SanitizedThreadRealtimeStartedNotificationJSON
type ThreadRealtimeTranscriptDeltaNotification ¶
type ThreadRealtimeTranscriptDeltaNotification = SanitizedThreadRealtimeTranscriptDeltaNotificationJSON
type ThreadRealtimeTranscriptDoneNotification ¶
type ThreadRealtimeTranscriptDoneNotification = SanitizedThreadRealtimeTranscriptDoneNotificationJSON
type ThreadResponse ¶
type ThreadResponse struct {
ThreadID string `json:"threadId,omitempty"`
Thread *Thread `json:"thread,omitempty"`
}
ThreadResponse is the shared shape for thread/start and thread/resume responses.
type ThreadResumeParams ¶
type ThreadResumeParams struct {
ThreadID string `json:"threadId"`
Model *string `json:"model,omitempty"`
ModelProvider *string `json:"modelProvider,omitempty"`
Cwd *string `json:"cwd,omitempty"`
ApprovalPolicy json.RawMessage `json:"approvalPolicy,omitempty"`
Sandbox json.RawMessage `json:"sandbox,omitempty"`
Config *map[string]any `json:"config,omitempty"`
BaseInstructions *string `json:"baseInstructions,omitempty"`
DeveloperInstructions *string `json:"developerInstructions,omitempty"`
}
ThreadResumeParams is maintained manually because the raw schema currently exceeds the generator's capabilities.
type ThreadResumeResponse ¶
type ThreadResumeResponse = ThreadResponse
ThreadResumeResponse is the response payload for thread/resume.
type ThreadRollbackParams ¶
type ThreadRollbackParams = SanitizedThreadRollbackParamsJSON
type ThreadRollbackResponse ¶
type ThreadRollbackResponse interface{}
type ThreadSetNameParams ¶
type ThreadSetNameParams = SanitizedThreadSetNameParamsJSON
type ThreadSetNameResponse ¶
type ThreadSetNameResponse interface{}
type ThreadSettingsUpdatedNotification ¶
type ThreadSettingsUpdatedNotification interface{}
type ThreadShellCommandParams ¶
type ThreadShellCommandParams = SanitizedThreadShellCommandParamsJSON
type ThreadShellCommandResponse ¶
type ThreadShellCommandResponse interface{}
type ThreadSortKey ¶
type ThreadSortKey string
const ThreadSortKeyCreatedAt ThreadSortKey = "created_at"
const ThreadSortKeyRecencyAt ThreadSortKey = "recency_at"
const ThreadSortKeyUpdatedAt ThreadSortKey = "updated_at"
type ThreadSourceKind ¶
type ThreadSourceKind string
const ThreadSourceKindAppServer ThreadSourceKind = "appServer"
const ThreadSourceKindCli ThreadSourceKind = "cli"
const ThreadSourceKindExec ThreadSourceKind = "exec"
const ThreadSourceKindSubAgent ThreadSourceKind = "subAgent"
const ThreadSourceKindSubAgentCompact ThreadSourceKind = "subAgentCompact"
const ThreadSourceKindSubAgentOther ThreadSourceKind = "subAgentOther"
const ThreadSourceKindSubAgentReview ThreadSourceKind = "subAgentReview"
const ThreadSourceKindSubAgentThreadSpawn ThreadSourceKind = "subAgentThreadSpawn"
const ThreadSourceKindUnknown ThreadSourceKind = "unknown"
const ThreadSourceKindVscode ThreadSourceKind = "vscode"
type ThreadStartParams ¶
type ThreadStartParams struct {
Model *string `json:"model,omitempty"`
Cwd *string `json:"cwd,omitempty"`
ApprovalPolicy json.RawMessage `json:"approvalPolicy,omitempty"`
Sandbox json.RawMessage `json:"sandbox,omitempty"`
Config *map[string]any `json:"config,omitempty"`
BaseInstructions *string `json:"baseInstructions,omitempty"`
DeveloperInstructions *string `json:"developerInstructions,omitempty"`
}
ThreadStartParams is maintained manually because the raw schema currently exceeds the generator's capabilities.
type ThreadStartResponse ¶
type ThreadStartResponse = ThreadResponse
ThreadStartResponse is the response payload for thread/start.
type ThreadStartedNotification ¶
type ThreadStartedNotification interface{}
type ThreadStatus ¶
type ThreadStatus interface{}
type ThreadStatusChangedNotification ¶
type ThreadStatusChangedNotification = SanitizedThreadStatusChangedNotificationJSON
type ThreadTokenUsage ¶
type ThreadTokenUsage struct {
// Last corresponds to the JSON schema field "last".
Last TokenUsageBreakdown `json:"last"`
// ModelContextWindow corresponds to the JSON schema field "modelContextWindow".
ModelContextWindow *int `json:"modelContextWindow,omitempty"`
// Total corresponds to the JSON schema field "total".
Total TokenUsageBreakdown `json:"total"`
}
type ThreadTokenUsageUpdatedNotification ¶
type ThreadTokenUsageUpdatedNotification = SanitizedThreadTokenUsageUpdatedNotificationJSON
type ThreadUnarchiveParams ¶
type ThreadUnarchiveParams = SanitizedThreadUnarchiveParamsJSON
type ThreadUnarchiveResponse ¶
type ThreadUnarchiveResponse interface{}
type ThreadUnarchivedNotification ¶
type ThreadUnarchivedNotification = SanitizedThreadUnarchivedNotificationJSON
type ThreadUnsubscribeParams ¶
type ThreadUnsubscribeParams = SanitizedThreadUnsubscribeParamsJSON
type ThreadUnsubscribeResponse ¶
type ThreadUnsubscribeResponse = SanitizedThreadUnsubscribeResponseJSON
type ThreadUnsubscribeStatus ¶
type ThreadUnsubscribeStatus string
const ThreadUnsubscribeStatusNotLoaded ThreadUnsubscribeStatus = "notLoaded"
const ThreadUnsubscribeStatusNotSubscribed ThreadUnsubscribeStatus = "notSubscribed"
const ThreadUnsubscribeStatusUnsubscribed ThreadUnsubscribeStatus = "unsubscribed"
type TokenUsageBreakdown ¶
type TokenUsageBreakdown struct {
// CachedInputTokens corresponds to the JSON schema field "cachedInputTokens".
CachedInputTokens int `json:"cachedInputTokens"`
// InputTokens corresponds to the JSON schema field "inputTokens".
InputTokens int `json:"inputTokens"`
// OutputTokens corresponds to the JSON schema field "outputTokens".
OutputTokens int `json:"outputTokens"`
// ReasoningOutputTokens corresponds to the JSON schema field
// "reasoningOutputTokens".
ReasoningOutputTokens int `json:"reasoningOutputTokens"`
// TotalTokens corresponds to the JSON schema field "totalTokens".
TotalTokens int `json:"totalTokens"`
}
type Tool ¶
type Tool struct {
// Meta corresponds to the JSON schema field "_meta".
Meta interface{} `json:"_meta,omitempty"`
// Annotations corresponds to the JSON schema field "annotations".
Annotations interface{} `json:"annotations,omitempty"`
// Description corresponds to the JSON schema field "description".
Description *string `json:"description,omitempty"`
// Icons corresponds to the JSON schema field "icons".
Icons []interface{} `json:"icons,omitempty"`
// InputSchema corresponds to the JSON schema field "inputSchema".
InputSchema interface{} `json:"inputSchema"`
// Name corresponds to the JSON schema field "name".
Name string `json:"name"`
// OutputSchema corresponds to the JSON schema field "outputSchema".
OutputSchema interface{} `json:"outputSchema,omitempty"`
// Title corresponds to the JSON schema field "title".
Title *string `json:"title,omitempty"`
}
Definition for a tool the client can call.
type ToolRequestUserInputAnswer ¶
type ToolRequestUserInputAnswer struct {
// Answers corresponds to the JSON schema field "answers".
Answers []string `json:"answers"`
}
EXPERIMENTAL. Captures a user's answer to a request_user_input question.
type ToolRequestUserInputOption ¶
type ToolRequestUserInputOption struct {
// Description corresponds to the JSON schema field "description".
Description string `json:"description"`
// Label corresponds to the JSON schema field "label".
Label string `json:"label"`
}
EXPERIMENTAL. Defines a single selectable option for request_user_input.
type ToolRequestUserInputParams ¶
type ToolRequestUserInputParams = SanitizedToolRequestUserInputParams
ToolRequestUserInputParams uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type ToolRequestUserInputQuestion ¶
type ToolRequestUserInputQuestion struct {
// Header corresponds to the JSON schema field "header".
Header string `json:"header"`
// ID corresponds to the JSON schema field "id".
ID string `json:"id"`
// IsOther corresponds to the JSON schema field "isOther".
IsOther bool `json:"isOther,omitempty"`
// IsSecret corresponds to the JSON schema field "isSecret".
IsSecret bool `json:"isSecret,omitempty"`
// Options corresponds to the JSON schema field "options".
Options []ToolRequestUserInputOption `json:"options,omitempty"`
// Question corresponds to the JSON schema field "question".
Question string `json:"question"`
}
EXPERIMENTAL. Represents one request_user_input question and its required options.
type ToolRequestUserInputResponse ¶
type ToolRequestUserInputResponse = SanitizedToolRequestUserInputResponse
ToolRequestUserInputResponse uses the sanitized schema variant because the raw schema currently exceeds the generator's capabilities.
type TurnCompletedNotification ¶
type TurnCompletedNotification = TurnNotification
TurnCompletedNotification is the payload for turn/completed.
type TurnDiffUpdatedNotification ¶
type TurnDiffUpdatedNotification = SanitizedTurnDiffUpdatedNotificationJSON
type TurnError ¶
type TurnError struct {
// AdditionalDetails corresponds to the JSON schema field "additionalDetails".
AdditionalDetails *string `json:"additionalDetails,omitempty"`
// CodexErrorInfo corresponds to the JSON schema field "codexErrorInfo".
CodexErrorInfo interface{} `json:"codexErrorInfo,omitempty"`
// Message corresponds to the JSON schema field "message".
Message string `json:"message"`
}
type TurnInterruptParams ¶
type TurnInterruptParams = SanitizedTurnInterruptParamsJSON
type TurnInterruptResponse ¶
type TurnInterruptResponse interface{}
type TurnModerationMetadataNotification ¶
type TurnModerationMetadataNotification = SanitizedTurnModerationMetadataNotificationJSON
type TurnNotification ¶
type TurnNotification struct {
ThreadID string `json:"threadId,omitempty"`
Turn *TurnNotificationTurn `json:"turn,omitempty"`
}
TurnNotification describes turn/started and turn/completed notifications.
type TurnNotificationError ¶
type TurnNotificationError struct {
Message string `json:"message,omitempty"`
}
TurnNotificationError describes a turn error payload.
type TurnNotificationTurn ¶
type TurnNotificationTurn struct {
ID string `json:"id,omitempty"`
Status string `json:"status,omitempty"`
Error *TurnNotificationError `json:"error,omitempty"`
}
TurnNotificationTurn describes a turn summary in notifications.
type TurnPlanStep ¶
type TurnPlanStep struct {
// Status corresponds to the JSON schema field "status".
Status TurnPlanStepStatus `json:"status"`
// Step corresponds to the JSON schema field "step".
Step string `json:"step"`
}
type TurnPlanStepStatus ¶
type TurnPlanStepStatus string
const TurnPlanStepStatusCompleted TurnPlanStepStatus = "completed"
const TurnPlanStepStatusInProgress TurnPlanStepStatus = "inProgress"
const TurnPlanStepStatusPending TurnPlanStepStatus = "pending"
type TurnPlanUpdatedNotification ¶
type TurnPlanUpdatedNotification = SanitizedTurnPlanUpdatedNotificationJSON
type TurnStartParams ¶
type TurnStartParams struct {
ThreadID string `json:"threadId"`
Input []TurnStartParamsInputElem `json:"input"`
Cwd *string `json:"cwd,omitempty"`
ApprovalPolicy json.RawMessage `json:"approvalPolicy,omitempty"`
SandboxPolicy json.RawMessage `json:"sandboxPolicy,omitempty"`
Model *string `json:"model,omitempty"`
Effort json.RawMessage `json:"effort,omitempty"`
Summary json.RawMessage `json:"summary,omitempty"`
OutputSchema json.RawMessage `json:"outputSchema,omitempty"`
}
TurnStartParams is maintained manually because the raw schema currently exceeds the generator's capabilities.
type TurnStartParamsInputElem ¶
type TurnStartParamsInputElem interface{}
TurnStartParamsInputElem is maintained manually because turn input entries are represented by the high-level codex.Input type before marshaling.
type TurnStartResponse ¶
type TurnStartResponse interface{}
type TurnStartedNotification ¶
type TurnStartedNotification = TurnNotification
TurnStartedNotification is the payload for turn/started.
type TurnSteerParams ¶
type TurnSteerParams = SanitizedTurnSteerParamsJSON
type TurnSteerParamsInputElem ¶
type TurnSteerParamsInputElem = SanitizedTurnSteerParamsJSONInputElem
TurnSteerParamsInputElem aliases the sanitized generated input element type.
type TurnSteerResponse ¶
type TurnSteerResponse = SanitizedTurnSteerResponseJSON
type WarningNotification ¶
type WarningNotification = SanitizedWarningNotificationJSON
type WebSearchMode ¶
type WebSearchMode string
const WebSearchModeCached WebSearchMode = "cached"
const WebSearchModeDisabled WebSearchMode = "disabled"
const WebSearchModeIndexed WebSearchMode = "indexed"
const WebSearchModeLive WebSearchMode = "live"
type WindowsSandboxReadiness ¶
type WindowsSandboxReadiness string
const WindowsSandboxReadinessNotConfigured WindowsSandboxReadiness = "notConfigured"
const WindowsSandboxReadinessReady WindowsSandboxReadiness = "ready"
const WindowsSandboxReadinessUpdateRequired WindowsSandboxReadiness = "updateRequired"
type WindowsSandboxReadinessResponse ¶
type WindowsSandboxReadinessResponse = SanitizedWindowsSandboxReadinessResponseJSON
type WindowsSandboxSetupCompletedNotification ¶
type WindowsSandboxSetupCompletedNotification = SanitizedWindowsSandboxSetupCompletedNotificationJSON
type WindowsSandboxSetupMode ¶
type WindowsSandboxSetupMode string
const WindowsSandboxSetupModeElevated WindowsSandboxSetupMode = "elevated"
const WindowsSandboxSetupModeUnelevated WindowsSandboxSetupMode = "unelevated"
type WindowsSandboxSetupStartParams ¶
type WindowsSandboxSetupStartParams interface{}
type WindowsSandboxSetupStartResponse ¶
type WindowsSandboxSetupStartResponse = SanitizedWindowsSandboxSetupStartResponseJSON
type WindowsWorldWritableWarningNotification ¶
type WindowsWorldWritableWarningNotification = SanitizedWindowsWorldWritableWarningNotificationJSON
type WorkspaceMessage ¶
type WorkspaceMessage struct {
// Unix timestamp (in seconds) when the message was archived.
ArchivedAt *int `json:"archivedAt,omitempty"`
// Unix timestamp (in seconds) when the message was created.
CreatedAt *int `json:"createdAt,omitempty"`
// MessageBody corresponds to the JSON schema field "messageBody".
MessageBody string `json:"messageBody"`
// MessageID corresponds to the JSON schema field "messageId".
MessageID string `json:"messageId"`
// MessageType corresponds to the JSON schema field "messageType".
MessageType WorkspaceMessageType `json:"messageType"`
}
type WorkspaceMessageType ¶
type WorkspaceMessageType string
const WorkspaceMessageTypeAnnouncement WorkspaceMessageType = "announcement"
const WorkspaceMessageTypeHeadline WorkspaceMessageType = "headline"
const WorkspaceMessageTypeUnknown WorkspaceMessageType = "unknown"