{ "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "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`. `guardian_subagent` uses a carefully prompted subagent to gather relevant context and apply a risk-based decision framework before approving or denying the request.", "enum": [ "user", "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" } ] }, "ContentItem": { "oneOf": [ { "properties": { "text": { "type": "string" }, "type": { "enum": [ "input_text" ], "title": "InputTextContentItemType", "type": "string" } }, "required": [ "text", "type" ], "title": "InputTextContentItem", "type": "object" }, { "properties": { "image_url": { "type": "string" }, "type": { "enum": [ "input_image" ], "title": "InputImageContentItemType", "type": "string" } }, "required": [ "image_url", "type" ], "title": "InputImageContentItem", "type": "object" }, { "properties": { "text": { "type": "string" }, "type": { "enum": [ "output_text" ], "title": "OutputTextContentItemType", "type": "string" } }, "required": [ "text", "type" ], "title": "OutputTextContentItem", "type": "object" } ] }, "FunctionCallOutputBody": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/definitions/FunctionCallOutputContentItem" }, "type": "array" } ] }, "FunctionCallOutputContentItem": { "description": "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.", "oneOf": [ { "properties": { "text": { "type": "string" }, "type": { "enum": [ "input_text" ], "title": "InputTextFunctionCallOutputContentItemType", "type": "string" } }, "required": [ "text", "type" ], "title": "InputTextFunctionCallOutputContentItem", "type": "object" }, { "properties": { "detail": { "anyOf": [ { "$ref": "#/definitions/ImageDetail" }, { "type": "null" } ] }, "image_url": { "type": "string" }, "type": { "enum": [ "input_image" ], "title": "InputImageFunctionCallOutputContentItemType", "type": "string" } }, "required": [ "image_url", "type" ], "title": "InputImageFunctionCallOutputContentItem", "type": "object" } ] }, "GhostCommit": { "description": "Details of a ghost commit created from a repository state.", "properties": { "id": { "type": "string" }, "parent": { "type": [ "string", "null" ] }, "preexisting_untracked_dirs": { "items": { "type": "string" }, "type": "array" }, "preexisting_untracked_files": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "preexisting_untracked_dirs", "preexisting_untracked_files" ], "type": "object" }, "ImageDetail": { "enum": [ "auto", "low", "high", "original" ], "type": "string" }, "LocalShellAction": { "oneOf": [ { "properties": { "command": { "items": { "type": "string" }, "type": "array" }, "env": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "timeout_ms": { "format": "uint64", "minimum": 0.0, "type": [ "integer", "null" ] }, "type": { "enum": [ "exec" ], "title": "ExecLocalShellActionType", "type": "string" }, "user": { "type": [ "string", "null" ] }, "working_directory": { "type": [ "string", "null" ] } }, "required": [ "command", "type" ], "title": "ExecLocalShellAction", "type": "object" } ] }, "LocalShellStatus": { "enum": [ "completed", "in_progress", "incomplete" ], "type": "string" }, "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" } ] }, "Personality": { "enum": [ "none", "friendly", "pragmatic" ], "type": "string" }, "ReasoningItemContent": { "oneOf": [ { "properties": { "text": { "type": "string" }, "type": { "enum": [ "reasoning_text" ], "title": "ReasoningTextReasoningItemContentType", "type": "string" } }, "required": [ "text", "type" ], "title": "ReasoningTextReasoningItemContent", "type": "object" }, { "properties": { "text": { "type": "string" }, "type": { "enum": [ "text" ], "title": "TextReasoningItemContentType", "type": "string" } }, "required": [ "text", "type" ], "title": "TextReasoningItemContent", "type": "object" } ] }, "ReasoningItemReasoningSummary": { "oneOf": [ { "properties": { "text": { "type": "string" }, "type": { "enum": [ "summary_text" ], "title": "SummaryTextReasoningItemReasoningSummaryType", "type": "string" } }, "required": [ "text", "type" ], "title": "SummaryTextReasoningItemReasoningSummary", "type": "object" } ] }, "ResponseItem": { "oneOf": [ { "properties": { "content": { "items": { "$ref": "#/definitions/ContentItem" }, "type": "array" }, "end_turn": { "type": [ "boolean", "null" ] }, "id": { "type": [ "string", "null" ], "writeOnly": true }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "phase": { "anyOf": [ { "$ref": "#/definitions/MessagePhase" }, { "type": "null" } ] }, "role": { "type": "string" }, "type": { "enum": [ "message" ], "title": "MessageResponseItemType", "type": "string" } }, "required": [ "content", "role", "type" ], "title": "MessageResponseItem", "type": "object" }, { "properties": { "content": { "default": null, "items": { "$ref": "#/definitions/ReasoningItemContent" }, "type": [ "array", "null" ] }, "encrypted_content": { "type": [ "string", "null" ] }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "summary": { "items": { "$ref": "#/definitions/ReasoningItemReasoningSummary" }, "type": "array" }, "type": { "enum": [ "reasoning" ], "title": "ReasoningResponseItemType", "type": "string" } }, "required": [ "summary", "type" ], "title": "ReasoningResponseItem", "type": "object" }, { "properties": { "action": { "$ref": "#/definitions/LocalShellAction" }, "call_id": { "description": "Set when using the Responses API.", "type": [ "string", "null" ] }, "id": { "description": "Legacy id field retained for compatibility with older payloads.", "type": [ "string", "null" ], "writeOnly": true }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "status": { "$ref": "#/definitions/LocalShellStatus" }, "type": { "enum": [ "local_shell_call" ], "title": "LocalShellCallResponseItemType", "type": "string" } }, "required": [ "action", "status", "type" ], "title": "LocalShellCallResponseItem", "type": "object" }, { "properties": { "arguments": { "type": "string" }, "call_id": { "type": "string" }, "id": { "type": [ "string", "null" ], "writeOnly": true }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "name": { "type": "string" }, "namespace": { "type": [ "string", "null" ] }, "type": { "enum": [ "function_call" ], "title": "FunctionCallResponseItemType", "type": "string" } }, "required": [ "arguments", "call_id", "name", "type" ], "title": "FunctionCallResponseItem", "type": "object" }, { "properties": { "arguments": true, "call_id": { "type": [ "string", "null" ] }, "execution": { "type": "string" }, "id": { "type": [ "string", "null" ], "writeOnly": true }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "status": { "type": [ "string", "null" ] }, "type": { "enum": [ "tool_search_call" ], "title": "ToolSearchCallResponseItemType", "type": "string" } }, "required": [ "arguments", "execution", "type" ], "title": "ToolSearchCallResponseItem", "type": "object" }, { "properties": { "call_id": { "type": "string" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "output": { "$ref": "#/definitions/FunctionCallOutputBody" }, "type": { "enum": [ "function_call_output" ], "title": "FunctionCallOutputResponseItemType", "type": "string" } }, "required": [ "call_id", "output", "type" ], "title": "FunctionCallOutputResponseItem", "type": "object" }, { "properties": { "call_id": { "type": "string" }, "id": { "type": [ "string", "null" ], "writeOnly": true }, "input": { "type": "string" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "name": { "type": "string" }, "status": { "type": [ "string", "null" ] }, "type": { "enum": [ "custom_tool_call" ], "title": "CustomToolCallResponseItemType", "type": "string" } }, "required": [ "call_id", "input", "name", "type" ], "title": "CustomToolCallResponseItem", "type": "object" }, { "properties": { "call_id": { "type": "string" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "name": { "type": [ "string", "null" ] }, "output": { "$ref": "#/definitions/FunctionCallOutputBody" }, "type": { "enum": [ "custom_tool_call_output" ], "title": "CustomToolCallOutputResponseItemType", "type": "string" } }, "required": [ "call_id", "output", "type" ], "title": "CustomToolCallOutputResponseItem", "type": "object" }, { "properties": { "call_id": { "type": [ "string", "null" ] }, "execution": { "type": "string" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "status": { "type": "string" }, "tools": { "items": true, "type": "array" }, "type": { "enum": [ "tool_search_output" ], "title": "ToolSearchOutputResponseItemType", "type": "string" } }, "required": [ "execution", "status", "tools", "type" ], "title": "ToolSearchOutputResponseItem", "type": "object" }, { "properties": { "action": { "anyOf": [ { "$ref": "#/definitions/ResponsesApiWebSearchAction" }, { "type": "null" } ] }, "id": { "type": [ "string", "null" ], "writeOnly": true }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "status": { "type": [ "string", "null" ] }, "type": { "enum": [ "web_search_call" ], "title": "WebSearchCallResponseItemType", "type": "string" } }, "required": [ "type" ], "title": "WebSearchCallResponseItem", "type": "object" }, { "properties": { "id": { "type": "string" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "result": { "type": "string" }, "revised_prompt": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "type": { "enum": [ "image_generation_call" ], "title": "ImageGenerationCallResponseItemType", "type": "string" } }, "required": [ "id", "result", "status", "type" ], "title": "ImageGenerationCallResponseItem", "type": "object" }, { "properties": { "ghost_commit": { "$ref": "#/definitions/GhostCommit" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "type": { "enum": [ "ghost_snapshot" ], "title": "GhostSnapshotResponseItemType", "type": "string" } }, "required": [ "ghost_commit", "type" ], "title": "GhostSnapshotResponseItem", "type": "object" }, { "properties": { "encrypted_content": { "type": "string" }, "metadata": { "anyOf": [ { "$ref": "#/definitions/ResponseItemMetadata" }, { "type": "null" } ] }, "type": { "enum": [ "compaction" ], "title": "CompactionResponseItemType", "type": "string" } }, "required": [ "encrypted_content", "type" ], "title": "CompactionResponseItem", "type": "object" }, { "properties": { "type": { "enum": [ "other" ], "title": "OtherResponseItemType", "type": "string" } }, "required": [ "type" ], "title": "OtherResponseItem", "type": "object" } ] }, "ResponseItemMetadata": { "properties": { "is_tool_call_escalated": { "type": [ "boolean", "null" ] }, "review_decision": { "anyOf": [ { "$ref": "#/definitions/ReviewDecisionMetadata" }, { "type": "null" } ] }, "sandbox_policy": { "anyOf": [ { "$ref": "#/definitions/SandboxPolicyMetadata" }, { "type": "null" } ] }, "session_source": { "anyOf": [ { "$ref": "#/definitions/SessionSourceMetadata" }, { "type": "null" } ] }, "user_message_type": { "anyOf": [ { "$ref": "#/definitions/UserMessageType" }, { "type": "null" } ] }, "uuid": { "description": "Client-visible UUID generated by Codex for this item.", "type": [ "string", "null" ] } }, "type": "object" }, "ResponsesApiWebSearchAction": { "oneOf": [ { "properties": { "queries": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "query": { "type": [ "string", "null" ] }, "type": { "enum": [ "search" ], "title": "SearchResponsesApiWebSearchActionType", "type": "string" } }, "required": [ "type" ], "title": "SearchResponsesApiWebSearchAction", "type": "object" }, { "properties": { "type": { "enum": [ "open_page" ], "title": "OpenPageResponsesApiWebSearchActionType", "type": "string" }, "url": { "type": [ "string", "null" ] } }, "required": [ "type" ], "title": "OpenPageResponsesApiWebSearchAction", "type": "object" }, { "properties": { "pattern": { "type": [ "string", "null" ] }, "type": { "enum": [ "find_in_page" ], "title": "FindInPageResponsesApiWebSearchActionType", "type": "string" }, "url": { "type": [ "string", "null" ] } }, "required": [ "type" ], "title": "FindInPageResponsesApiWebSearchAction", "type": "object" }, { "properties": { "type": { "enum": [ "other" ], "title": "OtherResponsesApiWebSearchActionType", "type": "string" } }, "required": [ "type" ], "title": "OtherResponsesApiWebSearchAction", "type": "object" } ] }, "ReviewDecisionMetadata": { "enum": [ "approved", "denied", "abort", "approved_for_session", "approved_with_amendment", "approved_with_network_policy_allow", "denied_with_network_policy_deny" ], "type": "string" }, "SandboxMode": { "enum": [ "read-only", "workspace-write", "danger-full-access" ], "type": "string" }, "SandboxPolicyMetadata": { "enum": [ "read_only", "sandbox", "full_access" ], "type": "string" }, "ServiceTier": { "enum": [ "fast", "flex" ], "type": "string" }, "SessionSourceMetadata": { "enum": [ "user", "agent_guardian", "agent_review", "agent_spawned", "agent_compaction", "agent_memory", "agent_other", "unknown" ], "type": "string" }, "UserMessageType": { "enum": [ "prompt", "prompt_steering", "prompt_queued" ], "type": "string" } }, "description": "There are three ways to resume a thread: 1. By thread_id: load the thread from disk by thread_id and resume it. 2. By history: instantiate the thread from memory and resume it. 3. By path: load the thread from disk by path and resume it.\n\nThe precedence is: history > path > thread_id. If using history or path, the thread_id param will be ignored.\n\nPrefer using thread_id whenever possible.", "properties": { "approvalPolicy": { "anyOf": [ { "$ref": "#/definitions/AskForApproval" }, { "type": "null" } ] }, "approvalsReviewer": { "anyOf": [ { "$ref": "#/definitions/ApprovalsReviewer" }, { "type": "null" } ], "description": "Override where approval requests are routed for review on this thread and subsequent turns." }, "baseInstructions": { "type": [ "string", "null" ] }, "config": { "additionalProperties": true, "type": [ "object", "null" ] }, "cwd": { "type": [ "string", "null" ] }, "developerInstructions": { "type": [ "string", "null" ] }, "model": { "description": "Configuration overrides for the resumed thread, if any.", "type": [ "string", "null" ] }, "modelProvider": { "type": [ "string", "null" ] }, "personality": { "anyOf": [ { "$ref": "#/definitions/Personality" }, { "type": "null" } ] }, "sandbox": { "anyOf": [ { "$ref": "#/definitions/SandboxMode" }, { "type": "null" } ] }, "serviceTier": { "anyOf": [ { "anyOf": [ { "$ref": "#/definitions/ServiceTier" }, { "type": "null" } ] }, { "type": "null" } ] }, "threadId": { "type": "string" } }, "required": [ "threadId" ], "title": "ThreadResumeParams", "type": "object" }