cabbage/codex-telegram-bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Support Codex app-server 0.133

Browse Source
This commit is contained in:
Codex
2026-05-25 05:38:32 +00:00
parent c282674057
commit 9dbf7727c5
49 changed files with 4707 additions and 2203 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
internal/telegram/bot.go
View File

@@ -1657,6 +1657,19 @@ func (b *Bot) handleCodexNotification(ctx context.Context, event codexapp.Event)
}
return b.store.SyncThreadTitleByCodexID(ctx, params.ThreadID, title)
}
case "thread/settings/updated":
var params struct {
ThreadID string `json:"threadId"`
ThreadSettings struct {
CWD string `json:"cwd"`
} `json:"threadSettings"`
}
if err := json.Unmarshal(event.Params, &params); err != nil {
return err
}
if params.ThreadID != "" {
return b.syncThreadWorkspaceFromCWD(ctx, params.ThreadID, params.ThreadSettings.CWD)
}
case "serverRequest/resolved":
var params struct {
ThreadID string `json:"threadId"`
@@ -1667,6 +1680,34 @@ func (b *Bot) handleCodexNotification(ctx context.Context, event codexapp.Event)
return nil
}
func (b *Bot) syncThreadWorkspaceFromCWD(ctx context.Context, codexThreadID, cwd string) error {
thread, err := b.store.GetThreadByCodexID(ctx, codexThreadID)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil
}
return err
}
workspace, ok, err := b.workspaceForCodexCWD(ctx, cwd)
if err != nil || !ok {
return err
}
if workspace.ID == thread.WorkspaceID {
return nil
}
if err := b.store.SyncThreadWorkspace(ctx, thread.TelegramUserID, thread.ID, workspace.ID); err != nil {
return err
}
session, err := b.store.GetSession(ctx, thread.TelegramUserID)
if err != nil {
return err
}
if session.ActiveThreadID == thread.ID {
return b.store.SetSessionWorkspace(ctx, thread.TelegramUserID, workspace.ID)
}
return nil
}
func (b *Bot) handleCodexServerRequest(ctx context.Context, event codexapp.Event) error {
if event.ID == nil {
return nil

737
schemas/ClientRequest.json
View File

@@ -172,6 +172,78 @@
},
"title": "Thread/name/setRequest"
},
{
"type": "object",
"required": [
"id",
"method",
"params"
],
"properties": {
"id": {
"$ref": "#/definitions/RequestId"
},
"method": {
"type": "string",
"enum": [
"thread/goal/set"
],
"title": "Thread/goal/setRequestMethod"
},
"params": {
"$ref": "#/definitions/ThreadGoalSetParams"
}
},
"title": "Thread/goal/setRequest"
},
{
"type": "object",
"required": [
"id",
"method",
"params"
],
"properties": {
"id": {
"$ref": "#/definitions/RequestId"
},
"method": {
"type": "string",
"enum": [
"thread/goal/get"
],
"title": "Thread/goal/getRequestMethod"
},
"params": {
"$ref": "#/definitions/ThreadGoalGetParams"
}
},
"title": "Thread/goal/getRequest"
},
{
"type": "object",
"required": [
"id",
"method",
"params"
],
"properties": {
"id": {
"$ref": "#/definitions/RequestId"
},
"method": {
"type": "string",
"enum": [
"thread/goal/clear"
],
"title": "Thread/goal/clearRequestMethod"
},
"params": {
"$ref": "#/definitions/ThreadGoalClearParams"
}
},
"title": "Thread/goal/clearRequest"
},
{
"type": "object",
"required": [
@@ -1229,6 +1301,30 @@
},
"title": "ExperimentalFeature/listRequest"
},
{
"type": "object",
"required": [
"id",
"method",
"params"
],
"properties": {
"id": {
"$ref": "#/definitions/RequestId"
},
"method": {
"type": "string",
"enum": [
"permissionProfile/list"
],
"title": "PermissionProfile/listRequestMethod"
},
"params": {
"$ref": "#/definitions/PermissionProfileListParams"
}
},
"title": "PermissionProfile/listRequest"
},
{
"type": "object",
"required": [
@@ -1858,26 +1954,6 @@
"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": {
"type": "object",
"required": [
"id"
],
"properties": {
"extends": {
"description": "Parent profile identifier once permissions profiles support inheritance. This is currently always `null`.",
"default": null,
"type": [
"string",
"null"
]
},
"id": {
"description": "Identifier from `default_permissions` or the implicit built-in default, such as `:workspace` or a user-defined `[permissions.<id>]` profile.",
"type": "string"
}
}
},
"AddCreditsNudgeCreditType": {
"type": "string",
"enum": [
@@ -2885,6 +2961,26 @@
}
},
"title": "InputImageFunctionCallOutputContentItem"
},
{
"type": "object",
"required": [
"encrypted_content",
"type"
],
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"encrypted_content"
],
"title": "EncryptedContentFunctionCallOutputContentItemType"
}
},
"title": "EncryptedContentFunctionCallOutputContentItem"
}
]
},
@@ -3150,11 +3246,11 @@
"outputSchema": {
"description": "Optional JSON Schema used to constrain the final assistant message for this turn."
},
"summary": {
"description": "Override the reasoning summary for this turn and subsequent turns.",
"sandboxPolicy": {
"description": "Override the sandbox policy for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
"$ref": "#/definitions/SandboxPolicy"
},
{
"type": "null"
@@ -3172,11 +3268,11 @@
}
]
},
"sandboxPolicy": {
"description": "Override the sandbox policy for this turn and subsequent turns.",
"summary": {
"description": "Override the reasoning summary for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/SandboxPolicy"
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
@@ -3740,6 +3836,34 @@
"enabled"
]
},
"PermissionProfileListParams": {
"type": "object",
"properties": {
"cursor": {
"description": "Opaque pagination cursor returned by a previous call.",
"type": [
"string",
"null"
]
},
"cwd": {
"description": "Optional working directory to resolve project config layers.",
"type": [
"string",
"null"
]
},
"limit": {
"description": "Optional page size; defaults to the full result set.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0.0
}
}
},
"Personality": {
"type": "string",
"enum": [
@@ -3804,6 +3928,7 @@
"type": "string",
"enum": [
"local",
"vertical",
"workspace-directory",
"shared-with-me"
]
@@ -5247,7 +5372,7 @@
}
},
"ThreadResumeParams": {
"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.",
"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\nFor non-running threads, the precedence is: history > non-empty path > thread_id. If using history or a non-empty path for a non-running thread, the thread_id param will be ignored.\n\nIf thread_id identifies a running thread, app-server rejoins that thread and treats a non-empty path as a consistency check against the active rollout path. Empty string path values are treated as absent.\n\nPrefer using thread_id whenever possible.",
"type": "object",
"required": [
"threadId"
@@ -5299,6 +5424,16 @@
"null"
]
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"sandbox": {
"anyOf": [
{
@@ -5309,12 +5444,6 @@
}
]
},
"serviceTier": {
"type": [
"string",
"null"
]
},
"model": {
"description": "Configuration overrides for the resumed thread, if any.",
"type": [
@@ -5328,14 +5457,10 @@
"null"
]
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
"serviceTier": {
"type": [
"string",
"null"
]
},
"threadId": {
@@ -5354,50 +5479,26 @@
}
}
},
"ThreadRealtimeStartTransport": {
"description": "EXPERIMENTAL - transport used by thread realtime.",
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"websocket"
],
"title": "WebsocketThreadRealtimeStartTransportType"
}
},
"title": "WebsocketThreadRealtimeStartTransport"
"ThreadRollbackParams": {
"type": "object",
"required": [
"numTurns",
"threadId"
],
"properties": {
"numTurns": {
"description": "The number of turns to drop from the end of the thread. Must be >= 1.\n\nThis only modifies the thread's history and does not revert local file changes that have been made by the agent. Clients are responsible for reverting these changes.",
"type": "integer",
"format": "uint32",
"minimum": 0.0
},
{
"type": "object",
"required": [
"sdp",
"type"
],
"properties": {
"sdp": {
"description": "SDP offer generated by a WebRTC RTCPeerConnection after configuring audio and the realtime events data channel.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"webrtc"
],
"title": "WebrtcThreadRealtimeStartTransportType"
}
},
"title": "WebrtcThreadRealtimeStartTransport"
"threadId": {
"type": "string"
}
]
}
},
"ThreadForkParams": {
"description": "There are two ways to fork a thread: 1. By thread_id: load the thread from disk by thread_id and fork it into a new thread. 2. By path: load the thread from disk by path and fork it into a new thread.\n\nIf using path, the thread_id param will be ignored.\n\nPrefer using thread_id whenever possible.",
"description": "There are two ways to fork a thread: 1. By thread_id: load the thread from disk by thread_id and fork it into a new thread. 2. By path: load the thread from disk by path and fork it into a new thread.\n\nIf using a non-empty path, the thread_id param will be ignored. Empty string path values are treated as absent.\n\nPrefer using thread_id whenever possible.",
"type": "object",
"required": [
"threadId"
@@ -5452,11 +5553,10 @@
"ephemeral": {
"type": "boolean"
},
"threadSource": {
"description": "Optional client-supplied analytics source classification for this forked thread.",
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
@@ -5476,10 +5576,66 @@
"null"
]
},
"sandbox": {
"serviceTier": {
"type": [
"string",
"null"
]
},
"threadId": {
"type": "string"
},
"threadSource": {
"description": "Optional client-supplied analytics source classification for this forked thread.",
"anyOf": [
{
"$ref": "#/definitions/SandboxMode"
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
]
}
}
},
"ThreadGoalClearParams": {
"type": "object",
"required": [
"threadId"
],
"properties": {
"threadId": {
"type": "string"
}
}
},
"ThreadGoalGetParams": {
"type": "object",
"required": [
"threadId"
],
"properties": {
"threadId": {
"type": "string"
}
}
},
"ThreadGoalSetParams": {
"type": "object",
"required": [
"threadId"
],
"properties": {
"objective": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/definitions/ThreadGoalStatus"
},
{
"type": "null"
@@ -5489,158 +5645,15 @@
"threadId": {
"type": "string"
},
"serviceTier": {
"tokenBudget": {
"type": [
"string",
"null"
]
}
}
},
"ThreadStartSource": {
"type": "string",
"enum": [
"startup",
"clear"
]
},
"ThreadStartParams": {
"type": "object",
"properties": {
"approvalPolicy": {
"anyOf": [
{
"$ref": "#/definitions/AskForApproval"
},
{
"type": "null"
}
]
},
"approvalsReviewer": {
"description": "Override where approval requests are routed for review on this thread and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/ApprovalsReviewer"
},
{
"type": "null"
}
]
},
"baseInstructions": {
"type": [
"string",
"null"
]
},
"config": {
"type": [
"object",
"integer",
"null"
],
"additionalProperties": true
},
"cwd": {
"type": [
"string",
"null"
]
},
"developerInstructions": {
"type": [
"string",
"null"
]
},
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
}
]
},
"sessionStartSource": {
"anyOf": [
{
"$ref": "#/definitions/ThreadStartSource"
},
{
"type": "null"
}
]
},
"ephemeral": {
"type": [
"boolean",
"null"
]
},
"threadSource": {
"description": "Optional client-supplied analytics source classification for this thread.",
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
]
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"modelProvider": {
"type": [
"string",
"null"
]
},
"serviceName": {
"type": [
"string",
"null"
]
},
"serviceTier": {
"type": [
"string",
"null"
]
"format": "int64"
}
}
},
"ThreadSourceKind": {
"type": "string",
"enum": [
"cli",
"vscode",
"exec",
"appServer",
"subAgent",
"subAgentReview",
"subAgentCompact",
"subAgentThreadSpawn",
"subAgentOther",
"unknown"
]
},
"ThreadGoalStatus": {
"type": "string",
"enum": [
@@ -5652,12 +5665,11 @@
"complete"
]
},
"ThreadSource": {
"ThreadStartSource": {
"type": "string",
"enum": [
"user",
"subagent",
"memory_consolidation"
"startup",
"clear"
]
},
"ThreadInjectItemsParams": {
@@ -5810,12 +5822,127 @@
"disabled"
]
},
"ThreadSortKey": {
"type": "string",
"enum": [
"created_at",
"updated_at"
]
"ThreadStartParams": {
"type": "object",
"properties": {
"approvalPolicy": {
"anyOf": [
{
"$ref": "#/definitions/AskForApproval"
},
{
"type": "null"
}
]
},
"approvalsReviewer": {
"description": "Override where approval requests are routed for review on this thread and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/ApprovalsReviewer"
},
{
"type": "null"
}
]
},
"baseInstructions": {
"type": [
"string",
"null"
]
},
"config": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"cwd": {
"type": [
"string",
"null"
]
},
"developerInstructions": {
"type": [
"string",
"null"
]
},
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
}
]
},
"threadSource": {
"description": "Optional client-supplied analytics source classification for this thread.",
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
]
},
"ephemeral": {
"type": [
"boolean",
"null"
]
},
"serviceTier": {
"type": [
"string",
"null"
]
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"modelProvider": {
"type": [
"string",
"null"
]
},
"sessionStartSource": {
"anyOf": [
{
"$ref": "#/definitions/ThreadStartSource"
},
{
"type": "null"
}
]
},
"serviceName": {
"type": [
"string",
"null"
]
}
}
},
"ThreadMetadataGitInfoUpdateParams": {
"type": "object",
@@ -5881,36 +6008,28 @@
}
}
},
"ThreadShellCommandParams": {
"type": "object",
"required": [
"command",
"threadId"
],
"properties": {
"command": {
"description": "Shell command string evaluated by the thread's configured shell. Unlike `command/exec`, this intentionally preserves shell syntax such as pipes, redirects, and quoting. This runs unsandboxed with full access rather than inheriting the thread sandbox policy.",
"type": "string"
},
"threadId": {
"type": "string"
}
}
"ThreadSourceKind": {
"type": "string",
"enum": [
"cli",
"vscode",
"exec",
"appServer",
"subAgent",
"subAgentReview",
"subAgentCompact",
"subAgentThreadSpawn",
"subAgentOther",
"unknown"
]
},
"ThreadSetNameParams": {
"type": "object",
"required": [
"name",
"threadId"
],
"properties": {
"name": {
"type": "string"
},
"threadId": {
"type": "string"
}
}
"ThreadSource": {
"type": "string",
"enum": [
"user",
"subagent",
"memory_consolidation"
]
},
"ThreadRealtimeAudioChunk": {
"description": "EXPERIMENTAL - thread realtime audio chunk.",
@@ -5950,18 +6069,80 @@
}
}
},
"ThreadRollbackParams": {
"ThreadSortKey": {
"type": "string",
"enum": [
"created_at",
"updated_at"
]
},
"ThreadShellCommandParams": {
"type": "object",
"required": [
"numTurns",
"command",
"threadId"
],
"properties": {
"numTurns": {
"description": "The number of turns to drop from the end of the thread. Must be >= 1.\n\nThis only modifies the thread's history and does not revert local file changes that have been made by the agent. Clients are responsible for reverting these changes.",
"type": "integer",
"format": "uint32",
"minimum": 0.0
"command": {
"description": "Shell command string evaluated by the thread's configured shell. Unlike `command/exec`, this intentionally preserves shell syntax such as pipes, redirects, and quoting. This runs unsandboxed with full access rather than inheriting the thread sandbox policy.",
"type": "string"
},
"threadId": {
"type": "string"
}
}
},
"ThreadRealtimeStartTransport": {
"description": "EXPERIMENTAL - transport used by thread realtime.",
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"websocket"
],
"title": "WebsocketThreadRealtimeStartTransportType"
}
},
"title": "WebsocketThreadRealtimeStartTransport"
},
{
"type": "object",
"required": [
"sdp",
"type"
],
"properties": {
"sdp": {
"description": "SDP offer generated by a WebRTC RTCPeerConnection after configuring audio and the realtime events data channel.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"webrtc"
],
"title": "WebrtcThreadRealtimeStartTransportType"
}
},
"title": "WebrtcThreadRealtimeStartTransport"
}
]
},
"ThreadSetNameParams": {
"type": "object",
"required": [
"name",
"threadId"
],
"properties": {
"name": {
"type": "string"
},
"threadId": {
"type": "string"

2
schemas/CommandExecutionRequestApprovalParams.json
View File

@@ -375,7 +375,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {

2
schemas/PermissionsRequestApprovalParams.json
View File

@@ -101,7 +101,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {

2
schemas/PermissionsRequestApprovalResponse.json
View File

@@ -88,7 +88,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {

391
schemas/ServerNotification.json
View File

@@ -204,6 +204,26 @@
},
"title": "Thread/goal/clearedNotification"
},
{
"type": "object",
"required": [
"method",
"params"
],
"properties": {
"method": {
"type": "string",
"enum": [
"thread/settings/updated"
],
"title": "Thread/settings/updatedNotificationMethod"
},
"params": {
"$ref": "#/definitions/ThreadSettingsUpdatedNotification"
}
},
"title": "Thread/settings/updatedNotification"
},
{
"type": "object",
"required": [
@@ -1336,6 +1356,26 @@
}
}
},
"ActivePermissionProfile": {
"type": "object",
"required": [
"id"
],
"properties": {
"extends": {
"description": "Parent profile identifier from the selected permissions profile's `extends` setting, when present.",
"default": null,
"type": [
"string",
"null"
]
},
"id": {
"description": "Identifier from `default_permissions` or the implicit built-in default, such as `:workspace` or a user-defined `[permissions.<id>]` profile.",
"type": "string"
}
}
},
"AdditionalFileSystemPermissions": {
"type": "object",
"properties": {
@@ -1687,6 +1727,65 @@
}
}
},
"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.",
"type": "string",
"enum": [
"user",
"auto_review",
"guardian_subagent"
]
},
"AskForApproval": {
"oneOf": [
{
"type": "string",
"enum": [
"untrusted",
"on-failure",
"on-request",
"never"
]
},
{
"type": "object",
"required": [
"granular"
],
"properties": {
"granular": {
"type": "object",
"required": [
"mcp_elicitations",
"rules",
"sandbox_approval"
],
"properties": {
"mcp_elicitations": {
"type": "boolean"
},
"request_permissions": {
"default": false,
"type": "boolean"
},
"rules": {
"type": "boolean"
},
"sandbox_approval": {
"type": "boolean"
},
"skill_approval": {
"default": false,
"type": "boolean"
}
}
}
},
"additionalProperties": false,
"title": "GranularAskForApproval"
}
]
},
"AuthMode": {
"description": "Authentication mode for OpenAI-backed providers.",
"oneOf": [
@@ -1930,6 +2029,22 @@
"failed"
]
},
"CollaborationMode": {
"description": "Collaboration mode for a Codex session.",
"type": "object",
"required": [
"mode",
"settings"
],
"properties": {
"mode": {
"$ref": "#/definitions/ModeKind"
},
"settings": {
"$ref": "#/definitions/Settings"
}
}
},
"CommandAction": {
"oneOf": [
{
@@ -2358,7 +2473,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {
@@ -3013,6 +3128,8 @@
"postCompact",
"sessionStart",
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
]
},
@@ -3529,6 +3646,14 @@
}
]
},
"ModeKind": {
"description": "Initial collaboration mode to use when the TUI starts.",
"type": "string",
"enum": [
"plan",
"default"
]
},
"ModelRerouteReason": {
"type": "string",
"enum": [
@@ -3590,6 +3715,13 @@
}
}
},
"NetworkAccess": {
"type": "string",
"enum": [
"restricted",
"enabled"
]
},
"NetworkApprovalProtocol": {
"type": "string",
"enum": [
@@ -3673,6 +3805,14 @@
}
]
},
"Personality": {
"type": "string",
"enum": [
"none",
"friendly",
"pragmatic"
]
},
"PlanDeltaNotification": {
"description": "EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content.",
"type": "object",
@@ -3926,6 +4066,26 @@
"xhigh"
]
},
"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": [
{
"type": "string",
"enum": [
"auto",
"concise",
"detailed"
]
},
{
"description": "Option to disable reasoning summaries.",
"type": "string",
"enum": [
"none"
]
}
]
},
"ReasoningSummaryPartAddedNotification": {
"type": "object",
"required": [
@@ -4078,6 +4238,105 @@
},
"additionalProperties": false
},
"SandboxPolicy": {
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"dangerFullAccess"
],
"title": "DangerFullAccessSandboxPolicyType"
}
},
"title": "DangerFullAccessSandboxPolicy"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"networkAccess": {
"default": false,
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"readOnly"
],
"title": "ReadOnlySandboxPolicyType"
}
},
"title": "ReadOnlySandboxPolicy"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"networkAccess": {
"default": "restricted",
"allOf": [
{
"$ref": "#/definitions/NetworkAccess"
}
]
},
"type": {
"type": "string",
"enum": [
"externalSandbox"
],
"title": "ExternalSandboxSandboxPolicyType"
}
},
"title": "ExternalSandboxSandboxPolicy"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"excludeSlashTmp": {
"default": false,
"type": "boolean"
},
"excludeTmpdirEnvVar": {
"default": false,
"type": "boolean"
},
"networkAccess": {
"default": false,
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"workspaceWrite"
],
"title": "WorkspaceWriteSandboxPolicyType"
},
"writableRoots": {
"default": [],
"type": "array",
"items": {
"$ref": "#/definitions/AbsolutePathBuf"
}
}
},
"title": "WorkspaceWriteSandboxPolicy"
}
]
},
"ServerRequestResolvedNotification": {
"type": "object",
"required": [
@@ -4133,6 +4392,34 @@
}
]
},
"Settings": {
"description": "Settings for a collaboration mode.",
"type": "object",
"required": [
"model"
],
"properties": {
"developer_instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningEffort"
},
{
"type": "null"
}
]
}
}
},
"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"
@@ -4875,6 +5162,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{
@@ -5419,6 +5712,102 @@
}
}
},
"ThreadSettings": {
"type": "object",
"required": [
"approvalPolicy",
"approvalsReviewer",
"collaborationMode",
"cwd",
"model",
"modelProvider",
"sandboxPolicy"
],
"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"
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"sandboxPolicy": {
"$ref": "#/definitions/SandboxPolicy"
},
"serviceTier": {
"type": [
"string",
"null"
]
},
"summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
}
}
},
"ThreadSettingsUpdatedNotification": {
"type": "object",
"required": [
"threadId",
"threadSettings"
],
"properties": {
"threadId": {
"type": "string"
},
"threadSettings": {
"$ref": "#/definitions/ThreadSettings"
}
}
},
"ThreadSource": {
"type": "string",
"enum": [

2
schemas/ServerRequest.json
View File

@@ -885,7 +885,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {

2269
schemas/codex_app_server_protocol.schemas.json
View File

File diff suppressed because it is too large Load Diff

2375
schemas/codex_app_server_protocol.v2.schemas.json
View File

File diff suppressed because it is too large Load Diff

20
schemas/v2/CommandExecParams.json
View File

@@ -106,26 +106,6 @@
"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": {
"type": "object",
"required": [
"id"
],
"properties": {
"extends": {
"description": "Parent profile identifier once permissions profiles support inheritance. This is currently always `null`.",
"default": null,
"type": [
"string",
"null"
]
},
"id": {
"description": "Identifier from `default_permissions` or the implicit built-in default, such as `:workspace` or a user-defined `[permissions.<id>]` profile.",
"type": "string"
}
}
},
"CommandExecTerminalSize": {
"description": "PTY size in character cells for `command/exec` PTY sessions.",
"type": "object",

29
schemas/v2/ConfigReadResponse.json
View File

@@ -214,6 +214,25 @@
}
]
},
"AutoCompactTokenLimitScope": {
"description": "Selects which part of the active context is charged against `model_auto_compact_token_limit`.",
"oneOf": [
{
"description": "Count the full active context against the limit.",
"type": "string",
"enum": [
"total"
]
},
{
"description": "Count sampled output and later growth after the carried window prefix.",
"type": "string",
"enum": [
"body_after_prefix"
]
}
]
},
"Config": {
"type": "object",
"properties": {
@@ -316,6 +335,16 @@
],
"format": "int64"
},
"model_auto_compact_token_limit_scope": {
"anyOf": [
{
"$ref": "#/definitions/AutoCompactTokenLimitScope"
},
{
"type": "null"
}
]
},
"model_context_window": {
"type": [
"integer",

44
schemas/v2/ConfigRequirementsReadResponse.json
View File

@@ -75,6 +75,17 @@
}
]
},
"ComputerUseRequirements": {
"type": "object",
"properties": {
"allowLockedComputerUse": {
"type": [
"boolean",
"null"
]
}
}
},
"ConfigRequirements": {
"type": "object",
"properties": {
@@ -102,6 +113,15 @@
"type": "boolean"
}
},
"allowedPermissions": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"allowedSandboxModes": {
"type": [
"array",
@@ -120,6 +140,16 @@
"$ref": "#/definitions/WebSearchMode"
}
},
"computerUse": {
"anyOf": [
{
"$ref": "#/definitions/ComputerUseRequirements"
},
{
"type": "null"
}
]
},
"enforceResidency": {
"anyOf": [
{
@@ -242,6 +272,8 @@
"PreToolUse",
"SessionStart",
"Stop",
"SubagentStart",
"SubagentStop",
"UserPromptSubmit"
],
"properties": {
@@ -287,6 +319,18 @@
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
}
},
"SubagentStart": {
"type": "array",
"items": {
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
}
},
"SubagentStop": {
"type": "array",
"items": {
"$ref": "#/definitions/ConfiguredHookMatcherGroup"
}
},
"UserPromptSubmit": {
"type": "array",
"items": {

2
schemas/v2/HookCompletedNotification.json
View File

@@ -35,6 +35,8 @@
"postCompact",
"sessionStart",
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
]
},

2
schemas/v2/HookStartedNotification.json
View File

@@ -35,6 +35,8 @@
"postCompact",
"sessionStart",
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
]
},

2
schemas/v2/HooksListResponse.json
View File

@@ -43,6 +43,8 @@
"postCompact",
"sessionStart",
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
]
},

6
schemas/v2/ItemCompletedNotification.json
View File

@@ -833,6 +833,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

2
schemas/v2/ItemGuardianApprovalReviewCompletedNotification.json
View File

@@ -121,7 +121,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {

2
schemas/v2/ItemGuardianApprovalReviewStartedNotification.json
View File

@@ -104,7 +104,7 @@
"enum": [
"read",
"write",
"none"
"deny"
]
},
"FileSystemPath": {

6
schemas/v2/ItemStartedNotification.json
View File

@@ -833,6 +833,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

8
schemas/v2/ModelListResponse.json
View File

@@ -74,6 +74,14 @@
"defaultReasoningEffort": {
"$ref": "#/definitions/ReasoningEffort"
},
"defaultServiceTier": {
"description": "Catalog default service tier id for this model, when one is configured.",
"default": null,
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},

30
schemas/v2/PermissionProfileListParams.json Normal file
View File

@@ -0,0 +1,30 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "PermissionProfileListParams",
"type": "object",
"properties": {
"cursor": {
"description": "Opaque pagination cursor returned by a previous call.",
"type": [
"string",
"null"
]
},
"cwd": {
"description": "Optional working directory to resolve project config layers.",
"type": [
"string",
"null"
]
},
"limit": {
"description": "Optional page size; defaults to the full result set.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0.0
}
}
}

44
schemas/v2/PermissionProfileListResponse.json Normal file
View File

@@ -0,0 +1,44 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "PermissionProfileListResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/PermissionProfileSummary"
}
},
"nextCursor": {
"description": "Opaque cursor to pass to the next call to continue after the last item. If None, there are no more items to return.",
"type": [
"string",
"null"
]
}
},
"definitions": {
"PermissionProfileSummary": {
"type": "object",
"required": [
"id"
],
"properties": {
"description": {
"description": "Optional user-facing description for display in clients.",
"type": [
"string",
"null"
]
},
"id": {
"description": "Available permission profile identifier.",
"type": "string"
}
}
}
}
}

1
schemas/v2/PluginListParams.json
View File

@@ -33,6 +33,7 @@
"type": "string",
"enum": [
"local",
"vertical",
"workspace-directory",
"shared-with-me"
]

2
schemas/v2/PluginReadResponse.json
View File

@@ -57,6 +57,8 @@
"postCompact",
"sessionStart",
"userPromptSubmit",
"subagentStart",
"subagentStop",
"stop"
]
},

20
schemas/v2/RawResponseItemCompletedNotification.json
View File

@@ -158,6 +158,26 @@
}
},
"title": "InputImageFunctionCallOutputContentItem"
},
{
"type": "object",
"required": [
"encrypted_content",
"type"
],
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"encrypted_content"
],
"title": "EncryptedContentFunctionCallOutputContentItemType"
}
},
"title": "EncryptedContentFunctionCallOutputContentItem"
}
]
},

6
schemas/v2/ReviewStartResponse.json
View File

@@ -968,6 +968,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

32
schemas/v2/ThreadForkParams.json
View File

@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadForkParams",
"description": "There are two ways to fork a thread: 1. By thread_id: load the thread from disk by thread_id and fork it into a new thread. 2. By path: load the thread from disk by path and fork it into a new thread.\n\nIf using path, the thread_id param will be ignored.\n\nPrefer using thread_id whenever possible.",
"description": "There are two ways to fork a thread: 1. By thread_id: load the thread from disk by thread_id and fork it into a new thread. 2. By path: load the thread from disk by path and fork it into a new thread.\n\nIf using a non-empty path, the thread_id param will be ignored. Empty string path values are treated as absent.\n\nPrefer using thread_id whenever possible.",
"type": "object",
"required": [
"threadId"
@@ -56,11 +56,10 @@
"ephemeral": {
"type": "boolean"
},
"threadSource": {
"description": "Optional client-supplied analytics source classification for this forked thread.",
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
@@ -80,23 +79,24 @@
"null"
]
},
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
}
"serviceTier": {
"type": [
"string",
"null"
]
},
"threadId": {
"type": "string"
},
"serviceTier": {
"type": [
"string",
"null"
"threadSource": {
"description": "Optional client-supplied analytics source classification for this forked thread.",
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
]
}
},

22
schemas/v2/ThreadForkResponse.json
View File

@@ -12,11 +12,8 @@
"thread"
],
"properties": {
"serviceTier": {
"type": [
"string",
"null"
]
"thread": {
"$ref": "#/definitions/Thread"
},
"approvalPolicy": {
"$ref": "#/definitions/AskForApproval"
@@ -56,8 +53,11 @@
}
]
},
"thread": {
"$ref": "#/definitions/Thread"
"serviceTier": {
"type": [
"string",
"null"
]
},
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
@@ -80,7 +80,7 @@
],
"properties": {
"extends": {
"description": "Parent profile identifier once permissions profiles support inheritance. This is currently always `null`.",
"description": "Parent profile identifier from the selected permissions profile's `extends` setting, when present.",
"default": null,
"type": [
"string",
@@ -1498,6 +1498,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

13
schemas/v2/ThreadGoalClearParams.json Normal file
View File

@@ -0,0 +1,13 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadGoalClearParams",
"type": "object",
"required": [
"threadId"
],
"properties": {
"threadId": {
"type": "string"
}
}
}

13
schemas/v2/ThreadGoalClearResponse.json Normal file
View File

@@ -0,0 +1,13 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadGoalClearResponse",
"type": "object",
"required": [
"cleared"
],
"properties": {
"cleared": {
"type": "boolean"
}
}
}

13
schemas/v2/ThreadGoalGetParams.json Normal file
View File

@@ -0,0 +1,13 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadGoalGetParams",
"type": "object",
"required": [
"threadId"
],
"properties": {
"threadId": {
"type": "string"
}
}
}

76
schemas/v2/ThreadGoalGetResponse.json Normal file
View File

@@ -0,0 +1,76 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadGoalGetResponse",
"type": "object",
"properties": {
"goal": {
"anyOf": [
{
"$ref": "#/definitions/ThreadGoal"
},
{
"type": "null"
}
]
}
},
"definitions": {
"ThreadGoal": {
"type": "object",
"required": [
"createdAt",
"objective",
"status",
"threadId",
"timeUsedSeconds",
"tokensUsed",
"updatedAt"
],
"properties": {
"createdAt": {
"type": "integer",
"format": "int64"
},
"objective": {
"type": "string"
},
"status": {
"$ref": "#/definitions/ThreadGoalStatus"
},
"threadId": {
"type": "string"
},
"timeUsedSeconds": {
"type": "integer",
"format": "int64"
},
"tokenBudget": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"tokensUsed": {
"type": "integer",
"format": "int64"
},
"updatedAt": {
"type": "integer",
"format": "int64"
}
}
},
"ThreadGoalStatus": {
"type": "string",
"enum": [
"active",
"paused",
"blocked",
"usageLimited",
"budgetLimited",
"complete"
]
}
}
}

49
schemas/v2/ThreadGoalSetParams.json Normal file
View File

@@ -0,0 +1,49 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadGoalSetParams",
"type": "object",
"required": [
"threadId"
],
"properties": {
"objective": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/definitions/ThreadGoalStatus"
},
{
"type": "null"
}
]
},
"threadId": {
"type": "string"
},
"tokenBudget": {
"type": [
"integer",
"null"
],
"format": "int64"
}
},
"definitions": {
"ThreadGoalStatus": {
"type": "string",
"enum": [
"active",
"paused",
"blocked",
"usageLimited",
"budgetLimited",
"complete"
]
}
}
}

72
schemas/v2/ThreadGoalSetResponse.json Normal file
View File

@@ -0,0 +1,72 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadGoalSetResponse",
"type": "object",
"required": [
"goal"
],
"properties": {
"goal": {
"$ref": "#/definitions/ThreadGoal"
}
},
"definitions": {
"ThreadGoal": {
"type": "object",
"required": [
"createdAt",
"objective",
"status",
"threadId",
"timeUsedSeconds",
"tokensUsed",
"updatedAt"
],
"properties": {
"createdAt": {
"type": "integer",
"format": "int64"
},
"objective": {
"type": "string"
},
"status": {
"$ref": "#/definitions/ThreadGoalStatus"
},
"threadId": {
"type": "string"
},
"timeUsedSeconds": {
"type": "integer",
"format": "int64"
},
"tokenBudget": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"tokensUsed": {
"type": "integer",
"format": "int64"
},
"updatedAt": {
"type": "integer",
"format": "int64"
}
}
},
"ThreadGoalStatus": {
"type": "string",
"enum": [
"active",
"paused",
"blocked",
"usageLimited",
"budgetLimited",
"complete"
]
}
}
}

6
schemas/v2/ThreadListResponse.json
View File

@@ -1272,6 +1272,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/ThreadMetadataUpdateResponse.json
View File

@@ -1255,6 +1255,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/ThreadReadResponse.json
View File

@@ -1255,6 +1255,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

50
schemas/v2/ThreadResumeParams.json
View File

@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadResumeParams",
"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.",
"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\nFor non-running threads, the precedence is: history > non-empty path > thread_id. If using history or a non-empty path for a non-running thread, the thread_id param will be ignored.\n\nIf thread_id identifies a running thread, app-server rejoins that thread and treats a non-empty path as a consistency check against the active rollout path. Empty string path values are treated as absent.\n\nPrefer using thread_id whenever possible.",
"type": "object",
"required": [
"threadId"
@@ -53,6 +53,16 @@
"null"
]
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"sandbox": {
"anyOf": [
{
@@ -63,12 +73,6 @@
}
]
},
"serviceTier": {
"type": [
"string",
"null"
]
},
"model": {
"description": "Configuration overrides for the resumed thread, if any.",
"type": [
@@ -82,14 +86,10 @@
"null"
]
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
"serviceTier": {
"type": [
"string",
"null"
]
},
"threadId": {
@@ -295,6 +295,26 @@
}
},
"title": "InputImageFunctionCallOutputContentItem"
},
{
"type": "object",
"required": [
"encrypted_content",
"type"
],
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"encrypted_content"
],
"title": "EncryptedContentFunctionCallOutputContentItemType"
}
},
"title": "EncryptedContentFunctionCallOutputContentItem"
}
]
},

22
schemas/v2/ThreadResumeResponse.json
View File

@@ -12,8 +12,11 @@
"thread"
],
"properties": {
"thread": {
"$ref": "#/definitions/Thread"
"serviceTier": {
"type": [
"string",
"null"
]
},
"approvalPolicy": {
"$ref": "#/definitions/AskForApproval"
@@ -53,11 +56,8 @@
}
]
},
"serviceTier": {
"type": [
"string",
"null"
]
"thread": {
"$ref": "#/definitions/Thread"
},
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
@@ -80,7 +80,7 @@
],
"properties": {
"extends": {
"description": "Parent profile identifier once permissions profiles support inheritance. This is currently always `null`.",
"description": "Parent profile identifier from the selected permissions profile's `extends` setting, when present.",
"default": null,
"type": [
"string",
@@ -1498,6 +1498,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/ThreadRollbackResponse.json
View File

@@ -1260,6 +1260,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

381
schemas/v2/ThreadSettingsUpdatedNotification.json Normal file
View File

@@ -0,0 +1,381 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadSettingsUpdatedNotification",
"type": "object",
"required": [
"threadId",
"threadSettings"
],
"properties": {
"threadId": {
"type": "string"
},
"threadSettings": {
"$ref": "#/definitions/ThreadSettings"
}
},
"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": {
"type": "object",
"required": [
"id"
],
"properties": {
"extends": {
"description": "Parent profile identifier from the selected permissions profile's `extends` setting, when present.",
"default": null,
"type": [
"string",
"null"
]
},
"id": {
"description": "Identifier from `default_permissions` or the implicit built-in default, such as `:workspace` or a user-defined `[permissions.<id>]` profile.",
"type": "string"
}
}
},
"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.",
"type": "string",
"enum": [
"user",
"auto_review",
"guardian_subagent"
]
},
"AskForApproval": {
"oneOf": [
{
"type": "string",
"enum": [
"untrusted",
"on-failure",
"on-request",
"never"
]
},
{
"type": "object",
"required": [
"granular"
],
"properties": {
"granular": {
"type": "object",
"required": [
"mcp_elicitations",
"rules",
"sandbox_approval"
],
"properties": {
"mcp_elicitations": {
"type": "boolean"
},
"request_permissions": {
"default": false,
"type": "boolean"
},
"rules": {
"type": "boolean"
},
"sandbox_approval": {
"type": "boolean"
},
"skill_approval": {
"default": false,
"type": "boolean"
}
}
}
},
"additionalProperties": false,
"title": "GranularAskForApproval"
}
]
},
"CollaborationMode": {
"description": "Collaboration mode for a Codex session.",
"type": "object",
"required": [
"mode",
"settings"
],
"properties": {
"mode": {
"$ref": "#/definitions/ModeKind"
},
"settings": {
"$ref": "#/definitions/Settings"
}
}
},
"ModeKind": {
"description": "Initial collaboration mode to use when the TUI starts.",
"type": "string",
"enum": [
"plan",
"default"
]
},
"NetworkAccess": {
"type": "string",
"enum": [
"restricted",
"enabled"
]
},
"Personality": {
"type": "string",
"enum": [
"none",
"friendly",
"pragmatic"
]
},
"ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning",
"type": "string",
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
},
"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": [
{
"type": "string",
"enum": [
"auto",
"concise",
"detailed"
]
},
{
"description": "Option to disable reasoning summaries.",
"type": "string",
"enum": [
"none"
]
}
]
},
"SandboxPolicy": {
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"dangerFullAccess"
],
"title": "DangerFullAccessSandboxPolicyType"
}
},
"title": "DangerFullAccessSandboxPolicy"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"networkAccess": {
"default": false,
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"readOnly"
],
"title": "ReadOnlySandboxPolicyType"
}
},
"title": "ReadOnlySandboxPolicy"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"networkAccess": {
"default": "restricted",
"allOf": [
{
"$ref": "#/definitions/NetworkAccess"
}
]
},
"type": {
"type": "string",
"enum": [
"externalSandbox"
],
"title": "ExternalSandboxSandboxPolicyType"
}
},
"title": "ExternalSandboxSandboxPolicy"
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"excludeSlashTmp": {
"default": false,
"type": "boolean"
},
"excludeTmpdirEnvVar": {
"default": false,
"type": "boolean"
},
"networkAccess": {
"default": false,
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"workspaceWrite"
],
"title": "WorkspaceWriteSandboxPolicyType"
},
"writableRoots": {
"default": [],
"type": "array",
"items": {
"$ref": "#/definitions/AbsolutePathBuf"
}
}
},
"title": "WorkspaceWriteSandboxPolicy"
}
]
},
"Settings": {
"description": "Settings for a collaboration mode.",
"type": "object",
"required": [
"model"
],
"properties": {
"developer_instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningEffort"
},
{
"type": "null"
}
]
}
}
},
"ThreadSettings": {
"type": "object",
"required": [
"approvalPolicy",
"approvalsReviewer",
"collaborationMode",
"cwd",
"model",
"modelProvider",
"sandboxPolicy"
],
"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"
},
"personality": {
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"sandboxPolicy": {
"$ref": "#/definitions/SandboxPolicy"
},
"serviceTier": {
"type": [
"string",
"null"
]
},
"summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
}
}
}
}
}

32
schemas/v2/ThreadStartParams.json
View File

@@ -59,10 +59,11 @@
}
]
},
"sessionStartSource": {
"threadSource": {
"description": "Optional client-supplied analytics source classification for this thread.",
"anyOf": [
{
"$ref": "#/definitions/ThreadStartSource"
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
@@ -75,15 +76,10 @@
"null"
]
},
"threadSource": {
"description": "Optional client-supplied analytics source classification for this thread.",
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
"serviceTier": {
"type": [
"string",
"null"
]
},
"personality": {
@@ -108,13 +104,17 @@
"null"
]
},
"serviceName": {
"type": [
"string",
"null"
"sessionStartSource": {
"anyOf": [
{
"$ref": "#/definitions/ThreadStartSource"
},
{
"type": "null"
}
]
},
"serviceTier": {
"serviceName": {
"type": [
"string",
"null"

22
schemas/v2/ThreadStartResponse.json
View File

@@ -12,8 +12,11 @@
"thread"
],
"properties": {
"thread": {
"$ref": "#/definitions/Thread"
"serviceTier": {
"type": [
"string",
"null"
]
},
"approvalPolicy": {
"$ref": "#/definitions/AskForApproval"
@@ -53,11 +56,8 @@
}
]
},
"serviceTier": {
"type": [
"string",
"null"
]
"thread": {
"$ref": "#/definitions/Thread"
},
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
@@ -80,7 +80,7 @@
],
"properties": {
"extends": {
"description": "Parent profile identifier once permissions profiles support inheritance. This is currently always `null`.",
"description": "Parent profile identifier from the selected permissions profile's `extends` setting, when present.",
"default": null,
"type": [
"string",
@@ -1498,6 +1498,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/ThreadStartedNotification.json
View File

@@ -1255,6 +1255,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/ThreadUnarchiveResponse.json
View File

@@ -1255,6 +1255,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/TurnCompletedNotification.json
View File

@@ -967,6 +967,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

12
schemas/v2/TurnStartParams.json
View File

@@ -73,11 +73,11 @@
"outputSchema": {
"description": "Optional JSON Schema used to constrain the final assistant message for this turn."
},
"summary": {
"description": "Override the reasoning summary for this turn and subsequent turns.",
"sandboxPolicy": {
"description": "Override the sandbox policy for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
"$ref": "#/definitions/SandboxPolicy"
},
{
"type": "null"
@@ -95,11 +95,11 @@
}
]
},
"sandboxPolicy": {
"description": "Override the sandbox policy for this turn and subsequent turns.",
"summary": {
"description": "Override the reasoning summary for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/SandboxPolicy"
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"

6
schemas/v2/TurnStartResponse.json
View File

@@ -963,6 +963,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{

6
schemas/v2/TurnStartedNotification.json
View File

@@ -967,6 +967,12 @@
"null"
]
},
"pluginId": {
"type": [
"string",
"null"
]
},
"result": {
"anyOf": [
{