{ "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "AccountLoginCompletedNotification": { "properties": { "error": { "type": [ "string", "null" ] }, "loginId": { "type": [ "string", "null" ] }, "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" }, "AccountRateLimitsUpdatedNotification": { "properties": { "rateLimits": { "$ref": "#/definitions/RateLimitSnapshot" } }, "required": [ "rateLimits" ], "type": "object" }, "AccountUpdatedNotification": { "properties": { "authMode": { "anyOf": [ { "$ref": "#/definitions/AuthMode" }, { "type": "null" } ] }, "planType": { "anyOf": [ { "$ref": "#/definitions/PlanType" }, { "type": "null" } ] } }, "type": "object" }, "AgentMessageDeltaNotification": { "properties": { "delta": { "type": "string" }, "itemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "delta", "itemId", "threadId", "turnId" ], "type": "object" }, "AgentPath": { "type": "string" }, "AppBranding": { "description": "EXPERIMENTAL - app metadata returned by app-list APIs.", "properties": { "category": { "type": [ "string", "null" ] }, "developer": { "type": [ "string", "null" ] }, "isDiscoverableApp": { "type": "boolean" }, "privacyPolicy": { "type": [ "string", "null" ] }, "termsOfService": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] } }, "required": [ "isDiscoverableApp" ], "type": "object" }, "AppInfo": { "description": "EXPERIMENTAL - app metadata returned by app-list APIs.", "properties": { "appMetadata": { "anyOf": [ { "$ref": "#/definitions/AppMetadata" }, { "type": "null" } ] }, "branding": { "anyOf": [ { "$ref": "#/definitions/AppBranding" }, { "type": "null" } ] }, "description": { "type": [ "string", "null" ] }, "distributionChannel": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "installUrl": { "type": [ "string", "null" ] }, "isAccessible": { "default": false, "type": "boolean" }, "isEnabled": { "default": true, "description": "Whether this app is enabled in config.toml. Example: ```toml [apps.bad_app] enabled = false ```", "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "logoUrl": { "type": [ "string", "null" ] }, "logoUrlDark": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "pluginDisplayNames": { "default": [], "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name" ], "type": "object" }, "AppListUpdatedNotification": { "description": "EXPERIMENTAL - notification emitted when the app list changes.", "properties": { "data": { "items": { "$ref": "#/definitions/AppInfo" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "AppMetadata": { "properties": { "categories": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "developer": { "type": [ "string", "null" ] }, "firstPartyRequiresInstall": { "type": [ "boolean", "null" ] }, "firstPartyType": { "type": [ "string", "null" ] }, "review": { "anyOf": [ { "$ref": "#/definitions/AppReview" }, { "type": "null" } ] }, "screenshots": { "items": { "$ref": "#/definitions/AppScreenshot" }, "type": [ "array", "null" ] }, "seoDescription": { "type": [ "string", "null" ] }, "showInComposerWhenUnlinked": { "type": [ "boolean", "null" ] }, "subCategories": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "version": { "type": [ "string", "null" ] }, "versionId": { "type": [ "string", "null" ] }, "versionNotes": { "type": [ "string", "null" ] } }, "type": "object" }, "AppReview": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "AppScreenshot": { "properties": { "fileId": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "userPrompt": { "type": "string" } }, "required": [ "userPrompt" ], "type": "object" }, "AuthMode": { "description": "Authentication mode for OpenAI-backed providers.", "oneOf": [ { "description": "OpenAI API key provided by the caller and stored by Codex.", "enum": [ "apikey" ], "type": "string" }, { "description": "ChatGPT OAuth managed by Codex (tokens persisted and refreshed by Codex).", "enum": [ "chatgpt" ], "type": "string" }, { "description": "[UNSTABLE] FOR OPENAI INTERNAL USE ONLY - DO NOT USE.\n\nChatGPT auth tokens are supplied by an external host app and are only stored in memory. Token refresh must be handled by the external host app.", "enum": [ "chatgptAuthTokens" ], "type": "string" } ] }, "ByteRange": { "properties": { "end": { "format": "uint", "minimum": 0.0, "type": "integer" }, "start": { "format": "uint", "minimum": 0.0, "type": "integer" } }, "required": [ "end", "start" ], "type": "object" }, "CodexErrorInfo": { "description": "This translation layer make sure that we expose codex error code in camel case.\n\nWhen 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.", "oneOf": [ { "enum": [ "contextWindowExceeded", "usageLimitExceeded", "serverOverloaded", "internalServerError", "unauthorized", "badRequest", "threadRollbackFailed", "sandboxError", "other" ], "type": "string" }, { "additionalProperties": false, "properties": { "httpConnectionFailed": { "properties": { "httpStatusCode": { "format": "uint16", "minimum": 0.0, "type": [ "integer", "null" ] } }, "type": "object" } }, "required": [ "httpConnectionFailed" ], "title": "HttpConnectionFailedCodexErrorInfo", "type": "object" }, { "additionalProperties": false, "description": "Failed to connect to the response SSE stream.", "properties": { "responseStreamConnectionFailed": { "properties": { "httpStatusCode": { "format": "uint16", "minimum": 0.0, "type": [ "integer", "null" ] } }, "type": "object" } }, "required": [ "responseStreamConnectionFailed" ], "title": "ResponseStreamConnectionFailedCodexErrorInfo", "type": "object" }, { "additionalProperties": false, "description": "The response SSE stream disconnected in the middle of a turn before completion.", "properties": { "responseStreamDisconnected": { "properties": { "httpStatusCode": { "format": "uint16", "minimum": 0.0, "type": [ "integer", "null" ] } }, "type": "object" } }, "required": [ "responseStreamDisconnected" ], "title": "ResponseStreamDisconnectedCodexErrorInfo", "type": "object" }, { "additionalProperties": false, "description": "Reached the retry limit for responses.", "properties": { "responseTooManyFailedAttempts": { "properties": { "httpStatusCode": { "format": "uint16", "minimum": 0.0, "type": [ "integer", "null" ] } }, "type": "object" } }, "required": [ "responseTooManyFailedAttempts" ], "title": "ResponseTooManyFailedAttemptsCodexErrorInfo", "type": "object" } ] }, "CollabAgentState": { "properties": { "message": { "type": [ "string", "null" ] }, "status": { "$ref": "#/definitions/CollabAgentStatus" } }, "required": [ "status" ], "type": "object" }, "CollabAgentStatus": { "enum": [ "pendingInit", "running", "interrupted", "completed", "errored", "shutdown", "notFound" ], "type": "string" }, "CollabAgentTool": { "enum": [ "spawnAgent", "sendInput", "resumeAgent", "wait", "closeAgent" ], "type": "string" }, "CollabAgentToolCallStatus": { "enum": [ "inProgress", "completed", "failed" ], "type": "string" }, "CommandAction": { "oneOf": [ { "properties": { "command": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "type": { "enum": [ "read" ], "title": "ReadCommandActionType", "type": "string" } }, "required": [ "command", "name", "path", "type" ], "title": "ReadCommandAction", "type": "object" }, { "properties": { "command": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "type": { "enum": [ "listFiles" ], "title": "ListFilesCommandActionType", "type": "string" } }, "required": [ "command", "type" ], "title": "ListFilesCommandAction", "type": "object" }, { "properties": { "command": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "query": { "type": [ "string", "null" ] }, "type": { "enum": [ "search" ], "title": "SearchCommandActionType", "type": "string" } }, "required": [ "command", "type" ], "title": "SearchCommandAction", "type": "object" }, { "properties": { "command": { "type": "string" }, "type": { "enum": [ "unknown" ], "title": "UnknownCommandActionType", "type": "string" } }, "required": [ "command", "type" ], "title": "UnknownCommandAction", "type": "object" } ] }, "CommandExecOutputDeltaNotification": { "description": "Base64-encoded output chunk emitted for a streaming `command/exec` request.\n\nThese notifications are connection-scoped. If the originating connection closes, the server terminates the process.", "properties": { "capReached": { "description": "`true` on the final streamed chunk for a stream when `outputBytesCap` truncated later output on that stream.", "type": "boolean" }, "deltaBase64": { "description": "Base64-encoded output bytes.", "type": "string" }, "processId": { "description": "Client-supplied, connection-scoped `processId` from the original `command/exec` request.", "type": "string" }, "stream": { "allOf": [ { "$ref": "#/definitions/CommandExecOutputStream" } ], "description": "Output stream for this chunk." } }, "required": [ "capReached", "deltaBase64", "processId", "stream" ], "type": "object" }, "CommandExecOutputStream": { "description": "Stream label for `command/exec/outputDelta` notifications.", "oneOf": [ { "description": "stdout stream. PTY mode multiplexes terminal output here.", "enum": [ "stdout" ], "type": "string" }, { "description": "stderr stream.", "enum": [ "stderr" ], "type": "string" } ] }, "CommandExecutionOutputDeltaNotification": { "properties": { "delta": { "type": "string" }, "itemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "delta", "itemId", "threadId", "turnId" ], "type": "object" }, "CommandExecutionSource": { "enum": [ "agent", "userShell", "unifiedExecStartup", "unifiedExecInteraction" ], "type": "string" }, "CommandExecutionStatus": { "enum": [ "inProgress", "completed", "failed", "declined" ], "type": "string" }, "ConfigWarningNotification": { "properties": { "details": { "description": "Optional extra guidance or error details.", "type": [ "string", "null" ] }, "path": { "description": "Optional path to the config file that triggered the warning.", "type": [ "string", "null" ] }, "range": { "anyOf": [ { "$ref": "#/definitions/TextRange" }, { "type": "null" } ], "description": "Optional range for the error location inside the config file." }, "summary": { "description": "Concise summary of the warning.", "type": "string" } }, "required": [ "summary" ], "type": "object" }, "ContextCompactedNotification": { "description": "Deprecated: Use `ContextCompaction` item type instead.", "properties": { "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "threadId", "turnId" ], "type": "object" }, "CreditsSnapshot": { "properties": { "balance": { "type": [ "string", "null" ] }, "hasCredits": { "type": "boolean" }, "unlimited": { "type": "boolean" } }, "required": [ "hasCredits", "unlimited" ], "type": "object" }, "DeprecationNoticeNotification": { "properties": { "details": { "description": "Optional extra guidance, such as migration steps or rationale.", "type": [ "string", "null" ] }, "summary": { "description": "Concise summary of what is deprecated.", "type": "string" } }, "required": [ "summary" ], "type": "object" }, "DynamicToolCallOutputContentItem": { "oneOf": [ { "properties": { "text": { "type": "string" }, "type": { "enum": [ "inputText" ], "title": "InputTextDynamicToolCallOutputContentItemType", "type": "string" } }, "required": [ "text", "type" ], "title": "InputTextDynamicToolCallOutputContentItem", "type": "object" }, { "properties": { "imageUrl": { "type": "string" }, "type": { "enum": [ "inputImage" ], "title": "InputImageDynamicToolCallOutputContentItemType", "type": "string" } }, "required": [ "imageUrl", "type" ], "title": "InputImageDynamicToolCallOutputContentItem", "type": "object" } ] }, "DynamicToolCallStatus": { "enum": [ "inProgress", "completed", "failed" ], "type": "string" }, "ErrorNotification": { "properties": { "error": { "$ref": "#/definitions/TurnError" }, "threadId": { "type": "string" }, "turnId": { "type": "string" }, "willRetry": { "type": "boolean" } }, "required": [ "error", "threadId", "turnId", "willRetry" ], "type": "object" }, "FileChangeOutputDeltaNotification": { "properties": { "delta": { "type": "string" }, "itemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "delta", "itemId", "threadId", "turnId" ], "type": "object" }, "FileUpdateChange": { "properties": { "diff": { "type": "string" }, "kind": { "$ref": "#/definitions/PatchChangeKind" }, "path": { "type": "string" } }, "required": [ "diff", "kind", "path" ], "type": "object" }, "FuzzyFileSearchMatchType": { "enum": [ "file", "directory" ], "type": "string" }, "FuzzyFileSearchResult": { "description": "Superset of [`codex_file_search::FileMatch`]", "properties": { "file_name": { "type": "string" }, "indices": { "items": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "type": [ "array", "null" ] }, "match_type": { "$ref": "#/definitions/FuzzyFileSearchMatchType" }, "path": { "type": "string" }, "root": { "type": "string" }, "score": { "format": "uint32", "minimum": 0.0, "type": "integer" } }, "required": [ "file_name", "match_type", "path", "root", "score" ], "type": "object" }, "FuzzyFileSearchSessionCompletedNotification": { "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "type": "object" }, "FuzzyFileSearchSessionUpdatedNotification": { "properties": { "files": { "items": { "$ref": "#/definitions/FuzzyFileSearchResult" }, "type": "array" }, "query": { "type": "string" }, "sessionId": { "type": "string" } }, "required": [ "files", "query", "sessionId" ], "type": "object" }, "GitInfo": { "properties": { "branch": { "type": [ "string", "null" ] }, "originUrl": { "type": [ "string", "null" ] }, "sha": { "type": [ "string", "null" ] } }, "type": "object" }, "GuardianApprovalReview": { "description": "[UNSTABLE] Temporary guardian approval review payload used by `item/autoApprovalReview/*` notifications. This shape is expected to change soon.", "properties": { "rationale": { "type": [ "string", "null" ] }, "riskLevel": { "anyOf": [ { "$ref": "#/definitions/GuardianRiskLevel" }, { "type": "null" } ] }, "riskScore": { "format": "uint8", "minimum": 0.0, "type": [ "integer", "null" ] }, "status": { "$ref": "#/definitions/GuardianApprovalReviewStatus" } }, "required": [ "status" ], "type": "object" }, "GuardianApprovalReviewStatus": { "description": "[UNSTABLE] Lifecycle state for a guardian approval review.", "enum": [ "inProgress", "approved", "denied", "aborted" ], "type": "string" }, "GuardianRiskLevel": { "description": "[UNSTABLE] Risk level assigned by guardian approval review.", "enum": [ "low", "medium", "high" ], "type": "string" }, "HookCompletedNotification": { "properties": { "run": { "$ref": "#/definitions/HookRunSummary" }, "threadId": { "type": "string" }, "turnId": { "type": [ "string", "null" ] } }, "required": [ "run", "threadId" ], "type": "object" }, "HookEventName": { "enum": [ "sessionStart", "userPromptSubmit", "stop" ], "type": "string" }, "HookExecutionMode": { "enum": [ "sync", "async" ], "type": "string" }, "HookHandlerType": { "enum": [ "command", "prompt", "agent" ], "type": "string" }, "HookOutputEntry": { "properties": { "kind": { "$ref": "#/definitions/HookOutputEntryKind" }, "text": { "type": "string" } }, "required": [ "kind", "text" ], "type": "object" }, "HookOutputEntryKind": { "enum": [ "warning", "stop", "feedback", "context", "error" ], "type": "string" }, "HookPromptFragment": { "properties": { "hookRunId": { "type": "string" }, "text": { "type": "string" } }, "required": [ "hookRunId", "text" ], "type": "object" }, "HookRunStatus": { "enum": [ "running", "completed", "failed", "blocked", "stopped" ], "type": "string" }, "HookRunSummary": { "properties": { "completedAt": { "format": "int64", "type": [ "integer", "null" ] }, "displayOrder": { "format": "int64", "type": "integer" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "entries": { "items": { "$ref": "#/definitions/HookOutputEntry" }, "type": "array" }, "eventName": { "$ref": "#/definitions/HookEventName" }, "executionMode": { "$ref": "#/definitions/HookExecutionMode" }, "handlerType": { "$ref": "#/definitions/HookHandlerType" }, "id": { "type": "string" }, "scope": { "$ref": "#/definitions/HookScope" }, "sourcePath": { "type": "string" }, "startedAt": { "format": "int64", "type": "integer" }, "status": { "$ref": "#/definitions/HookRunStatus" }, "statusMessage": { "type": [ "string", "null" ] } }, "required": [ "displayOrder", "entries", "eventName", "executionMode", "handlerType", "id", "scope", "sourcePath", "startedAt", "status" ], "type": "object" }, "HookScope": { "enum": [ "thread", "turn" ], "type": "string" }, "HookStartedNotification": { "properties": { "run": { "$ref": "#/definitions/HookRunSummary" }, "threadId": { "type": "string" }, "turnId": { "type": [ "string", "null" ] } }, "required": [ "run", "threadId" ], "type": "object" }, "ItemCompletedNotification": { "properties": { "item": { "$ref": "#/definitions/ThreadItem" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "item", "threadId", "turnId" ], "type": "object" }, "ItemGuardianApprovalReviewCompletedNotification": { "description": "[UNSTABLE] Temporary notification payload for guardian automatic approval review. This shape is expected to change soon.\n\nTODO(ccunningham): Attach guardian review state to the reviewed tool item's lifecycle instead of sending separate standalone review notifications so the app-server API can persist and replay review state via `thread/read`.", "properties": { "action": true, "review": { "$ref": "#/definitions/GuardianApprovalReview" }, "targetItemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "review", "targetItemId", "threadId", "turnId" ], "type": "object" }, "ItemGuardianApprovalReviewStartedNotification": { "description": "[UNSTABLE] Temporary notification payload for guardian automatic approval review. This shape is expected to change soon.\n\nTODO(ccunningham): Attach guardian review state to the reviewed tool item's lifecycle instead of sending separate standalone review notifications so the app-server API can persist and replay review state via `thread/read`.", "properties": { "action": true, "review": { "$ref": "#/definitions/GuardianApprovalReview" }, "targetItemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "review", "targetItemId", "threadId", "turnId" ], "type": "object" }, "ItemStartedNotification": { "properties": { "item": { "$ref": "#/definitions/ThreadItem" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "item", "threadId", "turnId" ], "type": "object" }, "McpServerOauthLoginCompletedNotification": { "properties": { "error": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "name", "success" ], "type": "object" }, "McpServerStartupState": { "enum": [ "starting", "ready", "failed", "cancelled" ], "type": "string" }, "McpServerStatusUpdatedNotification": { "properties": { "error": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "status": { "$ref": "#/definitions/McpServerStartupState" } }, "required": [ "name", "status" ], "type": "object" }, "McpToolCallError": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "McpToolCallProgressNotification": { "properties": { "itemId": { "type": "string" }, "message": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "itemId", "message", "threadId", "turnId" ], "type": "object" }, "McpToolCallResult": { "properties": { "content": { "items": true, "type": "array" }, "structuredContent": true }, "required": [ "content" ], "type": "object" }, "McpToolCallStatus": { "enum": [ "inProgress", "completed", "failed" ], "type": "string" }, "MemoryCitation": { "properties": { "entries": { "items": { "$ref": "#/definitions/MemoryCitationEntry" }, "type": "array" }, "threadIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "entries", "threadIds" ], "type": "object" }, "MemoryCitationEntry": { "properties": { "lineEnd": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "lineStart": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "note": { "type": "string" }, "path": { "type": "string" } }, "required": [ "lineEnd", "lineStart", "note", "path" ], "type": "object" }, "MessagePhase": { "description": "Classifies an assistant message as interim commentary or final answer text.\n\nProviders do not emit this consistently, so callers must treat `None` as \"phase unknown\" and keep compatibility behavior for legacy models.", "oneOf": [ { "description": "Mid-turn assistant text (for example preamble/progress narration).\n\nAdditional tool calls or assistant output may follow before turn completion.", "enum": [ "commentary" ], "type": "string" }, { "description": "The assistant's terminal answer text for the current turn.", "enum": [ "final_answer" ], "type": "string" } ] }, "ModelRerouteReason": { "enum": [ "highRiskCyberActivity" ], "type": "string" }, "ModelReroutedNotification": { "properties": { "fromModel": { "type": "string" }, "reason": { "$ref": "#/definitions/ModelRerouteReason" }, "threadId": { "type": "string" }, "toModel": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "fromModel", "reason", "threadId", "toModel", "turnId" ], "type": "object" }, "PatchApplyStatus": { "enum": [ "inProgress", "completed", "failed", "declined" ], "type": "string" }, "PatchChangeKind": { "oneOf": [ { "properties": { "type": { "enum": [ "add" ], "title": "AddPatchChangeKindType", "type": "string" } }, "required": [ "type" ], "title": "AddPatchChangeKind", "type": "object" }, { "properties": { "type": { "enum": [ "delete" ], "title": "DeletePatchChangeKindType", "type": "string" } }, "required": [ "type" ], "title": "DeletePatchChangeKind", "type": "object" }, { "properties": { "move_path": { "type": [ "string", "null" ] }, "type": { "enum": [ "update" ], "title": "UpdatePatchChangeKindType", "type": "string" } }, "required": [ "type" ], "title": "UpdatePatchChangeKind", "type": "object" } ] }, "PlanDeltaNotification": { "description": "EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content.", "properties": { "delta": { "type": "string" }, "itemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "delta", "itemId", "threadId", "turnId" ], "type": "object" }, "PlanType": { "enum": [ "free", "go", "plus", "pro", "team", "business", "enterprise", "edu", "unknown" ], "type": "string" }, "RateLimitSnapshot": { "properties": { "credits": { "anyOf": [ { "$ref": "#/definitions/CreditsSnapshot" }, { "type": "null" } ] }, "limitId": { "type": [ "string", "null" ] }, "limitName": { "type": [ "string", "null" ] }, "planType": { "anyOf": [ { "$ref": "#/definitions/PlanType" }, { "type": "null" } ] }, "primary": { "anyOf": [ { "$ref": "#/definitions/RateLimitWindow" }, { "type": "null" } ] }, "secondary": { "anyOf": [ { "$ref": "#/definitions/RateLimitWindow" }, { "type": "null" } ] } }, "type": "object" }, "RateLimitWindow": { "properties": { "resetsAt": { "format": "int64", "type": [ "integer", "null" ] }, "usedPercent": { "format": "int32", "type": "integer" }, "windowDurationMins": { "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "usedPercent" ], "type": "object" }, "RealtimeConversationVersion": { "enum": [ "v1", "v2" ], "type": "string" }, "ReasoningEffort": { "description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh" ], "type": "string" }, "ReasoningSummaryPartAddedNotification": { "properties": { "itemId": { "type": "string" }, "summaryIndex": { "format": "int64", "type": "integer" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "itemId", "summaryIndex", "threadId", "turnId" ], "type": "object" }, "ReasoningSummaryTextDeltaNotification": { "properties": { "delta": { "type": "string" }, "itemId": { "type": "string" }, "summaryIndex": { "format": "int64", "type": "integer" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "delta", "itemId", "summaryIndex", "threadId", "turnId" ], "type": "object" }, "ReasoningTextDeltaNotification": { "properties": { "contentIndex": { "format": "int64", "type": "integer" }, "delta": { "type": "string" }, "itemId": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "contentIndex", "delta", "itemId", "threadId", "turnId" ], "type": "object" }, "RequestId": { "anyOf": [ { "type": "string" }, { "format": "int64", "type": "integer" } ] }, "ServerRequestResolvedNotification": { "properties": { "requestId": { "$ref": "#/definitions/RequestId" }, "threadId": { "type": "string" } }, "required": [ "requestId", "threadId" ], "type": "object" }, "SessionSource": { "oneOf": [ { "enum": [ "cli", "vscode", "exec", "appServer", "unknown" ], "type": "string" }, { "additionalProperties": false, "properties": { "custom": { "type": "string" } }, "required": [ "custom" ], "title": "CustomSessionSource", "type": "object" }, { "additionalProperties": false, "properties": { "subAgent": { "$ref": "#/definitions/SubAgentSource" } }, "required": [ "subAgent" ], "title": "SubAgentSessionSource", "type": "object" } ] }, "SkillsChangedNotification": { "description": "Notification emitted when watched local skill files change.\n\nTreat this as an invalidation signal and re-run `skills/list` with the client's current parameters when refreshed skill metadata is needed.", "type": "object" }, "SubAgentSource": { "oneOf": [ { "enum": [ "review", "compact", "memory_consolidation" ], "type": "string" }, { "additionalProperties": false, "properties": { "thread_spawn": { "properties": { "agent_nickname": { "default": null, "type": [ "string", "null" ] }, "agent_path": { "anyOf": [ { "$ref": "#/definitions/AgentPath" }, { "type": "null" } ], "default": null }, "agent_role": { "default": null, "type": [ "string", "null" ] }, "depth": { "format": "int32", "type": "integer" }, "parent_thread_id": { "$ref": "#/definitions/ThreadId" } }, "required": [ "depth", "parent_thread_id" ], "type": "object" } }, "required": [ "thread_spawn" ], "title": "ThreadSpawnSubAgentSource", "type": "object" }, { "additionalProperties": false, "properties": { "other": { "type": "string" } }, "required": [ "other" ], "title": "OtherSubAgentSource", "type": "object" } ] }, "TerminalInteractionNotification": { "properties": { "itemId": { "type": "string" }, "processId": { "type": "string" }, "stdin": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "itemId", "processId", "stdin", "threadId", "turnId" ], "type": "object" }, "TextElement": { "properties": { "byteRange": { "allOf": [ { "$ref": "#/definitions/ByteRange" } ], "description": "Byte range in the parent `text` buffer that this element occupies." }, "placeholder": { "description": "Optional human-readable placeholder for the element, displayed in the UI.", "type": [ "string", "null" ] } }, "required": [ "byteRange" ], "type": "object" }, "TextPosition": { "properties": { "column": { "description": "1-based column number (in Unicode scalar values).", "format": "uint", "minimum": 0.0, "type": "integer" }, "line": { "description": "1-based line number.", "format": "uint", "minimum": 0.0, "type": "integer" } }, "required": [ "column", "line" ], "type": "object" }, "TextRange": { "properties": { "end": { "$ref": "#/definitions/TextPosition" }, "start": { "$ref": "#/definitions/TextPosition" } }, "required": [ "end", "start" ], "type": "object" }, "Thread": { "properties": { "agentNickname": { "description": "Optional random unique nickname assigned to an AgentControl-spawned sub-agent.", "type": [ "string", "null" ] }, "agentRole": { "description": "Optional role (agent_role) assigned to an AgentControl-spawned sub-agent.", "type": [ "string", "null" ] }, "cliVersion": { "description": "Version of the CLI that created the thread.", "type": "string" }, "createdAt": { "description": "Unix timestamp (in seconds) when the thread was created.", "format": "int64", "type": "integer" }, "cwd": { "description": "Working directory captured for the thread.", "type": "string" }, "ephemeral": { "description": "Whether the thread is ephemeral and should not be materialized on disk.", "type": "boolean" }, "gitInfo": { "anyOf": [ { "$ref": "#/definitions/GitInfo" }, { "type": "null" } ], "description": "Optional Git metadata captured when the thread was created." }, "id": { "type": "string" }, "modelProvider": { "description": "Model provider used for this thread (for example, 'openai').", "type": "string" }, "name": { "description": "Optional user-facing thread title.", "type": [ "string", "null" ] }, "path": { "description": "[UNSTABLE] Path to the thread on disk.", "type": [ "string", "null" ] }, "preview": { "description": "Usually the first user message in the thread, if available.", "type": "string" }, "source": { "allOf": [ { "$ref": "#/definitions/SessionSource" } ], "description": "Origin of the thread (CLI, VSCode, codex exec, codex app-server, etc.)." }, "status": { "allOf": [ { "$ref": "#/definitions/ThreadStatus" } ], "description": "Current runtime status for the thread." }, "turns": { "description": "Only populated on `thread/resume`, `thread/rollback`, `thread/fork`, and `thread/read` (when `includeTurns` is true) responses. For all other responses and notifications returning a Thread, the turns field will be an empty list.", "items": { "$ref": "#/definitions/Turn" }, "type": "array" }, "updatedAt": { "description": "Unix timestamp (in seconds) when the thread was last updated.", "format": "int64", "type": "integer" } }, "required": [ "cliVersion", "createdAt", "cwd", "ephemeral", "id", "modelProvider", "preview", "source", "status", "turns", "updatedAt" ], "type": "object" }, "ThreadActiveFlag": { "enum": [ "waitingOnApproval", "waitingOnUserInput" ], "type": "string" }, "ThreadArchivedNotification": { "properties": { "threadId": { "type": "string" } }, "required": [ "threadId" ], "type": "object" }, "ThreadClosedNotification": { "properties": { "threadId": { "type": "string" } }, "required": [ "threadId" ], "type": "object" }, "ThreadId": { "type": "string" }, "ThreadItem": { "oneOf": [ { "properties": { "content": { "items": { "$ref": "#/definitions/UserInput" }, "type": "array" }, "id": { "type": "string" }, "type": { "enum": [ "userMessage" ], "title": "UserMessageThreadItemType", "type": "string" } }, "required": [ "content", "id", "type" ], "title": "UserMessageThreadItem", "type": "object" }, { "properties": { "fragments": { "items": { "$ref": "#/definitions/HookPromptFragment" }, "type": "array" }, "id": { "type": "string" }, "type": { "enum": [ "hookPrompt" ], "title": "HookPromptThreadItemType", "type": "string" } }, "required": [ "fragments", "id", "type" ], "title": "HookPromptThreadItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "memoryCitation": { "anyOf": [ { "$ref": "#/definitions/MemoryCitation" }, { "type": "null" } ], "default": null }, "phase": { "anyOf": [ { "$ref": "#/definitions/MessagePhase" }, { "type": "null" } ], "default": null }, "text": { "type": "string" }, "type": { "enum": [ "agentMessage" ], "title": "AgentMessageThreadItemType", "type": "string" } }, "required": [ "id", "text", "type" ], "title": "AgentMessageThreadItem", "type": "object" }, { "description": "EXPERIMENTAL - proposed plan item content. The completed plan item is authoritative and may not match the concatenation of `PlanDelta` text.", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "type": { "enum": [ "plan" ], "title": "PlanThreadItemType", "type": "string" } }, "required": [ "id", "text", "type" ], "title": "PlanThreadItem", "type": "object" }, { "properties": { "content": { "default": [], "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "summary": { "default": [], "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "reasoning" ], "title": "ReasoningThreadItemType", "type": "string" } }, "required": [ "id", "type" ], "title": "ReasoningThreadItem", "type": "object" }, { "properties": { "aggregatedOutput": { "description": "The command's output, aggregated from stdout and stderr.", "type": [ "string", "null" ] }, "command": { "description": "The command to be executed.", "type": "string" }, "commandActions": { "description": "A best-effort parsing of the command to understand the action(s) it will perform. This returns a list of CommandAction objects because a single shell command may be composed of many commands piped together.", "items": { "$ref": "#/definitions/CommandAction" }, "type": "array" }, "cwd": { "description": "The command's working directory.", "type": "string" }, "durationMs": { "description": "The duration of the command execution in milliseconds.", "format": "int64", "type": [ "integer", "null" ] }, "exitCode": { "description": "The command's exit code.", "format": "int32", "type": [ "integer", "null" ] }, "id": { "type": "string" }, "processId": { "description": "Identifier for the underlying PTY process (when available).", "type": [ "string", "null" ] }, "source": { "allOf": [ { "$ref": "#/definitions/CommandExecutionSource" } ], "default": "agent" }, "status": { "$ref": "#/definitions/CommandExecutionStatus" }, "type": { "enum": [ "commandExecution" ], "title": "CommandExecutionThreadItemType", "type": "string" } }, "required": [ "command", "commandActions", "cwd", "id", "status", "type" ], "title": "CommandExecutionThreadItem", "type": "object" }, { "properties": { "changes": { "items": { "$ref": "#/definitions/FileUpdateChange" }, "type": "array" }, "id": { "type": "string" }, "status": { "$ref": "#/definitions/PatchApplyStatus" }, "type": { "enum": [ "fileChange" ], "title": "FileChangeThreadItemType", "type": "string" } }, "required": [ "changes", "id", "status", "type" ], "title": "FileChangeThreadItem", "type": "object" }, { "properties": { "arguments": true, "durationMs": { "description": "The duration of the MCP tool call in milliseconds.", "format": "int64", "type": [ "integer", "null" ] }, "error": { "anyOf": [ { "$ref": "#/definitions/McpToolCallError" }, { "type": "null" } ] }, "id": { "type": "string" }, "result": { "anyOf": [ { "$ref": "#/definitions/McpToolCallResult" }, { "type": "null" } ] }, "server": { "type": "string" }, "status": { "$ref": "#/definitions/McpToolCallStatus" }, "tool": { "type": "string" }, "type": { "enum": [ "mcpToolCall" ], "title": "McpToolCallThreadItemType", "type": "string" } }, "required": [ "arguments", "id", "server", "status", "tool", "type" ], "title": "McpToolCallThreadItem", "type": "object" }, { "properties": { "arguments": true, "contentItems": { "items": { "$ref": "#/definitions/DynamicToolCallOutputContentItem" }, "type": [ "array", "null" ] }, "durationMs": { "description": "The duration of the dynamic tool call in milliseconds.", "format": "int64", "type": [ "integer", "null" ] }, "id": { "type": "string" }, "status": { "$ref": "#/definitions/DynamicToolCallStatus" }, "success": { "type": [ "boolean", "null" ] }, "tool": { "type": "string" }, "type": { "enum": [ "dynamicToolCall" ], "title": "DynamicToolCallThreadItemType", "type": "string" } }, "required": [ "arguments", "id", "status", "tool", "type" ], "title": "DynamicToolCallThreadItem", "type": "object" }, { "properties": { "agentsStates": { "additionalProperties": { "$ref": "#/definitions/CollabAgentState" }, "description": "Last known status of the target agents, when available.", "type": "object" }, "id": { "description": "Unique identifier for this collab tool call.", "type": "string" }, "model": { "description": "Model requested for the spawned agent, when applicable.", "type": [ "string", "null" ] }, "prompt": { "description": "Prompt text sent as part of the collab tool call, when available.", "type": [ "string", "null" ] }, "reasoningEffort": { "anyOf": [ { "$ref": "#/definitions/ReasoningEffort" }, { "type": "null" } ], "description": "Reasoning effort requested for the spawned agent, when applicable." }, "receiverThreadIds": { "description": "Thread ID of the receiving agent, when applicable. In case of spawn operation, this corresponds to the newly spawned agent.", "items": { "type": "string" }, "type": "array" }, "senderThreadId": { "description": "Thread ID of the agent issuing the collab request.", "type": "string" }, "status": { "allOf": [ { "$ref": "#/definitions/CollabAgentToolCallStatus" } ], "description": "Current status of the collab tool call." }, "tool": { "allOf": [ { "$ref": "#/definitions/CollabAgentTool" } ], "description": "Name of the collab tool that was invoked." }, "type": { "enum": [ "collabAgentToolCall" ], "title": "CollabAgentToolCallThreadItemType", "type": "string" } }, "required": [ "agentsStates", "id", "receiverThreadIds", "senderThreadId", "status", "tool", "type" ], "title": "CollabAgentToolCallThreadItem", "type": "object" }, { "properties": { "action": { "anyOf": [ { "$ref": "#/definitions/WebSearchAction" }, { "type": "null" } ] }, "id": { "type": "string" }, "query": { "type": "string" }, "type": { "enum": [ "webSearch" ], "title": "WebSearchThreadItemType", "type": "string" } }, "required": [ "id", "query", "type" ], "title": "WebSearchThreadItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "type": { "enum": [ "imageView" ], "title": "ImageViewThreadItemType", "type": "string" } }, "required": [ "id", "path", "type" ], "title": "ImageViewThreadItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "result": { "type": "string" }, "revisedPrompt": { "type": [ "string", "null" ] }, "savedPath": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "type": { "enum": [ "imageGeneration" ], "title": "ImageGenerationThreadItemType", "type": "string" } }, "required": [ "id", "result", "status", "type" ], "title": "ImageGenerationThreadItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "review": { "type": "string" }, "type": { "enum": [ "enteredReviewMode" ], "title": "EnteredReviewModeThreadItemType", "type": "string" } }, "required": [ "id", "review", "type" ], "title": "EnteredReviewModeThreadItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "review": { "type": "string" }, "type": { "enum": [ "exitedReviewMode" ], "title": "ExitedReviewModeThreadItemType", "type": "string" } }, "required": [ "id", "review", "type" ], "title": "ExitedReviewModeThreadItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "type": { "enum": [ "contextCompaction" ], "title": "ContextCompactionThreadItemType", "type": "string" } }, "required": [ "id", "type" ], "title": "ContextCompactionThreadItem", "type": "object" } ] }, "ThreadNameUpdatedNotification": { "properties": { "threadId": { "type": "string" }, "threadName": { "type": [ "string", "null" ] } }, "required": [ "threadId" ], "type": "object" }, "ThreadRealtimeAudioChunk": { "description": "EXPERIMENTAL - thread realtime audio chunk.", "properties": { "data": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "numChannels": { "format": "uint16", "minimum": 0.0, "type": "integer" }, "sampleRate": { "format": "uint32", "minimum": 0.0, "type": "integer" }, "samplesPerChannel": { "format": "uint32", "minimum": 0.0, "type": [ "integer", "null" ] } }, "required": [ "data", "numChannels", "sampleRate" ], "type": "object" }, "ThreadRealtimeClosedNotification": { "description": "EXPERIMENTAL - emitted when thread realtime transport closes.", "properties": { "reason": { "type": [ "string", "null" ] }, "threadId": { "type": "string" } }, "required": [ "threadId" ], "type": "object" }, "ThreadRealtimeErrorNotification": { "description": "EXPERIMENTAL - emitted when thread realtime encounters an error.", "properties": { "message": { "type": "string" }, "threadId": { "type": "string" } }, "required": [ "message", "threadId" ], "type": "object" }, "ThreadRealtimeItemAddedNotification": { "description": "EXPERIMENTAL - raw non-audio thread realtime item emitted by the backend.", "properties": { "item": true, "threadId": { "type": "string" } }, "required": [ "item", "threadId" ], "type": "object" }, "ThreadRealtimeOutputAudioDeltaNotification": { "description": "EXPERIMENTAL - streamed output audio emitted by thread realtime.", "properties": { "audio": { "$ref": "#/definitions/ThreadRealtimeAudioChunk" }, "threadId": { "type": "string" } }, "required": [ "audio", "threadId" ], "type": "object" }, "ThreadRealtimeStartedNotification": { "description": "EXPERIMENTAL - emitted when thread realtime startup is accepted.", "properties": { "sessionId": { "type": [ "string", "null" ] }, "threadId": { "type": "string" }, "version": { "$ref": "#/definitions/RealtimeConversationVersion" } }, "required": [ "threadId", "version" ], "type": "object" }, "ThreadRealtimeTranscriptUpdatedNotification": { "description": "EXPERIMENTAL - flat transcript delta emitted whenever realtime transcript text changes.", "properties": { "role": { "type": "string" }, "text": { "type": "string" }, "threadId": { "type": "string" } }, "required": [ "role", "text", "threadId" ], "type": "object" }, "ThreadStartedNotification": { "properties": { "thread": { "$ref": "#/definitions/Thread" } }, "required": [ "thread" ], "type": "object" }, "ThreadStatus": { "oneOf": [ { "properties": { "type": { "enum": [ "notLoaded" ], "title": "NotLoadedThreadStatusType", "type": "string" } }, "required": [ "type" ], "title": "NotLoadedThreadStatus", "type": "object" }, { "properties": { "type": { "enum": [ "idle" ], "title": "IdleThreadStatusType", "type": "string" } }, "required": [ "type" ], "title": "IdleThreadStatus", "type": "object" }, { "properties": { "type": { "enum": [ "systemError" ], "title": "SystemErrorThreadStatusType", "type": "string" } }, "required": [ "type" ], "title": "SystemErrorThreadStatus", "type": "object" }, { "properties": { "activeFlags": { "items": { "$ref": "#/definitions/ThreadActiveFlag" }, "type": "array" }, "type": { "enum": [ "active" ], "title": "ActiveThreadStatusType", "type": "string" } }, "required": [ "activeFlags", "type" ], "title": "ActiveThreadStatus", "type": "object" } ] }, "ThreadStatusChangedNotification": { "properties": { "status": { "$ref": "#/definitions/ThreadStatus" }, "threadId": { "type": "string" } }, "required": [ "status", "threadId" ], "type": "object" }, "ThreadTokenUsage": { "properties": { "last": { "$ref": "#/definitions/TokenUsageBreakdown" }, "modelContextWindow": { "format": "int64", "type": [ "integer", "null" ] }, "total": { "$ref": "#/definitions/TokenUsageBreakdown" } }, "required": [ "last", "total" ], "type": "object" }, "ThreadTokenUsageUpdatedNotification": { "properties": { "threadId": { "type": "string" }, "tokenUsage": { "$ref": "#/definitions/ThreadTokenUsage" }, "turnId": { "type": "string" } }, "required": [ "threadId", "tokenUsage", "turnId" ], "type": "object" }, "ThreadUnarchivedNotification": { "properties": { "threadId": { "type": "string" } }, "required": [ "threadId" ], "type": "object" }, "TokenUsageBreakdown": { "properties": { "cachedInputTokens": { "format": "int64", "type": "integer" }, "inputTokens": { "format": "int64", "type": "integer" }, "outputTokens": { "format": "int64", "type": "integer" }, "reasoningOutputTokens": { "format": "int64", "type": "integer" }, "totalTokens": { "format": "int64", "type": "integer" } }, "required": [ "cachedInputTokens", "inputTokens", "outputTokens", "reasoningOutputTokens", "totalTokens" ], "type": "object" }, "Turn": { "properties": { "error": { "anyOf": [ { "$ref": "#/definitions/TurnError" }, { "type": "null" } ], "description": "Only populated when the Turn's status is failed." }, "id": { "type": "string" }, "items": { "description": "Only populated on a `thread/resume` or `thread/fork` response. For all other responses and notifications returning a Turn, the items field will be an empty list.", "items": { "$ref": "#/definitions/ThreadItem" }, "type": "array" }, "status": { "$ref": "#/definitions/TurnStatus" } }, "required": [ "id", "items", "status" ], "type": "object" }, "TurnCompletedNotification": { "properties": { "threadId": { "type": "string" }, "turn": { "$ref": "#/definitions/Turn" } }, "required": [ "threadId", "turn" ], "type": "object" }, "TurnDiffUpdatedNotification": { "description": "Notification that the turn-level unified diff has changed. Contains the latest aggregated diff across all file changes in the turn.", "properties": { "diff": { "type": "string" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "diff", "threadId", "turnId" ], "type": "object" }, "TurnError": { "properties": { "additionalDetails": { "default": null, "type": [ "string", "null" ] }, "codexErrorInfo": { "anyOf": [ { "$ref": "#/definitions/CodexErrorInfo" }, { "type": "null" } ] }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "TurnPlanStep": { "properties": { "status": { "$ref": "#/definitions/TurnPlanStepStatus" }, "step": { "type": "string" } }, "required": [ "status", "step" ], "type": "object" }, "TurnPlanStepStatus": { "enum": [ "pending", "inProgress", "completed" ], "type": "string" }, "TurnPlanUpdatedNotification": { "properties": { "explanation": { "type": [ "string", "null" ] }, "plan": { "items": { "$ref": "#/definitions/TurnPlanStep" }, "type": "array" }, "threadId": { "type": "string" }, "turnId": { "type": "string" } }, "required": [ "plan", "threadId", "turnId" ], "type": "object" }, "TurnStartedNotification": { "properties": { "threadId": { "type": "string" }, "turn": { "$ref": "#/definitions/Turn" } }, "required": [ "threadId", "turn" ], "type": "object" }, "TurnStatus": { "enum": [ "completed", "interrupted", "failed", "inProgress" ], "type": "string" }, "UserInput": { "oneOf": [ { "properties": { "text": { "type": "string" }, "text_elements": { "default": [], "description": "UI-defined spans within `text` used to render or persist special elements.", "items": { "$ref": "#/definitions/TextElement" }, "type": "array" }, "type": { "enum": [ "text" ], "title": "TextUserInputType", "type": "string" } }, "required": [ "text", "type" ], "title": "TextUserInput", "type": "object" }, { "properties": { "type": { "enum": [ "image" ], "title": "ImageUserInputType", "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "url" ], "title": "ImageUserInput", "type": "object" }, { "properties": { "path": { "type": "string" }, "type": { "enum": [ "localImage" ], "title": "LocalImageUserInputType", "type": "string" } }, "required": [ "path", "type" ], "title": "LocalImageUserInput", "type": "object" }, { "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "type": { "enum": [ "skill" ], "title": "SkillUserInputType", "type": "string" } }, "required": [ "name", "path", "type" ], "title": "SkillUserInput", "type": "object" }, { "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "type": { "enum": [ "mention" ], "title": "MentionUserInputType", "type": "string" } }, "required": [ "name", "path", "type" ], "title": "MentionUserInput", "type": "object" } ] }, "WebSearchAction": { "oneOf": [ { "properties": { "queries": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "query": { "type": [ "string", "null" ] }, "type": { "enum": [ "search" ], "title": "SearchWebSearchActionType", "type": "string" } }, "required": [ "type" ], "title": "SearchWebSearchAction", "type": "object" }, { "properties": { "type": { "enum": [ "openPage" ], "title": "OpenPageWebSearchActionType", "type": "string" }, "url": { "type": [ "string", "null" ] } }, "required": [ "type" ], "title": "OpenPageWebSearchAction", "type": "object" }, { "properties": { "pattern": { "type": [ "string", "null" ] }, "type": { "enum": [ "findInPage" ], "title": "FindInPageWebSearchActionType", "type": "string" }, "url": { "type": [ "string", "null" ] } }, "required": [ "type" ], "title": "FindInPageWebSearchAction", "type": "object" }, { "properties": { "type": { "enum": [ "other" ], "title": "OtherWebSearchActionType", "type": "string" } }, "required": [ "type" ], "title": "OtherWebSearchAction", "type": "object" } ] }, "WindowsSandboxSetupCompletedNotification": { "properties": { "error": { "type": [ "string", "null" ] }, "mode": { "$ref": "#/definitions/WindowsSandboxSetupMode" }, "success": { "type": "boolean" } }, "required": [ "mode", "success" ], "type": "object" }, "WindowsSandboxSetupMode": { "enum": [ "elevated", "unelevated" ], "type": "string" }, "WindowsWorldWritableWarningNotification": { "properties": { "extraCount": { "format": "uint", "minimum": 0.0, "type": "integer" }, "failedScan": { "type": "boolean" }, "samplePaths": { "items": { "type": "string" }, "type": "array" } }, "required": [ "extraCount", "failedScan", "samplePaths" ], "type": "object" } }, "description": "Notification sent from the server to the client.", "oneOf": [ { "description": "NEW NOTIFICATIONS", "properties": { "method": { "enum": [ "error" ], "title": "ErrorNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ErrorNotification" } }, "required": [ "method", "params" ], "title": "ErrorNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/started" ], "title": "Thread/startedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadStartedNotification" } }, "required": [ "method", "params" ], "title": "Thread/startedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/status/changed" ], "title": "Thread/status/changedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadStatusChangedNotification" } }, "required": [ "method", "params" ], "title": "Thread/status/changedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/archived" ], "title": "Thread/archivedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadArchivedNotification" } }, "required": [ "method", "params" ], "title": "Thread/archivedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/unarchived" ], "title": "Thread/unarchivedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadUnarchivedNotification" } }, "required": [ "method", "params" ], "title": "Thread/unarchivedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/closed" ], "title": "Thread/closedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadClosedNotification" } }, "required": [ "method", "params" ], "title": "Thread/closedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "skills/changed" ], "title": "Skills/changedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/SkillsChangedNotification" } }, "required": [ "method", "params" ], "title": "Skills/changedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/name/updated" ], "title": "Thread/name/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadNameUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Thread/name/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/tokenUsage/updated" ], "title": "Thread/tokenUsage/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadTokenUsageUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Thread/tokenUsage/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "turn/started" ], "title": "Turn/startedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/TurnStartedNotification" } }, "required": [ "method", "params" ], "title": "Turn/startedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "hook/started" ], "title": "Hook/startedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/HookStartedNotification" } }, "required": [ "method", "params" ], "title": "Hook/startedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "turn/completed" ], "title": "Turn/completedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/TurnCompletedNotification" } }, "required": [ "method", "params" ], "title": "Turn/completedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "hook/completed" ], "title": "Hook/completedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/HookCompletedNotification" } }, "required": [ "method", "params" ], "title": "Hook/completedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "turn/diff/updated" ], "title": "Turn/diff/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/TurnDiffUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Turn/diff/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "turn/plan/updated" ], "title": "Turn/plan/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/TurnPlanUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Turn/plan/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/started" ], "title": "Item/startedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ItemStartedNotification" } }, "required": [ "method", "params" ], "title": "Item/startedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/autoApprovalReview/started" ], "title": "Item/autoApprovalReview/startedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ItemGuardianApprovalReviewStartedNotification" } }, "required": [ "method", "params" ], "title": "Item/autoApprovalReview/startedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/autoApprovalReview/completed" ], "title": "Item/autoApprovalReview/completedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ItemGuardianApprovalReviewCompletedNotification" } }, "required": [ "method", "params" ], "title": "Item/autoApprovalReview/completedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/completed" ], "title": "Item/completedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ItemCompletedNotification" } }, "required": [ "method", "params" ], "title": "Item/completedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/agentMessage/delta" ], "title": "Item/agentMessage/deltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/AgentMessageDeltaNotification" } }, "required": [ "method", "params" ], "title": "Item/agentMessage/deltaNotification", "type": "object" }, { "description": "EXPERIMENTAL - proposed plan streaming deltas for plan items.", "properties": { "method": { "enum": [ "item/plan/delta" ], "title": "Item/plan/deltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/PlanDeltaNotification" } }, "required": [ "method", "params" ], "title": "Item/plan/deltaNotification", "type": "object" }, { "description": "Stream base64-encoded stdout/stderr chunks for a running `command/exec` session.", "properties": { "method": { "enum": [ "command/exec/outputDelta" ], "title": "Command/exec/outputDeltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/CommandExecOutputDeltaNotification" } }, "required": [ "method", "params" ], "title": "Command/exec/outputDeltaNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/commandExecution/outputDelta" ], "title": "Item/commandExecution/outputDeltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/CommandExecutionOutputDeltaNotification" } }, "required": [ "method", "params" ], "title": "Item/commandExecution/outputDeltaNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/commandExecution/terminalInteraction" ], "title": "Item/commandExecution/terminalInteractionNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/TerminalInteractionNotification" } }, "required": [ "method", "params" ], "title": "Item/commandExecution/terminalInteractionNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/fileChange/outputDelta" ], "title": "Item/fileChange/outputDeltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/FileChangeOutputDeltaNotification" } }, "required": [ "method", "params" ], "title": "Item/fileChange/outputDeltaNotification", "type": "object" }, { "properties": { "method": { "enum": [ "serverRequest/resolved" ], "title": "ServerRequest/resolvedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ServerRequestResolvedNotification" } }, "required": [ "method", "params" ], "title": "ServerRequest/resolvedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/mcpToolCall/progress" ], "title": "Item/mcpToolCall/progressNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/McpToolCallProgressNotification" } }, "required": [ "method", "params" ], "title": "Item/mcpToolCall/progressNotification", "type": "object" }, { "properties": { "method": { "enum": [ "mcpServer/oauthLogin/completed" ], "title": "McpServer/oauthLogin/completedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/McpServerOauthLoginCompletedNotification" } }, "required": [ "method", "params" ], "title": "McpServer/oauthLogin/completedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "mcpServer/startupStatus/updated" ], "title": "McpServer/startupStatus/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/McpServerStatusUpdatedNotification" } }, "required": [ "method", "params" ], "title": "McpServer/startupStatus/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "account/updated" ], "title": "Account/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/AccountUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Account/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "account/rateLimits/updated" ], "title": "Account/rateLimits/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/AccountRateLimitsUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Account/rateLimits/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "app/list/updated" ], "title": "App/list/updatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/AppListUpdatedNotification" } }, "required": [ "method", "params" ], "title": "App/list/updatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/reasoning/summaryTextDelta" ], "title": "Item/reasoning/summaryTextDeltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ReasoningSummaryTextDeltaNotification" } }, "required": [ "method", "params" ], "title": "Item/reasoning/summaryTextDeltaNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/reasoning/summaryPartAdded" ], "title": "Item/reasoning/summaryPartAddedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ReasoningSummaryPartAddedNotification" } }, "required": [ "method", "params" ], "title": "Item/reasoning/summaryPartAddedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "item/reasoning/textDelta" ], "title": "Item/reasoning/textDeltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ReasoningTextDeltaNotification" } }, "required": [ "method", "params" ], "title": "Item/reasoning/textDeltaNotification", "type": "object" }, { "description": "Deprecated: Use `ContextCompaction` item type instead.", "properties": { "method": { "enum": [ "thread/compacted" ], "title": "Thread/compactedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ContextCompactedNotification" } }, "required": [ "method", "params" ], "title": "Thread/compactedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "model/rerouted" ], "title": "Model/reroutedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ModelReroutedNotification" } }, "required": [ "method", "params" ], "title": "Model/reroutedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "deprecationNotice" ], "title": "DeprecationNoticeNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/DeprecationNoticeNotification" } }, "required": [ "method", "params" ], "title": "DeprecationNoticeNotification", "type": "object" }, { "properties": { "method": { "enum": [ "configWarning" ], "title": "ConfigWarningNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ConfigWarningNotification" } }, "required": [ "method", "params" ], "title": "ConfigWarningNotification", "type": "object" }, { "properties": { "method": { "enum": [ "fuzzyFileSearch/sessionUpdated" ], "title": "FuzzyFileSearch/sessionUpdatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/FuzzyFileSearchSessionUpdatedNotification" } }, "required": [ "method", "params" ], "title": "FuzzyFileSearch/sessionUpdatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "fuzzyFileSearch/sessionCompleted" ], "title": "FuzzyFileSearch/sessionCompletedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/FuzzyFileSearchSessionCompletedNotification" } }, "required": [ "method", "params" ], "title": "FuzzyFileSearch/sessionCompletedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/realtime/started" ], "title": "Thread/realtime/startedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadRealtimeStartedNotification" } }, "required": [ "method", "params" ], "title": "Thread/realtime/startedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/realtime/itemAdded" ], "title": "Thread/realtime/itemAddedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadRealtimeItemAddedNotification" } }, "required": [ "method", "params" ], "title": "Thread/realtime/itemAddedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/realtime/transcriptUpdated" ], "title": "Thread/realtime/transcriptUpdatedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadRealtimeTranscriptUpdatedNotification" } }, "required": [ "method", "params" ], "title": "Thread/realtime/transcriptUpdatedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/realtime/outputAudio/delta" ], "title": "Thread/realtime/outputAudio/deltaNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadRealtimeOutputAudioDeltaNotification" } }, "required": [ "method", "params" ], "title": "Thread/realtime/outputAudio/deltaNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/realtime/error" ], "title": "Thread/realtime/errorNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadRealtimeErrorNotification" } }, "required": [ "method", "params" ], "title": "Thread/realtime/errorNotification", "type": "object" }, { "properties": { "method": { "enum": [ "thread/realtime/closed" ], "title": "Thread/realtime/closedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/ThreadRealtimeClosedNotification" } }, "required": [ "method", "params" ], "title": "Thread/realtime/closedNotification", "type": "object" }, { "description": "Notifies the user of world-writable directories on Windows, which cannot be protected by the sandbox.", "properties": { "method": { "enum": [ "windows/worldWritableWarning" ], "title": "Windows/worldWritableWarningNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/WindowsWorldWritableWarningNotification" } }, "required": [ "method", "params" ], "title": "Windows/worldWritableWarningNotification", "type": "object" }, { "properties": { "method": { "enum": [ "windowsSandbox/setupCompleted" ], "title": "WindowsSandbox/setupCompletedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/WindowsSandboxSetupCompletedNotification" } }, "required": [ "method", "params" ], "title": "WindowsSandbox/setupCompletedNotification", "type": "object" }, { "properties": { "method": { "enum": [ "account/login/completed" ], "title": "Account/login/completedNotificationMethod", "type": "string" }, "params": { "$ref": "#/definitions/AccountLoginCompletedNotification" } }, "required": [ "method", "params" ], "title": "Account/login/completedNotification", "type": "object" } ], "title": "ServerNotification" }