{ "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "AbsolutePathBuf": { "description": "A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).\n\nIMPORTANT: 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": "string" }, "ActivePermissionProfile": { "properties": { "extends": { "default": null, "description": "Parent profile identifier once permissions profiles support inheritance. This is currently always `null`.", "type": [ "string", "null" ] }, "id": { "description": "Identifier from `default_permissions` or the implicit built-in default, such as `:workspace` or a user-defined `[permissions.]` profile.", "type": "string" }, "modifications": { "default": [], "description": "Bounded user-requested modifications applied on top of the named profile, if any.", "items": { "$ref": "#/definitions/ActivePermissionProfileModification" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "ActivePermissionProfileModification": { "oneOf": [ { "description": "Additional concrete directory that should be writable.", "properties": { "path": { "$ref": "#/definitions/AbsolutePathBuf" }, "type": { "enum": [ "additionalWritableRoot" ], "title": "AdditionalWritableRootActivePermissionProfileModificationType", "type": "string" } }, "required": [ "path", "type" ], "title": "AdditionalWritableRootActivePermissionProfileModification", "type": "object" } ] }, "ApprovalsReviewer": { "description": "Configures who approval requests are routed to for review. Examples include sandbox escapes, blocked network access, MCP approval prompts, and ARC escalations. Defaults to `user`. `auto_review` uses a carefully prompted subagent to gather relevant context and apply a risk-based decision framework before approving or denying the request. The legacy value `guardian_subagent` is accepted for compatibility.", "enum": [ "user", "auto_review", "guardian_subagent" ], "type": "string" }, "AskForApproval": { "oneOf": [ { "enum": [ "untrusted", "on-failure", "on-request", "never" ], "type": "string" }, { "additionalProperties": false, "properties": { "granular": { "properties": { "mcp_elicitations": { "type": "boolean" }, "request_permissions": { "default": false, "type": "boolean" }, "rules": { "type": "boolean" }, "sandbox_approval": { "type": "boolean" }, "skill_approval": { "default": false, "type": "boolean" } }, "required": [ "mcp_elicitations", "rules", "sandbox_approval" ], "type": "object" } }, "required": [ "granular" ], "title": "GranularAskForApproval", "type": "object" } ] }, "CollaborationMode": { "description": "Collaboration mode for a Codex session.", "properties": { "mode": { "$ref": "#/definitions/ModeKind" }, "settings": { "$ref": "#/definitions/Settings" } }, "required": [ "mode", "settings" ], "type": "object" }, "FileSystemAccessMode": { "enum": [ "read", "write", "none" ], "type": "string" }, "FileSystemPath": { "oneOf": [ { "properties": { "path": { "$ref": "#/definitions/AbsolutePathBuf" }, "type": { "enum": [ "path" ], "title": "PathFileSystemPathType", "type": "string" } }, "required": [ "path", "type" ], "title": "PathFileSystemPath", "type": "object" }, { "properties": { "pattern": { "type": "string" }, "type": { "enum": [ "glob_pattern" ], "title": "GlobPatternFileSystemPathType", "type": "string" } }, "required": [ "pattern", "type" ], "title": "GlobPatternFileSystemPath", "type": "object" }, { "properties": { "type": { "enum": [ "special" ], "title": "SpecialFileSystemPathType", "type": "string" }, "value": { "$ref": "#/definitions/FileSystemSpecialPath" } }, "required": [ "type", "value" ], "title": "SpecialFileSystemPath", "type": "object" } ] }, "FileSystemSandboxEntry": { "properties": { "access": { "$ref": "#/definitions/FileSystemAccessMode" }, "path": { "$ref": "#/definitions/FileSystemPath" } }, "required": [ "access", "path" ], "type": "object" }, "FileSystemSpecialPath": { "oneOf": [ { "properties": { "kind": { "enum": [ "root" ], "type": "string" } }, "required": [ "kind" ], "title": "RootFileSystemSpecialPath", "type": "object" }, { "properties": { "kind": { "enum": [ "minimal" ], "type": "string" } }, "required": [ "kind" ], "title": "MinimalFileSystemSpecialPath", "type": "object" }, { "properties": { "kind": { "enum": [ "project_roots" ], "type": "string" }, "subpath": { "type": [ "string", "null" ] } }, "required": [ "kind" ], "title": "KindFileSystemSpecialPath", "type": "object" }, { "properties": { "kind": { "enum": [ "tmpdir" ], "type": "string" } }, "required": [ "kind" ], "title": "TmpdirFileSystemSpecialPath", "type": "object" }, { "properties": { "kind": { "enum": [ "slash_tmp" ], "type": "string" } }, "required": [ "kind" ], "title": "SlashTmpFileSystemSpecialPath", "type": "object" }, { "properties": { "kind": { "enum": [ "unknown" ], "type": "string" }, "path": { "type": "string" }, "subpath": { "type": [ "string", "null" ] } }, "required": [ "kind", "path" ], "type": "object" } ] }, "ModeKind": { "description": "Initial collaboration mode to use when the TUI starts.", "enum": [ "plan", "default" ], "type": "string" }, "NetworkAccess": { "enum": [ "restricted", "enabled" ], "type": "string" }, "PermissionProfile": { "oneOf": [ { "description": "Codex owns sandbox construction for this profile.", "properties": { "fileSystem": { "$ref": "#/definitions/PermissionProfileFileSystemPermissions" }, "network": { "$ref": "#/definitions/PermissionProfileNetworkPermissions" }, "type": { "enum": [ "managed" ], "title": "ManagedPermissionProfileType", "type": "string" } }, "required": [ "fileSystem", "network", "type" ], "title": "ManagedPermissionProfile", "type": "object" }, { "description": "Do not apply an outer sandbox.", "properties": { "type": { "enum": [ "disabled" ], "title": "DisabledPermissionProfileType", "type": "string" } }, "required": [ "type" ], "title": "DisabledPermissionProfile", "type": "object" }, { "description": "Filesystem isolation is enforced by an external caller.", "properties": { "network": { "$ref": "#/definitions/PermissionProfileNetworkPermissions" }, "type": { "enum": [ "external" ], "title": "ExternalPermissionProfileType", "type": "string" } }, "required": [ "network", "type" ], "title": "ExternalPermissionProfile", "type": "object" } ] }, "PermissionProfileFileSystemPermissions": { "oneOf": [ { "properties": { "entries": { "items": { "$ref": "#/definitions/FileSystemSandboxEntry" }, "type": "array" }, "globScanMaxDepth": { "format": "uint", "minimum": 1.0, "type": [ "integer", "null" ] }, "type": { "enum": [ "restricted" ], "title": "RestrictedPermissionProfileFileSystemPermissionsType", "type": "string" } }, "required": [ "entries", "type" ], "title": "RestrictedPermissionProfileFileSystemPermissions", "type": "object" }, { "properties": { "type": { "enum": [ "unrestricted" ], "title": "UnrestrictedPermissionProfileFileSystemPermissionsType", "type": "string" } }, "required": [ "type" ], "title": "UnrestrictedPermissionProfileFileSystemPermissions", "type": "object" } ] }, "PermissionProfileNetworkPermissions": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "Personality": { "enum": [ "none", "friendly", "pragmatic" ], "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" }, "ReasoningSummary": { "description": "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", "oneOf": [ { "enum": [ "auto", "concise", "detailed" ], "type": "string" }, { "description": "Option to disable reasoning summaries.", "enum": [ "none" ], "type": "string" } ] }, "SandboxPolicy": { "oneOf": [ { "properties": { "type": { "enum": [ "dangerFullAccess" ], "title": "DangerFullAccessSandboxPolicyType", "type": "string" } }, "required": [ "type" ], "title": "DangerFullAccessSandboxPolicy", "type": "object" }, { "properties": { "networkAccess": { "default": false, "type": "boolean" }, "type": { "enum": [ "readOnly" ], "title": "ReadOnlySandboxPolicyType", "type": "string" } }, "required": [ "type" ], "title": "ReadOnlySandboxPolicy", "type": "object" }, { "properties": { "networkAccess": { "allOf": [ { "$ref": "#/definitions/NetworkAccess" } ], "default": "restricted" }, "type": { "enum": [ "externalSandbox" ], "title": "ExternalSandboxSandboxPolicyType", "type": "string" } }, "required": [ "type" ], "title": "ExternalSandboxSandboxPolicy", "type": "object" }, { "properties": { "excludeSlashTmp": { "default": false, "type": "boolean" }, "excludeTmpdirEnvVar": { "default": false, "type": "boolean" }, "networkAccess": { "default": false, "type": "boolean" }, "type": { "enum": [ "workspaceWrite" ], "title": "WorkspaceWriteSandboxPolicyType", "type": "string" }, "writableRoots": { "default": [], "items": { "$ref": "#/definitions/AbsolutePathBuf" }, "type": "array" } }, "required": [ "type" ], "title": "WorkspaceWriteSandboxPolicy", "type": "object" } ] }, "Settings": { "description": "Settings for a collaboration mode.", "properties": { "developer_instructions": { "type": [ "string", "null" ] }, "model": { "type": "string" }, "reasoning_effort": { "anyOf": [ { "$ref": "#/definitions/ReasoningEffort" }, { "type": "null" } ] } }, "required": [ "model" ], "type": "object" }, "ThreadTurnContext": { "properties": { "activePermissionProfile": { "anyOf": [ { "$ref": "#/definitions/ActivePermissionProfile" }, { "type": "null" } ] }, "approvalPolicy": { "$ref": "#/definitions/AskForApproval" }, "approvalsReviewer": { "$ref": "#/definitions/ApprovalsReviewer" }, "collaborationMode": { "$ref": "#/definitions/CollaborationMode" }, "cwd": { "$ref": "#/definitions/AbsolutePathBuf" }, "effort": { "anyOf": [ { "$ref": "#/definitions/ReasoningEffort" }, { "type": "null" } ] }, "model": { "type": "string" }, "modelProvider": { "type": "string" }, "permissionProfile": { "$ref": "#/definitions/PermissionProfile" }, "personality": { "anyOf": [ { "$ref": "#/definitions/Personality" }, { "type": "null" } ] }, "sandboxPolicy": { "$ref": "#/definitions/SandboxPolicy" }, "serviceTier": { "type": [ "string", "null" ] }, "summary": { "anyOf": [ { "$ref": "#/definitions/ReasoningSummary" }, { "type": "null" } ] } }, "required": [ "approvalPolicy", "approvalsReviewer", "collaborationMode", "cwd", "model", "modelProvider", "permissionProfile", "sandboxPolicy" ], "type": "object" } }, "properties": { "turnContext": { "$ref": "#/definitions/ThreadTurnContext" } }, "required": [ "turnContext" ], "title": "ThreadTurnContextUpdateResponse", "type": "object" }