detektu
OpenAI API changes
Info

Webhook added

openapi:* *::operation.webhook-added
Product
OpenAI API
Source
OpenAPI URL
Change kind
Webhook Added
Detected
Last updated

Deterministic evidence

Before / after

Extracted from OpenAI's published contract. Shows the shared components — a narrower excerpt was not available for this change. Open the source ↗

−5+90529 changes

1 / 29
"encrypted_content"
"encrypted_content"
]
]
},
},
"AgentEnvironmentEvent": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"AgentEnvironmentListResource": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PublicEnvironmentResource"
},
"maxItems": 2000,
"type": "array"
},
"first_id": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"last_id": {
"type": [
"string",
"null"
]
},
"object": {
"default": "list",
"enum": [
"list"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"object",
"data",
"first_id",
"last_id",
"has_more"
],
"type": "object"
},
"AgentListResource": {
"AgentListResource": {
"additionalProperties": false,
"additionalProperties": false,
"properties": {
"properties": {
"name": "Costs object"
"name": "Costs object"
}
}
},
},
"CreateAgentEnvironmentParams": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/components/schemas/CreateEnvironmentParam"
},
"vault_ids": {
"items": {
"maxLength": 1048576,
"type": "string"
},
"maxItems": 10,
"type": [
"array",
"null"
]
}
},
"required": [
"environment"
],
"type": "object"
},
"CreateAgentParams": {
"CreateAgentParams": {
"additionalProperties": false,
"additionalProperties": false,
"properties": {
"properties": {
],
],
"type": "object"
"type": "object"
},
},
"CreateEnvironmentParam": {
"discriminator": {
"mapping": {
"openai_hosted": "#/components/schemas/CreateEnvironmentParamOpenaiHosted"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/CreateEnvironmentParamOpenaiHosted"
}
],
"x-oai-discriminator-values": [
"openai_hosted"
]
},
"CreateEnvironmentParamOpenaiHosted": {
"additionalProperties": false,
"properties": {
"capability_directories": {
"items": {
"maxLength": 1048576,
"type": "string"
},
"maxItems": 16384,
"type": [
"array",
"null"
]
},
"desktop": {
"anyOf": [
{
"$ref": "#/components/schemas/DesktopParam"
},
{
"type": "null"
}
]
},
"env": {
"additionalProperties": {
"maxLength": 1048576,
"type": "string"
},
"maxProperties": 1024,
"propertyNames": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"type": [
"object",
"null"
]
},
"environment_template_id": {
"maxLength": 64,
"type": "string"
},
"files": {
"items": {
"$ref": "#/components/schemas/HostedEnvironmentFileParam"
},
"maxItems": 50,
"type": [
"array",
"null"
]
},
"network": {
"anyOf": [
{
"$ref": "#/components/schemas/NetworkPolicyParam"
},
{
"type": "null"
}
]
},
"packages": {
"anyOf": [
{
"$ref": "#/components/schemas/EnvironmentPackagesParam"
},
{
"type": "null"
}
]
},
"plugins": {
"items": {
"$ref": "#/components/schemas/HostedPluginParam"
},
"maxItems": 32,
"type": [
"array",
"null"
]
},
"setup_commands": {
"items": {
"$ref": "#/components/schemas/SetupCommandParam"
},
"maxItems": 16,
"type": [
"array",
"null"
]
},
"skills": {
"items": {
"$ref": "#/components/schemas/HostedSkillParam"
},
"maxItems": 200,
"type": [
"array",
"null"
]
},
"type": {
"default": "openai_hosted",
"enum": [
"openai_hosted"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"CreateEnvironmentTemplateParams": {
"CreateEnvironmentTemplateParams": {
"additionalProperties": false,
"additionalProperties": false,
"properties": {
"properties": {
},
},
"image_url": {
"image_url": {
"maxLength": 1073741824,
"maxLength": 1073741824,
"pattern": "^data:",
"pattern": "^(data:|https?://)",
"type": "string"
"type": "string"
},
},
"type": {
"type": {
},
},
"EnvironmentParamOpenaiHosted": {
"EnvironmentParamOpenaiHosted": {
"additionalProperties": false,
"additionalProperties": false,
"not": {
"anyOf": [
{
"required": [
"packages"
]
},
{
"required": [
"setup_commands"
]
},
{
"required": [
"network"
]
},
{
"required": [
"desktop"
]
},
{
"required": [
"env"
]
},
{
"required": [
"capability_directories"
]
},
{
"required": [
"skills"
]
},
{
"required": [
"plugins"
]
},
{
"required": [
"files"
]
},
{
"required": [
"environment_template_id"
]
},
{
"required": [
"container_size"
]
}
],
"required": [
"environment_id"
]
},
"properties": {
"properties": {
"capability_directories": {
"capability_directories": {
"items": {
"items": {
"null"
"null"
]
]
},
},
"environment_id": {
"maxLength": 256,
"minLength": 9,
"type": "string"
},
"environment_template_id": {
"environment_template_id": {
"maxLength": 64,
"maxLength": 64,
"type": "string"
"type": "string"
"EnvironmentStatusResource": {
"EnvironmentStatusResource": {
"enum": [
"enum": [
"pending",
"pending",
"ready",
"connected",
"connected",
"disconnected",
"disconnected",
"suspended",
"expired",
"expired",
"failed"
"failed"
],
],
"type": "string",
"type": "string",
"x-enumDescriptions": [
"x-enumDescriptions": [
"",
"",
"Provisioning succeeded and the environment is available for attachment or use.",
"",
"",
"",
"",
"The sandbox is stopped and can be resumed from its private checkpoint.",
"",
"",
""
""
]
]
],
],
"type": "object"
"type": "object"
},
},
"EnvironmentTypeParam": {
"enum": [
"openai_hosted"
],
"type": "string"
},
"EnvironmentTypeResource": {
"EnvironmentTypeResource": {
"enum": [
"enum": [
"openai_hosted",
"openai_hosted",
"type": "object",
"type": "object",
"x-oaiMeta": {}
"x-oaiMeta": {}
},
},
"LiveAllowedToolsChoiceParam": {
"properties": {
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/LiveToolChoiceValueEnum"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"discriminator": {
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/LiveFunctionToolChoiceParam"
},
{
"$ref": "#/components/schemas/LiveMCPToolChoiceParam"
},
{
"$ref": "#/components/schemas/LiveSpecificFileSearchParam"
},
{
"$ref": "#/components/schemas/LiveSpecificWebSearchParam"
},
{
"$ref": "#/components/schemas/LiveSpecificWebSearchPreviewParam"
},
{
"$ref": "#/components/schemas/LiveSpecificImageGenParam"
},
{
"$ref": "#/components/schemas/LiveSpecificComputerParam"
},
{
"$ref": "#/components/schemas/LiveSpecificCodeInterpreterParam"
},
{
"$ref": "#/components/schemas/LiveSpecificProgrammaticToolCallingParam"
},
{
"$ref": "#/components/schemas/LiveSpecificFunctionShellParam"
},
{
"$ref": "#/components/schemas/LiveSpecificCustomToolParam"
},
{
"$ref": "#/components/schemas/LiveSpecificApplyPatchParam"
}
]
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"type": {
"default": "allowed_tools",
"enum": [
"allowed_tools"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"tools"
],
"type": "object"
},
"LiveApplyPatchToolInputParam": {
"LiveApplyPatchToolInputParam": {
"properties": {
"properties": {
"type": {
"type": {
"type": "object",
"type": "object",
"x-oaiMeta": {}
"x-oaiMeta": {}
},
},
"LiveFunctionToolChoiceParam": {
"properties": {
"name": {
"type": "string"
},
"type": {
"default": "function",
"enum": [
"function"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"LiveFunctionToolInputParam": {
"LiveFunctionToolInputParam": {
"properties": {
"properties": {
"name": {
"name": {
],
],
"type": "object"
"type": "object"
},
},
"LiveMCPToolChoiceParam": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"server_label": {
"type": "string"
},
"type": {
"default": "mcp",
"enum": [
"mcp"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"server_label"
],
"type": "object"
},
"LiveMCPToolInputParam": {
"LiveMCPToolInputParam": {
"properties": {
"properties": {
"type": {
"type": {
"$ref": "#/components/schemas/LiveToolChoiceEnum"
"$ref": "#/components/schemas/LiveToolChoiceEnum"
},
},
{
{
"additionalProperties": {},
"discriminator": {
"type": "object"
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/LiveFunctionToolChoiceParam"
},
{
"$ref": "#/components/schemas/LiveMCPToolChoiceParam"
},
{
"$ref": "#/components/schemas/LiveSpecificFileSearchParam"
},
{
"$ref": "#/components/schemas/LiveSpecificWebSearchParam"
},
{
"$ref": "#/components/schemas/LiveSpecificWebSearchPreviewParam"
},
{
"$ref": "#/components/schemas/LiveSpecificImageGenParam"
},
{
"$ref": "#/components/schemas/LiveSpecificComputerParam"
},
{
"$ref": "#/components/schemas/LiveSpecificCodeInterpreterParam"
},
{
"$ref": "#/components/schemas/LiveSpecificProgrammaticToolCallingParam"
},
{
"$ref": "#/components/schemas/LiveSpecificFunctionShellParam"
},
{
"$ref": "#/components/schemas/LiveSpecificCustomToolParam"
},
{
"$ref": "#/components/schemas/LiveSpecificApplyPatchParam"
}
]
},
{
"$ref": "#/components/schemas/LiveAllowedToolsChoiceParam"
}
}
]
]
},
},
"$ref": "#/components/schemas/LiveToolChoiceEnum"
"$ref": "#/components/schemas/LiveToolChoiceEnum"
},
},
{
{
"additionalProperties": {},
"discriminator": {
"type": "object"
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/LiveFunctionToolChoiceParam"
},
{
"$ref": "#/components/schemas/LiveMCPToolChoiceParam"
},
{
"$ref": "#/components/schemas/LiveSpecificFileSearchParam"
},
{
"$ref": "#/components/schemas/LiveSpecificWebSearchParam"
},
{
"$ref": "#/components/schemas/LiveSpecificWebSearchPreviewParam"
},
{
"$ref": "#/components/schemas/LiveSpecificImageGenParam"
},
{
"$ref": "#/components/schemas/LiveSpecificComputerParam"
},
{
"$ref": "#/components/schemas/LiveSpecificCodeInterpreterParam"
},
{
"$ref": "#/components/schemas/LiveSpecificProgrammaticToolCallingParam"
},
{
"$ref": "#/components/schemas/LiveSpecificFunctionShellParam"
},
{
"$ref": "#/components/schemas/LiveSpecificCustomToolParam"
},
{
"$ref": "#/components/schemas/LiveSpecificApplyPatchParam"
}
]
},
{
"$ref": "#/components/schemas/LiveAllowedToolsChoiceParam"
}
}
]
]
},
},
],
],
"type": "object"
"type": "object"
},
},
"LiveSpecificApplyPatchParam": {
"properties": {
"type": {
"default": "apply_patch",
"enum": [
"apply_patch"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"title": "Specific apply patch tool choice",
"type": "object"
},
"LiveSpecificCodeInterpreterParam": {
"properties": {
"type": {
"default": "code_interpreter",
"enum": [
"code_interpreter"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveSpecificComputerParam": {
"properties": {
"type": {
"default": "computer",
"enum": [
"computer"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveSpecificCustomToolParam": {
"properties": {
"name": {
"type": "string"
},
"type": {
"default": "custom",
"enum": [
"custom"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"LiveSpecificFileSearchParam": {
"properties": {
"type": {
"default": "file_search",
"enum": [
"file_search"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveSpecificFunctionShellParam": {
"properties": {
"type": {
"default": "shell",
"enum": [
"shell"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"title": "Specific shell tool choice",
"type": "object"
},
"LiveSpecificImageGenParam": {
"properties": {
"type": {
"default": "image_generation",
"enum": [
"image_generation"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveSpecificProgrammaticToolCallingParam": {
"properties": {
"type": {
"default": "programmatic_tool_calling",
"enum": [
"programmatic_tool_calling"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveSpecificWebSearchParam": {
"properties": {
"type": {
"default": "web_search",
"enum": [
"web_search"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveSpecificWebSearchPreviewParam": {
"properties": {
"type": {
"default": "web_search_preview",
"enum": [
"web_search_preview"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type"
],
"type": "object"
},
"LiveTextVerbosity": {
"LiveTextVerbosity": {
"enum": [
"enum": [
"low",
"low",
],
],
"type": "string"
"type": "string"
},
},
"LiveToolChoiceValueEnum": {
"enum": [
"none",
"auto",
"required"
],
"type": "string"
},
"LiveToolSearchToolInputParam": {
"LiveToolSearchToolInputParam": {
"properties": {
"properties": {
"type": {
"type": {
"realtime.call.incoming",
"realtime.call.incoming",
"video.completed",
"video.completed",
"video.failed",
"video.failed",
"agent.environment.ready",
"agent.environment.failed",
"agent.environment.suspended",
"agent.environment.expired",
"agent.session.created",
"agent.session.created",
"agent.session.action_required",
"agent.session.action_required",
"agent.session.in_progress",
"agent.session.in_progress",
"format": "unixtime",
"format": "unixtime",
"type": "integer"
"type": "integer"
},
},
"detailed_explanation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"error_type": {
"error_type": {
"$ref": "#/components/schemas/SafetyAlertErrorType"
"$ref": "#/components/schemas/SafetyAlertErrorType"
},
},
"ready",
"ready",
"connected",
"connected",
"disconnected",
"disconnected",
"suspended",
"expired",
"failed"
"failed"
],
],
"type": "string",
"type": "string",
"The environment is ready to connect.",
"The environment is ready to connect.",
"The environment is connected.",
"The environment is connected.",
"The environment is disconnected.",
"The environment is disconnected.",
"The environment is stopped and can be resumed from its private checkpoint.",
"The environment and its private checkpoint have expired.",
"The environment failed to connect."
"The environment failed to connect."
]
]
},
},
"agent.session.created": "#/components/schemas/SessionEventAgentSessionCreated",
"agent.session.created": "#/components/schemas/SessionEventAgentSessionCreated",
"agent.session.environment.connected": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected",
"agent.session.environment.connected": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected",
"agent.session.environment.disconnected": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected",
"agent.session.environment.disconnected": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected",
"agent.session.environment.expired": "#/components/schemas/SessionEventAgentSessionEnvironmentExpired",
"agent.session.environment.failed": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed",
"agent.session.environment.failed": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed",
"agent.session.environment.pending": "#/components/schemas/SessionEventAgentSessionEnvironmentPending",
"agent.session.environment.pending": "#/components/schemas/SessionEventAgentSessionEnvironmentPending",
"agent.session.environment.ready": "#/components/schemas/SessionEventAgentSessionEnvironmentReady",
"agent.session.environment.ready": "#/components/schemas/SessionEventAgentSessionEnvironmentReady",
"agent.session.environment.reset": "#/components/schemas/SessionEventAgentSessionEnvironmentReset",
"agent.session.environment.reset": "#/components/schemas/SessionEventAgentSessionEnvironmentReset",
"agent.session.environment.suspended": "#/components/schemas/SessionEventAgentSessionEnvironmentSuspended",
"agent.session.failed": "#/components/schemas/SessionEventAgentSessionFailed",
"agent.session.failed": "#/components/schemas/SessionEventAgentSessionFailed",
"agent.session.idle": "#/components/schemas/SessionEventAgentSessionIdle",
"agent.session.idle": "#/components/schemas/SessionEventAgentSessionIdle",
"agent.session.in_progress": "#/components/schemas/SessionEventAgentSessionInProgress",
"agent.session.in_progress": "#/components/schemas/SessionEventAgentSessionInProgress",
"$ref": "#/components/schemas/SessionEventAgentSessionEnvironmentReady"
"$ref": "#/components/schemas/SessionEventAgentSessionEnvironmentReady"
},
},
{
{
"$ref": "#/components/schemas/SessionEventAgentSessionEnvironmentSuspended"
},
{
"$ref": "#/components/schemas/SessionEventAgentSessionEnvironmentExpired"
},
{
"$ref": "#/components/schemas/SessionEventAgentSessionEnvironmentReset"
"$ref": "#/components/schemas/SessionEventAgentSessionEnvironmentReset"
},
},
{
{
"x-oai-discriminator-values": [
"x-oai-discriminator-values": [
"error",
"error",
"agent.session.environment.ready",
"agent.session.environment.ready",
"agent.session.environment.suspended",
"agent.session.environment.expired",
"agent.session.environment.reset",
"agent.session.environment.reset",
"agent.output.command_execution_output.delta",
"agent.output.command_execution_output.delta",
"agent.session.created",
"agent.session.created",
],
],
"type": "object"
"type": "object"
},
},
"SessionEventAgentSessionEnvironmentExpired": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/components/schemas/SessionEnvironmentStateResource"
},
"event_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"turn_id": {
"type": [
"string",
"null"
]
},
"type": {
"default": "agent.session.environment.expired",
"enum": [
"agent.session.environment.expired"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"event_id",
"session_id",
"turn_id",
"environment"
],
"type": "object"
},
"SessionEventAgentSessionEnvironmentFailed": {
"SessionEventAgentSessionEnvironmentFailed": {
"additionalProperties": false,
"additionalProperties": false,
"properties": {
"properties": {
],
],
"type": "object"
"type": "object"
},
},
"SessionEventAgentSessionEnvironmentSuspended": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/components/schemas/SessionEnvironmentStateResource"
},
"event_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"turn_id": {
"type": [
"string",
"null"
]
},
"type": {
"default": "agent.session.environment.suspended",
"enum": [
"agent.session.environment.suspended"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"event_id",
"session_id",
"turn_id",
"environment"
],
"type": "object"
},
"SessionEventAgentSessionFailed": {
"SessionEventAgentSessionFailed": {
"additionalProperties": false,
"additionalProperties": false,
"properties": {
"properties": {
],
],
"title": "Web search tool call",
"title": "Web search tool call",
"type": "object"
"type": "object"
},
"WebhookAgentEnvironmentExpired": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentEnvironmentEvent"
},
"type": {
"enum": [
"agent.environment.expired"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.environment.expired",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.environment.expired"
}
},
"WebhookAgentEnvironmentFailed": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentEnvironmentEvent"
},
"type": {
"enum": [
"agent.environment.failed"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.environment.failed",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.environment.failed"
}
},
"WebhookAgentEnvironmentReady": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentEnvironmentEvent"
},
"type": {
"enum": [
"agent.environment.ready"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.environment.ready",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.environment.ready"
}
},
"WebhookAgentEnvironmentSuspended": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentEnvironmentEvent"
},
"type": {
"enum": [
"agent.environment.suspended"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.environment.suspended",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.environment.suspended"
}
},
},
"WebhookAgentSessionActionRequired": {
"WebhookAgentSessionActionRequired": {
"allOf": [
"allOf": [

Monitored for you

Does this change affect your integration?

Choose the operations and fields your services use. Detektu matches OpenAI findings to that declared usage so your team can review the relevant evidence. No agent or repository access required.

Monitor OpenAI free See pricing