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

Refresh Codex protocol schemas

Browse Source
This commit is contained in:
Codex
2026-06-23 11:20:03 +00:00
parent 595e8aee0e
commit 85326d845d
75 changed files with 11791 additions and 3800 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1572
schemas/ClientRequest.json
View File

File diff suppressed because it is too large Load Diff

19
schemas/CommandExecutionRequestApprovalParams.json
View File

@@ -43,13 +43,21 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"anyOf": [ "anyOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
{ {
"type": "null" "type": "null"
} }
] ]
}, },
"environmentId": {
"description": "Environment in which the command will run.",
"default": null,
"type": [
"string",
"null"
]
},
"itemId": { "itemId": {
"type": "string" "type": "string"
}, },
@@ -129,7 +137,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -139,7 +147,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -388,7 +396,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -566,6 +574,9 @@
} }
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"NetworkApprovalContext": { "NetworkApprovalContext": {
"type": "object", "type": "object",
"required": [ "required": [

21
schemas/McpServerElicitationRequestParams.json
View File

@@ -26,6 +26,27 @@
} }
} }
}, },
{
"type": "object",
"required": [
"message",
"mode",
"requestedSchema"
],
"properties": {
"_meta": true,
"message": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"openai/form"
]
},
"requestedSchema": true
}
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

16
schemas/PermissionsRequestApprovalParams.json
View File

@@ -14,6 +14,13 @@
"cwd": { "cwd": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/AbsolutePathBuf"
}, },
"environmentId": {
"default": null,
"type": [
"string",
"null"
]
},
"itemId": { "itemId": {
"type": "string" "type": "string"
}, },
@@ -70,7 +77,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -80,7 +87,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -114,7 +121,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -292,6 +299,9 @@
} }
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"RequestPermissionProfile": { "RequestPermissionProfile": {
"type": "object", "type": "object",
"properties": { "properties": {

13
schemas/PermissionsRequestApprovalResponse.json
View File

@@ -26,10 +26,6 @@
} }
}, },
"definitions": { "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"
},
"AdditionalFileSystemPermissions": { "AdditionalFileSystemPermissions": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -57,7 +53,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -67,7 +63,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -101,7 +97,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -304,6 +300,9 @@
} }
} }
}, },
"LegacyAppPathString": {
"type": "string"
},
"PermissionGrantScope": { "PermissionGrantScope": {
"type": "string", "type": "string",
"enum": [ "enum": [

519
schemas/ServerNotification.json
View File

@@ -84,6 +84,26 @@
}, },
"title": "Thread/archivedNotification" "title": "Thread/archivedNotification"
}, },
{
"type": "object",
"required": [
"method",
"params"
],
"properties": {
"method": {
"type": "string",
"enum": [
"thread/deleted"
],
"title": "Thread/deletedNotificationMethod"
},
"params": {
"$ref": "#/definitions/ThreadDeletedNotification"
}
},
"title": "Thread/deletedNotification"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -789,6 +809,26 @@
}, },
"title": "RemoteControl/status/changedNotification" "title": "RemoteControl/status/changedNotification"
}, },
{
"type": "object",
"required": [
"method",
"params"
],
"properties": {
"method": {
"type": "string",
"enum": [
"externalAgentConfig/import/progress"
],
"title": "ExternalAgentConfig/import/progressNotificationMethod"
},
"params": {
"$ref": "#/definitions/ExternalAgentConfigImportProgressNotification"
}
},
"title": "ExternalAgentConfig/import/progressNotification"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -950,6 +990,46 @@
}, },
"title": "Model/verificationNotification" "title": "Model/verificationNotification"
}, },
{
"type": "object",
"required": [
"method",
"params"
],
"properties": {
"method": {
"type": "string",
"enum": [
"turn/moderationMetadata"
],
"title": "Turn/moderationMetadataNotificationMethod"
},
"params": {
"$ref": "#/definitions/TurnModerationMetadataNotification"
}
},
"title": "Turn/moderationMetadataNotification"
},
{
"type": "object",
"required": [
"method",
"params"
],
"properties": {
"method": {
"type": "string",
"enum": [
"model/safetyBuffering/updated"
],
"title": "Model/safetyBuffering/updatedNotificationMethod"
},
"params": {
"$ref": "#/definitions/ModelSafetyBufferingUpdatedNotification"
}
},
"title": "Model/safetyBuffering/updatedNotification"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1321,6 +1401,7 @@
} }
}, },
"AccountRateLimitsUpdatedNotification": { "AccountRateLimitsUpdatedNotification": {
"description": "Sparse rolling rate-limit update.\n\nClients should merge available values into the most recent `account/rateLimits/read` response or refetch that snapshot. Nullable account metadata may be unavailable in a rolling update and does not clear a previously observed value.",
"type": "object", "type": "object",
"required": [ "required": [
"rateLimits" "rateLimits"
@@ -1403,7 +1484,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -1413,7 +1494,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -1816,6 +1897,20 @@
"enum": [ "enum": [
"agentIdentity" "agentIdentity"
] ]
},
{
"description": "Programmatic Codex auth backed by a personal access token.",
"type": "string",
"enum": [
"personalAccessToken"
]
},
{
"description": "Amazon Bedrock bearer token managed by Codex.",
"type": "string",
"enum": [
"bedrockApiKey"
]
} }
] ]
}, },
@@ -2416,7 +2511,145 @@
} }
}, },
"ExternalAgentConfigImportCompletedNotification": { "ExternalAgentConfigImportCompletedNotification": {
"type": "object" "type": "object",
"required": [
"importId",
"itemTypeResults"
],
"properties": {
"importId": {
"type": "string"
},
"itemTypeResults": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportTypeResult"
}
}
}
},
"ExternalAgentConfigImportItemTypeFailure": {
"type": "object",
"required": [
"failureStage",
"itemType",
"message"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"errorType": {
"type": [
"string",
"null"
]
},
"failureStage": {
"type": "string"
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"message": {
"type": "string"
},
"source": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportItemTypeSuccess": {
"type": "object",
"required": [
"itemType"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"source": {
"type": [
"string",
"null"
]
},
"target": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportProgressNotification": {
"type": "object",
"required": [
"importId",
"itemTypeResults"
],
"properties": {
"importId": {
"type": "string"
},
"itemTypeResults": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportTypeResult"
}
}
}
},
"ExternalAgentConfigImportTypeResult": {
"type": "object",
"required": [
"failures",
"itemType",
"successes"
],
"properties": {
"failures": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeFailure"
}
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"successes": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeSuccess"
}
}
}
},
"ExternalAgentConfigMigrationItemType": {
"type": "string",
"enum": [
"AGENTS_MD",
"CONFIG",
"SKILLS",
"PLUGINS",
"MCP_SERVER_CONFIG",
"SUBAGENTS",
"HOOKS",
"COMMANDS",
"SESSIONS"
]
}, },
"FileChangeOutputDeltaNotification": { "FileChangeOutputDeltaNotification": {
"description": "Deprecated legacy notification for `apply_patch` textual output.\n\nThe server no longer emits this notification.", "description": "Deprecated legacy notification for `apply_patch` textual output.\n\nThe server no longer emits this notification.",
@@ -2486,7 +2719,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -3295,6 +3528,7 @@
"sessionFlags", "sessionFlags",
"plugin", "plugin",
"cloudRequirements", "cloudRequirements",
"cloudManagedConfig",
"legacyManagedConfigFile", "legacyManagedConfigFile",
"legacyManagedConfigMdm", "legacyManagedConfigMdm",
"unknown" "unknown"
@@ -3324,6 +3558,8 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
@@ -3472,6 +3708,9 @@
} }
} }
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpServerOauthLoginCompletedNotification": { "McpServerOauthLoginCompletedNotification": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -3520,6 +3759,35 @@
}, },
"status": { "status": {
"$ref": "#/definitions/McpServerStartupState" "$ref": "#/definitions/McpServerStartupState"
},
"threadId": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
} }
} }
}, },
@@ -3687,6 +3955,39 @@
} }
} }
}, },
"ModelSafetyBufferingUpdatedNotification": {
"type": "object",
"required": [
"model",
"reasons",
"threadId",
"turnId",
"useCases"
],
"properties": {
"model": {
"type": "string"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"threadId": {
"type": "string"
},
"turnId": {
"type": "string"
},
"useCases": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ModelVerification": { "ModelVerification": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -3715,6 +4016,15 @@
} }
} }
}, },
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
},
"NetworkAccess": { "NetworkAccess": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -3967,6 +4277,16 @@
} }
] ]
}, },
"individualLimit": {
"anyOf": [
{
"$ref": "#/definitions/SpendControlLimitSnapshot"
},
{
"type": "null"
}
]
},
"limitId": { "limitId": {
"type": [ "type": [
"string", "string",
@@ -4055,16 +4375,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"ReasoningSummary": { "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", "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",
@@ -4424,6 +4737,39 @@
"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.", "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" "type": "object"
}, },
"SpendControlLimitSnapshot": {
"type": "object",
"required": [
"limit",
"remainingPercent",
"resetsAt",
"used"
],
"properties": {
"limit": {
"type": "string"
},
"remainingPercent": {
"type": "integer",
"format": "int32"
},
"resetsAt": {
"type": "integer",
"format": "int64"
},
"used": {
"type": "string"
}
}
},
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -4670,6 +5016,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -4681,6 +5034,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -4755,6 +5116,17 @@
} }
} }
}, },
"ThreadDeletedNotification": {
"type": "object",
"required": [
"threadId"
],
"properties": {
"threadId": {
"type": "string"
}
}
},
"ThreadGoal": { "ThreadGoal": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -4857,6 +5229,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -5041,7 +5419,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -5134,6 +5512,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -5157,6 +5545,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -5341,6 +5730,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -5399,6 +5820,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -5762,6 +6209,16 @@
"modelProvider": { "modelProvider": {
"type": "string" "type": "string"
}, },
"summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
},
"personality": { "personality": {
"anyOf": [ "anyOf": [
{ {
@@ -5780,16 +6237,6 @@
"string", "string",
"null" "null"
] ]
},
"summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
} }
} }
}, },
@@ -5809,12 +6256,7 @@
} }
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStartedNotification": { "ThreadStartedNotification": {
"type": "object", "type": "object",
@@ -6156,6 +6598,23 @@
} }
] ]
}, },
"TurnModerationMetadataNotification": {
"type": "object",
"required": [
"metadata",
"threadId",
"turnId"
],
"properties": {
"metadata": true,
"threadId": {
"type": "string"
},
"turnId": {
"type": "string"
}
}
},
"TurnPlanStep": { "TurnPlanStep": {
"type": "object", "type": "object",
"required": [ "required": [

130
schemas/ServerRequest.json
View File

@@ -285,7 +285,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -295,7 +295,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -638,13 +638,21 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"anyOf": [ "anyOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
{ {
"type": "null" "type": "null"
} }
] ]
}, },
"environmentId": {
"description": "Environment in which the command will run.",
"default": null,
"type": [
"string",
"null"
]
},
"itemId": { "itemId": {
"type": "string" "type": "string"
}, },
@@ -693,6 +701,43 @@
} }
} }
}, },
"ToolRequestUserInputQuestion": {
"description": "EXPERIMENTAL. Represents one request_user_input question and its required options.",
"type": "object",
"required": [
"header",
"id",
"question"
],
"properties": {
"header": {
"type": "string"
},
"id": {
"type": "string"
},
"isOther": {
"default": false,
"type": "boolean"
},
"isSecret": {
"default": false,
"type": "boolean"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ToolRequestUserInputOption"
}
},
"question": {
"type": "string"
}
}
},
"DynamicToolCallParams": { "DynamicToolCallParams": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -898,7 +943,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -1076,6 +1121,9 @@
} }
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpElicitationArrayType": { "McpElicitationArrayType": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -1633,6 +1681,27 @@
} }
} }
}, },
{
"type": "object",
"required": [
"message",
"mode",
"requestedSchema"
],
"properties": {
"_meta": true,
"message": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"openai/form"
]
},
"requestedSchema": true
}
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1852,6 +1921,13 @@
"cwd": { "cwd": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/AbsolutePathBuf"
}, },
"environmentId": {
"default": null,
"type": [
"string",
"null"
]
},
"itemId": { "itemId": {
"type": "string" "type": "string"
}, },
@@ -1943,6 +2019,15 @@
"turnId" "turnId"
], ],
"properties": { "properties": {
"autoResolutionMs": {
"default": null,
"type": [
"integer",
"null"
],
"format": "uint64",
"minimum": 0.0
},
"itemId": { "itemId": {
"type": "string" "type": "string"
}, },
@@ -1959,43 +2044,6 @@
"type": "string" "type": "string"
} }
} }
},
"ToolRequestUserInputQuestion": {
"description": "EXPERIMENTAL. Represents one request_user_input question and its required options.",
"type": "object",
"required": [
"header",
"id",
"question"
],
"properties": {
"header": {
"type": "string"
},
"id": {
"type": "string"
},
"isOther": {
"default": false,
"type": "boolean"
},
"isSecret": {
"default": false,
"type": "boolean"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ToolRequestUserInputOption"
}
},
"question": {
"type": "string"
}
}
} }
} }
} }

9
schemas/ToolRequestUserInputParams.json
View File

@@ -10,6 +10,15 @@
"turnId" "turnId"
], ],
"properties": { "properties": {
"autoResolutionMs": {
"default": null,
"type": [
"integer",
"null"
],
"format": "uint64",
"minimum": 0.0
},
"itemId": { "itemId": {
"type": "string" "type": "string"
}, },

4325
schemas/codex_app_server_protocol.schemas.json
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

4
schemas/v1/InitializeParams.json
View File

@@ -51,6 +51,10 @@
"default": false, "default": false,
"type": "boolean" "type": "boolean"
}, },
"mcpServerOpenaiFormElicitation": {
"description": "Allow downstream MCP servers to request OpenAI extended form elicitations.",
"type": "boolean"
},
"optOutNotificationMethods": { "optOutNotificationMethods": {
"description": "Exact notification method names that should be suppressed for this connection (for example `thread/started`).", "description": "Exact notification method names that should be suppressed for this connection (for example `thread/started`).",
"type": [ "type": [

36
schemas/v2/AccountRateLimitsUpdatedNotification.json
View File

@@ -1,6 +1,7 @@
{ {
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "AccountRateLimitsUpdatedNotification", "title": "AccountRateLimitsUpdatedNotification",
"description": "Sparse rolling rate-limit update.\n\nClients should merge available values into the most recent `account/rateLimits/read` response or refetch that snapshot. Nullable account metadata may be unavailable in a rolling update and does not clear a previously observed value.",
"type": "object", "type": "object",
"required": [ "required": [
"rateLimits" "rateLimits"
@@ -72,6 +73,16 @@
} }
] ]
}, },
"individualLimit": {
"anyOf": [
{
"$ref": "#/definitions/SpendControlLimitSnapshot"
},
{
"type": "null"
}
]
},
"limitId": { "limitId": {
"type": [ "type": [
"string", "string",
@@ -151,6 +162,31 @@
"format": "int64" "format": "int64"
} }
} }
},
"SpendControlLimitSnapshot": {
"type": "object",
"required": [
"limit",
"remainingPercent",
"resetsAt",
"used"
],
"properties": {
"limit": {
"type": "string"
},
"remainingPercent": {
"type": "integer",
"format": "int32"
},
"resetsAt": {
"type": "integer",
"format": "int64"
},
"used": {
"type": "string"
}
}
} }
} }
} }

14
schemas/v2/AccountUpdatedNotification.json
View File

@@ -55,6 +55,20 @@
"enum": [ "enum": [
"agentIdentity" "agentIdentity"
] ]
},
{
"description": "Programmatic Codex auth backed by a personal access token.",
"type": "string",
"enum": [
"personalAccessToken"
]
},
{
"description": "Amazon Bedrock bearer token managed by Codex.",
"type": "string",
"enum": [
"bedrockApiKey"
]
} }
] ]
}, },

1
schemas/v2/ConfigReadParams.json
View File

@@ -11,7 +11,6 @@
] ]
}, },
"includeLayers": { "includeLayers": {
"default": false,
"type": "boolean" "type": "boolean"
} }
} }

183
schemas/v2/ConfigReadResponse.json
View File

@@ -46,6 +46,16 @@
"AppConfig": { "AppConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"approvals_reviewer": {
"anyOf": [
{
"$ref": "#/definitions/ApprovalsReviewer"
},
{
"type": "null"
}
]
},
"default_tools_approval_mode": { "default_tools_approval_mode": {
"anyOf": [ "anyOf": [
{ {
@@ -150,6 +160,26 @@
"AppsDefaultConfig": { "AppsDefaultConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"approvals_reviewer": {
"anyOf": [
{
"$ref": "#/definitions/ApprovalsReviewer"
},
{
"type": "null"
}
]
},
"default_tools_approval_mode": {
"anyOf": [
{
"$ref": "#/definitions/AppToolApproval"
},
{
"type": "null"
}
]
},
"destructive_enabled": { "destructive_enabled": {
"default": true, "default": true,
"type": "boolean" "type": "boolean"
@@ -388,19 +418,6 @@
} }
] ]
}, },
"profile": {
"type": [
"string",
"null"
]
},
"profiles": {
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ProfileV2"
}
},
"review_model": { "review_model": {
"type": [ "type": [
"string", "string",
@@ -537,6 +554,33 @@
}, },
"title": "SystemConfigLayerSource" "title": "SystemConfigLayerSource"
}, },
{
"description": "Enterprise-managed config layer delivered by the cloud config bundle.",
"type": "object",
"required": [
"id",
"name",
"type"
],
"properties": {
"id": {
"description": "Stable identifier for the delivered layer.",
"type": "string"
},
"name": {
"description": "Admin-facing name for the delivered layer. This is surfaced in diagnostics so users know which cloud layer needs administrator attention.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"enterpriseManaged"
],
"title": "EnterpriseManagedConfigLayerSourceType"
}
},
"title": "EnterpriseManagedConfigLayerSource"
},
{ {
"description": "User config layer from $CODEX_HOME/config.toml. This layer is special in that it is expected to be: - writable by the user - generally outside the workspace directory", "description": "User config layer from $CODEX_HOME/config.toml. This layer is special in that it is expected to be: - writable by the user - generally outside the workspace directory",
"type": "object", "type": "object",
@@ -668,118 +712,10 @@
"api" "api"
] ]
}, },
"ProfileV2": {
"type": "object",
"properties": {
"approval_policy": {
"anyOf": [
{
"$ref": "#/definitions/AskForApproval"
},
{
"type": "null"
}
]
},
"approvals_reviewer": {
"description": "[UNSTABLE] Optional profile-level override for where approval requests are routed for review. If omitted, the enclosing config default is used.",
"anyOf": [
{
"$ref": "#/definitions/ApprovalsReviewer"
},
{
"type": "null"
}
]
},
"chatgpt_base_url": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"model_provider": {
"type": [
"string",
"null"
]
},
"model_reasoning_effort": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningEffort"
},
{
"type": "null"
}
]
},
"model_reasoning_summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
},
"model_verbosity": {
"anyOf": [
{
"$ref": "#/definitions/Verbosity"
},
{
"type": "null"
}
]
},
"service_tier": {
"type": [
"string",
"null"
]
},
"tools": {
"anyOf": [
{
"$ref": "#/definitions/ToolsV2"
},
{
"type": "null"
}
]
},
"web_search": {
"anyOf": [
{
"$ref": "#/definitions/WebSearchMode"
},
{
"type": "null"
}
]
}
},
"additionalProperties": true
},
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"ReasoningSummary": { "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", "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",
@@ -900,6 +836,7 @@
"enum": [ "enum": [
"disabled", "disabled",
"cached", "cached",
"indexed",
"live" "live"
] ]
}, },

45
schemas/v2/ConfigRequirementsReadResponse.json
View File

@@ -89,12 +89,24 @@
"ConfigRequirements": { "ConfigRequirements": {
"type": "object", "type": "object",
"properties": { "properties": {
"allowAppshots": {
"type": [
"boolean",
"null"
]
},
"allowManagedHooksOnly": { "allowManagedHooksOnly": {
"type": [ "type": [
"boolean", "boolean",
"null" "null"
] ]
}, },
"allowRemoteControl": {
"type": [
"boolean",
"null"
]
},
"allowedApprovalPolicies": { "allowedApprovalPolicies": {
"type": [ "type": [
"array", "array",
@@ -113,13 +125,13 @@
"type": "boolean" "type": "boolean"
} }
}, },
"allowedPermissions": { "allowedPermissionProfiles": {
"type": [ "type": [
"array", "object",
"null" "null"
], ],
"items": { "additionalProperties": {
"type": "string" "type": "boolean"
} }
}, },
"allowedSandboxModes": { "allowedSandboxModes": {
@@ -140,6 +152,15 @@
"$ref": "#/definitions/WebSearchMode" "$ref": "#/definitions/WebSearchMode"
} }
}, },
"allowedWindowsSandboxImplementations": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/WindowsSandboxSetupMode"
}
},
"computerUse": { "computerUse": {
"anyOf": [ "anyOf": [
{ {
@@ -150,6 +171,12 @@
} }
] ]
}, },
"defaultPermissions": {
"type": [
"string",
"null"
]
},
"enforceResidency": { "enforceResidency": {
"anyOf": [ "anyOf": [
{ {
@@ -470,7 +497,7 @@
"type": "string", "type": "string",
"enum": [ "enum": [
"allow", "allow",
"none" "deny"
] ]
}, },
"ResidencyRequirement": { "ResidencyRequirement": {
@@ -492,8 +519,16 @@
"enum": [ "enum": [
"disabled", "disabled",
"cached", "cached",
"indexed",
"live" "live"
] ]
},
"WindowsSandboxSetupMode": {
"type": "string",
"enum": [
"elevated",
"unelevated"
]
} }
} }
} }

27
schemas/v2/ConfigWriteResponse.json
View File

@@ -106,6 +106,33 @@
}, },
"title": "SystemConfigLayerSource" "title": "SystemConfigLayerSource"
}, },
{
"description": "Enterprise-managed config layer delivered by the cloud config bundle.",
"type": "object",
"required": [
"id",
"name",
"type"
],
"properties": {
"id": {
"description": "Stable identifier for the delivered layer.",
"type": "string"
},
"name": {
"description": "Admin-facing name for the delivered layer. This is surfaced in diagnostics so users know which cloud layer needs administrator attention.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"enterpriseManaged"
],
"title": "EnterpriseManagedConfigLayerSourceType"
}
},
"title": "EnterpriseManagedConfigLayerSource"
},
{ {
"description": "User config layer from $CODEX_HOME/config.toml. This layer is special in that it is expected to be: - writable by the user - generally outside the workspace directory", "description": "User config layer from $CODEX_HOME/config.toml. This layer is special in that it is expected to be: - writable by the user - generally outside the workspace directory",
"type": "object", "type": "object",

14
schemas/v2/ConsumeAccountRateLimitResetCreditParams.json Normal file
View File

@@ -0,0 +1,14 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ConsumeAccountRateLimitResetCreditParams",
"type": "object",
"required": [
"idempotencyKey"
],
"properties": {
"idempotencyKey": {
"description": "Identifies one logical reset attempt. A UUID is recommended; reuse the same value when retrying that attempt.",
"type": "string"
}
}
}

47
schemas/v2/ConsumeAccountRateLimitResetCreditResponse.json Normal file
View File

@@ -0,0 +1,47 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ConsumeAccountRateLimitResetCreditResponse",
"type": "object",
"required": [
"outcome"
],
"properties": {
"outcome": {
"$ref": "#/definitions/ConsumeAccountRateLimitResetCreditOutcome"
}
},
"definitions": {
"ConsumeAccountRateLimitResetCreditOutcome": {
"oneOf": [
{
"description": "A reset credit was consumed and the eligible rate-limit windows were reset.",
"type": "string",
"enum": [
"reset"
]
},
{
"description": "No current rate-limit window is eligible for a reset.",
"type": "string",
"enum": [
"nothingToReset"
]
},
{
"description": "The account has no earned reset credits available.",
"type": "string",
"enum": [
"noCredit"
]
},
{
"description": "The same idempotency key already completed a reset successfully.",
"type": "string",
"enum": [
"alreadyRedeemed"
]
}
]
}
}
}

2
schemas/v2/ExternalAgentConfigDetectParams.json
View File

@@ -14,7 +14,7 @@
} }
}, },
"includeHome": { "includeHome": {
"description": "If true, include detection under the user's home (~/.claude, ~/.codex, etc.).", "description": "If true, include detection under the user's home directory.",
"type": "boolean" "type": "boolean"
} }
} }

124
schemas/v2/ExternalAgentConfigImportCompletedNotification.json
View File

@@ -1,5 +1,127 @@
{ {
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "ExternalAgentConfigImportCompletedNotification", "title": "ExternalAgentConfigImportCompletedNotification",
"type": "object" "type": "object",
"required": [
"importId",
"itemTypeResults"
],
"properties": {
"importId": {
"type": "string"
},
"itemTypeResults": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportTypeResult"
}
}
},
"definitions": {
"ExternalAgentConfigImportItemTypeFailure": {
"type": "object",
"required": [
"failureStage",
"itemType",
"message"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"errorType": {
"type": [
"string",
"null"
]
},
"failureStage": {
"type": "string"
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"message": {
"type": "string"
},
"source": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportItemTypeSuccess": {
"type": "object",
"required": [
"itemType"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"source": {
"type": [
"string",
"null"
]
},
"target": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportTypeResult": {
"type": "object",
"required": [
"failures",
"itemType",
"successes"
],
"properties": {
"failures": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeFailure"
}
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"successes": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeSuccess"
}
}
}
},
"ExternalAgentConfigMigrationItemType": {
"type": "string",
"enum": [
"AGENTS_MD",
"CONFIG",
"SKILLS",
"PLUGINS",
"MCP_SERVER_CONFIG",
"SUBAGENTS",
"HOOKS",
"COMMANDS",
"SESSIONS"
]
}
}
} }

128
schemas/v2/ExternalAgentConfigImportHistoriesReadResponse.json Normal file
View File

@@ -0,0 +1,128 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ExternalAgentConfigImportHistoriesReadResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportHistory"
}
}
},
"definitions": {
"ExternalAgentConfigImportHistory": {
"type": "object",
"required": [
"completedAtMs",
"failures",
"importId",
"successes"
],
"properties": {
"completedAtMs": {
"type": "integer",
"format": "int64"
},
"failures": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeFailure"
}
},
"importId": {
"type": "string"
},
"successes": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeSuccess"
}
}
}
},
"ExternalAgentConfigImportItemTypeFailure": {
"type": "object",
"required": [
"failureStage",
"itemType",
"message"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"errorType": {
"type": [
"string",
"null"
]
},
"failureStage": {
"type": "string"
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"message": {
"type": "string"
},
"source": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportItemTypeSuccess": {
"type": "object",
"required": [
"itemType"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"source": {
"type": [
"string",
"null"
]
},
"target": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigMigrationItemType": {
"type": "string",
"enum": [
"AGENTS_MD",
"CONFIG",
"SKILLS",
"PLUGINS",
"MCP_SERVER_CONFIG",
"SUBAGENTS",
"HOOKS",
"COMMANDS",
"SESSIONS"
]
}
}
}

7
schemas/v2/ExternalAgentConfigImportParams.json
View File

@@ -11,6 +11,13 @@
"items": { "items": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItem" "$ref": "#/definitions/ExternalAgentConfigMigrationItem"
} }
},
"source": {
"description": "Source product that produced the migration items. Missing means unspecified.",
"type": [
"string",
"null"
]
} }
}, },
"definitions": { "definitions": {

127
schemas/v2/ExternalAgentConfigImportProgressNotification.json Normal file
View File

@@ -0,0 +1,127 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ExternalAgentConfigImportProgressNotification",
"type": "object",
"required": [
"importId",
"itemTypeResults"
],
"properties": {
"importId": {
"type": "string"
},
"itemTypeResults": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportTypeResult"
}
}
},
"definitions": {
"ExternalAgentConfigImportItemTypeFailure": {
"type": "object",
"required": [
"failureStage",
"itemType",
"message"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"errorType": {
"type": [
"string",
"null"
]
},
"failureStage": {
"type": "string"
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"message": {
"type": "string"
},
"source": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportItemTypeSuccess": {
"type": "object",
"required": [
"itemType"
],
"properties": {
"cwd": {
"type": [
"string",
"null"
]
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"source": {
"type": [
"string",
"null"
]
},
"target": {
"type": [
"string",
"null"
]
}
}
},
"ExternalAgentConfigImportTypeResult": {
"type": "object",
"required": [
"failures",
"itemType",
"successes"
],
"properties": {
"failures": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeFailure"
}
},
"itemType": {
"$ref": "#/definitions/ExternalAgentConfigMigrationItemType"
},
"successes": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalAgentConfigImportItemTypeSuccess"
}
}
}
},
"ExternalAgentConfigMigrationItemType": {
"type": "string",
"enum": [
"AGENTS_MD",
"CONFIG",
"SKILLS",
"PLUGINS",
"MCP_SERVER_CONFIG",
"SUBAGENTS",
"HOOKS",
"COMMANDS",
"SESSIONS"
]
}
}
}

10
schemas/v2/ExternalAgentConfigImportResponse.json
View File

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

3
schemas/v2/FeedbackUploadParams.json
View File

@@ -3,8 +3,7 @@
"title": "FeedbackUploadParams", "title": "FeedbackUploadParams",
"type": "object", "type": "object",
"required": [ "required": [
"classification", "classification"
"includeLogs"
], ],
"properties": { "properties": {
"classification": { "classification": {

1
schemas/v2/GetAccountParams.json
View File

@@ -5,7 +5,6 @@
"properties": { "properties": {
"refreshToken": { "refreshToken": {
"description": "When `true`, requests a proactive token refresh before returning.\n\nIn managed auth mode this triggers the normal refresh-token flow. In external auth mode this flag is ignored. Clients should refresh tokens themselves and call `account/login/start` with `chatgptAuthTokens`.", "description": "When `true`, requests a proactive token refresh before returning.\n\nIn managed auth mode this triggers the normal refresh-token flow. In external auth mode this flag is ignored. Clients should refresh tokens themselves and call `account/login/start` with `chatgptAuthTokens`.",
"default": false,
"type": "boolean" "type": "boolean"
} }
} }

57
schemas/v2/GetAccountRateLimitsResponse.json
View File

@@ -6,6 +6,16 @@
"rateLimits" "rateLimits"
], ],
"properties": { "properties": {
"rateLimitResetCredits": {
"anyOf": [
{
"$ref": "#/definitions/RateLimitResetCreditsSummary"
},
{
"type": "null"
}
]
},
"rateLimits": { "rateLimits": {
"description": "Backward-compatible single-bucket view; mirrors the historical payload.", "description": "Backward-compatible single-bucket view; mirrors the historical payload.",
"allOf": [ "allOf": [
@@ -74,6 +84,18 @@
"workspace_member_usage_limit_reached" "workspace_member_usage_limit_reached"
] ]
}, },
"RateLimitResetCreditsSummary": {
"type": "object",
"required": [
"availableCount"
],
"properties": {
"availableCount": {
"type": "integer",
"format": "int64"
}
}
},
"RateLimitSnapshot": { "RateLimitSnapshot": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -87,6 +109,16 @@
} }
] ]
}, },
"individualLimit": {
"anyOf": [
{
"$ref": "#/definitions/SpendControlLimitSnapshot"
},
{
"type": "null"
}
]
},
"limitId": { "limitId": {
"type": [ "type": [
"string", "string",
@@ -166,6 +198,31 @@
"format": "int64" "format": "int64"
} }
} }
},
"SpendControlLimitSnapshot": {
"type": "object",
"required": [
"limit",
"remainingPercent",
"resetsAt",
"used"
],
"properties": {
"limit": {
"type": "string"
},
"remainingPercent": {
"type": "integer",
"format": "int32"
},
"resetsAt": {
"type": "integer",
"format": "int64"
},
"used": {
"type": "string"
}
}
} }
} }
} }

20
schemas/v2/GetAccountResponse.json
View File

@@ -48,7 +48,10 @@
], ],
"properties": { "properties": {
"email": { "email": {
"type": "string" "type": [
"string",
"null"
]
}, },
"planType": { "planType": {
"$ref": "#/definitions/PlanType" "$ref": "#/definitions/PlanType"
@@ -69,6 +72,14 @@
"type" "type"
], ],
"properties": { "properties": {
"credentialSource": {
"default": "awsManaged",
"allOf": [
{
"$ref": "#/definitions/AmazonBedrockCredentialSource"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -81,6 +92,13 @@
} }
] ]
}, },
"AmazonBedrockCredentialSource": {
"type": "string",
"enum": [
"codexManaged",
"awsManaged"
]
},
"PlanType": { "PlanType": {
"type": "string", "type": "string",
"enum": [ "enum": [

80
schemas/v2/GetAccountTokenUsageResponse.json Normal file
View File

@@ -0,0 +1,80 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "GetAccountTokenUsageResponse",
"type": "object",
"required": [
"summary"
],
"properties": {
"dailyUsageBuckets": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/AccountTokenUsageDailyBucket"
}
},
"summary": {
"$ref": "#/definitions/AccountTokenUsageSummary"
}
},
"definitions": {
"AccountTokenUsageDailyBucket": {
"type": "object",
"required": [
"startDate",
"tokens"
],
"properties": {
"startDate": {
"type": "string"
},
"tokens": {
"type": "integer",
"format": "int64"
}
}
},
"AccountTokenUsageSummary": {
"type": "object",
"properties": {
"currentStreakDays": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"lifetimeTokens": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"longestRunningTurnSec": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"longestStreakDays": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"peakDailyTokens": {
"type": [
"integer",
"null"
],
"format": "int64"
}
}
}
}
}

67
schemas/v2/GetWorkspaceMessagesResponse.json Normal file
View File

@@ -0,0 +1,67 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "GetWorkspaceMessagesResponse",
"type": "object",
"required": [
"featureEnabled",
"messages"
],
"properties": {
"featureEnabled": {
"description": "Whether the workspace-message backend route is available for this client.",
"type": "boolean"
},
"messages": {
"description": "Active workspace messages returned by the backend.",
"type": "array",
"items": {
"$ref": "#/definitions/WorkspaceMessage"
}
}
},
"definitions": {
"WorkspaceMessage": {
"type": "object",
"required": [
"messageBody",
"messageId",
"messageType"
],
"properties": {
"archivedAt": {
"description": "Unix timestamp (in seconds) when the message was archived.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"createdAt": {
"description": "Unix timestamp (in seconds) when the message was created.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"messageBody": {
"type": "string"
},
"messageId": {
"type": "string"
},
"messageType": {
"$ref": "#/definitions/WorkspaceMessageType"
}
}
},
"WorkspaceMessageType": {
"type": "string",
"enum": [
"headline",
"announcement",
"unknown"
]
}
}
}

1
schemas/v2/HookCompletedNotification.json
View File

@@ -187,6 +187,7 @@
"sessionFlags", "sessionFlags",
"plugin", "plugin",
"cloudRequirements", "cloudRequirements",
"cloudManagedConfig",
"legacyManagedConfigFile", "legacyManagedConfigFile",
"legacyManagedConfigMdm", "legacyManagedConfigMdm",
"unknown" "unknown"

1
schemas/v2/HookStartedNotification.json
View File

@@ -187,6 +187,7 @@
"sessionFlags", "sessionFlags",
"plugin", "plugin",
"cloudRequirements", "cloudRequirements",
"cloudManagedConfig",
"legacyManagedConfigFile", "legacyManagedConfigFile",
"legacyManagedConfigMdm", "legacyManagedConfigMdm",
"unknown" "unknown"

1
schemas/v2/HooksListResponse.json
View File

@@ -144,6 +144,7 @@
"sessionFlags", "sessionFlags",
"plugin", "plugin",
"cloudRequirements", "cloudRequirements",
"cloudManagedConfig",
"legacyManagedConfigFile", "legacyManagedConfigFile",
"legacyManagedConfigMdm", "legacyManagedConfigMdm",
"unknown" "unknown"

120
schemas/v2/ItemCompletedNotification.json
View File

@@ -312,10 +312,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -484,15 +512,16 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string",
"minLength": 1
},
"SubAgentActivityKind": {
"type": "string", "type": "string",
"enum": [ "enum": [
"none", "started",
"minimal", "interacted",
"low", "interrupted"
"medium",
"high",
"xhigh"
] ]
}, },
"TextElement": { "TextElement": {
@@ -528,6 +557,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -712,7 +747,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -805,6 +840,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -828,6 +873,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1012,6 +1058,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1070,6 +1148,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

9
schemas/v2/ItemGuardianApprovalReviewCompletedNotification.json
View File

@@ -83,7 +83,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -93,7 +93,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -134,7 +134,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -584,6 +584,9 @@
"high" "high"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"NetworkApprovalProtocol": { "NetworkApprovalProtocol": {
"type": "string", "type": "string",
"enum": [ "enum": [

9
schemas/v2/ItemGuardianApprovalReviewStartedNotification.json
View File

@@ -73,7 +73,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"write": { "write": {
@@ -83,7 +83,7 @@
"null" "null"
], ],
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
} }
} }
@@ -117,7 +117,7 @@
], ],
"properties": { "properties": {
"path": { "path": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"type": { "type": {
"type": "string", "type": "string",
@@ -567,6 +567,9 @@
"high" "high"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"NetworkApprovalProtocol": { "NetworkApprovalProtocol": {
"type": "string", "type": "string",
"enum": [ "enum": [

120
schemas/v2/ItemStartedNotification.json
View File

@@ -312,10 +312,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -484,15 +512,16 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string",
"minLength": 1
},
"SubAgentActivityKind": {
"type": "string", "type": "string",
"enum": [ "enum": [
"none", "started",
"minimal", "interacted",
"low", "interrupted"
"medium",
"high",
"xhigh"
] ]
}, },
"TextElement": { "TextElement": {
@@ -528,6 +557,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -712,7 +747,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -805,6 +840,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -828,6 +873,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1012,6 +1058,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1070,6 +1148,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

6
schemas/v2/ListMcpServerStatusParams.json
View File

@@ -29,6 +29,12 @@
], ],
"format": "uint32", "format": "uint32",
"minimum": 0.0 "minimum": 0.0
},
"threadId": {
"type": [
"string",
"null"
]
} }
}, },
"definitions": { "definitions": {

51
schemas/v2/ListMcpServerStatusResponse.json
View File

@@ -30,6 +30,47 @@
"oAuth" "oAuth"
] ]
}, },
"McpServerInfo": {
"description": "Presentation metadata advertised by an initialized MCP server.",
"type": "object",
"required": [
"name",
"version"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"icons": {
"type": [
"array",
"null"
],
"items": true
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"version": {
"type": "string"
},
"websiteUrl": {
"type": [
"string",
"null"
]
}
}
},
"McpServerStatus": { "McpServerStatus": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -58,6 +99,16 @@
"$ref": "#/definitions/Resource" "$ref": "#/definitions/Resource"
} }
}, },
"serverInfo": {
"anyOf": [
{
"$ref": "#/definitions/McpServerInfo"
},
{
"type": "null"
}
]
},
"tools": { "tools": {
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {

6
schemas/v2/McpServerStatusUpdatedNotification.json
View File

@@ -18,6 +18,12 @@
}, },
"status": { "status": {
"$ref": "#/definitions/McpServerStartupState" "$ref": "#/definitions/McpServerStartupState"
},
"threadId": {
"type": [
"string",
"null"
]
} }
}, },
"definitions": { "definitions": {

11
schemas/v2/ModelListResponse.json
View File

@@ -205,16 +205,9 @@
} }
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"ReasoningEffortOption": { "ReasoningEffortOption": {
"type": "object", "type": "object",

35
schemas/v2/ModelSafetyBufferingUpdatedNotification.json Normal file
View File

@@ -0,0 +1,35 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ModelSafetyBufferingUpdatedNotification",
"type": "object",
"required": [
"model",
"reasons",
"threadId",
"turnId",
"useCases"
],
"properties": {
"model": {
"type": "string"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"threadId": {
"type": "string"
},
"turnId": {
"type": "string"
},
"useCases": {
"type": "array",
"items": {
"type": "string"
}
}
}
}

5
schemas/v2/PermissionProfileListResponse.json
View File

@@ -24,9 +24,14 @@
"PermissionProfileSummary": { "PermissionProfileSummary": {
"type": "object", "type": "object",
"required": [ "required": [
"allowed",
"id" "id"
], ],
"properties": { "properties": {
"allowed": {
"description": "Whether the effective requirements allow selecting this profile.",
"type": "boolean"
},
"description": { "description": {
"description": "Optional user-facing description for display in clients.", "description": "Optional user-facing description for display in clients.",
"type": [ "type": [

12
schemas/v2/PluginInstallResponse.json
View File

@@ -23,10 +23,15 @@
"type": "object", "type": "object",
"required": [ "required": [
"id", "id",
"name", "name"
"needsAuth"
], ],
"properties": { "properties": {
"category": {
"type": [
"string",
"null"
]
},
"description": { "description": {
"type": [ "type": [
"string", "string",
@@ -44,9 +49,6 @@
}, },
"name": { "name": {
"type": "string" "type": "string"
},
"needsAuth": {
"type": "boolean"
} }
} }
}, },

3
schemas/v2/PluginListParams.json
View File

@@ -35,7 +35,8 @@
"local", "local",
"vertical", "vertical",
"workspace-directory", "workspace-directory",
"shared-with-me" "shared-with-me",
"created-by-me-remote"
] ]
} }
} }

94
schemas/v2/PluginReadResponse.json
View File

@@ -20,10 +20,15 @@
"type": "object", "type": "object",
"required": [ "required": [
"id", "id",
"name", "name"
"needsAuth"
], ],
"properties": { "properties": {
"category": {
"type": [
"string",
"null"
]
},
"description": { "description": {
"type": [ "type": [
"string", "string",
@@ -41,12 +46,78 @@
}, },
"name": { "name": {
"type": "string" "type": "string"
},
"needsAuth": {
"type": "boolean"
} }
} }
}, },
"AppTemplateSummary": {
"type": "object",
"required": [
"materializedAppIds",
"name",
"templateId"
],
"properties": {
"canonicalConnectorId": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"logoUrlDark": {
"type": [
"string",
"null"
]
},
"materializedAppIds": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"reason": {
"anyOf": [
{
"$ref": "#/definitions/AppTemplateUnavailableReason"
},
{
"type": "null"
}
]
},
"templateId": {
"type": "string"
}
}
},
"AppTemplateUnavailableReason": {
"type": "string",
"enum": [
"NOT_CONFIGURED_FOR_WORKSPACE",
"NO_ACTIVE_WORKSPACE"
]
},
"HookEventName": { "HookEventName": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -89,6 +160,7 @@
"PluginDetail": { "PluginDetail": {
"type": "object", "type": "object",
"required": [ "required": [
"appTemplates",
"apps", "apps",
"hooks", "hooks",
"marketplaceName", "marketplaceName",
@@ -97,6 +169,12 @@
"summary" "summary"
], ],
"properties": { "properties": {
"appTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/AppTemplateSummary"
}
},
"apps": { "apps": {
"type": "array", "type": "array",
"items": { "items": {
@@ -134,6 +212,12 @@
"type": "string" "type": "string"
} }
}, },
"shareUrl": {
"type": [
"string",
"null"
]
},
"skills": { "skills": {
"type": "array", "type": "array",
"items": { "items": {

293
schemas/v2/RawResponseItemCompletedNotification.json
View File

@@ -19,6 +19,50 @@
} }
}, },
"definitions": { "definitions": {
"AgentMessageInputContent": {
"oneOf": [
{
"type": "object",
"required": [
"text",
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"input_text"
],
"title": "InputTextAgentMessageInputContentType"
}
},
"title": "InputTextAgentMessageInputContent"
},
{
"type": "object",
"required": [
"encrypted_content",
"type"
],
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"encrypted_content"
],
"title": "EncryptedContentAgentMessageInputContentType"
}
},
"title": "EncryptedContentAgentMessageInputContent"
}
]
},
"ContentItem": { "ContentItem": {
"oneOf": [ "oneOf": [
{ {
@@ -184,10 +228,24 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"InternalChatMessageMetadataPassthrough": {
"description": "Internal Responses API passthrough metadata copied into underlying chat messages.\n\nResponses API strongly types this payload. Do not modify it without first getting API approval and making the corresponding Responses API change.",
"type": "object",
"properties": {
"turn_id": {
"type": [
"string",
"null"
]
}
}
},
"LocalShellAction": { "LocalShellAction": {
"oneOf": [ "oneOf": [
{ {
@@ -356,12 +414,21 @@
} }
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"phase": { "phase": {
"anyOf": [ "anyOf": [
{ {
@@ -385,6 +452,53 @@
}, },
"title": "MessageResponseItem" "title": "MessageResponseItem"
}, },
{
"type": "object",
"required": [
"author",
"content",
"recipient",
"type"
],
"properties": {
"author": {
"type": "string"
},
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/AgentMessageInputContent"
}
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"recipient": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"agent_message"
],
"title": "AgentMessageResponseItemType"
}
},
"title": "AgentMessageResponseItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -408,6 +522,22 @@
"null" "null"
] ]
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"summary": { "summary": {
"type": "array", "type": "array",
"items": { "items": {
@@ -444,12 +574,21 @@
}, },
"id": { "id": {
"description": "Legacy id field retained for compatibility with older payloads.", "description": "Legacy id field retained for compatibility with older payloads.",
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"$ref": "#/definitions/LocalShellStatus" "$ref": "#/definitions/LocalShellStatus"
}, },
@@ -479,12 +618,21 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": { "name": {
"type": "string" "type": "string"
}, },
@@ -523,12 +671,21 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"type": [ "type": [
"string", "string",
@@ -556,6 +713,22 @@
"call_id": { "call_id": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"output": { "output": {
"$ref": "#/definitions/FunctionCallOutputBody" "$ref": "#/definitions/FunctionCallOutputBody"
}, },
@@ -582,7 +755,6 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
@@ -591,6 +763,16 @@
"input": { "input": {
"type": "string" "type": "string"
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": { "name": {
"type": "string" "type": "string"
}, },
@@ -621,6 +803,22 @@
"call_id": { "call_id": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": { "name": {
"type": [ "type": [
"string", "string",
@@ -658,6 +856,22 @@
"execution": { "execution": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -692,12 +906,21 @@
] ]
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"type": [ "type": [
"string", "string",
@@ -717,14 +940,26 @@
{ {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"result", "result",
"status", "status",
"type" "type"
], ],
"properties": { "properties": {
"id": { "id": {
"type": "string" "type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
}, },
"result": { "result": {
"type": "string" "type": "string"
@@ -758,6 +993,22 @@
"encrypted_content": { "encrypted_content": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -774,6 +1025,16 @@
"type" "type"
], ],
"properties": { "properties": {
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -796,6 +1057,22 @@
"null" "null"
] ]
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [

120
schemas/v2/ReviewStartResponse.json
View File

@@ -440,10 +440,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -619,15 +647,16 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string",
"minLength": 1
},
"SubAgentActivityKind": {
"type": "string", "type": "string",
"enum": [ "enum": [
"none", "started",
"minimal", "interacted",
"low", "interrupted"
"medium",
"high",
"xhigh"
] ]
}, },
"TextElement": { "TextElement": {
@@ -663,6 +692,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -847,7 +882,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -940,6 +975,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -963,6 +1008,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1147,6 +1193,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1205,6 +1283,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

22
schemas/v2/SkillsExtraRootsSetParams.json Normal file
View File

@@ -0,0 +1,22 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "SkillsExtraRootsSetParams",
"type": "object",
"required": [
"extraRoots"
],
"properties": {
"extraRoots": {
"type": "array",
"items": {
"$ref": "#/definitions/AbsolutePathBuf"
}
}
},
"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"
}
}
}

5
schemas/v2/SkillsExtraRootsSetResponse.json Normal file
View File

@@ -0,0 +1,5 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "SkillsExtraRootsSetResponse",
"type": "object"
}

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

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

5
schemas/v2/ThreadDeleteResponse.json Normal file
View File

@@ -0,0 +1,5 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ThreadDeleteResponse",
"type": "object"
}

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

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

45
schemas/v2/ThreadForkParams.json
View File

@@ -56,14 +56,10 @@
"ephemeral": { "ephemeral": {
"type": "boolean" "type": "boolean"
}, },
"sandbox": { "serviceTier": {
"anyOf": [ "type": [
{ "string",
"$ref": "#/definitions/SandboxMode" "null"
},
{
"type": "null"
}
] ]
}, },
"model": { "model": {
@@ -79,15 +75,6 @@
"null" "null"
] ]
}, },
"serviceTier": {
"type": [
"string",
"null"
]
},
"threadId": {
"type": "string"
},
"threadSource": { "threadSource": {
"description": "Optional client-supplied analytics source classification for this forked thread.", "description": "Optional client-supplied analytics source classification for this forked thread.",
"anyOf": [ "anyOf": [
@@ -98,9 +85,26 @@
"type": "null" "type": "null"
} }
] ]
},
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
}
]
},
"threadId": {
"type": "string"
} }
}, },
"definitions": { "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"
},
"ApprovalsReviewer": { "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.", "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", "type": "string",
@@ -169,12 +173,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
} }
} }
} }

189
schemas/v2/ThreadForkResponse.json
View File

@@ -12,8 +12,11 @@
"thread" "thread"
], ],
"properties": { "properties": {
"thread": { "serviceTier": {
"$ref": "#/definitions/Thread" "type": [
"string",
"null"
]
}, },
"approvalPolicy": { "approvalPolicy": {
"$ref": "#/definitions/AskForApproval" "$ref": "#/definitions/AskForApproval"
@@ -30,11 +33,11 @@
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/AbsolutePathBuf"
}, },
"instructionSources": { "instructionSources": {
"description": "Instruction source files currently loaded for this thread.", "description": "Environment-native paths to instruction source files currently loaded for this thread.",
"default": [], "default": [],
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"model": { "model": {
@@ -43,6 +46,14 @@
"modelProvider": { "modelProvider": {
"type": "string" "type": "string"
}, },
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
"allOf": [
{
"$ref": "#/definitions/SandboxPolicy"
}
]
},
"reasoningEffort": { "reasoningEffort": {
"anyOf": [ "anyOf": [
{ {
@@ -53,19 +64,8 @@
} }
] ]
}, },
"serviceTier": { "thread": {
"type": [ "$ref": "#/definitions/Thread"
"string",
"null"
]
},
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
"allOf": [
{
"$ref": "#/definitions/SandboxPolicy"
}
]
} }
}, },
"definitions": { "definitions": {
@@ -598,10 +598,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -702,6 +730,15 @@
} }
] ]
}, },
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
},
"NetworkAccess": { "NetworkAccess": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -784,16 +821,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SandboxPolicy": { "SandboxPolicy": {
"oneOf": [ "oneOf": [
@@ -934,6 +964,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -1117,6 +1155,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -1128,6 +1173,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -1193,6 +1246,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1377,7 +1436,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1470,6 +1529,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1493,6 +1562,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1677,6 +1747,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1735,6 +1837,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1850,12 +1978,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

11
schemas/v2/ThreadListParams.json
View File

@@ -47,6 +47,10 @@
"type": "string" "type": "string"
} }
}, },
"useStateDbOnly": {
"description": "If true, return from the state DB without scanning JSONL rollouts to repair thread metadata. Omitted or false preserves scan-and-repair behavior.",
"type": "boolean"
},
"searchTerm": { "searchTerm": {
"description": "Optional substring filter for the extracted thread title.", "description": "Optional substring filter for the extracted thread title.",
"type": [ "type": [
@@ -85,10 +89,6 @@
"items": { "items": {
"$ref": "#/definitions/ThreadSourceKind" "$ref": "#/definitions/ThreadSourceKind"
} }
},
"useStateDbOnly": {
"description": "If true, return from the state DB without scanning JSONL rollouts to repair thread metadata. Omitted or false preserves scan-and-repair behavior.",
"type": "boolean"
} }
}, },
"definitions": { "definitions": {
@@ -116,7 +116,8 @@
"type": "string", "type": "string",
"enum": [ "enum": [
"created_at", "created_at",
"updated_at" "updated_at",
"recency_at"
] ]
}, },
"ThreadSourceKind": { "ThreadSourceKind": {

146
schemas/v2/ThreadListResponse.json
View File

@@ -478,10 +478,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -657,16 +685,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SessionSource": { "SessionSource": {
"oneOf": [ "oneOf": [
@@ -708,6 +729,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -891,6 +920,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -902,6 +938,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -967,6 +1011,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1151,7 +1201,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1244,6 +1294,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1267,6 +1327,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1451,6 +1512,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1509,6 +1602,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1624,12 +1743,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

146
schemas/v2/ThreadMetadataUpdateResponse.json
View File

@@ -461,10 +461,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -640,16 +668,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SessionSource": { "SessionSource": {
"oneOf": [ "oneOf": [
@@ -691,6 +712,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -874,6 +903,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -885,6 +921,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -950,6 +994,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1134,7 +1184,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1227,6 +1277,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1250,6 +1310,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1434,6 +1495,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1492,6 +1585,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1607,12 +1726,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

1
schemas/v2/ThreadReadParams.json
View File

@@ -8,7 +8,6 @@
"properties": { "properties": {
"includeTurns": { "includeTurns": {
"description": "When true, include turns and their items from rollout history.", "description": "When true, include turns and their items from rollout history.",
"default": false,
"type": "boolean" "type": "boolean"
}, },
"threadId": { "threadId": {

146
schemas/v2/ThreadReadResponse.json
View File

@@ -461,10 +461,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -640,16 +668,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SessionSource": { "SessionSource": {
"oneOf": [ "oneOf": [
@@ -691,6 +712,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -874,6 +903,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -885,6 +921,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -950,6 +994,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1134,7 +1184,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1227,6 +1277,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1250,6 +1310,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1434,6 +1495,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1492,6 +1585,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1607,12 +1726,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

399
schemas/v2/ThreadResumeParams.json
View File

@@ -53,6 +53,15 @@
"null" "null"
] ]
}, },
"serviceTier": {
"type": [
"string",
"null"
]
},
"threadId": {
"type": "string"
},
"personality": { "personality": {
"anyOf": [ "anyOf": [
{ {
@@ -63,16 +72,6 @@
} }
] ]
}, },
"sandbox": {
"anyOf": [
{
"$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
}
]
},
"model": { "model": {
"description": "Configuration overrides for the resumed thread, if any.", "description": "Configuration overrides for the resumed thread, if any.",
"type": [ "type": [
@@ -86,17 +85,66 @@
"null" "null"
] ]
}, },
"serviceTier": { "sandbox": {
"type": [ "anyOf": [
"string", {
"null" "$ref": "#/definitions/SandboxMode"
},
{
"type": "null"
}
] ]
},
"threadId": {
"type": "string"
} }
}, },
"definitions": { "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"
},
"AgentMessageInputContent": {
"oneOf": [
{
"type": "object",
"required": [
"text",
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"input_text"
],
"title": "InputTextAgentMessageInputContentType"
}
},
"title": "InputTextAgentMessageInputContent"
},
{
"type": "object",
"required": [
"encrypted_content",
"type"
],
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"encrypted_content"
],
"title": "EncryptedContentAgentMessageInputContentType"
}
},
"title": "EncryptedContentAgentMessageInputContent"
}
]
},
"ApprovalsReviewer": { "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.", "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", "type": "string",
@@ -321,10 +369,24 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"InternalChatMessageMetadataPassthrough": {
"description": "Internal Responses API passthrough metadata copied into underlying chat messages.\n\nResponses API strongly types this payload. Do not modify it without first getting API approval and making the corresponding Responses API change.",
"type": "object",
"properties": {
"turn_id": {
"type": [
"string",
"null"
]
}
}
},
"LocalShellAction": { "LocalShellAction": {
"oneOf": [ "oneOf": [
{ {
@@ -501,12 +563,21 @@
} }
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"phase": { "phase": {
"anyOf": [ "anyOf": [
{ {
@@ -530,6 +601,53 @@
}, },
"title": "MessageResponseItem" "title": "MessageResponseItem"
}, },
{
"type": "object",
"required": [
"author",
"content",
"recipient",
"type"
],
"properties": {
"author": {
"type": "string"
},
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/AgentMessageInputContent"
}
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"recipient": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"agent_message"
],
"title": "AgentMessageResponseItemType"
}
},
"title": "AgentMessageResponseItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -553,6 +671,22 @@
"null" "null"
] ]
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"summary": { "summary": {
"type": "array", "type": "array",
"items": { "items": {
@@ -589,12 +723,21 @@
}, },
"id": { "id": {
"description": "Legacy id field retained for compatibility with older payloads.", "description": "Legacy id field retained for compatibility with older payloads.",
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"$ref": "#/definitions/LocalShellStatus" "$ref": "#/definitions/LocalShellStatus"
}, },
@@ -624,12 +767,21 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": { "name": {
"type": "string" "type": "string"
}, },
@@ -668,12 +820,21 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"type": [ "type": [
"string", "string",
@@ -701,6 +862,22 @@
"call_id": { "call_id": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"output": { "output": {
"$ref": "#/definitions/FunctionCallOutputBody" "$ref": "#/definitions/FunctionCallOutputBody"
}, },
@@ -727,7 +904,6 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
@@ -736,6 +912,16 @@
"input": { "input": {
"type": "string" "type": "string"
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": { "name": {
"type": "string" "type": "string"
}, },
@@ -766,6 +952,22 @@
"call_id": { "call_id": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": { "name": {
"type": [ "type": [
"string", "string",
@@ -803,6 +1005,22 @@
"execution": { "execution": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -837,12 +1055,21 @@
] ]
}, },
"id": { "id": {
"writeOnly": true,
"type": [ "type": [
"string", "string",
"null" "null"
] ]
}, },
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": { "status": {
"type": [ "type": [
"string", "string",
@@ -862,14 +1089,26 @@
{ {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"result", "result",
"status", "status",
"type" "type"
], ],
"properties": { "properties": {
"id": { "id": {
"type": "string" "type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
}, },
"result": { "result": {
"type": "string" "type": "string"
@@ -903,6 +1142,22 @@
"encrypted_content": { "encrypted_content": {
"type": "string" "type": "string"
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -919,6 +1174,16 @@
"type" "type"
], ],
"properties": { "properties": {
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -941,6 +1206,22 @@
"null" "null"
] ]
}, },
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/definitions/InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"type": { "type": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -1077,6 +1358,74 @@
"workspace-write", "workspace-write",
"danger-full-access" "danger-full-access"
] ]
},
"SortDirection": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"ThreadResumeInitialTurnsPageParams": {
"type": "object",
"properties": {
"itemsView": {
"description": "How much item detail to include for each returned turn; defaults to summary.",
"anyOf": [
{
"$ref": "#/definitions/TurnItemsView"
},
{
"type": "null"
}
]
},
"limit": {
"description": "Optional turn page size.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0.0
},
"sortDirection": {
"description": "Optional turn pagination direction; defaults to descending.",
"anyOf": [
{
"$ref": "#/definitions/SortDirection"
},
{
"type": "null"
}
]
}
}
},
"TurnItemsView": {
"oneOf": [
{
"description": "`items` was not loaded for this turn. The field is intentionally empty.",
"type": "string",
"enum": [
"notLoaded"
]
},
{
"description": "`items` contains only a display summary for this turn.",
"type": "string",
"enum": [
"summary"
]
},
{
"description": "`items` contains every ThreadItem available from persisted app-server history for this turn.",
"type": "string",
"enum": [
"full"
]
}
]
} }
} }
} }

217
schemas/v2/ThreadResumeResponse.json
View File

@@ -12,11 +12,8 @@
"thread" "thread"
], ],
"properties": { "properties": {
"serviceTier": { "thread": {
"type": [ "$ref": "#/definitions/Thread"
"string",
"null"
]
}, },
"approvalPolicy": { "approvalPolicy": {
"$ref": "#/definitions/AskForApproval" "$ref": "#/definitions/AskForApproval"
@@ -32,12 +29,20 @@
"cwd": { "cwd": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/AbsolutePathBuf"
}, },
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
"allOf": [
{
"$ref": "#/definitions/SandboxPolicy"
}
]
},
"instructionSources": { "instructionSources": {
"description": "Instruction source files currently loaded for this thread.", "description": "Environment-native paths to instruction source files currently loaded for this thread.",
"default": [], "default": [],
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"model": { "model": {
@@ -46,6 +51,12 @@
"modelProvider": { "modelProvider": {
"type": "string" "type": "string"
}, },
"serviceTier": {
"type": [
"string",
"null"
]
},
"reasoningEffort": { "reasoningEffort": {
"anyOf": [ "anyOf": [
{ {
@@ -55,17 +66,6 @@
"type": "null" "type": "null"
} }
] ]
},
"thread": {
"$ref": "#/definitions/Thread"
},
"sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
"allOf": [
{
"$ref": "#/definitions/SandboxPolicy"
}
]
} }
}, },
"definitions": { "definitions": {
@@ -598,10 +598,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -702,6 +730,15 @@
} }
] ]
}, },
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
},
"NetworkAccess": { "NetworkAccess": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -784,16 +821,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SandboxPolicy": { "SandboxPolicy": {
"oneOf": [ "oneOf": [
@@ -934,6 +964,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -1117,6 +1155,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -1128,6 +1173,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -1193,6 +1246,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1377,7 +1436,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1470,6 +1529,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1493,6 +1562,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1677,6 +1747,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1735,6 +1837,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1850,12 +1978,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [
@@ -2061,6 +2184,32 @@
"inProgress" "inProgress"
] ]
}, },
"TurnsPage": {
"type": "object",
"required": [
"data"
],
"properties": {
"backwardsCursor": {
"type": [
"string",
"null"
]
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Turn"
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
}
},
"UserInput": { "UserInput": {
"oneOf": [ "oneOf": [
{ {

146
schemas/v2/ThreadRollbackResponse.json
View File

@@ -466,10 +466,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -645,16 +673,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SessionSource": { "SessionSource": {
"oneOf": [ "oneOf": [
@@ -696,6 +717,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -879,6 +908,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -890,6 +926,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -955,6 +999,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1139,7 +1189,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1232,6 +1282,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1255,6 +1315,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1439,6 +1500,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1497,6 +1590,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1612,12 +1731,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

40
schemas/v2/ThreadSettingsUpdatedNotification.json
View File

@@ -122,6 +122,15 @@
"default" "default"
] ]
}, },
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
},
"NetworkAccess": { "NetworkAccess": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -138,16 +147,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"ReasoningSummary": { "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", "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",
@@ -346,6 +348,16 @@
"modelProvider": { "modelProvider": {
"type": "string" "type": "string"
}, },
"summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
},
"personality": { "personality": {
"anyOf": [ "anyOf": [
{ {
@@ -364,16 +376,6 @@
"string", "string",
"null" "null"
] ]
},
"summary": {
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
} }
} }
} }

234
schemas/v2/ThreadStartParams.json
View File

@@ -49,6 +49,12 @@
"null" "null"
] ]
}, },
"serviceName": {
"type": [
"string",
"null"
]
},
"sandbox": { "sandbox": {
"anyOf": [ "anyOf": [
{ {
@@ -59,27 +65,21 @@
} }
] ]
}, },
"threadSource": {
"description": "Optional client-supplied analytics source classification for this thread.",
"anyOf": [
{
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
]
},
"ephemeral": { "ephemeral": {
"type": [ "type": [
"boolean", "boolean",
"null" "null"
] ]
}, },
"serviceTier": { "threadSource": {
"type": [ "description": "Optional client-supplied analytics source classification for this thread.",
"string", "anyOf": [
"null" {
"$ref": "#/definitions/ThreadSource"
},
{
"type": "null"
}
] ]
}, },
"personality": { "personality": {
@@ -104,6 +104,12 @@
"null" "null"
] ]
}, },
"serviceTier": {
"type": [
"string",
"null"
]
},
"sessionStartSource": { "sessionStartSource": {
"anyOf": [ "anyOf": [
{ {
@@ -113,12 +119,6 @@
"type": "null" "type": "null"
} }
] ]
},
"serviceName": {
"type": [
"string",
"null"
]
} }
}, },
"definitions": { "definitions": {
@@ -185,31 +185,144 @@
} }
] ]
}, },
"DynamicToolSpec": { "CapabilityRootLocation": {
"type": "object", "description": "Location used to resolve a selected capability root.",
"required": [ "oneOf": [
"description", {
"inputSchema", "description": "A path owned by an execution environment.",
"name" "type": "object",
], "required": [
"properties": { "environmentId",
"deferLoading": { "path",
"type": "boolean" "type"
}, ],
"description": { "properties": {
"type": "string" "environmentId": {
}, "type": "string"
"inputSchema": true, },
"name": { "path": {
"type": "string" "type": "string"
}, },
"namespace": { "type": {
"type": [ "type": "string",
"string", "enum": [
"null" "environment"
] ],
"title": "EnvironmentCapabilityRootLocationType"
}
},
"title": "EnvironmentCapabilityRootLocation"
} }
} ]
},
"DynamicToolNamespaceTool": {
"oneOf": [
{
"type": "object",
"required": [
"description",
"inputSchema",
"name",
"type"
],
"properties": {
"deferLoading": {
"type": "boolean"
},
"description": {
"type": "string"
},
"inputSchema": true,
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"function"
],
"title": "FunctionDynamicToolNamespaceToolType"
}
},
"title": "FunctionDynamicToolNamespaceTool"
}
]
},
"DynamicToolSpec": {
"oneOf": [
{
"type": "object",
"required": [
"description",
"inputSchema",
"name",
"type"
],
"properties": {
"deferLoading": {
"type": "boolean"
},
"description": {
"type": "string"
},
"inputSchema": true,
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"function"
],
"title": "FunctionDynamicToolSpecType"
}
},
"title": "FunctionDynamicToolSpec"
},
{
"type": "object",
"required": [
"description",
"name",
"tools",
"type"
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"tools": {
"type": "array",
"items": {
"$ref": "#/definitions/DynamicToolNamespaceTool"
}
},
"type": {
"type": "string",
"enum": [
"namespace"
],
"title": "NamespaceDynamicToolSpecType"
}
},
"title": "NamespaceDynamicToolSpec"
}
]
},
"LegacyAppPathString": {
"type": "string"
},
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
}, },
"Personality": { "Personality": {
"type": "string", "type": "string",
@@ -227,13 +340,30 @@
"danger-full-access" "danger-full-access"
] ]
}, },
"SelectedCapabilityRoot": {
"description": "A user-selected root that can expose one or more runtime capabilities.",
"type": "object",
"required": [
"id",
"location"
],
"properties": {
"id": {
"description": "Stable identifier supplied by the capability selection platform.",
"type": "string"
},
"location": {
"description": "Where the selected root can be resolved.",
"allOf": [
{
"$ref": "#/definitions/CapabilityRootLocation"
}
]
}
}
},
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStartSource": { "ThreadStartSource": {
"type": "string", "type": "string",
@@ -250,7 +380,7 @@
], ],
"properties": { "properties": {
"cwd": { "cwd": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"environmentId": { "environmentId": {
"type": "string" "type": "string"

165
schemas/v2/ThreadStartResponse.json
View File

@@ -33,11 +33,11 @@
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/AbsolutePathBuf"
}, },
"instructionSources": { "instructionSources": {
"description": "Instruction source files currently loaded for this thread.", "description": "Environment-native paths to instruction source files currently loaded for this thread.",
"default": [], "default": [],
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
}, },
"model": { "model": {
@@ -46,6 +46,9 @@
"modelProvider": { "modelProvider": {
"type": "string" "type": "string"
}, },
"thread": {
"$ref": "#/definitions/Thread"
},
"reasoningEffort": { "reasoningEffort": {
"anyOf": [ "anyOf": [
{ {
@@ -56,9 +59,6 @@
} }
] ]
}, },
"thread": {
"$ref": "#/definitions/Thread"
},
"sandbox": { "sandbox": {
"description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.", "description": "Legacy sandbox policy retained for compatibility. Experimental clients should prefer `activePermissionProfile` for profile provenance.",
"allOf": [ "allOf": [
@@ -598,10 +598,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -702,6 +730,15 @@
} }
] ]
}, },
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
},
"NetworkAccess": { "NetworkAccess": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -784,16 +821,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SandboxPolicy": { "SandboxPolicy": {
"oneOf": [ "oneOf": [
@@ -934,6 +964,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -1117,6 +1155,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -1128,6 +1173,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -1193,6 +1246,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1377,7 +1436,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1470,6 +1529,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1493,6 +1562,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1677,6 +1747,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1735,6 +1837,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1850,12 +1978,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

146
schemas/v2/ThreadStartedNotification.json
View File

@@ -461,10 +461,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -640,16 +668,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SessionSource": { "SessionSource": {
"oneOf": [ "oneOf": [
@@ -691,6 +712,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -874,6 +903,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -885,6 +921,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -950,6 +994,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1134,7 +1184,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1227,6 +1277,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1250,6 +1310,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1434,6 +1495,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1492,6 +1585,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1607,12 +1726,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

146
schemas/v2/ThreadUnarchiveResponse.json
View File

@@ -461,10 +461,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -640,16 +668,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"SessionSource": { "SessionSource": {
"oneOf": [ "oneOf": [
@@ -691,6 +712,14 @@
} }
] ]
}, },
"SubAgentActivityKind": {
"type": "string",
"enum": [
"started",
"interacted",
"interrupted"
]
},
"SubAgentSource": { "SubAgentSource": {
"oneOf": [ "oneOf": [
{ {
@@ -874,6 +903,13 @@
"null" "null"
] ]
}, },
"parentThreadId": {
"description": "The ID of the parent thread. This will only be set if this thread is a subagent.",
"type": [
"string",
"null"
]
},
"path": { "path": {
"description": "[UNSTABLE] Path to the thread on disk.", "description": "[UNSTABLE] Path to the thread on disk.",
"type": [ "type": [
@@ -885,6 +921,14 @@
"description": "Usually the first user message in the thread, if available.", "description": "Usually the first user message in the thread, if available.",
"type": "string" "type": "string"
}, },
"recencyAt": {
"description": "Unix timestamp (in seconds) used for thread recency ordering.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"sessionId": { "sessionId": {
"description": "Session id shared by threads that belong to the same session tree.", "description": "Session id shared by threads that belong to the same session tree.",
"type": "string" "type": "string"
@@ -950,6 +994,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -1134,7 +1184,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -1227,6 +1277,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -1250,6 +1310,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1434,6 +1495,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1492,6 +1585,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1607,12 +1726,7 @@
] ]
}, },
"ThreadSource": { "ThreadSource": {
"type": "string", "type": "string"
"enum": [
"user",
"subagent",
"memory_consolidation"
]
}, },
"ThreadStatus": { "ThreadStatus": {
"oneOf": [ "oneOf": [

120
schemas/v2/TurnCompletedNotification.json
View File

@@ -439,10 +439,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -618,15 +646,16 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string",
"minLength": 1
},
"SubAgentActivityKind": {
"type": "string", "type": "string",
"enum": [ "enum": [
"none", "started",
"minimal", "interacted",
"low", "interrupted"
"medium",
"high",
"xhigh"
] ]
}, },
"TextElement": { "TextElement": {
@@ -662,6 +691,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -846,7 +881,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -939,6 +974,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -962,6 +1007,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1146,6 +1192,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1204,6 +1282,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

19
schemas/v2/TurnModerationMetadataNotification.json Normal file
View File

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

103
schemas/v2/TurnStartParams.json
View File

@@ -7,6 +7,9 @@
"threadId" "threadId"
], ],
"properties": { "properties": {
"threadId": {
"type": "string"
},
"approvalPolicy": { "approvalPolicy": {
"description": "Override the approval policy for this turn and subsequent turns.", "description": "Override the approval policy for this turn and subsequent turns.",
"anyOf": [ "anyOf": [
@@ -29,6 +32,12 @@
} }
] ]
}, },
"clientUserMessageId": {
"type": [
"string",
"null"
]
},
"serviceTier": { "serviceTier": {
"description": "Override the service tier for this turn and subsequent turns.", "description": "Override the service tier for this turn and subsequent turns.",
"type": [ "type": [
@@ -54,8 +63,16 @@
} }
] ]
}, },
"threadId": { "personality": {
"type": "string" "description": "Override the personality for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
}, },
"input": { "input": {
"type": "array", "type": "array",
@@ -70,6 +87,17 @@
"null" "null"
] ]
}, },
"summary": {
"description": "Override the reasoning summary for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
},
"outputSchema": { "outputSchema": {
"description": "Optional JSON Schema used to constrain the final assistant message for this turn." "description": "Optional JSON Schema used to constrain the final assistant message for this turn."
}, },
@@ -83,28 +111,6 @@
"type": "null" "type": "null"
} }
] ]
},
"personality": {
"description": "Override the personality for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/Personality"
},
{
"type": "null"
}
]
},
"summary": {
"description": "Override the reasoning summary for this turn and subsequent turns.",
"anyOf": [
{
"$ref": "#/definitions/ReasoningSummary"
},
{
"type": "null"
}
]
} }
}, },
"definitions": { "definitions": {
@@ -112,6 +118,28 @@
"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.", "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" "type": "string"
}, },
"AdditionalContextEntry": {
"type": "object",
"required": [
"kind",
"value"
],
"properties": {
"kind": {
"$ref": "#/definitions/AdditionalContextKind"
},
"value": {
"type": "string"
}
}
},
"AdditionalContextKind": {
"type": "string",
"enum": [
"untrusted",
"application"
]
},
"ApprovalsReviewer": { "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.", "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", "type": "string",
@@ -209,10 +237,15 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"ModeKind": { "ModeKind": {
"description": "Initial collaboration mode to use when the TUI starts.", "description": "Initial collaboration mode to use when the TUI starts.",
"type": "string", "type": "string",
@@ -221,6 +254,15 @@
"default" "default"
] ]
}, },
"MultiAgentMode": {
"description": "Controls whether the model receives multi-agent delegation instructions and, when it does, whether it should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help. `none` leaves the multi-agent tools available without injecting delegation instructions.",
"type": "string",
"enum": [
"none",
"explicitRequestOnly",
"proactive"
]
},
"NetworkAccess": { "NetworkAccess": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -237,16 +279,9 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string", "type": "string",
"enum": [ "minLength": 1
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
]
}, },
"ReasoningSummary": { "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", "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",
@@ -426,7 +461,7 @@
], ],
"properties": { "properties": {
"cwd": { "cwd": {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
}, },
"environmentId": { "environmentId": {
"type": "string" "type": "string"

120
schemas/v2/TurnStartResponse.json
View File

@@ -435,10 +435,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -614,15 +642,16 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string",
"minLength": 1
},
"SubAgentActivityKind": {
"type": "string", "type": "string",
"enum": [ "enum": [
"none", "started",
"minimal", "interacted",
"low", "interrupted"
"medium",
"high",
"xhigh"
] ]
}, },
"TextElement": { "TextElement": {
@@ -658,6 +687,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -842,7 +877,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -935,6 +970,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -958,6 +1003,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1142,6 +1188,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1200,6 +1278,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

120
schemas/v2/TurnStartedNotification.json
View File

@@ -439,10 +439,38 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]
}, },
"LegacyAppPathString": {
"type": "string"
},
"McpToolCallAppContext": {
"type": "object",
"required": [
"connectorId"
],
"properties": {
"connectorId": {
"type": "string"
},
"linkId": {
"type": [
"string",
"null"
]
},
"resourceUri": {
"type": [
"string",
"null"
]
}
}
},
"McpToolCallError": { "McpToolCallError": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -618,15 +646,16 @@
] ]
}, },
"ReasoningEffort": { "ReasoningEffort": {
"description": "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning", "description": "A non-empty reasoning effort value advertised by the model.",
"type": "string",
"minLength": 1
},
"SubAgentActivityKind": {
"type": "string", "type": "string",
"enum": [ "enum": [
"none", "started",
"minimal", "interacted",
"low", "interrupted"
"medium",
"high",
"xhigh"
] ]
}, },
"TextElement": { "TextElement": {
@@ -662,6 +691,12 @@
"type" "type"
], ],
"properties": { "properties": {
"clientId": {
"type": [
"string",
"null"
]
},
"content": { "content": {
"type": "array", "type": "array",
"items": { "items": {
@@ -846,7 +881,7 @@
"description": "The command's working directory.", "description": "The command's working directory.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/AbsolutePathBuf" "$ref": "#/definitions/LegacyAppPathString"
} }
] ]
}, },
@@ -939,6 +974,16 @@
"type" "type"
], ],
"properties": { "properties": {
"appContext": {
"anyOf": [
{
"$ref": "#/definitions/McpToolCallAppContext"
},
{
"type": "null"
}
]
},
"arguments": true, "arguments": true,
"durationMs": { "durationMs": {
"description": "The duration of the MCP tool call in milliseconds.", "description": "The duration of the MCP tool call in milliseconds.",
@@ -962,6 +1007,7 @@
"type": "string" "type": "string"
}, },
"mcpAppResourceUri": { "mcpAppResourceUri": {
"description": "Deprecated: use `appContext.resourceUri` instead.",
"type": [ "type": [
"string", "string",
"null" "null"
@@ -1146,6 +1192,38 @@
}, },
"title": "CollabAgentToolCallThreadItem" "title": "CollabAgentToolCallThreadItem"
}, },
{
"type": "object",
"required": [
"agentPath",
"agentThreadId",
"id",
"kind",
"type"
],
"properties": {
"agentPath": {
"type": "string"
},
"agentThreadId": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/SubAgentActivityKind"
},
"type": {
"type": "string",
"enum": [
"subAgentActivity"
],
"title": "SubAgentActivityThreadItemType"
}
},
"title": "SubAgentActivityThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [
@@ -1204,6 +1282,32 @@
}, },
"title": "ImageViewThreadItem" "title": "ImageViewThreadItem"
}, },
{
"type": "object",
"required": [
"durationMs",
"id",
"type"
],
"properties": {
"durationMs": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sleep"
],
"title": "SleepThreadItemType"
}
},
"title": "SleepThreadItem"
},
{ {
"type": "object", "type": "object",
"required": [ "required": [

36
schemas/v2/TurnSteerParams.json
View File

@@ -8,6 +8,15 @@
"threadId" "threadId"
], ],
"properties": { "properties": {
"threadId": {
"type": "string"
},
"clientUserMessageId": {
"type": [
"string",
"null"
]
},
"expectedTurnId": { "expectedTurnId": {
"description": "Required active turn id precondition. The request fails when it does not match the currently active turn.", "description": "Required active turn id precondition. The request fails when it does not match the currently active turn.",
"type": "string" "type": "string"
@@ -17,12 +26,31 @@
"items": { "items": {
"$ref": "#/definitions/UserInput" "$ref": "#/definitions/UserInput"
} }
},
"threadId": {
"type": "string"
} }
}, },
"definitions": { "definitions": {
"AdditionalContextEntry": {
"type": "object",
"required": [
"kind",
"value"
],
"properties": {
"kind": {
"$ref": "#/definitions/AdditionalContextKind"
},
"value": {
"type": "string"
}
}
},
"AdditionalContextKind": {
"type": "string",
"enum": [
"untrusted",
"application"
]
},
"ByteRange": { "ByteRange": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -45,6 +73,8 @@
"ImageDetail": { "ImageDetail": {
"type": "string", "type": "string",
"enum": [ "enum": [
"auto",
"low",
"high", "high",
"original" "original"
] ]