From 0c7b7663330ab384008d5b132e9f66db47ef2488 Mon Sep 17 00:00:00 2001 From: jessli Date: Thu, 11 Jun 2026 16:39:09 -0700 Subject: [PATCH 1/5] rebase to /feature/foundry-release and merge sqush jugonzales/agents-optimization-v2preview --- .../PostgreSql/lease.yaml | 5 - .../v1/microsoft-foundry-openapi3.json | 5441 ++-------- .../v1/microsoft-foundry-openapi3.yaml | 5781 +++-------- .../microsoft-foundry-openapi3.json | 9203 ++++------------- .../microsoft-foundry-openapi3.yaml | 5828 +++-------- .../src/agents-optimization/models.tsp | 321 +- .../src/agents-optimization/routes.tsp | 222 +- .../Foundry/src/servicepatterns.tsp | 2 +- 8 files changed, 6209 insertions(+), 20594 deletions(-) delete mode 100644 .github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml diff --git a/.github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml b/.github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml deleted file mode 100644 index a73ff4c971fd..000000000000 --- a/.github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml +++ /dev/null @@ -1,5 +0,0 @@ -lease: - resource-provider: Microsoft.DBforPostgreSQL - startdate: "2026-06-05" - duration: P180D - reviewer: "@vikeshi26" diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json index 3fa3fc7112b3..b0bff6ecd0e6 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json @@ -221,8 +221,8 @@ "/agent_optimization_jobs": { "post": { "operationId": "AgentOptimizationJobs_create", - "summary": "Create an agent optimization job", - "description": "Creates an agent optimization job and returns the queued job.\nHonors `Operation-Id` for idempotent retry.", + "summary": "Creates an agent optimization job.", + "description": "Create an optimization job. Returns 201 with the queued job. Honours `Operation-Id` for idempotent retry.", "parameters": [ { "name": "Foundry-Features", @@ -232,7 +232,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -312,22 +312,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OptimizationJob" } } }, - "description": "The optimization job inputs." + "description": "The job to create." }, "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, "get": { "operationId": "AgentOptimizationJobs_list", - "summary": "List agent optimization jobs", - "description": "Returns agent optimization jobs with cursor pagination and optional lifecycle or agent filters.", + "summary": "Returns a list of agent optimization jobs.", + "description": "List optimization jobs. Supports cursor pagination and optional status / agent_name filters.", "parameters": [ { "name": "Foundry-Features", @@ -337,7 +337,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -429,7 +429,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/OptimizationJobListItem" }, "description": "The requested list of items." }, @@ -477,7 +477,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } @@ -485,8 +485,8 @@ "/agent_optimization_jobs/{jobId}": { "get": { "operationId": "AgentOptimizationJobs_get", - "summary": "Get an agent optimization job", - "description": "Retrieves the specified agent optimization job.\nReturns 202 while the job is in progress and 200 after it reaches a terminal state.", + "summary": "Get info about an agent optimization job.", + "description": "Get an optimization job by id.", "parameters": [ { "name": "Foundry-Features", @@ -496,7 +496,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -526,25 +526,7 @@ "headers": { "Retry-After": { "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptimizationJob" - } - } - } - }, - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Retry-After": { - "required": false, + "description": "Recommended number of seconds to wait before polling again.", "schema": { "type": "integer", "format": "int32" @@ -585,14 +567,14 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, "delete": { "operationId": "AgentOptimizationJobs_delete", - "summary": "Delete an agent optimization job", - "description": "Deletes the specified agent optimization job and its candidate artifacts.\nCancels the job first when it is still in a non-terminal state.", + "summary": "Deletes an agent optimization job.", + "description": "Delete the job and its candidate artifacts. Cancels first if non-terminal.", "parameters": [ { "name": "Foundry-Features", @@ -602,7 +584,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -615,16 +597,6 @@ "type": "string" } }, - { - "name": "force", - "in": "query", - "required": false, - "description": "When true, force-delete even if the job is in a non-terminal state.", - "schema": { - "type": "boolean" - }, - "explode": false - }, { "name": "api-version", "in": "query", @@ -666,16 +638,16 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } }, - "/agent_optimization_jobs/{jobId}/candidates": { - "get": { - "operationId": "AgentOptimizationJobs_listCandidates", - "summary": "List optimization job candidates", - "description": "Returns the candidates produced by the specified optimization job.", + "/agent_optimization_jobs/{jobId}:cancel": { + "post": { + "operationId": "AgentOptimizationJobs_cancel", + "summary": "Cancels an agent optimization job.", + "description": "Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.", "parameters": [ { "name": "Foundry-Features", @@ -685,7 +657,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -693,53 +665,11 @@ "name": "jobId", "in": "path", "required": true, - "description": "The optimization job id.", + "description": "The ID of the job to cancel.", "schema": { "type": "string" } }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false - }, - { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false - }, - { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, { "name": "api-version", "in": "query", @@ -757,33 +687,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "data", - "has_more" - ], - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationCandidate" - }, - "description": "The requested list of items." - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list." - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list." - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list." - } - }, - "description": "The response data for a requested list of items." + "$ref": "#/components/schemas/OptimizationJob" } } } @@ -814,16 +718,14 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidate", - "summary": "Get an optimization candidate", - "description": "Retrieves metadata, manifest information, and promotion details for the specified candidate.", + "/agents": { + "post": { + "operationId": "Agents_createAgent_Agents_createAgentFromCode", "parameters": [ { "name": "Foundry-Features", @@ -831,48 +733,48 @@ "required": false, "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] + "$ref": "#/components/schemas/AgentDefinitionOptInKeys" } }, { - "name": "jobId", - "in": "path", + "name": "api-version", + "in": "query", "required": true, - "description": "The optimization job id.", + "description": "The API version to use for this operation.", "schema": { "type": "string" - } + }, + "explode": false }, { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", + "name": "x-ms-agent-name", + "in": "header", + "required": false, + "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", "schema": { - "type": "string" + "type": "string", + "maxLength": 63 } }, { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", + "name": "x-ms-code-zip-sha256", + "in": "header", + "required": false, + "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", "schema": { "type": "string" - }, - "explode": false + } } ], + "description": "Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Create an agent Create a new code-based agent", "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CandidateMetadata" + "$ref": "#/components/schemas/AgentObject" } } } @@ -898,51 +800,93 @@ } } }, - "tags": [ - "AgentOptimizationJobs" - ], + "x-ms-description-override": "Creates a new agent or a new version of an existing agent.", + "x-ms-summary-override": "Create an agent", "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" + "required_previews": [ + "CodeAgents=V1Preview" ] + }, + "tags": [ + "Agents" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAgentRequest" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/CreateAgentFromCodeContent" + }, + "encoding": { + "metadata": { + "contentType": "application/json" + } + } + } + } } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/config": { + }, "get": { - "operationId": "AgentOptimizationJobs_getCandidateConfig", - "summary": "Get an optimization candidate config", - "description": "Retrieves the deploy configuration JSON for the specified candidate.\nClients can use it to compose `agents.create_version(...)` requests.", + "operationId": "Agents_listAgents", + "summary": "List agents", + "description": "Returns a paged collection of agent resources.", "parameters": [ { - "name": "Foundry-Features", - "in": "header", + "name": "kind", + "in": "query", "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "description": "Filter agents by kind. If not provided, all agents are returned.", "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } + "$ref": "#/components/schemas/AgentKind" + }, + "explode": false }, { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", + "name": "limit", + "in": "query", + "required": false, + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", + "schema": { + "type": "integer", + "format": "int32", + "default": 20 + }, + "explode": false + }, + { + "name": "order", + "in": "query", + "required": false, + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", + "schema": { + "$ref": "#/components/schemas/PageOrder" + }, + "explode": false + }, + { + "name": "after", + "in": "query", + "required": false, + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "schema": { "type": "string" - } + }, + "explode": false }, { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", + "name": "before", + "in": "query", + "required": false, + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "schema": { "type": "string" - } + }, + "explode": false }, { "name": "api-version", @@ -961,619 +905,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CandidateDeployConfig" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/files": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateFile", - "summary": "Get an optimization candidate file", - "description": "Streams the specified file from the candidate's blob directory.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "path", - "in": "query", - "required": true, - "description": "Relative path of the file to download (e.g. 'files/examples.jsonl').", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/octet-stream": { - "schema": { - "contentMediaType": "application/octet-stream" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/results": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateResults", - "summary": "Get optimization candidate results", - "description": "Retrieves full per-task evaluation results for the specified candidate.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateResults" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote": { - "post": { - "operationId": "AgentOptimizationJobs_promoteCandidate", - "summary": "Promote an optimization candidate", - "description": "Promotes the specified candidate and records the deployment timestamp and target agent version.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id to promote.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateResponse" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateRequest" - } - } - }, - "description": "Promotion details." - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}:cancel": { - "post": { - "operationId": "AgentOptimizationJobs_cancel", - "summary": "Cancel an agent optimization job", - "description": "Requests cancellation of the specified agent optimization job.\nThe operation remains idempotent after the job reaches a terminal state.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The ID of the job to cancel.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptimizationJob" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agents": { - "post": { - "operationId": "Agents_createAgent_Agents_createAgentFromCode", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "$ref": "#/components/schemas/AgentDefinitionOptInKeys" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "x-ms-agent-name", - "in": "header", - "required": false, - "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", - "schema": { - "type": "string", - "maxLength": 63 - } - }, - { - "name": "x-ms-code-zip-sha256", - "in": "header", - "required": false, - "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", - "schema": { - "type": "string" - } - } - ], - "description": "Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", - "summary": "Create an agent Create a new code-based agent", - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AgentObject" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "x-ms-description-override": "Creates a new agent or a new version of an existing agent.", - "x-ms-summary-override": "Create an agent", - "x-ms-foundry-meta": { - "required_previews": [ - "CodeAgents=V1Preview" - ] - }, - "tags": [ - "Agents" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAgentRequest" - } - }, - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/CreateAgentFromCodeContent" - }, - "encoding": { - "metadata": { - "contentType": "application/json" - } - } - } - } - } - }, - "get": { - "operationId": "Agents_listAgents", - "summary": "List agents", - "description": "Returns a paged collection of agent resources.", - "parameters": [ - { - "name": "kind", - "in": "query", - "required": false, - "description": "Filter agents by kind. If not provided, all agents are returned.", - "schema": { - "$ref": "#/components/schemas/AgentKind" - }, - "explode": false - }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false - }, - { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false - }, - { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "data", - "has_more" - ], - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgentObject" - }, - "description": "The requested list of items." - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list." - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list." - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list." - } - }, - "description": "The response data for a requested list of items." + "type": "object", + "required": [ + "data", + "has_more" + ], + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgentObject" + }, + "description": "The requested list of items." + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list." + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list." + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list." + } + }, + "description": "The response data for a requested list of items." } } } @@ -13141,8 +12499,7 @@ }, "safety_identifier": { "type": "string", - "maxLength": 64, - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -13152,18 +12509,12 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { "anyOf": [ @@ -13199,6 +12550,15 @@ } ] }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "max_tool_calls": { "anyOf": [ { @@ -13366,16 +12726,6 @@ } ] }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" - } - ] - }, "agent_reference": { "anyOf": [ { @@ -13495,8 +12845,7 @@ }, "safety_identifier": { "type": "string", - "maxLength": 64, - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -13506,18 +12855,12 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { "anyOf": [ @@ -13553,6 +12896,15 @@ } ] }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "max_tool_calls": { "anyOf": [ { @@ -13699,16 +13051,6 @@ ], "description": "Context management configuration for this request." }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" - } - ] - }, "agent_reference": { "allOf": [ { @@ -18519,23 +17861,6 @@ ], "description": "A trace source that selects traces by agent reference with time-based filtering." }, - "AgentIdentifier": { - "type": "object", - "required": [ - "agent_name" - ], - "properties": { - "agent_name": { - "type": "string", - "description": "Registered Foundry agent name (required)." - }, - "agent_version": { - "type": "string", - "description": "Pinned agent version. Defaults to latest if omitted." - } - }, - "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." - }, "AgentIdentity": { "type": "object", "required": [ @@ -21033,160 +20358,6 @@ }, "description": "Definition of input parameters for the Browser Automation Tool." }, - "CandidateDeployConfig": { - "type": "object", - "properties": { - "instructions": { - "type": "string", - "description": "System prompt / instructions." - }, - "model": { - "type": "string", - "description": "Foundry deployment name." - }, - "temperature": { - "type": "number", - "format": "float", - "minimum": 0, - "maximum": 2, - "description": "Optional sampling temperature." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Optional skill overrides." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Optional tool overrides." - } - }, - "description": "Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version." - }, - "CandidateFileInfo": { - "type": "object", - "required": [ - "path", - "type", - "size_bytes" - ], - "properties": { - "path": { - "type": "string", - "description": "Relative path of the file." - }, - "type": { - "type": "string", - "description": "File type category (e.g. 'config', 'results')." - }, - "size_bytes": { - "type": "integer", - "format": "int64", - "description": "File size in bytes." - } - }, - "description": "File entry in a candidate's blob directory." - }, - "CandidateMetadata": { - "type": "object", - "required": [ - "candidate_id", - "job_id", - "candidate_name", - "status", - "has_results", - "created_at", - "updated_at", - "files" - ], - "properties": { - "candidate_id": { - "type": "string", - "description": "Server-assigned candidate identifier." - }, - "job_id": { - "type": "string", - "description": "Owning optimization job id." - }, - "candidate_name": { - "type": "string", - "description": "Display name of the candidate." - }, - "status": { - "type": "string", - "description": "Candidate lifecycle status." - }, - "score": { - "type": "number", - "format": "double", - "description": "Candidate's aggregate score." - }, - "has_results": { - "type": "boolean", - "description": "Whether detailed results are available for this candidate." - }, - "created_at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when the candidate was created, represented in Unix time." - }, - "updated_at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when the candidate was last updated, represented in Unix time." - }, - "promotion": { - "allOf": [ - { - "$ref": "#/components/schemas/PromotionInfo" - } - ], - "description": "Promotion metadata. Null if not promoted." - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CandidateFileInfo" - }, - "description": "Files in the candidate's blob directory." - } - }, - "description": "Candidate metadata returned by GET /candidates/{id}." - }, - "CandidateResults": { - "type": "object", - "required": [ - "candidate_id", - "results" - ], - "properties": { - "candidate_id": { - "type": "string", - "description": "Owning candidate id." - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Per-task evaluation rows." - } - }, - "description": "Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results." - }, "CaptureStructuredOutputsTool": { "type": "object", "required": [ @@ -22790,9 +21961,7 @@ }, "discriminator": { "propertyName": "type", - "mapping": { - "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" - } + "mapping": {} }, "description": "Base class for run data sources with discriminator support." }, @@ -22879,50 +22048,6 @@ ], "description": "Dataset source for evaluator generation jobs — reference to a dataset." }, - "DatasetInfo": { - "type": "object", - "required": [ - "task_count", - "is_inline" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name when using a registered dataset reference. Null for inline datasets." - }, - "version": { - "type": "string", - "description": "Dataset version when using a registered dataset reference. Null for inline datasets." - }, - "task_count": { - "type": "integer", - "format": "int32", - "description": "Number of tasks/rows in the dataset." - }, - "is_inline": { - "type": "boolean", - "description": "True when the dataset was provided inline in the request body." - } - }, - "description": "Metadata about the dataset used for optimization, surfaced in the response." - }, - "DatasetRef": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name." - }, - "version": { - "type": "string", - "description": "Dataset version. If not specified, the latest version is used." - } - }, - "description": "Reference to a registered dataset in the Foundry Dataset Service." - }, "DatasetReference": { "type": "object", "required": [ @@ -26813,8 +25938,7 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", - "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -28651,12 +27775,6 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ - "gpt-5.4", - "gpt-5.4-mini", - "gpt-5.4-nano", - "gpt-5.4-mini-2026-03-17", - "gpt-5.4-nano-2026-03-17", - "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -28781,19 +27899,6 @@ } ], "description": "The y-coordinate where the click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -28984,44 +28089,8 @@ ] }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "prompt_cache_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "prompt_cache_retention": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" - }, - { - "type": "null" - } - ] - }, - "service_tier": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -29041,9 +28110,7 @@ "gt", "gte", "lt", - "lte", - "in", - "nin" + "lte" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -29145,14 +28212,6 @@ } } }, - "OpenAI.ComputerActionList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerAction" - }, - "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", - "title": "Computer Action List" - }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -29222,8 +28281,7 @@ "required": [ "type", "image_url", - "file_id", - "detail" + "file_id" ], "properties": { "type": { @@ -29246,22 +28304,8 @@ ] }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ImageDetail" - } - ], - "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "type": "string", + "nullable": true } }, "allOf": [ @@ -29299,29 +28343,6 @@ }, "description": "A computer screenshot image used with the computer use tool." }, - "OpenAI.ComputerTool": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer" - ], - "description": "The type of the computer tool. Always `computer`.", - "x-stainless-const": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", - "title": "Computer" - }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -29509,6 +28530,14 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." + }, + "domain_secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" + }, + "minItems": 1, + "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -29538,6 +28567,32 @@ } ] }, + "OpenAI.ContainerNetworkPolicyDomainSecretParam": { + "type": "object", + "required": [ + "domain", + "name", + "value" + ], + "properties": { + "domain": { + "type": "string", + "minLength": 1, + "description": "The domain associated with the secret." + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the secret to inject for the domain." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 10485760, + "description": "The secret value to inject for the domain." + } + } + }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -29666,18 +28721,14 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", - "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", - "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -29689,57 +28740,13 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", "title": "Conversation item" }, - "OpenAI.ConversationItemAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, "OpenAI.ConversationItemApplyPatchToolCall": { "type": "object", "required": [ @@ -29932,50 +28939,13 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, - "OpenAI.ConversationItemCompactionBody": { - "type": "object", - "required": [ - "type", - "id", - "encrypted_content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "compaction" - ], - "description": "The type of the item. Always `compaction`.", - "x-stainless-const": true, - "default": "compaction" - }, - "id": { - "type": "string", - "description": "The unique ID of the compaction item." - }, - "encrypted_content": { - "type": "string", - "description": "The encrypted content that was produced by compaction." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ], - "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", - "title": "Compaction item" - }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -29999,9 +28969,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -30027,11 +28994,10 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutput": { + "OpenAI.ConversationItemComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -30047,8 +29013,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -30078,17 +29043,56 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } + ] + }, + "OpenAI.ConversationItemCustomToolCall": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input" ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, - "OpenAI.ConversationItemCustomToolCallOutputResource": { + "OpenAI.ConversationItemCustomToolCallOutput": { "type": "object", "required": [ "type", "call_id", - "output", - "status" + "output" ], "properties": { "type": { @@ -30120,76 +29124,6 @@ } ], "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ], - "title": "ResponseCustomToolCallOutputItem" - }, - "OpenAI.ConversationItemCustomToolCallResource": { - "type": "object", - "required": [ - "type", - "call_id", - "name", - "input", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call" - ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." - }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." - }, - "input": { - "type": "string", - "description": "The input for the custom tool call generated by the model." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -30197,7 +29131,8 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "The output of a custom tool call from your code, being sent back to the model.", + "title": "Custom tool call output" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -30299,7 +29234,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -30358,7 +29293,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -30393,44 +29328,43 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCall": { + "OpenAI.ConversationItemFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -30446,49 +29380,40 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", - "title": "Function tool call" + ] }, - "OpenAI.ConversationItemFunctionToolCallOutput": { + "OpenAI.ConversationItemFunctionToolCallResource": { "type": "object", "required": [ - "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -30504,9 +29429,7 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -30824,7 +29747,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -30955,16 +29879,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -31037,138 +29951,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.ConversationItemToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, - "OpenAI.ConversationItemToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -31185,11 +29967,7 @@ "image_generation_call", "computer_call", "computer_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", - "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -31378,8 +30156,7 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", - "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -32384,10 +31161,6 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." - }, - "defer_loading": { - "type": "boolean", - "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -32460,8 +31233,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.DoubleClickAction": { @@ -32469,8 +31241,7 @@ "required": [ "type", "x", - "y", - "keys" + "y" ], "properties": { "type": { @@ -32496,19 +31267,6 @@ } ], "description": "The y-coordinate where the double click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -32540,19 +31298,6 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -32592,16 +31337,6 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "type": { "type": "string", "enum": [ @@ -32628,9 +31363,6 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, - "OpenAI.EmptyModelParam": { - "type": "object" - }, "OpenAI.Error": { "type": "object", "required": [ @@ -33683,13 +32415,6 @@ "description": "A citation to a file.", "title": "File citation" }, - "OpenAI.FileInputDetail": { - "type": "string", - "enum": [ - "low", - "high" - ] - }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -34662,22 +33387,14 @@ "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -34731,7 +33448,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -34794,22 +33511,6 @@ "incomplete" ] }, - "OpenAI.FunctionCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.FunctionCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -35246,14 +33947,6 @@ } ] }, - "OpenAI.FunctionShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -35300,14 +33993,6 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, - "OpenAI.FunctionShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -35490,18 +34175,8 @@ ] }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "defer_loading": { "type": "boolean", - "description": "Whether this function is deferred and loaded via tool search." + "nullable": true } }, "allOf": [ @@ -35512,62 +34187,61 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolParam": { + "OpenAI.FunctionToolCallOutput": { "type": "object", "required": [ - "name", - "type" + "type", + "call_id", + "output" ], "properties": { - "name": { + "id": { "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_-]+$" + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - }, - { - "type": "null" - } - ] + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." }, - "strict": { - "anyOf": [ + "output": { + "oneOf": [ { - "type": "boolean" + "type": "string" }, { - "type": "null" + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } } - ] + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, - "type": { + "status": { "type": "string", "enum": [ - "function" + "in_progress", + "completed", + "incomplete" ], - "x-stainless-const": true, - "default": "function" - }, - "defer_loading": { - "type": "boolean", - "description": "Whether this function should be deferred and discovered via tool search." + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." } - } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.GraderLabelModel": { "type": "object", @@ -35915,8 +34589,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.ImageGenActionEnum": { @@ -35969,21 +34642,14 @@ "default": "auto" }, "size": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" - ] - } + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" ], - "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", + "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", "default": "auto" }, "output_format": { @@ -36118,7 +34784,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -36289,22 +34955,14 @@ "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -36358,7 +35016,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -36450,22 +35108,14 @@ "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "description": "A file input to the model.", @@ -36517,23 +35167,9 @@ ] }, "file_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] - }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "type": "string", + "format": "uri", + "nullable": true } }, "description": "A file input to the model.", @@ -36582,7 +35218,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -36660,9 +35296,6 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", - "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", - "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", - "additional_tools": "#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -36683,56 +35316,6 @@ }, "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs." }, - "OpenAI.InputItemAdditionalToolsItemParam": { - "type": "object", - "required": [ - "type", - "role", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The item type. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "role": { - "type": "string", - "enum": [ - "developer" - ], - "description": "The role that provided the additional tools. Only `developer` is supported.", - "x-stainless-const": true, - "default": "developer" - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "A list of additional tools made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - ] - }, "OpenAI.InputItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -37044,6 +35627,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -37067,9 +35651,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -37120,10 +35701,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -37467,7 +36044,6 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -37476,8 +36052,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -37491,10 +36066,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -37795,7 +36366,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -37918,16 +36490,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -38008,143 +36570,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.InputItemToolSearchCallItemParam": { - "type": "object", - "required": [ - "type", - "arguments" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The item type. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - } - ], - "description": "The arguments supplied to the tool search call." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - ] - }, - "OpenAI.InputItemToolSearchOutputItemParam": { - "type": "object", - "required": [ - "type", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The item type. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by the tool search output." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - ] - }, "OpenAI.InputItemType": { "anyOf": [ { @@ -38161,9 +36586,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -38239,6 +36661,52 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.InputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -38247,6 +36715,55 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, + "OpenAI.InputMessageResource": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.InputParam": { "oneOf": [ { @@ -38323,7 +36840,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemInputMessage", + "message": "#/components/schemas/OpenAI.InputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -38331,9 +36848,6 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", - "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", - "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", - "additional_tools": "#/components/schemas/OpenAI.ItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -38354,56 +36868,6 @@ }, "description": "Content item used to generate a response." }, - "OpenAI.ItemAdditionalToolsItemParam": { - "type": "object", - "required": [ - "type", - "role", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The item type. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "role": { - "type": "string", - "enum": [ - "developer" - ], - "description": "The role that provided the additional tools. Only `developer` is supported.", - "x-stainless-const": true, - "default": "developer" - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "A list of additional tools made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ] - }, "OpenAI.ItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -38715,6 +37179,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -38738,9 +37203,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -38791,10 +37253,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -38872,17 +37330,14 @@ "discriminator": { "propertyName": "type", "mapping": { + "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", - "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ItemFieldAdditionalTools", - "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -38902,50 +37357,6 @@ }, "description": "An item representing a message, tool call, tool output, reasoning, or other response element." }, - "OpenAI.ItemFieldAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ] - }, "OpenAI.ItemFieldApplyPatchToolCall": { "type": "object", "required": [ @@ -39182,6 +37593,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -39205,9 +37617,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -39233,11 +37642,10 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutput": { + "OpenAI.ItemFieldComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -39253,8 +37661,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -39284,9 +37691,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -39313,10 +37718,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -39481,7 +37882,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -39540,7 +37941,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -39578,7 +37979,6 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -39587,8 +37987,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -39602,10 +38001,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -39632,64 +38027,6 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, - "OpenAI.ItemFieldFunctionToolCallOutput": { - "type": "object", - "required": [ - "id", - "type", - "call_id", - "output" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true - }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true - }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" - }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -39959,7 +38296,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -40090,16 +38428,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -40172,138 +38500,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.ItemFieldToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ] - }, - "OpenAI.ItemFieldToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ] - }, "OpenAI.ItemFieldType": { "anyOf": [ { @@ -40314,9 +38510,6 @@ "enum": [ "message", "function_call", - "tool_search_call", - "tool_search_output", - "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -40675,7 +38868,6 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -40684,8 +38876,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -40699,10 +38890,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -40779,59 +38966,6 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, - "OpenAI.ItemInputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true, - "default": "message" - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -41056,7 +39190,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -41179,16 +39314,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -41310,19 +39435,14 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", + "message": "#/components/schemas/OpenAI.InputMessageResource", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", - "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ItemResourceAdditionalTools", - "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", - "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -41334,57 +39454,11 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" } }, "description": "Content item used to generate a response." }, - "OpenAI.ItemResourceAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.ItemResourceApplyPatchToolCall": { "type": "object", "required": [ @@ -41577,50 +39651,13 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, - "OpenAI.ItemResourceCompactionBody": { - "type": "object", - "required": [ - "type", - "id", - "encrypted_content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "compaction" - ], - "description": "The type of the item. Always `compaction`.", - "x-stainless-const": true, - "default": "compaction" - }, - "id": { - "type": "string", - "description": "The unique ID of the compaction item." - }, - "encrypted_content": { - "type": "string", - "description": "The encrypted content that was produced by compaction." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", - "title": "Compaction item" - }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -41644,9 +39681,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -41672,11 +39706,10 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutput": { + "OpenAI.ItemResourceComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -41692,8 +39725,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -41723,126 +39755,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" - }, - "OpenAI.ItemResourceCustomToolCallOutputResource": { - "type": "object", - "required": [ - "type", - "call_id", - "output", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call_output" - ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "title": "ResponseCustomToolCallOutputItem" - }, - "OpenAI.ItemResourceCustomToolCallResource": { - "type": "object", - "required": [ - "type", - "call_id", - "name", - "input", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call" - ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." - }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." - }, - "input": { - "type": "string", - "description": "The input for the custom tool call generated by the model." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "title": "ResponseCustomToolCallItem" + ] }, "OpenAI.ItemResourceFileSearchToolCall": { "type": "object", @@ -41944,7 +39857,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -42003,7 +39916,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -42038,44 +39951,43 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCall": { + "OpenAI.ItemResourceFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -42091,49 +40003,40 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", - "title": "Function tool call" + ] }, - "OpenAI.ItemResourceFunctionToolCallOutput": { + "OpenAI.ItemResourceFunctionToolCallResource": { "type": "object", "required": [ - "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -42149,9 +40052,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, "OpenAI.ItemResourceImageGenToolCall": { "type": "object", @@ -42203,59 +40104,6 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, - "OpenAI.ItemResourceInputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true, - "default": "message" - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", "required": [ @@ -42475,7 +40323,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -42598,16 +40447,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -42626,200 +40465,6 @@ "description": "An output message from the model.", "title": "Output message" }, - "OpenAI.ItemResourceReasoningItem": { - "type": "object", - "required": [ - "type", - "id", - "summary" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "reasoning" - ], - "description": "The type of the object. Always `reasoning`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique identifier of the reasoning content." - }, - "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "summary": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.SummaryTextContent" - }, - "description": "Reasoning summary content." - }, - "content": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" - }, - "description": "Reasoning text content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", - "title": "Reasoning" - }, - "OpenAI.ItemResourceToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, - "OpenAI.ItemResourceToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.ItemResourceType": { "anyOf": [ { @@ -42836,11 +40481,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", - "reasoning", - "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -42853,8 +40493,6 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", - "custom_tool_call", - "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -42937,143 +40575,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.ItemToolSearchCallItemParam": { - "type": "object", - "required": [ - "type", - "arguments" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The item type. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - } - ], - "description": "The arguments supplied to the tool search call." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ] - }, - "OpenAI.ItemToolSearchOutputItemParam": { - "type": "object", - "required": [ - "type", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The item type. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by the tool search output." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ] - }, "OpenAI.ItemType": { "anyOf": [ { @@ -43090,9 +40591,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -43347,6 +40845,22 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, + "OpenAI.LocalShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.LocalShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -43646,10 +41160,6 @@ ], "default": "always" }, - "defer_loading": { - "type": "boolean", - "description": "Whether this MCP tool is deferred and discovered via tool search." - }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -43730,8 +41240,7 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", - "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" } }, "description": "A content part that makes up an input or output item." @@ -43765,22 +41274,14 @@ "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -43834,7 +41335,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -43997,14 +41498,6 @@ } ] }, - "OpenAI.MessagePhase": { - "type": "string", - "enum": [ - "commentary", - "final_answer" - ], - "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." - }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -44291,19 +41784,6 @@ } ], "description": "The y-coordinate to move to." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -44314,57 +41794,6 @@ "description": "A mouse move action.", "title": "Move" }, - "OpenAI.NamespaceToolParam": { - "type": "object", - "required": [ - "type", - "name", - "description", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "namespace" - ], - "description": "The type of the tool. Always `namespace`.", - "x-stainless-const": true - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The namespace name used in tool calls (for example, `crm`)." - }, - "description": { - "type": "string", - "minLength": 1, - "description": "A description of the namespace shown to the model." - }, - "tools": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionToolParam" - }, - { - "$ref": "#/components/schemas/OpenAI.CustomToolParam" - } - ] - }, - "minItems": 1, - "description": "The function/custom tools available inside this namespace." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "Groups function/custom tools under a shared namespace.", - "title": "Namespace" - }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -44553,19 +41982,13 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", - "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.OutputItemAdditionalTools", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", - "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -44573,56 +41996,10 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" } } }, - "OpenAI.OutputItemAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ] - }, "OpenAI.OutputItemApplyPatchToolCall": { "type": "object", "required": [ @@ -44859,6 +42236,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -44882,9 +42260,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -44910,128 +42285,13 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemComputerToolCallOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "output" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer_call_output" - ], - "description": "The type of the computer tool call output. Always `computer_call_output`.", - "x-stainless-const": true, - "default": "computer_call_output" - }, - "id": { - "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true - }, - "call_id": { - "type": "string", - "description": "The ID of the computer tool call that produced the output." - }, - "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "description": "The safety checks reported by the API that have been acknowledged by the\n developer." - }, - "output": { - "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" - }, - "OpenAI.OutputItemCustomToolCallOutputResource": { - "type": "object", - "required": [ - "type", - "call_id", - "output", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call_output" - ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "title": "ResponseCustomToolCallOutputItem" - }, - "OpenAI.OutputItemCustomToolCallResource": { + "OpenAI.OutputItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", "name", - "input", - "status" + "input" ], "properties": { "type": { @@ -45050,10 +42310,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -45061,18 +42317,6 @@ "input": { "type": "string", "description": "The input for the custom tool call generated by the model." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -45080,7 +42324,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -45182,7 +42427,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -45241,7 +42486,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -45279,7 +42524,6 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -45288,8 +42532,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -45303,10 +42546,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -45333,64 +42572,6 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, - "OpenAI.OutputItemFunctionToolCallOutput": { - "type": "object", - "required": [ - "id", - "type", - "call_id", - "output" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true - }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true - }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" - }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", "required": [ @@ -45488,54 +42669,6 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, - "OpenAI.OutputItemLocalShellToolCallOutput": { - "type": "object", - "required": [ - "type", - "id", - "output" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "local_shell_call_output" - ], - "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the local shell tool call generated by the model." - }, - "output": { - "type": "string", - "description": "A JSON string of the output of the local shell tool call." - }, - "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a local shell tool call.", - "title": "Local shell call output" - }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -45579,54 +42712,6 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, - "OpenAI.OutputItemMcpApprovalResponseResource": { - "type": "object", - "required": [ - "type", - "id", - "approval_request_id", - "approve" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_approval_response" - ], - "description": "The type of the item. Always `mcp_approval_response`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the approval response" - }, - "approval_request_id": { - "type": "string", - "description": "The ID of the approval request being answered." - }, - "approve": { - "type": "boolean", - "description": "Whether the request was approved." - }, - "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "A response to an MCP approval request.", - "title": "MCP approval response" - }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -45660,7 +42745,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -45783,16 +42869,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -45873,138 +42949,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.OutputItemToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ] - }, - "OpenAI.OutputItemToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ] - }, "OpenAI.OutputItemType": { "anyOf": [ { @@ -46016,19 +42960,13 @@ "output_message", "file_search_call", "function_call", - "function_call_output", "web_search_call", "computer_call", - "computer_call_output", "reasoning", - "tool_search_call", - "tool_search_output", - "additional_tools", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", - "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -46036,9 +42974,7 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", - "mcp_approval_response", "custom_tool_call", - "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -46259,13 +43195,6 @@ }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, - "OpenAI.PromptCacheRetentionEnum": { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -46302,123 +43231,6 @@ } } }, - "OpenAI.RealtimeMCPError": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", - "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", - "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" - } - } - }, - "OpenAI.RealtimeMCPHTTPError": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "http_error" - ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" - }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP HTTP error" - }, - "OpenAI.RealtimeMCPProtocolError": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "protocol_error" - ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" - }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP protocol error" - }, - "OpenAI.RealtimeMCPToolExecutionError": { - "type": "object", - "required": [ - "type", - "message" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_execution_error" - ], - "x-stainless-const": true - }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP tool execution error" - }, - "OpenAI.RealtimeMcpErrorType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "protocol_error", - "tool_execution_error", - "http_error" - ] - } - ] - }, "OpenAI.Reasoning": { "type": "object", "properties": { @@ -46565,8 +43377,7 @@ }, "safety_identifier": { "type": "string", - "maxLength": 64, - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -46576,18 +43387,12 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { "anyOf": [ @@ -46623,6 +43428,15 @@ } ] }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "max_tool_calls": { "anyOf": [ { @@ -46790,16 +43604,6 @@ } ] }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" - } - ] - }, "agent_reference": { "anyOf": [ { @@ -46851,11 +43655,6 @@ "description": "A chunk of Base64 encoded response audio bytes." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -46887,11 +43686,6 @@ "description": "The sequence number of the delta." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -46928,11 +43722,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -46964,11 +43753,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -47019,11 +43803,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -47074,11 +43853,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -47124,11 +43898,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -47174,11 +43943,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -47224,11 +43988,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -47269,11 +44028,6 @@ "description": "The sequence number for this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -47337,11 +44091,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -47405,11 +44154,6 @@ "description": "The content part that is done." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -47450,11 +44194,6 @@ "description": "The sequence number for this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -47505,11 +44244,6 @@ "description": "The incremental input data (delta) for the custom tool call." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -47561,11 +44295,6 @@ "description": "The complete input data for the custom tool call." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -47666,11 +44395,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -47711,11 +44435,6 @@ "description": "The response that failed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -47761,11 +44480,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -47811,11 +44525,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -47861,11 +44570,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -48018,11 +44722,6 @@ "description": "The function-call arguments delta that is added." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -48077,11 +44776,6 @@ "description": "The function-call arguments." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -48127,11 +44821,6 @@ "description": "The unique identifier of the image generation item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -48178,11 +44867,6 @@ "description": "The sequence number of the image generation item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -48229,11 +44913,6 @@ "description": "The sequence number of the image generation item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -48294,11 +44973,6 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -48340,11 +45014,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -48397,11 +45066,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -48433,7 +45097,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probabilities of up to 20 of the most likely tokens." + "description": "The log probability of the top 20 most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -48492,11 +45156,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -48548,11 +45207,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -48599,11 +45253,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -48650,11 +45299,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -48701,11 +45345,6 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -48752,11 +45391,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -48803,11 +45437,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -48854,11 +45483,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -48909,11 +45533,6 @@ "description": "The output item that was added." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -48963,11 +45582,6 @@ "description": "The output item that was marked done." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -49040,11 +45654,6 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -49109,11 +45718,6 @@ "description": "The sequence number for this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -49178,11 +45782,6 @@ "description": "The summary part that was added." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -49265,11 +45864,6 @@ "description": "The completed summary part." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -49348,11 +45942,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -49412,11 +46001,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -49476,11 +46060,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -49540,11 +46119,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -49604,11 +46178,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -49668,11 +46237,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -49680,140 +46244,6 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, - "OpenAI.ResponseStreamEvent": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", - "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", - "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", - "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", - "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", - "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", - "error": "#/components/schemas/OpenAI.ResponseErrorEvent", - "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", - "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", - "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", - "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", - "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", - "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", - "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", - "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", - "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", - "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", - "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", - "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", - "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", - "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", - "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", - "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", - "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", - "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", - "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", - "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", - "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", - "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", - "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", - "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", - "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", - "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", - "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", - "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", - "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", - "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", - "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", - "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", - "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", - "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", - "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", - "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", - "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", - "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", - "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", - "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", - "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", - "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", - "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", - "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", - "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", - "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" - } - } - }, - "OpenAI.ResponseStreamEventType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "response.audio.delta", - "response.audio.done", - "response.audio.transcript.delta", - "response.audio.transcript.done", - "response.code_interpreter_call_code.delta", - "response.code_interpreter_call_code.done", - "response.code_interpreter_call.completed", - "response.code_interpreter_call.in_progress", - "response.code_interpreter_call.interpreting", - "response.completed", - "response.content_part.added", - "response.content_part.done", - "response.created", - "error", - "response.file_search_call.completed", - "response.file_search_call.in_progress", - "response.file_search_call.searching", - "response.function_call_arguments.delta", - "response.function_call_arguments.done", - "response.in_progress", - "response.failed", - "response.incomplete", - "response.output_item.added", - "response.output_item.done", - "response.reasoning_summary_part.added", - "response.reasoning_summary_part.done", - "response.reasoning_summary_text.delta", - "response.reasoning_summary_text.done", - "response.reasoning_text.delta", - "response.reasoning_text.done", - "response.refusal.delta", - "response.refusal.done", - "response.output_text.delta", - "response.output_text.done", - "response.web_search_call.completed", - "response.web_search_call.in_progress", - "response.web_search_call.searching", - "response.image_generation_call.completed", - "response.image_generation_call.generating", - "response.image_generation_call.in_progress", - "response.image_generation_call.partial_image", - "response.mcp_call_arguments.delta", - "response.mcp_call_arguments.done", - "response.mcp_call.completed", - "response.mcp_call.failed", - "response.mcp_call.in_progress", - "response.mcp_list_tools.completed", - "response.mcp_list_tools.failed", - "response.mcp_list_tools.in_progress", - "response.output_text.annotation.added", - "response.queued", - "response.custom_tool_call_input.delta", - "response.custom_tool_call_input.done" - ] - } - ] - }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -49884,11 +46314,6 @@ "description": "The log probabilities of the tokens in the delta." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -49956,11 +46381,6 @@ "description": "The log probabilities of the tokens in the delta." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -50093,11 +46513,6 @@ "description": "The sequence number of the web search call being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -50143,11 +46558,6 @@ "description": "The sequence number of the web search call being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -50193,11 +46603,6 @@ "description": "The sequence number of the web search call being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -50277,19 +46682,6 @@ } ], "description": "The vertical scroll distance." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -50300,13 +46692,6 @@ "description": "A scroll action.", "title": "Scroll" }, - "OpenAI.SearchContentType": { - "type": "string", - "enum": [ - "text", - "image" - ] - }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -50333,15 +46718,6 @@ ], "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter." }, - "OpenAI.ServiceTierEnum": { - "type": "string", - "enum": [ - "auto", - "default", - "flex", - "priority" - ] - }, "OpenAI.SkillReferenceParam": { "type": "object", "required": [ @@ -50639,10 +47015,7 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", - "computer": "#/components/schemas/OpenAI.ComputerTool", - "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", - "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -50708,46 +47081,6 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, - "OpenAI.ToolChoiceComputer": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ], - "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." - }, - "OpenAI.ToolChoiceComputerUse": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer_use" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ], - "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." - }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -50936,9 +47269,7 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", - "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", - "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -50962,9 +47293,7 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter", - "computer", - "computer_use" + "code_interpreter" ] } ] @@ -51009,64 +47338,6 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, - "OpenAI.ToolSearchExecutionType": { - "type": "string", - "enum": [ - "server", - "client" - ] - }, - "OpenAI.ToolSearchToolParam": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search" - ], - "description": "The type of the tool. Always `tool_search`.", - "x-stainless-const": true - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search is executed by the server or by the client." - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "Hosted or BYOT tool search configuration for deferred tools.", - "title": "Tool search tool" - }, "OpenAI.ToolType": { "anyOf": [ { @@ -51077,7 +47348,6 @@ "enum": [ "function", "file_search", - "computer", "computer_use_preview", "web_search", "mcp", @@ -51086,8 +47356,6 @@ "local_shell", "shell", "custom", - "namespace", - "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -51357,7 +47625,8 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type" + "type", + "query" ], "properties": { "type": { @@ -51370,7 +47639,7 @@ }, "query": { "type": "string", - "description": "The search query.", + "description": "[DEPRECATED] The search query.", "deprecated": true }, "queries": { @@ -51408,8 +47677,7 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri" + "type": "string" } } }, @@ -51503,12 +47771,6 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." - }, - "search_content_types": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.SearchContentType" - } } }, "allOf": [ @@ -51962,55 +48224,29 @@ ], "description": "The output of an OpenAPI tool call." }, - "OptimizationAgentDefinition": { + "OptimizationAgentIdentifier": { "type": "object", + "required": [ + "agent_name" + ], "properties": { "agent_name": { "type": "string", - "description": "Agent name." + "description": "Registered Foundry agent name (required)." }, "agent_version": { "type": "string", - "description": "Agent version." - }, - "model": { - "type": "string", - "description": "Model deployment name." - }, - "system_prompt": { - "type": "string", - "description": "System prompt / instructions." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Agent skills." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Agent tools." + "description": "Pinned agent version. Defaults to latest if omitted." } }, - "description": "Agent definition returned in response payloads (includes resolved config)." + "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." }, "OptimizationCandidate": { "type": "object", "required": [ "name", - "config", - "mutations", "avg_score", - "avg_tokens", - "pass_rate", - "task_scores", - "is_pareto_optimal" + "avg_tokens" ], "properties": { "candidate_id": { @@ -52021,14 +48257,6 @@ "type": "string", "description": "Display name of the candidate (e.g., 'baseline', 'instruction-v2')." }, - "config": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationAgentDefinition" - } - ], - "description": "The agent configuration that produced this candidate." - }, "mutations": { "type": "object", "unevaluatedProperties": {}, @@ -52044,22 +48272,6 @@ "format": "double", "description": "Average token usage across all tasks." }, - "pass_rate": { - "type": "number", - "format": "double", - "description": "Fraction of tasks that met the pass threshold." - }, - "task_scores": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Individual task-level scores." - }, - "is_pareto_optimal": { - "type": "boolean", - "description": "Whether this candidate is on the Pareto frontier (score vs cost)." - }, "eval_id": { "type": "string", "description": "Foundry evaluation identifier used to score this candidate." @@ -52079,12 +48291,144 @@ }, "description": "Aggregated evaluation result for a single candidate agent configuration across all tasks." }, + "OptimizationDatasetCriterion": { + "type": "object", + "required": [ + "name", + "instruction" + ], + "properties": { + "name": { + "type": "string", + "description": "Criterion name." + }, + "instruction": { + "type": "string", + "description": "Criterion instruction / description." + } + }, + "description": "Evaluation criterion: a name + instruction pair used for per-item scoring." + }, + "OptimizationDatasetInput": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInputType" + } + ], + "description": "Dataset input type discriminator." + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "inline": "#/components/schemas/OptimizationInlineDatasetInput", + "reference": "#/components/schemas/OptimizationReferenceDatasetInput" + } + }, + "description": "Base discriminated model for dataset input. Either inline items or a registered reference." + }, + "OptimizationDatasetInputType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "inline", + "reference" + ] + } + ], + "description": "Discriminator values for the dataset input union." + }, + "OptimizationDatasetItem": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "The user query / prompt." + }, + "ground_truth": { + "type": "string", + "description": "Expected ground truth answer." + }, + "desired_num_turns": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "description": "Desired number of conversation turns for simulation mode (1-20)." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetCriterion" + }, + "description": "Per-item evaluation criteria." + } + }, + "description": "A single item in an inline dataset." + }, + "OptimizationEvaluatorRef": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Evaluator name." + }, + "version": { + "type": "string", + "description": "Evaluator version. If not specified, the latest version is used." + } + }, + "description": "Reference to a named evaluator, optionally pinned to a version." + }, + "OptimizationInlineDatasetInput": { + "type": "object", + "required": [ + "type", + "items" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "inline" + ], + "description": "Dataset input type discriminator." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetItem" + }, + "description": "Dataset items." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Inline dataset — items supplied directly in the request body." + }, "OptimizationJob": { "type": "object", "required": [ "id", "status", - "created_at" + "created_at", + "updated_at" ], "properties": { "id": { @@ -52092,40 +48436,40 @@ "description": "Server-assigned unique identifier.", "readOnly": true }, - "status": { + "inputs": { "allOf": [ { - "$ref": "#/components/schemas/JobStatus" + "$ref": "#/components/schemas/OptimizationJobInputs" } ], - "description": "Current lifecycle status.", - "readOnly": true + "description": "Caller-supplied inputs." }, - "error": { + "result": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.Error" + "$ref": "#/components/schemas/OptimizationJobResult" } ], - "description": "Error details — populated only on failure.", + "description": "Result produced on success.", "readOnly": true }, - "result": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobResult" + "$ref": "#/components/schemas/JobStatus" } ], - "description": "Result produced on success.", + "description": "Current lifecycle status.", "readOnly": true }, - "inputs": { + "error": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OpenAI.Error" } ], - "description": "Caller-supplied inputs." + "description": "Error details — populated only on failure.", + "readOnly": true }, "created_at": { "allOf": [ @@ -52142,7 +48486,7 @@ "$ref": "#/components/schemas/FoundryTimestamp" } ], - "description": "The timestamp when the job was last updated (status, progress, or result change), represented in Unix time.", + "description": "The timestamp when the job was last updated, represented in Unix time.", "readOnly": true }, "progress": { @@ -52151,16 +48495,15 @@ "$ref": "#/components/schemas/OptimizationJobProgress" } ], - "description": "Progress while in flight. Absent in terminal states.", + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", "readOnly": true }, - "dataset": { - "allOf": [ - { - "$ref": "#/components/schemas/DatasetInfo" - } - ], - "description": "Metadata about the dataset used for this optimization job.", + "warnings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Non-fatal warnings emitted at any point during optimization.", "readOnly": true } }, @@ -52170,29 +48513,30 @@ "type": "object", "required": [ "agent", - "train_dataset_reference" + "train_dataset", + "evaluators" ], "properties": { "agent": { "allOf": [ { - "$ref": "#/components/schemas/AgentIdentifier" + "$ref": "#/components/schemas/OptimizationAgentIdentifier" } ], "description": "The agent (and pinned version) being optimized." }, - "train_dataset_reference": { + "train_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], - "description": "Reference to a registered training dataset (required)." + "description": "Training dataset — either inline items or a reference to a registered dataset. Required." }, - "validation_dataset_reference": { + "validation_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], "description": "Optional held-out validation dataset for measuring generalization of the final candidate." @@ -52200,9 +48544,9 @@ "evaluators": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/OptimizationEvaluatorRef" }, - "description": "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + "description": "Job-level evaluators referenced by name and optional version. Required; at least one must be provided." }, "options": { "allOf": [ @@ -52215,18 +48559,89 @@ }, "description": "Caller-supplied inputs for an optimization job." }, + "OptimizationJobListItem": { + "type": "object", + "required": [ + "id", + "status", + "created_at", + "updated_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Server-assigned unique identifier.", + "readOnly": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/JobStatus" + } + ], + "description": "Current lifecycle status.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was created, represented in Unix time.", + "readOnly": true + }, + "updated_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was last updated, represented in Unix time.", + "readOnly": true + }, + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationAgentIdentifier" + } + ], + "description": "The agent targeted by this optimization job.", + "readOnly": true + }, + "progress": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationJobProgress" + } + ], + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", + "readOnly": true + }, + "error": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Error" + } + ], + "description": "Error details — populated only on failure.", + "readOnly": true + } + }, + "description": "Slim job representation returned by the LIST endpoint." + }, "OptimizationJobProgress": { "type": "object", "required": [ - "current_iteration", + "candidates_completed", "best_score", "elapsed_seconds" ], "properties": { - "current_iteration": { + "candidates_completed": { "type": "integer", "format": "int32", - "description": "1-based current iteration index." + "description": "Number of candidates whose evaluation has completed so far." }, "best_score": { "type": "number", @@ -52245,20 +48660,12 @@ "type": "object", "properties": { "baseline": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "Evaluation scores for the original (un-optimized) agent configuration." + "type": "string", + "description": "Candidate ID of the original (un-optimized) baseline evaluation." }, "best": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "The highest-scoring candidate found during optimization." + "type": "string", + "description": "Candidate ID of the highest-scoring candidate found during optimization." }, "candidates": { "type": "array", @@ -52266,25 +48673,6 @@ "$ref": "#/components/schemas/OptimizationCandidate" }, "description": "All evaluated candidates including baseline." - }, - "options": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationOptions" - } - ], - "description": "The options used for this optimization run." - }, - "warnings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped)." - }, - "all_target_attributes_failed": { - "type": "boolean", - "description": "True when all target attributes failed — only the baseline was evaluated." } }, "description": "Terminal-state result body. Populated when status is succeeded or failed." @@ -52292,10 +48680,10 @@ "OptimizationOptions": { "type": "object", "properties": { - "max_iterations": { + "max_candidates": { "type": "integer", "format": "int32", - "description": "Maximum optimization iterations per strategy. Must be >= 1. Default: 5.", + "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", "default": 5 }, "optimization_config": { @@ -52322,73 +48710,35 @@ }, "description": "Tuning knobs and run-mode for an optimization job." }, - "OptimizationTaskResult": { + "OptimizationReferenceDatasetInput": { "type": "object", "required": [ - "task_name", - "scores", - "composite_score", - "tokens", - "duration_seconds", - "passed" + "type", + "name" ], "properties": { - "task_name": { - "type": "string", - "description": "Task name (from the dataset)." - }, - "query": { - "type": "string", - "description": "The user query / input for the task." - }, - "scores": { - "type": "object", - "unevaluatedProperties": { - "type": "number", - "format": "double" - }, - "description": "Per-evaluator scores keyed by evaluator name." - }, - "composite_score": { - "type": "number", - "format": "double", - "description": "Composite score combining all evaluator scores." - }, - "tokens": { - "type": "integer", - "format": "int64", - "description": "Total tokens consumed during the agent run for this task." - }, - "duration_seconds": { - "type": "number", - "format": "double", - "description": "Wall-clock seconds for this task's agent execution." - }, - "passed": { - "type": "boolean", - "description": "Whether the task met the pass threshold." - }, - "error_message": { + "type": { "type": "string", - "description": "Error message if the task failed during execution." - }, - "rationales": { - "type": "object", - "unevaluatedProperties": { - "type": "string" - }, - "description": "Per-evaluator reasoning keyed by evaluator name." + "enum": [ + "reference" + ], + "description": "Dataset input type discriminator." }, - "response": { + "name": { "type": "string", - "description": "Raw agent response text." + "description": "Registered dataset name." }, - "run_id": { + "version": { "type": "string", - "description": "Identifier of the agent run that produced this result." + "description": "Dataset version. If not specified, the latest version is used." } }, - "description": "Per-task evaluation result for a single candidate." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Reference to a registered Foundry dataset." }, "OtlpTelemetryEndpoint": { "type": "object", @@ -52805,61 +49155,6 @@ ] } }, - "PromoteCandidateRequest": { - "type": "object", - "required": [ - "agent_name", - "agent_version" - ], - "properties": { - "agent_name": { - "type": "string", - "description": "Name of the Foundry agent to promote to." - }, - "agent_version": { - "type": "string", - "description": "Version of the Foundry agent to promote to." - } - }, - "description": "Request body for promoting a candidate to a Foundry agent version." - }, - "PromoteCandidateResponse": { - "type": "object", - "required": [ - "candidate_id", - "status", - "promoted_at", - "agent_name", - "agent_version" - ], - "properties": { - "candidate_id": { - "type": "string", - "description": "The promoted candidate id." - }, - "status": { - "type": "string", - "description": "Status after promotion." - }, - "promoted_at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when promotion occurred, represented in Unix time." - }, - "agent_name": { - "type": "string", - "description": "Name of the Foundry agent promoted to." - }, - "agent_version": { - "type": "string", - "description": "Version of the Foundry agent promoted to." - } - }, - "description": "Response after successfully promoting a candidate." - }, "PromotionInfo": { "type": "object", "required": [ diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml index c9076f0f7451..04878c37b0c2 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml @@ -1,125 +1,39 @@ -openapi: 3.2.0 +openapi: 3.0.0 info: title: Microsoft Foundry version: v1 tags: - - name: Fine-Tuning - - name: Responses Root - description: Responses - - name: Responses - parent: Responses Root - description: Responses (OpenAI) - - name: Conversations - parent: Responses Root - description: Conversations (OpenAI) - - name: Agents Root - description: Agents - name: Agents - parent: Agents Root - description: Agent Management - - name: Agent Invocations - parent: Agents Root - - name: Agent Invocations WebSocket - parent: Agents Root - description: Agent Invocations (WebSocket) - - name: Agent Sessions - parent: Agents Root - name: Agent Session Files - parent: Agents Root - - name: Agent Versions - parent: Agents Root - - name: Agent Containers - parent: Agents Root - - name: Platform APIs + - name: Agent Invocations + - name: Connections - name: Datasets - parent: Platform APIs + - name: Deployments + - name: Evaluation Taxonomies + - name: Evaluation Rules + - name: Evaluators + - name: EvaluatorGenerationJobs - name: Indexes - parent: Platform APIs - - name: Connections - parent: Platform APIs - - name: Scheduler - parent: Platform APIs - - name: Fine-tuning - parent: Platform APIs - summary: Fine-Tuning + - name: Insights - name: Models - parent: Platform APIs - name: Memory Stores - parent: Platform APIs - - name: Chat - parent: Platform APIs - - name: Assistants - parent: Platform APIs - - name: Audio - parent: Platform APIs - - name: Batch - parent: Platform APIs - - name: Completions - parent: Platform APIs - - name: Containers - parent: Platform APIs - - name: Embeddings - parent: Platform APIs - - name: Files - parent: Platform APIs - - name: Images - parent: Platform APIs - - name: Moderations - parent: Platform APIs - - name: Realtime - parent: Platform APIs - - name: Threads - parent: Platform APIs - - name: Uploads - parent: Platform APIs - - name: Vector stores - parent: Platform APIs - summary: Vector Stores - - name: Videos - parent: Platform APIs + - name: Conversations + - name: Evals + - name: Fine-Tuning + - name: Responses + - name: Redteams - name: Routines - parent: Platform APIs - name: Schedules - parent: Platform APIs - name: Skills - parent: Platform APIs - name: Toolboxes - parent: Platform APIs - - name: Deployments - parent: Platform APIs - name: DataGenerationJobs - parent: Platform APIs - summary: Data generation jobs - name: AgentOptimizationJobs - parent: Platform APIs - summary: Agent optimization jobs - - name: EvaluatorGenerationJobs - parent: Platform APIs - summary: Evaluator generation jobs - - name: Evaluations - - name: Evals - parent: Evaluations - - name: Evaluation Rules - parent: Evaluations - - name: Evaluators - parent: Evaluations - - name: Evaluation Taxonomies - parent: Evaluations - - name: Redteams - parent: Evaluations - summary: Red Teaming - - name: Evalsuite - parent: Evaluations - - name: Insights - parent: Evaluations paths: /agent_optimization_jobs: post: operationId: AgentOptimizationJobs_create - summary: Create an agent optimization job - description: |- - Creates an agent optimization job and returns the queued job. - Honors `Operation-Id` for idempotent retry. + summary: Creates an agent optimization job. + description: Create an optimization job. Returns 201 with the queued job. Honours `Operation-Id` for idempotent retry. parameters: - name: Foundry-Features in: header @@ -128,7 +42,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: Operation-Id in: header required: false @@ -179,15 +93,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OptimizationJobInputs' - description: The optimization job inputs. + $ref: '#/components/schemas/OptimizationJob' + description: The job to create. x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview get: operationId: AgentOptimizationJobs_list - summary: List agent optimization jobs - description: Returns agent optimization jobs with cursor pagination and optional lifecycle or agent filters. + summary: Returns a list of agent optimization jobs. + description: List optimization jobs. Supports cursor pagination and optional status / agent_name filters. parameters: - name: Foundry-Features in: header @@ -196,7 +110,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: limit in: query required: false @@ -272,7 +186,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/OptimizationJob' + $ref: '#/components/schemas/OptimizationJobListItem' description: The requested list of items. first_id: type: string @@ -300,14 +214,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}: get: operationId: AgentOptimizationJobs_get - summary: Get an agent optimization job - description: |- - Retrieves the specified agent optimization job. - Returns 202 while the job is in progress and 200 after it reaches a terminal state. + summary: Get info about an agent optimization job. + description: Get an optimization job by id. parameters: - name: Foundry-Features in: header @@ -316,7 +228,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -336,18 +248,7 @@ paths: headers: Retry-After: required: false - schema: - type: integer - format: int32 - content: - application/json: - schema: - $ref: '#/components/schemas/OptimizationJob' - '202': - description: The request has been accepted for processing, but processing has not yet completed. - headers: - Retry-After: - required: false + description: Recommended number of seconds to wait before polling again. schema: type: integer format: int32 @@ -371,13 +272,11 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview delete: operationId: AgentOptimizationJobs_delete - summary: Delete an agent optimization job - description: |- - Deletes the specified agent optimization job and its candidate artifacts. - Cancels the job first when it is still in a non-terminal state. + summary: Deletes an agent optimization job. + description: Delete the job and its candidate artifacts. Cancels first if non-terminal. parameters: - name: Foundry-Features in: header @@ -386,20 +285,13 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true description: The ID of the job to delete. schema: type: string - - name: force - in: query - required: false - description: When true, force-delete even if the job is in a non-terminal state. - schema: - type: boolean - explode: false - name: api-version in: query required: true @@ -426,425 +318,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates: - get: - operationId: AgentOptimizationJobs_listCandidates - summary: List optimization job candidates - description: Returns the candidates produced by the specified optimization job. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - type: object - required: - - data - - has_more - properties: - data: - type: array - items: - $ref: '#/components/schemas/OptimizationCandidate' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}: - get: - operationId: AgentOptimizationJobs_getCandidate - summary: Get an optimization candidate - description: Retrieves metadata, manifest information, and promotion details for the specified candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateMetadata' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/config: - get: - operationId: AgentOptimizationJobs_getCandidateConfig - summary: Get an optimization candidate config - description: |- - Retrieves the deploy configuration JSON for the specified candidate. - Clients can use it to compose `agents.create_version(...)` requests. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateDeployConfig' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/files: - get: - operationId: AgentOptimizationJobs_getCandidateFile - summary: Get an optimization candidate file - description: Streams the specified file from the candidate's blob directory. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: path - in: query - required: true - description: Relative path of the file to download (e.g. 'files/examples.jsonl'). - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/octet-stream: - schema: - contentMediaType: application/octet-stream - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/results: - get: - operationId: AgentOptimizationJobs_getCandidateResults - summary: Get optimization candidate results - description: Retrieves full per-task evaluation results for the specified candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateResults' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote: - post: - operationId: AgentOptimizationJobs_promoteCandidate - summary: Promote an optimization candidate - description: Promotes the specified candidate and records the deployment timestamp and target agent version. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id to promote. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateRequest' - description: Promotion details. - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}:cancel: post: operationId: AgentOptimizationJobs_cancel - summary: Cancel an agent optimization job - description: |- - Requests cancellation of the specified agent optimization job. - The operation remains idempotent after the job reaches a terminal state. + summary: Cancels an agent optimization job. + description: Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state. parameters: - name: Foundry-Features in: header @@ -853,7 +332,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -890,7 +369,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agents: post: operationId: Agents_createAgent_Agents_createAgentFromCode @@ -1345,7 +824,8 @@ paths: content: application/zip: schema: - contentMediaType: application/zip + type: string + format: binary 4XX: description: Client error content: @@ -1479,7 +959,7 @@ paths: application/json: schema: type: object - unevaluatedProperties: {} + additionalProperties: {} 4XX: description: Client error content: @@ -1699,7 +1179,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents requestBody: required: true content: @@ -1820,7 +1300,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2085,7 +1565,8 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream + type: string + format: binary x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -2142,7 +1623,8 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream + type: string + format: binary 4XX: description: Client error content: @@ -2219,7 +1701,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2279,7 +1761,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2332,7 +1814,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2450,7 +1932,7 @@ paths: required_previews: - CodeAgents=V1Preview tags: - - Agent Versions + - Agents requestBody: required: true content: @@ -2560,7 +2042,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion @@ -2606,7 +2088,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents delete: operationId: Agents_deleteAgentVersion summary: Delete an agent version @@ -2662,7 +2144,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream: get: operationId: Agents_getSessionLogStream @@ -2748,7 +2230,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -2796,7 +2278,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents requestBody: required: true content: @@ -5667,7 +5149,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -5844,7 +5326,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -6961,10 +6443,9 @@ paths: format: uri description: URL to poll for operation status. operationResult: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: URL to the operation result, or null if the operation is still in progress. 4XX: description: Client error @@ -7681,7 +7162,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -7909,7 +7391,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -8158,7 +7641,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -8664,22 +8148,26 @@ paths: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -8690,41 +8178,44 @@ paths: deprecated: true safety_identifier: type: string - maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -8736,12 +8227,11 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled id: type: string @@ -8769,20 +8259,19 @@ paths: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - - type: 'null' + nullable: true incomplete_details: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - - type: 'null' + nullable: true output: type: array items: @@ -8801,33 +8290,26 @@ paths: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true output_text: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' - moderation: - anyOf: - - $ref: '#/components/schemas/OpenAI.Moderation' - - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - - type: 'null' - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true agent_reference: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/AgentReference' - - type: 'null' + nullable: true description: The agent used for this response content_filters: type: array @@ -8869,22 +8351,26 @@ paths: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -8895,41 +8381,44 @@ paths: deprecated: true safety_identifier: type: string - maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -8941,69 +8430,55 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled input: $ref: '#/components/schemas/OpenAI.InputParam' include: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.IncludeEnum' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.IncludeEnum' + nullable: true parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true default: true store: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true default: true instructions: - anyOf: - - type: string - - type: 'null' - moderation: - anyOf: - - $ref: '#/components/schemas/OpenAI.ModerationParam' - - type: 'null' + type: string + nullable: true stream: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true stream_options: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - - type: 'null' + nullable: true conversation: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ConversationParam' - - type: 'null' + nullable: true context_management: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ContextManagementParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ContextManagementParam' + nullable: true description: Context management configuration for this request. - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' agent_reference: allOf: - $ref: '#/components/schemas/AgentReference' description: The agent to use for generating the response. structured_inputs: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. get: operationId: listResponses @@ -10635,7 +10110,8 @@ paths: content: application/zip: schema: - contentMediaType: application/zip + type: string + format: binary 4XX: description: Client error content: @@ -10989,7 +10465,8 @@ paths: content: application/zip: schema: - contentMediaType: application/zip + type: string + format: binary 4XX: description: Client error content: @@ -11321,7 +10798,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -11738,7 +11215,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -12193,18 +11670,6 @@ components: allOf: - $ref: '#/components/schemas/TraceSource' description: A trace source that selects traces by agent reference with time-based filtering. - AgentIdentifier: - type: object - required: - - agent_name - properties: - agent_name: - type: string - description: Registered Foundry agent name (required). - agent_version: - type: string - description: Pinned agent version. Defaults to latest if omitted. - description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config. AgentIdentity: type: object required: @@ -12435,11 +11900,10 @@ components: - definition properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -12932,7 +12396,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13311,7 +12775,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -13356,7 +12820,7 @@ components: description: The Azure Function Tool definition. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13504,7 +12968,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13636,7 +13100,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13765,7 +13229,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13847,116 +13311,6 @@ components: - $ref: '#/components/schemas/BrowserAutomationToolConnectionParameters' description: The project connection parameters associated with the Browser Automation Tool. description: Definition of input parameters for the Browser Automation Tool. - CandidateDeployConfig: - type: object - properties: - instructions: - type: string - description: System prompt / instructions. - model: - type: string - description: Foundry deployment name. - temperature: - type: number - format: float - minimum: 0 - maximum: 2 - description: Optional sampling temperature. - skills: - type: array - items: - type: object - unevaluatedProperties: {} - description: Optional skill overrides. - tools: - type: array - items: - type: object - unevaluatedProperties: {} - description: Optional tool overrides. - description: Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version. - CandidateFileInfo: - type: object - required: - - path - - type - - size_bytes - properties: - path: - type: string - description: Relative path of the file. - type: - type: string - description: File type category (e.g. 'config', 'results'). - size_bytes: - type: integer - format: int64 - description: File size in bytes. - description: File entry in a candidate's blob directory. - CandidateMetadata: - type: object - required: - - candidate_id - - job_id - - candidate_name - - status - - has_results - - created_at - - updated_at - - files - properties: - candidate_id: - type: string - description: Server-assigned candidate identifier. - job_id: - type: string - description: Owning optimization job id. - candidate_name: - type: string - description: Display name of the candidate. - status: - type: string - description: Candidate lifecycle status. - score: - type: number - format: double - description: Candidate's aggregate score. - has_results: - type: boolean - description: Whether detailed results are available for this candidate. - created_at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was created, represented in Unix time. - updated_at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was last updated, represented in Unix time. - promotion: - allOf: - - $ref: '#/components/schemas/PromotionInfo' - description: Promotion metadata. Null if not promoted. - files: - type: array - items: - $ref: '#/components/schemas/CandidateFileInfo' - description: Files in the candidate's blob directory. - description: Candidate metadata returned by GET /candidates/{id}. - CandidateResults: - type: object - required: - - candidate_id - - results - properties: - candidate_id: - type: string - description: Owning candidate id. - results: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Per-task evaluation rows. - description: Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results. CaptureStructuredOutputsTool: type: object required: @@ -13976,7 +13330,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -14042,7 +13396,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -14216,7 +13570,7 @@ components: readOnly: true metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata of the connection readOnly: true @@ -14245,8 +13599,7 @@ components: image: type: string description: The container image for the hosted agent. - examples: - - my-registry.azurecr.io/my-hosted-agent:latest + example: my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -14294,7 +13647,8 @@ components: format: double maximum: 100 description: Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100. - exclusiveMinimum: 0 + minimum: 0 + exclusiveMinimum: true default: 100 allOf: - $ref: '#/components/schemas/EvaluationRuleAction' @@ -14325,7 +13679,7 @@ components: default: 5 data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -14388,6 +13742,8 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: + type: string + format: binary description: The code zip file (max 250 MB). required: - metadata @@ -14409,7 +13765,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14428,7 +13784,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -14446,7 +13802,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14521,6 +13877,8 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: + type: string + format: binary description: The code zip file (max 250 MB). required: - metadata @@ -14536,7 +13894,7 @@ components: description: A human-readable description of the agent. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14566,7 +13924,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14585,7 +13943,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -14594,7 +13952,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14641,9 +13999,10 @@ components: type: string description: The name of the evaluation. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -14665,7 +14024,7 @@ components: description: A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`). properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14680,9 +14039,10 @@ components: type: string description: The name of the run. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -14692,7 +14052,7 @@ components: description: Details about the run's data source. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14708,7 +14068,9 @@ components: properties: files: type: array - items: {} + items: + type: string + format: binary description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -14764,7 +14126,7 @@ components: - CustomKeys description: The credential type readOnly: true - unevaluatedProperties: + additionalProperties: type: string allOf: - $ref: '#/components/schemas/BaseCredentials' @@ -14791,7 +14153,7 @@ components: description: The provider-specific event name that fires the routine. parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Provider-specific trigger parameters. allOf: - $ref: '#/components/schemas/RoutineTrigger' @@ -14946,7 +14308,7 @@ components: description: Description to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. description: Output options for data generation job. @@ -15068,12 +14430,11 @@ components: description: The data source type discriminator. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: - azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' + mapping: {} description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -15103,7 +14464,7 @@ components: readOnly: true tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -15133,38 +14494,6 @@ components: allOf: - $ref: '#/components/schemas/EvaluatorGenerationJobSource' description: Dataset source for evaluator generation jobs — reference to a dataset. - DatasetInfo: - type: object - required: - - task_count - - is_inline - properties: - name: - type: string - description: Dataset name when using a registered dataset reference. Null for inline datasets. - version: - type: string - description: Dataset version when using a registered dataset reference. Null for inline datasets. - task_count: - type: integer - format: int32 - description: Number of tasks/rows in the dataset. - is_inline: - type: boolean - description: True when the dataset was provided inline in the request body. - description: Metadata about the dataset used for optimization, surfaced in the response. - DatasetRef: - type: object - required: - - name - properties: - name: - type: string - description: Dataset name. - version: - type: string - description: Dataset version. If not specified, the latest version is used. - description: Reference to a registered dataset in the Foundry Dataset Service. DatasetReference: type: object required: @@ -15242,7 +14571,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -15614,9 +14943,10 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -15626,7 +14956,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15797,9 +15127,10 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -15811,7 +15142,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16070,7 +15401,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Details of the input data source item. results: type: array @@ -16160,10 +15491,9 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -16184,10 +15514,10 @@ components: description: The reason for the test criteria metric. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional details about the test criteria metric. - unevaluatedProperties: {} + additionalProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -16427,7 +15757,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -16531,7 +15861,7 @@ components: description: Identifier of the evaluation group. evalRun: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -16566,7 +15896,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -16580,7 +15910,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -16594,7 +15924,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -16642,7 +15972,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -16656,7 +15986,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -16693,15 +16023,15 @@ components: description: The type of evaluator definition init_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -16938,7 +16268,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -17003,7 +16333,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -17031,7 +16361,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -17043,7 +16373,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator categories: @@ -17063,7 +16393,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -17178,9 +16508,12 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string - - type: 'null' + nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -17191,7 +16524,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -17470,18 +16803,15 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - examples: - - X-Otlp-Api-Key + example: X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - examples: - - my-secret-store + example: my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - examples: - - OTLP_KEY + example: OTLP_KEY allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' description: Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. @@ -17509,21 +16839,19 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - examples: - - '0.25' + example: '0.25' memory: type: string description: The memory configuration for the hosted agent. - examples: - - 0.5Gi + example: 0.5Gi environment_variables: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set in the hosted agent container. - examples: - - name: LOG_LEVEL - value: debug + example: + name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -17536,11 +16864,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - examples: - - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + example: + - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -17642,7 +16970,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -17786,11 +17114,11 @@ components: description: Sample type features: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -18006,7 +17334,6 @@ components: red_team_taxonomy: '#/components/schemas/RedTeamTaxonomyItemGenerationParams' response_retrieval: '#/components/schemas/ResponseRetrievalItemGenerationParams' conversation_gen_preview: '#/components/schemas/ConversationGenPreviewItemGenerationParams' - synthetic_data_gen_preview: '#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams' description: Represents the set of parameters used to control item generation operations. ItemGenerationParamsType: anyOf: @@ -18264,7 +17591,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -18306,11 +17633,10 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - anyOf: - - type: array - items: - $ref: '#/components/schemas/MemoryItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/MemoryItem' + nullable: true description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -18462,7 +17788,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -18614,7 +17940,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -18666,7 +17992,7 @@ components: readOnly: true capabilities: type: object - unevaluatedProperties: + additionalProperties: type: string description: Capabilities of deployed model readOnly: true @@ -18815,7 +18141,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -18957,6 +18283,7 @@ components: - create_file description: Create a new file with the provided diff. x-stainless-const: true + default: create_file path: type: string description: Path of the file to create. @@ -18980,6 +18307,7 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true + default: create_file path: type: string minLength: 1 @@ -19004,6 +18332,7 @@ components: - delete_file description: Delete the specified file. x-stainless-const: true + default: delete_file path: type: string description: Path of the file to delete. @@ -19023,6 +18352,7 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true + default: delete_file path: type: string minLength: 1 @@ -19088,6 +18418,7 @@ components: - apply_patch description: The type of the tool. Always `apply_patch`. x-stainless-const: true + default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Allows the assistant to create, delete, or update files using unified diffs. @@ -19105,6 +18436,7 @@ components: - update_file description: Update an existing file with the provided diff. x-stainless-const: true + default: update_file path: type: string description: Path of the file to update. @@ -19128,6 +18460,7 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true + default: update_file path: type: string minLength: 1 @@ -19153,21 +18486,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -19187,9 +18516,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true network_policy: $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' description: Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. @@ -19213,12 +18542,6 @@ components: OpenAI.ChatModel: type: string enum: - - gpt-5.4 - - gpt-5.4-mini - - gpt-5.4-nano - - gpt-5.4-mini-2026-03-17 - - gpt-5.4-nano-2026-03-17 - - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest @@ -19313,6 +18636,7 @@ components: - click description: Specifies the event type. For a click action, this property is always `click`. x-stainless-const: true + default: click button: allOf: - $ref: '#/components/schemas/OpenAI.ClickButtonType' @@ -19325,12 +18649,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the click occurred. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A click action. @@ -19391,7 +18709,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -19456,27 +18774,13 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions: - anyOf: - - type: string - - type: 'null' - prompt_cache_key: - anyOf: - - type: string - - type: 'null' - prompt_cache_retention: - anyOf: - - $ref: '#/components/schemas/OpenAI.PromptCacheRetentionEnum' - - type: 'null' - service_tier: - anyOf: - - $ref: '#/components/schemas/OpenAI.ServiceTierEnum' - - type: 'null' + type: string + nullable: true OpenAI.ComparisonFilter: type: object required: @@ -19493,8 +18797,6 @@ components: - gte - lt - lte - - in - - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -19566,14 +18868,6 @@ components: scroll: '#/components/schemas/OpenAI.ScrollParam' type: '#/components/schemas/OpenAI.TypeParam' wait: '#/components/schemas/OpenAI.WaitParam' - OpenAI.ComputerActionList: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerAction' - description: |- - Flattened batched actions for `computer_use`. Each action includes an - `type` discriminator and action-specific fields. - title: Computer Action List OpenAI.ComputerActionType: anyOf: - type: string @@ -19597,13 +18891,11 @@ components: type: string description: The ID of the pending safety check. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -19619,7 +18911,6 @@ components: - type - image_url - file_id - - detail properties: type: type: string @@ -19627,19 +18918,14 @@ components: - computer_screenshot description: Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`. x-stainless-const: true + default: computer_screenshot image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -19666,21 +18952,6 @@ components: type: string description: The identifier of an uploaded file that contains the screenshot. description: A computer screenshot image used with the computer use tool. - OpenAI.ComputerTool: - type: object - required: - - type - properties: - type: - type: string - enum: - - computer - description: The type of the computer tool. Always `computer`. - x-stainless-const: true - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - title: Computer OpenAI.ComputerUsePreviewTool: type: object required: @@ -19695,6 +18966,7 @@ components: - computer_use_preview description: The type of the computer use tool. Always `computer_use_preview`. x-stainless-const: true + default: computer_use_preview environment: allOf: - $ref: '#/components/schemas/OpenAI.ComputerEnvironment' @@ -19722,6 +18994,7 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true + default: container_auto file_ids: type: array items: @@ -19729,9 +19002,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true skills: type: array items: @@ -19758,6 +19031,7 @@ components: - container_file_citation description: The type of the container file citation. Always `container_file_citation`. x-stainless-const: true + default: container_file_citation container_id: type: string description: The ID of the container file. @@ -19798,12 +19072,19 @@ components: - allowlist description: Allow outbound network access only to specified domains. Always `allowlist`. x-stainless-const: true + default: allowlist allowed_domains: type: array items: type: string minItems: 1 description: A list of allowed domains when type is `allowlist`. + domain_secrets: + type: array + items: + $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam' + minItems: 1 + description: Optional domain-scoped secrets for allowlisted domains. allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' OpenAI.ContainerNetworkPolicyDisabledParam: @@ -19817,8 +19098,29 @@ components: - disabled description: Disable outbound network access. Always `disabled`. x-stainless-const: true + default: disabled allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' + OpenAI.ContainerNetworkPolicyDomainSecretParam: + type: object + required: + - domain + - name + - value + properties: + domain: + type: string + minLength: 1 + description: The domain associated with the secret. + name: + type: string + minLength: 1 + description: The name of the secret to inject for the domain. + value: + type: string + minLength: 1 + maxLength: 10485760 + description: The secret value to inject for the domain. OpenAI.ContainerNetworkPolicyParam: type: object required: @@ -19851,6 +19153,7 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true + default: container_reference container_id: type: string allOf: @@ -19885,9 +19188,10 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true OpenAI.ConversationItem: type: object required: @@ -19899,18 +19203,14 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' file_search_call: '#/components/schemas/OpenAI.ConversationItemFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ConversationItemWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ConversationItemImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ConversationItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput' - tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' reasoning: '#/components/schemas/OpenAI.ConversationItemReasoningItem' - compaction: '#/components/schemas/OpenAI.ConversationItemCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCall' local_shell_call_output: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput' @@ -19922,39 +19222,10 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ConversationItemMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output). title: Conversation item - OpenAI.ConversationItemAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemApplyPatchToolCall: type: object required: @@ -20019,9 +19290,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -20062,54 +19332,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A tool call to run code. title: Code interpreter tool call - OpenAI.ConversationItemCompactionBody: - type: object - required: - - type - - id - - encrypted_content - properties: - type: - type: string - enum: - - compaction - description: The type of the item. Always `compaction`. - x-stainless-const: true - default: compaction - id: - type: string - description: The unique ID of the compaction item. - encrypted_content: - type: string - description: The encrypted content that was produced by compaction. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - title: Compaction item OpenAI.ConversationItemComputerToolCall: type: object required: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -20127,8 +19369,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -20149,11 +19389,10 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ConversationItemComputerToolCallOutput: + OpenAI.ConversationItemComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -20167,7 +19406,6 @@ components: id: type: string description: The ID of the computer tool call output. - readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -20191,91 +19429,68 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.ConversationItemCustomToolCallOutputResource: + OpenAI.ConversationItemCustomToolCall: type: object required: - type - call_id - - output - - status + - name + - input properties: type: type: string enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call output in the OpenAI platform. + description: The unique ID of the custom tool call in the OpenAI platform. call_id: type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: + description: An identifier used to map this custom tool call to a tool call output. + name: type: string - description: The identifier of the actor that created the item. + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallOutputItem - OpenAI.ConversationItemCustomToolCallResource: + description: A call to a custom tool created by the model. + title: Custom tool call + OpenAI.ConversationItemCustomToolCallOutput: type: object required: - type - call_id - - name - - input - - status + - output properties: type: type: string enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call in the OpenAI platform. + description: The unique ID of the custom tool call output in the OpenAI platform. call_id: type: string - description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. - name: - type: string - description: The name of the custom tool being called. - input: - type: string - description: The input for the custom tool call generated by the model. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. + The output from the custom tool call generated by your code. + Can be a string or an list of output content. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallItem + description: The output of a custom tool call from your code, being sent back to the model. + title: Custom tool call output OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -20310,11 +19525,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -20350,12 +19564,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -20388,7 +19603,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -20396,9 +19611,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -20406,37 +19622,36 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCall: + OpenAI.ConversationItemFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -20448,42 +19663,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: |- - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. - title: Function tool call - OpenAI.ConversationItemFunctionToolCallOutput: + OpenAI.ConversationItemFunctionToolCallResource: type: object required: - - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true + description: The unique ID of the function tool call. type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -20495,8 +19700,6 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a function tool call. - title: Function tool call output OpenAI.ConversationItemImageGenToolCall: type: object required: @@ -20523,9 +19726,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -20620,13 +19822,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -20686,9 +19887,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -20719,7 +19919,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -20752,20 +19953,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -20802,10 +20001,6 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A message to or from the model. @@ -20827,9 +20022,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -20857,87 +20051,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.ConversationItemToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemType: anyOf: - type: string @@ -20951,11 +20064,7 @@ components: - image_generation_call - computer_call - computer_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - - compaction - code_interpreter_call - local_shell_call - local_shell_call_output @@ -21091,7 +20200,6 @@ components: mapping: text: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText' json_object: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject' - json_schema: '#/components/schemas/OpenAI.ResponseFormatJsonSchema' description: |- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables @@ -21147,15 +20255,15 @@ components: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true items: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + nullable: true OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -21276,7 +20384,7 @@ components: default: custom item_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -21348,7 +20456,7 @@ components: default: logs metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -21493,7 +20601,7 @@ components: default: stored_completions metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -21543,18 +20651,16 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true minLength: 1 maxLength: 64 description: |- A string of up to 64 characters that will be added to your fine-tuned model name. For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. validation_file: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -21564,16 +20670,16 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/model-optimization) for more details. integrations: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + nullable: true description: A list of integrations to enable for your fine-tuning job. seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true minimum: 0 maximum: 2147483647 description: |- @@ -21582,9 +20688,10 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -21630,13 +20737,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -21709,6 +20814,7 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true + default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -21731,6 +20837,7 @@ components: - text description: Unconstrained text format. Always `text`. x-stainless-const: true + default: text allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: Unconstrained free-form text. @@ -21747,6 +20854,7 @@ components: - custom description: The type of the custom tool. Always `custom`. x-stainless-const: true + default: custom name: type: string description: The name of the custom tool, used to identify it in tool calls. @@ -21757,9 +20865,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: The input format for the custom tool. Default is unconstrained text. - defer_loading: - type: boolean - description: Whether this tool should be deferred and discovered via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) @@ -21807,14 +20912,12 @@ components: - low - high - auto - - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' - - keys properties: type: type: string @@ -21822,6 +20925,7 @@ components: - double_click description: Specifies the event type. For a double click action, this property is always set to `double_click`. x-stainless-const: true + default: double_click x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -21830,12 +20934,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the double click occurred. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A double click action. @@ -21852,6 +20950,7 @@ components: - drag description: Specifies the event type. For a drag action, this property is always set to `drag`. x-stainless-const: true + default: drag path: type: array items: @@ -21864,12 +20963,6 @@ components: { x: 200, y: 300 } ] ``` - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -21898,10 +20991,6 @@ components: description: |- Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' type: type: string enum: @@ -21926,8 +21015,6 @@ components: `assistant` role are presumed to have been generated by the model in previous interactions. title: Input message - OpenAI.EmptyModelParam: - type: object OpenAI.Error: type: object required: @@ -21935,15 +21022,13 @@ components: - message properties: code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string details: @@ -21952,10 +21037,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} debugInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalApiError: type: object required: @@ -22085,22 +21170,26 @@ components: type: object properties: seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true max_completions_tokens: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -22353,10 +21442,10 @@ components: properties: item: type: object - unevaluatedProperties: {} + additionalProperties: {} sample: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -22385,50 +21474,49 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions_search: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true users: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true tools: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -22574,25 +21662,28 @@ components: x-stainless-const: true default: stored_completions metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true limit: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -22621,6 +21712,7 @@ components: - file_citation description: The type of the file citation. Always `file_citation`. x-stainless-const: true + default: file_citation file_id: type: string description: The ID of the file. @@ -22635,11 +21727,6 @@ components: - $ref: '#/components/schemas/OpenAI.Annotation' description: A citation to a file. title: File citation - OpenAI.FileInputDetail: - type: string - enum: - - low - - high OpenAI.FilePath: type: object required: @@ -22676,6 +21763,7 @@ components: - file_search description: The type of the file search tool. Always `file_search`. x-stainless-const: true + default: file_search vector_store_ids: type: array items: @@ -22690,9 +21778,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.Filters' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -22701,7 +21789,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -22721,9 +21809,10 @@ components: filename: type: string attributes: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - - type: 'null' + nullable: true score: type: number format: float @@ -22931,13 +22020,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -22969,20 +22056,17 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - - type: 'null' + nullable: true fine_tuned_model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true finished_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -23015,39 +22099,36 @@ components: - cancelled description: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. trained_tokens: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true training_file: type: string description: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents). validation_file: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true integrations: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + nullable: true seed: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The seed used for the fine-tuning job. estimated_finish: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. title: FineTuningJob x-oaiMeta: @@ -23179,9 +22260,8 @@ components: message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.FineTuningJobEvent: type: object required: @@ -23247,8 +22327,11 @@ components: - type: string enum: - auto - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true + - type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true default: auto learning_rate_multiplier: oneOf: @@ -23290,23 +22373,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -23325,18 +22403,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -23375,18 +22451,6 @@ components: - in_progress - completed - incomplete - OpenAI.FunctionCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete - OpenAI.FunctionCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionObject: type: object required: @@ -23401,12 +22465,11 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.FunctionParameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. @@ -23422,13 +22485,15 @@ components: items: type: string timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -23442,13 +22507,15 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -23592,6 +22659,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -23612,6 +22680,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -23662,12 +22731,6 @@ components: enum: - timeout - exit - OpenAI.FunctionShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -23679,6 +22742,7 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true + default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcome' description: Indicates that the shell call exceeded its configured time limit. @@ -23694,16 +22758,11 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true + default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcomeParam' description: Indicates that the shell call exceeded its configured time limit. title: Shell call timeout outcome - OpenAI.FunctionShellCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionShellToolParam: type: object required: @@ -23715,10 +22774,12 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true + default: shell environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -23727,7 +22788,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -23810,61 +22871,67 @@ components: - function description: The type of the function tool. Always `function`. x-stainless-const: true + default: function name: type: string description: The name of the function to call. description: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true parameters: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true strict: - anyOf: - - type: boolean - - type: 'null' - defer_loading: type: boolean - description: Whether this function is deferred and loaded via tool search. + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). title: Function - OpenAI.FunctionToolParam: + OpenAI.FunctionToolCallOutput: type: object required: - - name - type + - call_id + - output properties: - name: + id: type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9_-]+$ - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true - default: function - defer_loading: - type: boolean - description: Whether this function should be deferred and discovered via tool search. + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a function tool call. + title: Function tool call output OpenAI.GraderLabelModel: type: object required: @@ -24241,7 +23308,6 @@ components: - low - high - auto - - original OpenAI.ImageGenActionEnum: type: string enum: @@ -24259,6 +23325,7 @@ components: - image_generation description: The type of the image generation tool. Always `image_generation`. x-stainless-const: true + default: image_generation model: anyOf: - type: string @@ -24280,15 +23347,15 @@ components: or `auto`. Default: `auto`. default: auto size: - anyOf: - - type: string - - type: string - enum: - - 1024x1024 - - 1024x1536 - - 1536x1024 - - auto - description: The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. + type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: |- + The size of the generated image. One of `1024x1024`, `1024x1536`, + `1536x1024`, or `auto`. Default: `auto`. default: auto output_format: type: string @@ -24325,9 +23392,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - - type: 'null' + nullable: true input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -24352,7 +23419,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -24386,7 +23453,6 @@ components: - memory_search_call.results description: |- Specify additional output data to include in the model response. Currently supported values are: - - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. @@ -24408,6 +23474,7 @@ components: - inline description: Defines an inline skill for this request. x-stainless-const: true + default: inline name: type: string description: The name of the skill. @@ -24504,23 +23571,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -24539,18 +23601,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -24602,23 +23662,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -24634,26 +23689,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_data: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_url: - anyOf: - - type: string - format: uri - - type: 'null' - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + type: string + format: uri + nullable: true description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -24670,18 +23717,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -24697,18 +23742,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - - type: 'null' + nullable: true description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -24730,9 +23773,6 @@ components: web_search_call: '#/components/schemas/OpenAI.InputItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.InputItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam' - tool_search_call: '#/components/schemas/OpenAI.InputItemToolSearchCallItemParam' - tool_search_output: '#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam' - additional_tools: '#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.InputItemReasoningItem' compaction: '#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.InputItemImageGenToolCall' @@ -24753,38 +23793,6 @@ components: An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs. - OpenAI.InputItemAdditionalToolsItemParam: - type: object - required: - - type - - role - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - additional_tools - description: The item type. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - role: - type: string - enum: - - developer - description: The role that provided the additional tools. Only `developer` is supported. - x-stainless-const: true - default: developer - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: A list of additional tools made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemApplyPatchToolCallItemParam: type: object required: @@ -24801,9 +23809,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24836,9 +23843,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24849,9 +23855,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -24889,17 +23894,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -24911,9 +23914,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -24937,9 +23939,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24955,15 +23956,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -24974,6 +23974,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -24991,8 +23992,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -25033,9 +24032,6 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -25112,11 +24108,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -25131,9 +24126,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25157,9 +24151,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -25172,9 +24166,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25192,13 +24185,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -25211,9 +24205,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25232,13 +24225,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -25246,7 +24240,6 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -25255,7 +24248,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -25265,9 +24257,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -25315,9 +24304,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -25376,13 +24364,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -25432,9 +24419,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -25442,9 +24428,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -25475,7 +24460,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -25508,20 +24494,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -25555,10 +24539,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -25589,9 +24569,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -25619,77 +24598,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.InputItemToolSearchCallItemParam: - type: object - required: - - type - - arguments - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_call - description: The item type. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - allOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - description: The arguments supplied to the tool search call. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.InputItem' - OpenAI.InputItemToolSearchOutputItemParam: - type: object - required: - - type - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_output - description: The item type. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by the tool search output. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemType: anyOf: - type: string @@ -25703,9 +24611,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -25762,6 +24667,44 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call + OpenAI.InputMessage: + type: object + required: + - type + - role + - content + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.InputMessageContentList: type: array items: @@ -25770,6 +24713,43 @@ components: A list of one or many input items to the model, containing different content types. title: Input item content list + OpenAI.InputMessageResource: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.InputParam: oneOf: - type: string @@ -25831,7 +24811,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemInputMessage' + message: '#/components/schemas/OpenAI.InputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -25839,9 +24819,6 @@ components: web_search_call: '#/components/schemas/OpenAI.ItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.ItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam' - tool_search_call: '#/components/schemas/OpenAI.ItemToolSearchCallItemParam' - tool_search_output: '#/components/schemas/OpenAI.ItemToolSearchOutputItemParam' - additional_tools: '#/components/schemas/OpenAI.ItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.ItemReasoningItem' compaction: '#/components/schemas/OpenAI.ItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.ItemImageGenToolCall' @@ -25859,38 +24836,6 @@ components: custom_tool_call_output: '#/components/schemas/OpenAI.ItemCustomToolCallOutput' custom_tool_call: '#/components/schemas/OpenAI.ItemCustomToolCall' description: Content item used to generate a response. - OpenAI.ItemAdditionalToolsItemParam: - type: object - required: - - type - - role - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - additional_tools - description: The item type. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - role: - type: string - enum: - - developer - description: The role that provided the additional tools. Only `developer` is supported. - x-stainless-const: true - default: developer - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: A list of additional tools made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemApplyPatchToolCallItemParam: type: object required: @@ -25907,9 +24852,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25942,9 +24886,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25955,9 +24898,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -25995,17 +24937,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -26017,9 +24957,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -26043,9 +24982,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -26061,15 +24999,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -26080,6 +25017,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -26097,8 +25035,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -26139,9 +25075,6 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -26194,17 +25127,14 @@ components: discriminator: propertyName: type mapping: + function_call_output: '#/components/schemas/OpenAI.FunctionToolCallOutput' message: '#/components/schemas/OpenAI.ItemFieldMessage' function_call: '#/components/schemas/OpenAI.ItemFieldFunctionToolCall' - tool_search_call: '#/components/schemas/OpenAI.ItemFieldToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ItemFieldToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ItemFieldAdditionalTools' - function_call_output: '#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ItemFieldFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ItemFieldWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ItemFieldImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ItemFieldComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -26221,35 +25151,6 @@ components: custom_tool_call: '#/components/schemas/OpenAI.ItemFieldCustomToolCall' custom_tool_call_output: '#/components/schemas/OpenAI.ItemFieldCustomToolCallOutput' description: An item representing a message, tool call, tool output, reasoning, or other response element. - OpenAI.ItemFieldAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldApplyPatchToolCall: type: object required: @@ -26314,9 +25215,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -26357,17 +25257,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -26405,6 +25303,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -26422,8 +25321,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -26444,11 +25341,10 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemFieldComputerToolCallOutput: + OpenAI.ItemFieldComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -26462,7 +25358,6 @@ components: id: type: string description: The ID of the computer tool call output. - readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -26486,8 +25381,6 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a computer tool call. - title: Computer tool call output OpenAI.ItemFieldCustomToolCall: type: object required: @@ -26508,9 +25401,6 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -26587,11 +25477,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -26627,12 +25516,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -26665,7 +25555,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -26673,9 +25563,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -26686,7 +25577,6 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: - - id - type - call_id - name @@ -26695,7 +25585,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -26705,9 +25594,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -26729,51 +25615,6 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call - OpenAI.ItemFieldFunctionToolCallOutput: - type: object - required: - - id - - type - - call_id - - output - properties: - id: - type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true - type: - type: string - enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. - x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a function tool call. - title: Function tool call output OpenAI.ItemFieldImageGenToolCall: type: object required: @@ -26800,9 +25641,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -26861,13 +25701,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -26927,9 +25766,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -26960,7 +25798,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -26993,20 +25832,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -27043,10 +25880,6 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A message to or from the model. @@ -27068,9 +25901,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -27098,87 +25930,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.ItemFieldToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - OpenAI.ItemFieldToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldType: anyOf: - type: string @@ -27186,9 +25937,6 @@ components: enum: - message - function_call - - tool_search_call - - tool_search_output - - additional_tools - function_call_output - file_search_call - web_search_call @@ -27283,11 +26031,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -27302,9 +26049,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27328,9 +26074,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -27343,9 +26089,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27363,13 +26108,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -27382,9 +26128,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27403,13 +26148,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -27417,7 +26163,6 @@ components: OpenAI.ItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -27426,7 +26171,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -27436,9 +26180,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -27486,57 +26227,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An image generation request made by the model. title: Image generation call - OpenAI.ItemInputMessage: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - default: message - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - readOnly: true - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.ItemLocalShellToolCall: type: object required: @@ -27591,13 +26287,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -27647,9 +26342,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -27657,9 +26351,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -27690,7 +26383,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -27723,20 +26417,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -27770,10 +26462,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -27804,9 +26492,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -27846,6 +26533,7 @@ components: - item_reference description: The type of item to reference. Always `item_reference`. x-stainless-const: true + default: item_reference id: type: string description: The ID of the item to reference. @@ -27863,19 +26551,14 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemResourceInputMessage' + message: '#/components/schemas/OpenAI.InputMessageResource' output_message: '#/components/schemas/OpenAI.ItemResourceOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemResourceFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemResourceComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput' - tool_search_call: '#/components/schemas/OpenAI.ItemResourceToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ItemResourceToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ItemResourceAdditionalTools' - reasoning: '#/components/schemas/OpenAI.ItemResourceReasoningItem' - compaction: '#/components/schemas/OpenAI.ItemResourceCompactionBody' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -27888,38 +26571,7 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ItemResourceMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ItemResourceCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource' description: Content item used to generate a response. - OpenAI.ItemResourceAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceApplyPatchToolCall: type: object required: @@ -27984,9 +26636,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -28027,54 +26678,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A tool call to run code. title: Code interpreter tool call - OpenAI.ItemResourceCompactionBody: - type: object - required: - - type - - id - - encrypted_content - properties: - type: - type: string - enum: - - compaction - description: The type of the item. Always `compaction`. - x-stainless-const: true - default: compaction - id: - type: string - description: The unique ID of the compaction item. - encrypted_content: - type: string - description: The encrypted content that was produced by compaction. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - title: Compaction item OpenAI.ItemResourceComputerToolCall: type: object required: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -28092,8 +26715,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -28114,11 +26735,10 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemResourceComputerToolCallOutput: + OpenAI.ItemResourceComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -28132,7 +26752,6 @@ components: id: type: string description: The ID of the computer tool call output. - readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -28156,91 +26775,6 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.ItemResourceCustomToolCallOutputResource: - type: object - required: - - type - - call_id - - output - - status - properties: - type: - type: string - enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. - x-stainless-const: true - id: - type: string - description: The unique ID of the custom tool call output in the OpenAI platform. - call_id: - type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - title: ResponseCustomToolCallOutputItem - OpenAI.ItemResourceCustomToolCallResource: - type: object - required: - - type - - call_id - - name - - input - - status - properties: - type: - type: string - enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. - x-stainless-const: true - id: - type: string - description: The unique ID of the custom tool call in the OpenAI platform. - call_id: - type: string - description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. - name: - type: string - description: The name of the custom tool being called. - input: - type: string - description: The input for the custom tool call generated by the model. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - title: ResponseCustomToolCallItem OpenAI.ItemResourceFileSearchToolCall: type: object required: @@ -28275,11 +26809,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -28315,12 +26848,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -28353,7 +26887,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -28361,9 +26895,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -28371,37 +26906,36 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCall: + OpenAI.ItemResourceFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -28413,42 +26947,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: |- - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. - title: Function tool call - OpenAI.ItemResourceFunctionToolCallOutput: + OpenAI.ItemResourceFunctionToolCallResource: type: object required: - - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true + description: The unique ID of the function tool call. type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -28460,8 +26984,6 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: The output of a function tool call. - title: Function tool call output OpenAI.ItemResourceImageGenToolCall: type: object required: @@ -28488,57 +27010,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An image generation request made by the model. title: Image generation call - OpenAI.ItemResourceInputMessage: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - default: message - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - readOnly: true - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.ItemResourceLocalShellToolCall: type: object required: @@ -28593,13 +27070,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -28659,9 +27135,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -28692,7 +27167,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -28725,20 +27201,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -28772,10 +27246,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -28789,134 +27259,6 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An output message from the model. title: Output message - OpenAI.ItemResourceReasoningItem: - type: object - required: - - type - - id - - summary - properties: - type: - type: string - enum: - - reasoning - description: The type of the object. Always `reasoning`. - x-stainless-const: true - id: - type: string - description: The unique identifier of the reasoning content. - encrypted_content: - anyOf: - - type: string - - type: 'null' - summary: - type: array - items: - $ref: '#/components/schemas/OpenAI.SummaryTextContent' - description: Reasoning summary content. - content: - type: array - items: - $ref: '#/components/schemas/OpenAI.ReasoningTextContent' - description: Reasoning text content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - description: |- - A description of the chain of thought used by a reasoning model while generating - a response. Be sure to include these items in your `input` to the Responses API - for subsequent turns of a conversation if you are manually - [managing context](/docs/guides/conversation-state). - title: Reasoning - OpenAI.ItemResourceToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceType: anyOf: - type: string @@ -28930,11 +27272,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - - reasoning - - compaction - image_generation_call - code_interpreter_call - local_shell_call @@ -28947,8 +27284,6 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call - - custom_tool_call - - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -29012,77 +27347,6 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call - OpenAI.ItemToolSearchCallItemParam: - type: object - required: - - type - - arguments - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_call - description: The item type. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - allOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - description: The arguments supplied to the tool search call. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - OpenAI.ItemToolSearchOutputItemParam: - type: object - required: - - type - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_output - description: The item type. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by the tool search output. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemType: anyOf: - type: string @@ -29096,9 +27360,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -29190,6 +27451,7 @@ components: - keypress description: Specifies the event type. For a keypress action, this property is always set to `keypress`. x-stainless-const: true + default: keypress keys: type: array items: @@ -29217,13 +27479,11 @@ components: - list x-stainless-const: true first_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true last_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true x-ms-list-continuation-token: true has_more: type: boolean @@ -29276,10 +27536,23 @@ components: - local description: The environment type. Always `local`. x-stainless-const: true + default: local allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' description: Represents the use of a local environment to perform shell actions. title: Local Environment + OpenAI.LocalShellCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete + OpenAI.LocalShellCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.LocalShellExecAction: type: object required: @@ -29300,23 +27573,22 @@ components: type: string description: The command to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true working_directory: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true env: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -29330,6 +27602,7 @@ components: - local_shell description: The type of the local shell tool. Always `local_shell`. x-stainless-const: true + default: local_shell name: type: string description: Optional user-defined name for this tool or configuration. @@ -29338,7 +27611,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -29396,17 +27669,17 @@ components: type: string description: The name of the tool. description: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - - type: 'null' + nullable: true description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -29468,36 +27741,38 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true allowed_tools: anyOf: - type: array items: type: string - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - - type: 'null' + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string enum: - always - never - - type: 'null' + nullable: true default: always - defer_loading: - type: boolean - description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -29559,7 +27834,6 @@ components: refusal: '#/components/schemas/OpenAI.MessageContentRefusalContent' input_image: '#/components/schemas/OpenAI.MessageContentInputImageContent' input_file: '#/components/schemas/OpenAI.MessageContentInputFileContent' - summary_text: '#/components/schemas/OpenAI.SummaryTextContent' description: A content part that makes up an input or output item. OpenAI.MessageContentInputFileContent: type: object @@ -29574,23 +27848,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -29609,18 +27878,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -29730,15 +27997,6 @@ components: - input_image - computer_screenshot - input_file - OpenAI.MessagePhase: - type: string - enum: - - commentary - - final_answer - description: |- - Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). - For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend - phase on all assistant messages — dropping it can degrade performance. Not used for user messages. OpenAI.MessageRole: type: string enum: @@ -29758,7 +28016,7 @@ components: - incomplete OpenAI.Metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -29769,9 +28027,13 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' + - allOf: + - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' + description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. + nullable: true - type: string - - type: 'null' + description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. + nullable: true description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. OpenAI.ModelIdsResponses: anyOf: @@ -29796,125 +28058,6 @@ components: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.ChatModel' - OpenAI.Moderation: - type: object - required: - - input - - output - properties: - input: - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: Moderation for the response input. - output: - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: Moderation for the response output. - description: Moderation results or errors for the response input and output. - title: Moderation - OpenAI.ModerationEntry: - type: object - required: - - type - properties: - type: - $ref: '#/components/schemas/OpenAI.ModerationEntryType' - discriminator: - propertyName: type - mapping: - moderation_result: '#/components/schemas/OpenAI.ModerationResultBody' - error: '#/components/schemas/OpenAI.ModerationErrorBody' - description: Moderation results or an error for a response moderation check. - OpenAI.ModerationEntryType: - anyOf: - - type: string - - type: string - enum: - - moderation_result - - error - OpenAI.ModerationErrorBody: - type: object - required: - - type - - code - - message - properties: - type: - type: string - enum: - - error - description: The object type, which was always `error` for moderation failures. - x-stainless-const: true - code: - type: string - description: The error code. - message: - type: string - description: The error message. - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: An error produced while attempting moderation for the response input or output. - title: Moderation error - OpenAI.ModerationInputType: - type: string - enum: - - text - - image - OpenAI.ModerationParam: - type: object - required: - - model - properties: - model: - type: string - description: The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. - description: Configuration for running moderation on the input and output of this response. - OpenAI.ModerationResultBody: - type: object - required: - - type - - model - - flagged - - categories - - category_scores - - category_applied_input_types - properties: - type: - type: string - enum: - - moderation_result - description: The object type, which was always `moderation_result` for successful moderation results. - x-stainless-const: true - model: - type: string - description: The moderation model that produced this result. - flagged: - type: boolean - description: A boolean indicating whether the content was flagged by any category. - categories: - type: object - unevaluatedProperties: - type: boolean - description: A dictionary of moderation categories to booleans, True if the input is flagged under this category. - x-oaiTypeLabel: map - category_scores: - type: object - unevaluatedProperties: - $ref: '#/components/schemas/OpenAI.numeric' - description: A dictionary of moderation categories to scores. - x-oaiTypeLabel: map - category_applied_input_types: - type: object - unevaluatedProperties: - type: array - items: - $ref: '#/components/schemas/OpenAI.ModerationInputType' - description: Which modalities of input are reflected by the score for each category. - x-oaiTypeLabel: map - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: A moderation result produced for the response input or output. - title: Moderation result OpenAI.MoveParam: type: object required: @@ -29928,6 +28071,7 @@ components: - move description: Specifies the event type. For a move action, this property is always set to `move`. x-stainless-const: true + default: move x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -29936,50 +28080,10 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate to move to. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A mouse move action. title: Move - OpenAI.NamespaceToolParam: - type: object - required: - - type - - name - - description - - tools - properties: - type: - type: string - enum: - - namespace - description: The type of the tool. Always `namespace`. - x-stainless-const: true - name: - type: string - minLength: 1 - description: The namespace name used in tool calls (for example, `crm`). - description: - type: string - minLength: 1 - description: A description of the namespace shown to the model. - tools: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionToolParam' - - $ref: '#/components/schemas/OpenAI.CustomToolParam' - minItems: 1 - description: The function/custom tools available inside this namespace. - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: Groups function/custom tools under a shared namespace. - title: Namespace OpenAI.OutputContent: type: object required: @@ -30116,19 +28220,13 @@ components: output_message: '#/components/schemas/OpenAI.OutputItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.OutputItemFileSearchToolCall' function_call: '#/components/schemas/OpenAI.OutputItemFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput' web_search_call: '#/components/schemas/OpenAI.OutputItemWebSearchToolCall' computer_call: '#/components/schemas/OpenAI.OutputItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.OutputItemComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.OutputItemReasoningItem' - tool_search_call: '#/components/schemas/OpenAI.OutputItemToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.OutputItemToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.OutputItemAdditionalTools' compaction: '#/components/schemas/OpenAI.OutputItemCompactionBody' image_generation_call: '#/components/schemas/OpenAI.OutputItemImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.OutputItemLocalShellToolCall' - local_shell_call_output: '#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput' shell_call: '#/components/schemas/OpenAI.OutputItemFunctionShellCall' shell_call_output: '#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput' apply_patch_call: '#/components/schemas/OpenAI.OutputItemApplyPatchToolCall' @@ -30136,38 +28234,7 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource' - custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource' - OpenAI.OutputItemAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -30232,9 +28299,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -30275,17 +28341,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -30323,6 +28387,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -30340,8 +28405,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -30362,99 +28425,13 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.OutputItemComputerToolCallOutput: - type: object - required: - - type - - id - - call_id - - output - properties: - type: - type: string - enum: - - computer_call_output - description: The type of the computer tool call output. Always `computer_call_output`. - x-stainless-const: true - default: computer_call_output - id: - type: string - description: The ID of the computer tool call output. - readOnly: true - call_id: - type: string - description: The ID of the computer tool call that produced the output. - acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - description: |- - The safety checks reported by the API that have been acknowledged by the - developer. - output: - $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the message input. One of `in_progress`, `completed`, or - `incomplete`. Populated when input items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.OutputItemCustomToolCallOutputResource: - type: object - required: - - type - - call_id - - output - - status - properties: - type: - type: string - enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. - x-stainless-const: true - id: - type: string - description: The unique ID of the custom tool call output in the OpenAI platform. - call_id: - type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - title: ResponseCustomToolCallOutputItem - OpenAI.OutputItemCustomToolCallResource: + OpenAI.OutputItemCustomToolCall: type: object required: - type - call_id - name - input - - status properties: type: type: string @@ -30468,27 +28445,16 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. input: type: string description: The input for the custom tool call generated by the model. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' - title: ResponseCustomToolCallItem + description: A call to a custom tool created by the model. + title: Custom tool call OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -30523,11 +28489,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -30563,12 +28528,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -30601,7 +28567,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -30609,9 +28575,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -30622,7 +28589,6 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -30631,7 +28597,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -30641,9 +28606,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -30665,51 +28627,6 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call - OpenAI.OutputItemFunctionToolCallOutput: - type: object - required: - - id - - type - - call_id - - output - properties: - id: - type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true - type: - type: string - enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. - x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: The output of a function tool call. - title: Function tool call output OpenAI.OutputItemImageGenToolCall: type: object required: @@ -30736,9 +28653,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -30777,37 +28693,6 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run a command on the local shell. title: Local shell call - OpenAI.OutputItemLocalShellToolCallOutput: - type: object - required: - - type - - id - - output - properties: - type: - type: string - enum: - - local_shell_call_output - description: The type of the local shell tool call output. Always `local_shell_call_output`. - x-stainless-const: true - id: - type: string - description: The unique ID of the local shell tool call generated by the model. - output: - type: string - description: A JSON string of the output of the local shell tool call. - status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: The output of a local shell tool call. - title: Local shell call output OpenAI.OutputItemMcpApprovalRequest: type: object required: @@ -30839,37 +28724,6 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A request for human approval of a tool invocation. title: MCP approval request - OpenAI.OutputItemMcpApprovalResponseResource: - type: object - required: - - type - - id - - approval_request_id - - approve - properties: - type: - type: string - enum: - - mcp_approval_response - description: The type of the item. Always `mcp_approval_response`. - x-stainless-const: true - id: - type: string - description: The unique ID of the approval response - approval_request_id: - type: string - description: The ID of the approval request being answered. - approve: - type: boolean - description: Whether the request was approved. - reason: - anyOf: - - type: string - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: A response to an MCP approval request. - title: MCP approval response OpenAI.OutputItemMcpListTools: type: object required: @@ -30896,7 +28750,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -30929,20 +28784,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -30976,10 +28829,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -31010,9 +28859,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -31040,87 +28888,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.OutputItemToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - OpenAI.OutputItemToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemType: anyOf: - type: string @@ -31129,19 +28896,13 @@ components: - output_message - file_search_call - function_call - - function_call_output - web_search_call - computer_call - - computer_call_output - reasoning - - tool_search_call - - tool_search_output - - additional_tools - compaction - image_generation_call - code_interpreter_call - local_shell_call - - local_shell_call_output - shell_call - shell_call_output - apply_patch_call @@ -31149,9 +28910,7 @@ components: - mcp_call - mcp_list_tools - mcp_approval_request - - mcp_approval_response - custom_tool_call - - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -31294,21 +29053,16 @@ components: type: string description: The unique identifier of the prompt template to use. version: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true variables: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - - type: 'null' + nullable: true description: |- Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). - OpenAI.PromptCacheRetentionEnum: - type: string - enum: - - in_memory - - 24h OpenAI.RankerVersionType: type: string enum: @@ -31329,118 +29083,39 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.HybridSearchOptions' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - OpenAI.RealtimeMCPError: - type: object - required: - - type - properties: - type: - $ref: '#/components/schemas/OpenAI.RealtimeMcpErrorType' - discriminator: - propertyName: type - mapping: - protocol_error: '#/components/schemas/OpenAI.RealtimeMCPProtocolError' - tool_execution_error: '#/components/schemas/OpenAI.RealtimeMCPToolExecutionError' - http_error: '#/components/schemas/OpenAI.RealtimeMCPHTTPError' - OpenAI.RealtimeMCPHTTPError: - type: object - required: - - type - - code - - message - properties: - type: - type: string - enum: - - http_error - x-stainless-const: true - code: - $ref: '#/components/schemas/OpenAI.integer' - message: - type: string - allOf: - - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' - title: Realtime MCP HTTP error - OpenAI.RealtimeMCPProtocolError: - type: object - required: - - type - - code - - message - properties: - type: - type: string - enum: - - protocol_error - x-stainless-const: true - code: - $ref: '#/components/schemas/OpenAI.integer' - message: - type: string - allOf: - - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' - title: Realtime MCP protocol error - OpenAI.RealtimeMCPToolExecutionError: - type: object - required: - - type - - message - properties: - type: - type: string - enum: - - tool_execution_error - x-stainless-const: true - message: - type: string - allOf: - - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' - title: Realtime MCP tool execution error - OpenAI.RealtimeMcpErrorType: - anyOf: - - type: string - - type: string - enum: - - protocol_error - - tool_execution_error - - http_error OpenAI.Reasoning: type: object properties: effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' summary: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true generate_summary: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - anyOf: - - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh - - type: 'null' + type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -31451,6 +29126,7 @@ components: - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + nullable: true OpenAI.ReasoningTextContent: type: object required: @@ -31483,22 +29159,26 @@ components: - agent_reference properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -31509,41 +29189,44 @@ components: deprecated: true safety_identifier: type: string - maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -31555,12 +29238,11 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled id: type: string @@ -31588,20 +29270,19 @@ components: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - - type: 'null' + nullable: true incomplete_details: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - - type: 'null' + nullable: true output: type: array items: @@ -31620,33 +29301,26 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true output_text: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' - moderation: - anyOf: - - $ref: '#/components/schemas/OpenAI.Moderation' - - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - - type: 'null' - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true agent_reference: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/AgentReference' - - type: 'null' + nullable: true description: The agent used for this response content_filters: type: array @@ -31673,10 +29347,8 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - contentEncoding: base64 + format: base64 description: A chunk of Base64 encoded response audio bytes. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial audio response. x-oaiMeta: name: response.audio.delta @@ -31704,8 +29376,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the delta. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the audio response is complete. x-oaiMeta: name: response.audio.done @@ -31736,8 +29406,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial transcript of audio. x-oaiMeta: name: response.audio.transcript.delta @@ -31765,8 +29433,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the full audio transcript is completed. x-oaiMeta: name: response.audio.transcript.done @@ -31806,8 +29472,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial code snippet is streamed by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.delta @@ -31849,8 +29513,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code snippet is finalized by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.done @@ -31888,8 +29550,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter call is completed. x-oaiMeta: name: response.code_interpreter_call.completed @@ -31926,8 +29586,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a code interpreter call is in progress. x-oaiMeta: name: response.code_interpreter_call.in_progress @@ -31964,8 +29622,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter is actively interpreting the code snippet. x-oaiMeta: name: response.code_interpreter_call.interpreting @@ -31998,8 +29654,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the model response is complete. x-oaiMeta: name: response.completed @@ -32094,8 +29748,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new content part is added. x-oaiMeta: name: response.content_part.added @@ -32148,8 +29800,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputContent' description: The content part that is done. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a content part is done. x-oaiMeta: name: response.content_part.done @@ -32188,8 +29838,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response is created. x-oaiMeta: name: response.created @@ -32261,8 +29909,6 @@ components: delta: type: string description: The incremental input data (delta) for the custom tool call. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event representing a delta (partial update) to the input of a custom tool call. title: ResponseCustomToolCallInputDelta x-oaiMeta: @@ -32304,8 +29950,6 @@ components: input: type: string description: The complete input data for the custom tool call. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event indicating that input for a custom tool call is complete. title: ResponseCustomToolCallInputDone x-oaiMeta: @@ -32368,22 +30012,18 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string description: The error message. param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true sequence_number: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an error occurs. x-oaiMeta: name: error @@ -32417,8 +30057,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Response' description: The response that failed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response fails. x-oaiMeta: name: response.failed @@ -32484,8 +30122,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is completed (results found). x-oaiMeta: name: response.file_search_call.completed @@ -32522,8 +30158,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is initiated. x-oaiMeta: name: response.file_search_call.in_progress @@ -32560,8 +30194,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search is currently searching. x-oaiMeta: name: response.file_search_call.searching @@ -32625,12 +30257,11 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.ResponseFormatJsonSchemaSchema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -32677,8 +30308,6 @@ components: delta: type: string description: The function-call arguments delta that is added. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial function-call arguments delta. x-oaiMeta: name: response.function_call_arguments.delta @@ -32723,8 +30352,6 @@ components: arguments: type: string description: The function-call arguments. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when function-call arguments are finalized. x-oaiMeta: name: response.function_call_arguments.done @@ -32763,8 +30390,6 @@ components: item_id: type: string description: The unique identifier of the image generation item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call has completed and the final image is available. title: ResponseImageGenCallCompletedEvent x-oaiMeta: @@ -32802,8 +30427,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is actively generating an image (intermediate state). title: ResponseImageGenCallGeneratingEvent x-oaiMeta: @@ -32841,8 +30464,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is in progress. title: ResponseImageGenCallInProgressEvent x-oaiMeta: @@ -32889,8 +30510,6 @@ components: partial_image_b64: type: string description: Base64-encoded partial image data, suitable for rendering as an image. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial image is available during image generation streaming. title: ResponseImageGenCallPartialImageEvent x-oaiMeta: @@ -32926,8 +30545,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the response is in progress. x-oaiMeta: name: response.in_progress @@ -32999,8 +30616,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response finishes as incomplete. x-oaiMeta: name: response.incomplete @@ -33058,7 +30673,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probabilities of up to 20 of the most likely tokens. + description: The log probability of the top 20 most likely tokens. description: |- A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) @@ -33099,8 +30714,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a delta (partial update) to the arguments of an MCP tool call. title: ResponseMCPCallArgumentsDeltaEvent x-oaiMeta: @@ -33143,8 +30756,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the arguments for an MCP tool call are finalized. title: ResponseMCPCallArgumentsDoneEvent x-oaiMeta: @@ -33183,8 +30794,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has completed successfully. title: ResponseMCPCallCompletedEvent x-oaiMeta: @@ -33222,8 +30831,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has failed. title: ResponseMCPCallFailedEvent x-oaiMeta: @@ -33261,8 +30868,6 @@ components: item_id: type: string description: The unique identifier of the MCP tool call item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call is in progress. title: ResponseMCPCallInProgressEvent x-oaiMeta: @@ -33300,8 +30905,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the list of available MCP tools has been successfully retrieved. title: ResponseMCPListToolsCompletedEvent x-oaiMeta: @@ -33339,8 +30942,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the attempt to list available MCP tools has failed. title: ResponseMCPListToolsFailedEvent x-oaiMeta: @@ -33378,8 +30979,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the system is in the process of retrieving the list of available MCP tools. title: ResponseMCPListToolsInProgressEvent x-oaiMeta: @@ -33418,8 +31017,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was added. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new output item is added. x-oaiMeta: name: response.output_item.added @@ -33463,8 +31060,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was marked done. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an output item is marked done. x-oaiMeta: name: response.output_item.done @@ -33528,8 +31123,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Annotation' description: The annotation object being added. (See annotation schema for details.) - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an annotation is added to output text content. title: ResponseOutputTextAnnotationAddedEvent x-oaiMeta: @@ -33552,7 +31145,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -33586,8 +31179,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a response is queued and waiting to be processed. title: ResponseQueuedEvent x-oaiMeta: @@ -33639,8 +31230,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEventPart' description: The summary part that was added. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new reasoning summary part is added. x-oaiMeta: name: response.reasoning_summary_part.added @@ -33705,8 +31294,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEventPart' description: The completed summary part. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary part is completed. x-oaiMeta: name: response.reasoning_summary_part.done @@ -33772,8 +31359,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning summary text. x-oaiMeta: name: response.reasoning_summary_text.delta @@ -33823,8 +31408,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary text is completed. x-oaiMeta: name: response.reasoning_summary_text.done @@ -33874,8 +31457,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning text. x-oaiMeta: name: response.reasoning_text.delta @@ -33923,8 +31504,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning text is completed. x-oaiMeta: name: response.reasoning_text.done @@ -33972,8 +31551,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial refusal text. x-oaiMeta: name: response.refusal.delta @@ -34021,8 +31598,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when refusal text is finalized. x-oaiMeta: name: response.refusal.done @@ -34036,127 +31611,6 @@ components: "refusal": "final refusal text", "sequence_number": 1 } - OpenAI.ResponseStreamEvent: - type: object - required: - - type - properties: - type: - $ref: '#/components/schemas/OpenAI.ResponseStreamEventType' - discriminator: - propertyName: type - mapping: - response.audio.transcript.delta: '#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent' - response.code_interpreter_call_code.delta: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent' - response.code_interpreter_call.in_progress: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent' - response.code_interpreter_call.interpreting: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent' - response.content_part.added: '#/components/schemas/OpenAI.ResponseContentPartAddedEvent' - response.created: '#/components/schemas/OpenAI.ResponseCreatedEvent' - error: '#/components/schemas/OpenAI.ResponseErrorEvent' - response.file_search_call.in_progress: '#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent' - response.file_search_call.searching: '#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent' - response.function_call_arguments.delta: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent' - response.in_progress: '#/components/schemas/OpenAI.ResponseInProgressEvent' - response.failed: '#/components/schemas/OpenAI.ResponseFailedEvent' - response.incomplete: '#/components/schemas/OpenAI.ResponseIncompleteEvent' - response.output_item.added: '#/components/schemas/OpenAI.ResponseOutputItemAddedEvent' - response.reasoning_summary_part.added: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent' - response.reasoning_summary_text.delta: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent' - response.reasoning_text.delta: '#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent' - response.refusal.delta: '#/components/schemas/OpenAI.ResponseRefusalDeltaEvent' - response.output_text.delta: '#/components/schemas/OpenAI.ResponseTextDeltaEvent' - response.web_search_call.in_progress: '#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent' - response.web_search_call.searching: '#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent' - response.image_generation_call.generating: '#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent' - response.image_generation_call.in_progress: '#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent' - response.image_generation_call.partial_image: '#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent' - response.mcp_call_arguments.delta: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent' - response.mcp_call.failed: '#/components/schemas/OpenAI.ResponseMCPCallFailedEvent' - response.mcp_call.in_progress: '#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent' - response.mcp_list_tools.failed: '#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent' - response.mcp_list_tools.in_progress: '#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent' - response.output_text.annotation.added: '#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent' - response.queued: '#/components/schemas/OpenAI.ResponseQueuedEvent' - response.custom_tool_call_input.delta: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent' - response.audio.done: '#/components/schemas/OpenAI.ResponseAudioDoneEvent' - response.audio.transcript.done: '#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent' - response.code_interpreter_call_code.done: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent' - response.code_interpreter_call.completed: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent' - response.completed: '#/components/schemas/OpenAI.ResponseCompletedEvent' - response.content_part.done: '#/components/schemas/OpenAI.ResponseContentPartDoneEvent' - response.file_search_call.completed: '#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent' - response.function_call_arguments.done: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent' - response.output_item.done: '#/components/schemas/OpenAI.ResponseOutputItemDoneEvent' - response.reasoning_summary_part.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent' - response.reasoning_summary_text.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent' - response.reasoning_text.done: '#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent' - response.refusal.done: '#/components/schemas/OpenAI.ResponseRefusalDoneEvent' - response.output_text.done: '#/components/schemas/OpenAI.ResponseTextDoneEvent' - response.web_search_call.completed: '#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent' - response.image_generation_call.completed: '#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent' - response.mcp_call_arguments.done: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent' - response.mcp_call.completed: '#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent' - response.mcp_list_tools.completed: '#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent' - response.custom_tool_call_input.done: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent' - response.audio.delta: '#/components/schemas/OpenAI.ResponseAudioDeltaEvent' - OpenAI.ResponseStreamEventType: - anyOf: - - type: string - - type: string - enum: - - response.audio.delta - - response.audio.done - - response.audio.transcript.delta - - response.audio.transcript.done - - response.code_interpreter_call_code.delta - - response.code_interpreter_call_code.done - - response.code_interpreter_call.completed - - response.code_interpreter_call.in_progress - - response.code_interpreter_call.interpreting - - response.completed - - response.content_part.added - - response.content_part.done - - response.created - - error - - response.file_search_call.completed - - response.file_search_call.in_progress - - response.file_search_call.searching - - response.function_call_arguments.delta - - response.function_call_arguments.done - - response.in_progress - - response.failed - - response.incomplete - - response.output_item.added - - response.output_item.done - - response.reasoning_summary_part.added - - response.reasoning_summary_part.done - - response.reasoning_summary_text.delta - - response.reasoning_summary_text.done - - response.reasoning_text.delta - - response.reasoning_text.done - - response.refusal.delta - - response.refusal.done - - response.output_text.delta - - response.output_text.done - - response.web_search_call.completed - - response.web_search_call.in_progress - - response.web_search_call.searching - - response.image_generation_call.completed - - response.image_generation_call.generating - - response.image_generation_call.in_progress - - response.image_generation_call.partial_image - - response.mcp_call_arguments.delta - - response.mcp_call_arguments.done - - response.mcp_call.completed - - response.mcp_call.failed - - response.mcp_call.in_progress - - response.mcp_list_tools.completed - - response.mcp_list_tools.failed - - response.mcp_list_tools.in_progress - - response.output_text.annotation.added - - response.queued - - response.custom_tool_call_input.delta - - response.custom_tool_call_input.done OpenAI.ResponseStreamOptions: type: object properties: @@ -34211,8 +31665,6 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is an additional text delta. x-oaiMeta: name: response.output_text.delta @@ -34266,8 +31718,6 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when text content is finalized. x-oaiMeta: name: response.output_text.done @@ -34364,8 +31814,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is completed. x-oaiMeta: name: response.web_search_call.completed @@ -34402,8 +31850,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is initiated. x-oaiMeta: name: response.web_search_call.in_progress @@ -34440,8 +31886,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is executing. x-oaiMeta: name: response.web_search_call.searching @@ -34464,6 +31908,7 @@ components: - screenshot description: Specifies the event type. For a screenshot action, this property is always set to `screenshot`. x-stainless-const: true + default: screenshot allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A screenshot action. @@ -34483,6 +31928,7 @@ components: - scroll description: Specifies the event type. For a scroll action, this property is always set to `scroll`. x-stainless-const: true + default: scroll x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -34499,21 +31945,10 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The vertical scroll distance. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A scroll action. title: Scroll - OpenAI.SearchContentType: - type: string - enum: - - text - - image OpenAI.SearchContextSize: type: string enum: @@ -34521,15 +31956,13 @@ components: - medium - high OpenAI.ServiceTier: - anyOf: - - type: string - enum: - - auto - - default - - flex - - scale - - priority - - type: 'null' + type: string + enum: + - auto + - default + - flex + - scale + - priority description: |- Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. @@ -34537,13 +31970,7 @@ components: - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - OpenAI.ServiceTierEnum: - type: string - enum: - - auto - - default - - flex - - priority + nullable: true OpenAI.SkillReferenceParam: type: object required: @@ -34556,6 +31983,7 @@ components: - skill_reference description: References a skill created with the /v1/skills endpoint. x-stainless-const: true + default: skill_reference skill_id: type: string minLength: 1 @@ -34577,6 +32005,7 @@ components: - apply_patch description: The tool to call. Always `apply_patch`. x-stainless-const: true + default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the apply_patch tool when executing a tool call. @@ -34592,6 +32021,7 @@ components: - shell description: The tool to call. Always `shell`. x-stainless-const: true + default: shell allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the shell tool when a tool call is required. @@ -34608,6 +32038,7 @@ components: - summary_text description: The type of the object. Always `summary_text`. x-stainless-const: true + default: summary_text text: type: string description: A summary of the reasoning output from the model so far. @@ -34626,6 +32057,7 @@ components: enum: - text x-stainless-const: true + default: text text: type: string allOf: @@ -34723,9 +32155,8 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -34768,9 +32199,6 @@ components: custom: '#/components/schemas/OpenAI.CustomToolParam' web_search_preview: '#/components/schemas/OpenAI.WebSearchPreviewTool' apply_patch: '#/components/schemas/OpenAI.ApplyPatchToolParam' - computer: '#/components/schemas/OpenAI.ComputerTool' - namespace: '#/components/schemas/OpenAI.NamespaceToolParam' - tool_search: '#/components/schemas/OpenAI.ToolSearchToolParam' description: A tool that can be used to generate a response. OpenAI.ToolChoiceAllowed: type: object @@ -34799,7 +32227,7 @@ components: type: array items: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: @@ -34828,34 +32256,6 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). - OpenAI.ToolChoiceComputer: - type: object - required: - - type - properties: - type: - type: string - enum: - - computer - allOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - description: |- - Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). - OpenAI.ToolChoiceComputerUse: - type: object - required: - - type - properties: - type: - type: string - enum: - - computer_use - allOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - description: |- - Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). OpenAI.ToolChoiceComputerUsePreview: type: object required: @@ -34952,9 +32352,8 @@ components: type: string description: The label of the MCP server to use. name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -34994,8 +32393,6 @@ components: web_search_preview_2025_03_11: '#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311' image_generation: '#/components/schemas/OpenAI.ToolChoiceImageGeneration' code_interpreter: '#/components/schemas/OpenAI.ToolChoiceCodeInterpreter' - computer: '#/components/schemas/OpenAI.ToolChoiceComputer' - computer_use: '#/components/schemas/OpenAI.ToolChoiceComputerUse' description: |- How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools @@ -35017,8 +32414,6 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter - - computer - - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -35047,38 +32442,6 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). - OpenAI.ToolSearchExecutionType: - type: string - enum: - - server - - client - OpenAI.ToolSearchToolParam: - type: object - required: - - type - properties: - type: - type: string - enum: - - tool_search - description: The type of the tool. Always `tool_search`. - x-stainless-const: true - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search is executed by the server or by the client. - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: Hosted or BYOT tool search configuration for deferred tools. - title: Tool search tool OpenAI.ToolType: anyOf: - type: string @@ -35086,7 +32449,6 @@ components: enum: - function - file_search - - computer - computer_use_preview - web_search - mcp @@ -35095,8 +32457,6 @@ components: - local_shell - shell - custom - - namespace - - tool_search - web_search_preview - apply_patch - a2a_preview @@ -35162,6 +32522,7 @@ components: - type description: Specifies the event type. For a type action, this property is always set to `type`. x-stainless-const: true + default: type text: type: string description: The text to type. @@ -35175,9 +32536,10 @@ components: - metadata properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -35196,6 +32558,7 @@ components: - url_citation description: The type of the URL citation. Always `url_citation`. x-stainless-const: true + default: url_citation url: type: string format: uri @@ -35217,7 +32580,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -35230,17 +32593,16 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - anyOf: - - type: string - enum: - - low - - medium - - high - - type: 'null' + type: string + enum: + - low + - medium + - high description: |- Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. + nullable: true OpenAI.WaitParam: type: object required: @@ -35252,6 +32614,7 @@ components: - wait description: Specifies the event type. For a wait action, this property is always set to `wait`. x-stainless-const: true + default: wait allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A wait action. @@ -35290,10 +32653,9 @@ components: description: The action type. x-stainless-const: true url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -35301,6 +32663,7 @@ components: type: object required: - type + - query properties: type: type: string @@ -35310,7 +32673,7 @@ components: x-stainless-const: true query: type: string - description: The search query. + description: '[DEPRECATED] The search query.' deprecated: true queries: type: array @@ -35339,7 +32702,6 @@ components: x-stainless-const: true url: type: string - format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -35353,21 +32715,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -35381,18 +32739,16 @@ components: - web_search_preview description: The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. x-stainless-const: true + default: web_search_preview user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - - type: 'null' + nullable: true search_context_size: allOf: - $ref: '#/components/schemas/OpenAI.SearchContextSize' description: High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - search_content_types: - type: array - items: - $ref: '#/components/schemas/OpenAI.SearchContentType' allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). @@ -35407,14 +32763,17 @@ components: enum: - web_search description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. + default: web_search filters: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - - type: 'null' + nullable: true user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - - type: 'null' + nullable: true search_context_size: type: string enum: @@ -35431,7 +32790,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -35453,11 +32812,10 @@ components: type: object properties: allowed_domains: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true OpenAI.integer: type: integer format: int64 @@ -35521,7 +32879,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. spec: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -35545,7 +32903,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -35624,7 +32982,7 @@ components: description: The openapi function definition. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -35691,45 +33049,24 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output of an OpenAPI tool call. - OptimizationAgentDefinition: + OptimizationAgentIdentifier: type: object + required: + - agent_name properties: agent_name: type: string - description: Agent name. + description: Registered Foundry agent name (required). agent_version: type: string - description: Agent version. - model: - type: string - description: Model deployment name. - system_prompt: - type: string - description: System prompt / instructions. - skills: - type: array - items: - type: object - unevaluatedProperties: {} - description: Agent skills. - tools: - type: array - items: - type: object - unevaluatedProperties: {} - description: Agent tools. - description: Agent definition returned in response payloads (includes resolved config). + description: Pinned agent version. Defaults to latest if omitted. + description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config. OptimizationCandidate: type: object required: - name - - config - - mutations - avg_score - avg_tokens - - pass_rate - - task_scores - - is_pareto_optimal properties: candidate_id: type: string @@ -35737,13 +33074,9 @@ components: name: type: string description: Display name of the candidate (e.g., 'baseline', 'instruction-v2'). - config: - allOf: - - $ref: '#/components/schemas/OptimizationAgentDefinition' - description: The agent configuration that produced this candidate. mutations: type: object - unevaluatedProperties: {} + additionalProperties: {} description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." avg_score: type: number @@ -35753,18 +33086,6 @@ components: type: number format: double description: Average token usage across all tasks. - pass_rate: - type: number - format: double - description: Fraction of tasks that met the pass threshold. - task_scores: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Individual task-level scores. - is_pareto_optimal: - type: boolean - description: Whether this candidate is on the Pareto frontier (score vs cost). eval_id: type: string description: Foundry evaluation identifier used to score this candidate. @@ -35776,17 +33097,115 @@ components: - $ref: '#/components/schemas/PromotionInfo' description: Promotion metadata. Null if the candidate has not been promoted. description: Aggregated evaluation result for a single candidate agent configuration across all tasks. + OptimizationDatasetCriterion: + type: object + required: + - name + - instruction + properties: + name: + type: string + description: Criterion name. + instruction: + type: string + description: Criterion instruction / description. + description: 'Evaluation criterion: a name + instruction pair used for per-item scoring.' + OptimizationDatasetInput: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInputType' + description: Dataset input type discriminator. + discriminator: + propertyName: type + mapping: + inline: '#/components/schemas/OptimizationInlineDatasetInput' + reference: '#/components/schemas/OptimizationReferenceDatasetInput' + description: Base discriminated model for dataset input. Either inline items or a registered reference. + OptimizationDatasetInputType: + anyOf: + - type: string + - type: string + enum: + - inline + - reference + description: Discriminator values for the dataset input union. + OptimizationDatasetItem: + type: object + properties: + query: + type: string + description: The user query / prompt. + ground_truth: + type: string + description: Expected ground truth answer. + desired_num_turns: + type: integer + format: int32 + minimum: 1 + maximum: 20 + description: Desired number of conversation turns for simulation mode (1-20). + criteria: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetCriterion' + description: Per-item evaluation criteria. + description: A single item in an inline dataset. + OptimizationEvaluatorRef: + type: object + required: + - name + properties: + name: + type: string + description: Evaluator name. + version: + type: string + description: Evaluator version. If not specified, the latest version is used. + description: Reference to a named evaluator, optionally pinned to a version. + OptimizationInlineDatasetInput: + type: object + required: + - type + - items + properties: + type: + type: string + enum: + - inline + description: Dataset input type discriminator. + items: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetItem' + description: Dataset items. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Inline dataset — items supplied directly in the request body. OptimizationJob: type: object required: - id - status - created_at + - updated_at properties: id: type: string description: Server-assigned unique identifier. readOnly: true + inputs: + allOf: + - $ref: '#/components/schemas/OptimizationJobInputs' + description: Caller-supplied inputs. + result: + allOf: + - $ref: '#/components/schemas/OptimizationJobResult' + description: Result produced on success. + readOnly: true status: allOf: - $ref: '#/components/schemas/JobStatus' @@ -35797,15 +33216,6 @@ components: - $ref: '#/components/schemas/OpenAI.Error' description: Error details — populated only on failure. readOnly: true - result: - allOf: - - $ref: '#/components/schemas/OptimizationJobResult' - description: Result produced on success. - readOnly: true - inputs: - allOf: - - $ref: '#/components/schemas/OptimizationJobInputs' - description: Caller-supplied inputs. created_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' @@ -35814,58 +33224,103 @@ components: updated_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' - description: The timestamp when the job was last updated (status, progress, or result change), represented in Unix time. + description: The timestamp when the job was last updated, represented in Unix time. readOnly: true progress: allOf: - $ref: '#/components/schemas/OptimizationJobProgress' - description: Progress while in flight. Absent in terminal states. + description: Progress snapshot. May be present in terminal states reflecting last-known progress. readOnly: true - dataset: - allOf: - - $ref: '#/components/schemas/DatasetInfo' - description: Metadata about the dataset used for this optimization job. + warnings: + type: array + items: + type: string + description: Non-fatal warnings emitted at any point during optimization. readOnly: true description: Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates. OptimizationJobInputs: type: object required: - agent - - train_dataset_reference + - train_dataset + - evaluators properties: agent: allOf: - - $ref: '#/components/schemas/AgentIdentifier' + - $ref: '#/components/schemas/OptimizationAgentIdentifier' description: The agent (and pinned version) being optimized. - train_dataset_reference: + train_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' - description: Reference to a registered training dataset (required). - validation_dataset_reference: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Training dataset — either inline items or a reference to a registered dataset. Required. + validation_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' + - $ref: '#/components/schemas/OptimizationDatasetInput' description: Optional held-out validation dataset for measuring generalization of the final candidate. evaluators: type: array items: - type: string - description: "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + $ref: '#/components/schemas/OptimizationEvaluatorRef' + description: Job-level evaluators referenced by name and optional version. Required; at least one must be provided. options: allOf: - $ref: '#/components/schemas/OptimizationOptions' description: Tuning knobs and run-mode. description: Caller-supplied inputs for an optimization job. + OptimizationJobListItem: + type: object + required: + - id + - status + - created_at + - updated_at + properties: + id: + type: string + description: Server-assigned unique identifier. + readOnly: true + status: + allOf: + - $ref: '#/components/schemas/JobStatus' + description: Current lifecycle status. + readOnly: true + created_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was created, represented in Unix time. + readOnly: true + updated_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was last updated, represented in Unix time. + readOnly: true + agent: + allOf: + - $ref: '#/components/schemas/OptimizationAgentIdentifier' + description: The agent targeted by this optimization job. + readOnly: true + progress: + allOf: + - $ref: '#/components/schemas/OptimizationJobProgress' + description: Progress snapshot. May be present in terminal states reflecting last-known progress. + readOnly: true + error: + allOf: + - $ref: '#/components/schemas/OpenAI.Error' + description: Error details — populated only on failure. + readOnly: true + description: Slim job representation returned by the LIST endpoint. OptimizationJobProgress: type: object required: - - current_iteration + - candidates_completed - best_score - elapsed_seconds properties: - current_iteration: + candidates_completed: type: integer format: int32 - description: 1-based current iteration index. + description: Number of candidates whose evaluation has completed so far. best_score: type: number format: double @@ -35879,42 +33334,28 @@ components: type: object properties: baseline: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: Evaluation scores for the original (un-optimized) agent configuration. + type: string + description: Candidate ID of the original (un-optimized) baseline evaluation. best: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: The highest-scoring candidate found during optimization. + type: string + description: Candidate ID of the highest-scoring candidate found during optimization. candidates: type: array items: $ref: '#/components/schemas/OptimizationCandidate' description: All evaluated candidates including baseline. - options: - allOf: - - $ref: '#/components/schemas/OptimizationOptions' - description: The options used for this optimization run. - warnings: - type: array - items: - type: string - description: Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped). - all_target_attributes_failed: - type: boolean - description: True when all target attributes failed — only the baseline was evaluated. description: Terminal-state result body. Populated when status is succeeded or failed. OptimizationOptions: type: object properties: - max_iterations: + max_candidates: type: integer format: int32 - description: 'Maximum optimization iterations per strategy. Must be >= 1. Default: 5.' + description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' default: 5 optimization_config: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. eval_model: type: string @@ -35927,58 +33368,26 @@ components: - $ref: '#/components/schemas/EvaluationLevel' description: Evaluation granularity. Null/omitted means per-item single-turn. Set to 'conversation' for per-conversation multi-turn simulation scoring. description: Tuning knobs and run-mode for an optimization job. - OptimizationTaskResult: + OptimizationReferenceDatasetInput: type: object required: - - task_name - - scores - - composite_score - - tokens - - duration_seconds - - passed + - type + - name properties: - task_name: - type: string - description: Task name (from the dataset). - query: - type: string - description: The user query / input for the task. - scores: - type: object - unevaluatedProperties: - type: number - format: double - description: Per-evaluator scores keyed by evaluator name. - composite_score: - type: number - format: double - description: Composite score combining all evaluator scores. - tokens: - type: integer - format: int64 - description: Total tokens consumed during the agent run for this task. - duration_seconds: - type: number - format: double - description: Wall-clock seconds for this task's agent execution. - passed: - type: boolean - description: Whether the task met the pass threshold. - error_message: + type: type: string - description: Error message if the task failed during execution. - rationales: - type: object - unevaluatedProperties: - type: string - description: Per-evaluator reasoning keyed by evaluator name. - response: + enum: + - reference + description: Dataset input type discriminator. + name: type: string - description: Raw agent response text. - run_id: + description: Registered dataset name. + version: type: string - description: Identifier of the agent run that produced this result. - description: Per-task evaluation result for a single candidate. + description: Dataset version. If not specified, the latest version is used. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Reference to a registered Foundry dataset. OtlpTelemetryEndpoint: type: object required: @@ -35994,14 +33403,12 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - examples: - - https://my-collector.example.com/otlp + example: https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - examples: - - Http + example: Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -36263,45 +33670,6 @@ components: x-ms-foundry-meta: required_previews: - MemoryStores=V1Preview - PromoteCandidateRequest: - type: object - required: - - agent_name - - agent_version - properties: - agent_name: - type: string - description: Name of the Foundry agent to promote to. - agent_version: - type: string - description: Version of the Foundry agent to promote to. - description: Request body for promoting a candidate to a Foundry agent version. - PromoteCandidateResponse: - type: object - required: - - candidate_id - - status - - promoted_at - - agent_name - - agent_version - properties: - candidate_id: - type: string - description: The promoted candidate id. - status: - type: string - description: Status after promotion. - promoted_at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when promotion occurred, represented in Unix time. - agent_name: - type: string - description: Name of the Foundry agent promoted to. - agent_version: - type: string - description: Version of the Foundry agent promoted to. - description: Response after successfully promoting a candidate. PromotionInfo: type: object required: @@ -36334,15 +33702,13 @@ components: type: string description: The model deployment to use for this agent. instructions: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A system (or developer) message inserted into the model's context. temperature: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 2 description: |- @@ -36350,10 +33716,9 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 1 description: |- @@ -36364,9 +33729,10 @@ components: Defaults to `1`. default: 1 reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true tools: type: array items: @@ -36387,7 +33753,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -36574,12 +33940,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -36731,7 +34097,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -36776,7 +34142,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -36850,7 +34216,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -37132,17 +34498,17 @@ components: description: Task for the schedule. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the resource. readOnly: true @@ -37210,7 +34576,7 @@ components: readOnly: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Properties of the schedule run. readOnly: true @@ -37226,7 +34592,7 @@ components: description: Type of the task. configuration: type: object - unevaluatedProperties: + additionalProperties: type: string description: Configuration for the task. discriminator: @@ -37315,13 +34681,11 @@ components: allOf: - $ref: '#/components/schemas/SessionLogEventType' description: The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types. - examples: - - log + example: log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - examples: - - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + example: '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' description: |- A single Server-Sent Event frame emitted by the hosted agent session log stream. @@ -37438,7 +34802,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -37531,7 +34895,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -37613,7 +34977,7 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean @@ -37636,12 +35000,11 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured output. strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -37829,7 +35192,7 @@ components: description: List of taxonomy sub categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -37854,7 +35217,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -37901,10 +35264,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - examples: - - - ContainerStdoutStderr - - ContainerOtel - - Metrics + example: + - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -37988,11 +35351,11 @@ components: description: The version of the evaluator. Latest version if not specified. initialization_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The initialization parameters for the evaluation. Must support structured outputs. data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: The model to use for the evaluation. Must support structured outputs. description: An Azure AI Evaluator grader used as testing criterion in evaluations. @@ -38020,7 +35383,7 @@ components: ToolCallOutputContent: anyOf: - type: object - unevaluatedProperties: {} + additionalProperties: {} - type: string - type: array items: {} @@ -38124,7 +35487,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -38181,11 +35544,10 @@ components: - tools properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -38446,7 +35808,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -38465,7 +35827,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -38474,7 +35836,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -38511,12 +35873,13 @@ components: name: type: string metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -38529,7 +35892,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Request body for updating a model version. Only description and tags can be modified. @@ -38707,7 +36070,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json index 9372b6f0c250..78f5fd20d96c 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json @@ -1,231 +1,101 @@ { - "openapi": "3.2.0", + "openapi": "3.0.0", "info": { "title": "Microsoft Foundry", "version": "virtual-public-preview" }, "tags": [ { - "name": "EvaluationSuiteGenerationJobs" + "name": "Agents" }, { - "name": "Fine-Tuning" + "name": "Agent Containers" }, { - "name": "Responses Root", - "description": "Responses" + "name": "Agent Session Files" }, { - "name": "Responses", - "parent": "Responses Root", - "description": "Responses (OpenAI)" + "name": "Agent Invocations" }, { - "name": "Conversations", - "parent": "Responses Root", - "description": "Conversations (OpenAI)" + "name": "Agent Invocations WebSocket" }, { - "name": "Agents Root", - "description": "Agents" + "name": "Connections" }, { - "name": "Agents", - "parent": "Agents Root", - "description": "Agent Management" + "name": "Datasets" }, { - "name": "Agent Invocations", - "parent": "Agents Root" + "name": "Deployments" }, { - "name": "Agent Invocations WebSocket", - "parent": "Agents Root", - "description": "Agent Invocations (WebSocket)" + "name": "Evaluation Taxonomies" }, { - "name": "Agent Sessions", - "parent": "Agents Root" + "name": "Evaluation Rules" }, { - "name": "Agent Session Files", - "parent": "Agents Root" - }, - { - "name": "Agent Versions", - "parent": "Agents Root" - }, - { - "name": "Agent Containers", - "parent": "Agents Root" - }, - { - "name": "Platform APIs" - }, - { - "name": "Datasets", - "parent": "Platform APIs" - }, - { - "name": "Indexes", - "parent": "Platform APIs" - }, - { - "name": "Connections", - "parent": "Platform APIs" - }, - { - "name": "Scheduler", - "parent": "Platform APIs" - }, - { - "name": "Fine-tuning", - "parent": "Platform APIs", - "summary": "Fine-Tuning" - }, - { - "name": "Models", - "parent": "Platform APIs" - }, - { - "name": "Memory Stores", - "parent": "Platform APIs" - }, - { - "name": "Chat", - "parent": "Platform APIs" - }, - { - "name": "Assistants", - "parent": "Platform APIs" - }, - { - "name": "Audio", - "parent": "Platform APIs" - }, - { - "name": "Batch", - "parent": "Platform APIs" - }, - { - "name": "Completions", - "parent": "Platform APIs" - }, - { - "name": "Containers", - "parent": "Platform APIs" - }, - { - "name": "Embeddings", - "parent": "Platform APIs" - }, - { - "name": "Files", - "parent": "Platform APIs" - }, - { - "name": "Images", - "parent": "Platform APIs" - }, - { - "name": "Moderations", - "parent": "Platform APIs" - }, - { - "name": "Realtime", - "parent": "Platform APIs" - }, - { - "name": "Threads", - "parent": "Platform APIs" - }, - { - "name": "Uploads", - "parent": "Platform APIs" - }, - { - "name": "Vector stores", - "parent": "Platform APIs", - "summary": "Vector Stores" + "name": "EvaluationSuiteGenerationJobs" }, { - "name": "Videos", - "parent": "Platform APIs" + "name": "Evaluators" }, { - "name": "Routines", - "parent": "Platform APIs" + "name": "EvaluatorGenerationJobs" }, { - "name": "Schedules", - "parent": "Platform APIs" + "name": "Indexes" }, { - "name": "Skills", - "parent": "Platform APIs" + "name": "Insights" }, { - "name": "Toolboxes", - "parent": "Platform APIs" + "name": "Models" }, { - "name": "Deployments", - "parent": "Platform APIs" + "name": "Memory Stores" }, { - "name": "DataGenerationJobs", - "parent": "Platform APIs", - "summary": "Data generation jobs" + "name": "Conversations" }, { - "name": "AgentOptimizationJobs", - "parent": "Platform APIs", - "summary": "Agent optimization jobs" + "name": "Evals" }, { - "name": "EvaluatorGenerationJobs", - "parent": "Platform APIs", - "summary": "Evaluator generation jobs" + "name": "Fine-Tuning" }, { - "name": "Evaluations" + "name": "Responses" }, { - "name": "Evals", - "parent": "Evaluations" + "name": "Redteams" }, { - "name": "Evaluation Rules", - "parent": "Evaluations" + "name": "Routines" }, { - "name": "Evaluators", - "parent": "Evaluations" + "name": "Schedules" }, { - "name": "Evaluation Taxonomies", - "parent": "Evaluations" + "name": "Skills" }, { - "name": "Redteams", - "parent": "Evaluations", - "summary": "Red Teaming" + "name": "Toolboxes" }, { - "name": "Evalsuite", - "parent": "Evaluations" + "name": "DataGenerationJobs" }, { - "name": "Insights", - "parent": "Evaluations" + "name": "AgentOptimizationJobs" } ], "paths": { "/agent_optimization_jobs": { "post": { "operationId": "AgentOptimizationJobs_create", - "summary": "Create an agent optimization job", - "description": "Creates an agent optimization job and returns the queued job.\nHonors `Operation-Id` for idempotent retry.", + "summary": "Creates an agent optimization job.", + "description": "Create an optimization job. Returns 201 with the queued job. Honours `Operation-Id` for idempotent retry.", "parameters": [ { "name": "Foundry-Features", @@ -235,7 +105,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -315,22 +185,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OptimizationJob" } } }, - "description": "The optimization job inputs." + "description": "The job to create." }, "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, "get": { "operationId": "AgentOptimizationJobs_list", - "summary": "List agent optimization jobs", - "description": "Returns agent optimization jobs with cursor pagination and optional lifecycle or agent filters.", + "summary": "Returns a list of agent optimization jobs.", + "description": "List optimization jobs. Supports cursor pagination and optional status / agent_name filters.", "parameters": [ { "name": "Foundry-Features", @@ -340,7 +210,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -432,7 +302,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/OptimizationJobListItem" }, "description": "The requested list of items." }, @@ -480,7 +350,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } @@ -488,8 +358,8 @@ "/agent_optimization_jobs/{jobId}": { "get": { "operationId": "AgentOptimizationJobs_get", - "summary": "Get an agent optimization job", - "description": "Retrieves the specified agent optimization job.\nReturns 202 while the job is in progress and 200 after it reaches a terminal state.", + "summary": "Get info about an agent optimization job.", + "description": "Get an optimization job by id.", "parameters": [ { "name": "Foundry-Features", @@ -499,7 +369,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -529,25 +399,7 @@ "headers": { "Retry-After": { "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptimizationJob" - } - } - } - }, - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Retry-After": { - "required": false, + "description": "Recommended number of seconds to wait before polling again.", "schema": { "type": "integer", "format": "int32" @@ -588,14 +440,14 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, "delete": { "operationId": "AgentOptimizationJobs_delete", - "summary": "Delete an agent optimization job", - "description": "Deletes the specified agent optimization job and its candidate artifacts.\nCancels the job first when it is still in a non-terminal state.", + "summary": "Deletes an agent optimization job.", + "description": "Delete the job and its candidate artifacts. Cancels first if non-terminal.", "parameters": [ { "name": "Foundry-Features", @@ -605,7 +457,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -618,16 +470,6 @@ "type": "string" } }, - { - "name": "force", - "in": "query", - "required": false, - "description": "When true, force-delete even if the job is in a non-terminal state.", - "schema": { - "type": "boolean" - }, - "explode": false - }, { "name": "api-version", "in": "query", @@ -669,16 +511,16 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } }, - "/agent_optimization_jobs/{jobId}/candidates": { - "get": { - "operationId": "AgentOptimizationJobs_listCandidates", - "summary": "List optimization job candidates", - "description": "Returns the candidates produced by the specified optimization job.", + "/agent_optimization_jobs/{jobId}:cancel": { + "post": { + "operationId": "AgentOptimizationJobs_cancel", + "summary": "Cancels an agent optimization job.", + "description": "Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.", "parameters": [ { "name": "Foundry-Features", @@ -688,7 +530,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -696,53 +538,11 @@ "name": "jobId", "in": "path", "required": true, - "description": "The optimization job id.", + "description": "The ID of the job to cancel.", "schema": { "type": "string" } }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false - }, - { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false - }, - { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, { "name": "api-version", "in": "query", @@ -760,33 +560,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "data", - "has_more" - ], - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationCandidate" - }, - "description": "The requested list of items." - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list." - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list." - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list." - } - }, - "description": "The response data for a requested list of items." + "$ref": "#/components/schemas/OptimizationJob" } } } @@ -817,16 +591,14 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidate", - "summary": "Get an optimization candidate", - "description": "Retrieves metadata, manifest information, and promotion details for the specified candidate.", + "/agents": { + "post": { + "operationId": "Agents_createAgent_Agents_createAgentFromCode", "parameters": [ { "name": "Foundry-Features", @@ -834,28 +606,7 @@ "required": false, "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" + "$ref": "#/components/schemas/AgentDefinitionOptInKeys" } }, { @@ -867,559 +618,36 @@ "type": "string" }, "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateMetadata" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/config": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateConfig", - "summary": "Get an optimization candidate config", - "description": "Retrieves the deploy configuration JSON for the specified candidate.\nClients can use it to compose `agents.create_version(...)` requests.", - "parameters": [ { - "name": "Foundry-Features", + "name": "x-ms-agent-name", "in": "header", "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", "schema": { "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" + "maxLength": 63 } }, { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", + "name": "x-ms-code-zip-sha256", + "in": "header", + "required": false, + "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", "schema": { "type": "string" } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false } ], + "description": "Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Create an agent Create a new code-based agent", "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CandidateDeployConfig" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/files": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateFile", - "summary": "Get an optimization candidate file", - "description": "Streams the specified file from the candidate's blob directory.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "path", - "in": "query", - "required": true, - "description": "Relative path of the file to download (e.g. 'files/examples.jsonl').", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/octet-stream": { - "schema": { - "contentMediaType": "application/octet-stream" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/results": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateResults", - "summary": "Get optimization candidate results", - "description": "Retrieves full per-task evaluation results for the specified candidate.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateResults" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote": { - "post": { - "operationId": "AgentOptimizationJobs_promoteCandidate", - "summary": "Promote an optimization candidate", - "description": "Promotes the specified candidate and records the deployment timestamp and target agent version.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id to promote.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateResponse" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateRequest" - } - } - }, - "description": "Promotion details." - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}:cancel": { - "post": { - "operationId": "AgentOptimizationJobs_cancel", - "summary": "Cancel an agent optimization job", - "description": "Requests cancellation of the specified agent optimization job.\nThe operation remains idempotent after the job reaches a terminal state.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The ID of the job to cancel.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptimizationJob" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agents": { - "post": { - "operationId": "Agents_createAgent_Agents_createAgentFromCode", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "$ref": "#/components/schemas/AgentDefinitionOptInKeys" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "x-ms-agent-name", - "in": "header", - "required": false, - "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", - "schema": { - "type": "string", - "maxLength": 63 - } - }, - { - "name": "x-ms-code-zip-sha256", - "in": "header", - "required": false, - "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", - "schema": { - "type": "string" - } - } - ], - "description": "Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", - "summary": "Create an agent Create a new code-based agent", - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AgentObject" + "$ref": "#/components/schemas/AgentObject" } } } @@ -2133,7 +1361,8 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" + "type": "string", + "format": "binary" } } } @@ -2336,7 +1565,7 @@ "application/json": { "schema": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } } @@ -2671,7 +1900,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "requestBody": { "required": true, @@ -2836,7 +2065,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3211,7 +2440,8 @@ "content": { "application/octet-stream": { "schema": { - "contentMediaType": "application/octet-stream" + "type": "string", + "format": "binary" } } } @@ -3293,7 +2523,8 @@ "content": { "application/octet-stream": { "schema": { - "contentMediaType": "application/octet-stream" + "type": "string", + "format": "binary" } } } @@ -3418,7 +2649,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3507,7 +2738,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3589,7 +2820,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3993,7 +3224,7 @@ ] }, "tags": [ - "Agent Versions" + "Agents" ], "requestBody": { "required": true, @@ -4142,7 +3373,7 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] } }, @@ -4214,7 +3445,7 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] }, "delete": { @@ -4295,7 +3526,7 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] } }, @@ -5185,7 +4416,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -5254,7 +4485,7 @@ } }, "tags": [ - "Agent Versions" + "Agents" ], "requestBody": { "required": true, @@ -11543,7 +10774,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -11796,7 +11027,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -13510,15 +12741,9 @@ "description": "URL to poll for operation status." }, "operationResult": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ], + "type": "string", + "format": "uri", + "nullable": true, "description": "URL to the operation result, or null if the operation is still in progress." } } @@ -14598,7 +13823,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -14943,7 +14172,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -15326,7 +14559,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -16088,45 +15325,41 @@ "type": "object", "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_logprobs": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "user": { @@ -16136,8 +15369,7 @@ }, "safety_identifier": { "type": "string", - "maxLength": 64, - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -16147,62 +15379,51 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "background": { - "anyOf": [ - { - "type": "boolean" - }, + "type": "boolean", + "nullable": true + }, + "max_output_tokens": { + "type": "integer", + "allOf": [ { - "type": "null" + "$ref": "#/components/schemas/OpenAI.integer" } - ] + ], + "nullable": true }, "max_tool_calls": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -16224,18 +15445,12 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "disabled" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "auto", + "disabled" ], + "nullable": true, "default": "disabled" }, "id": { @@ -16268,37 +15483,27 @@ "description": "Unix timestamp (in seconds) of when this Response was created." }, "completed_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "incomplete_details": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output": { "type": "array", @@ -16317,59 +15522,30 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "usage": { "$ref": "#/components/schemas/OpenAI.ResponseUsage" }, - "moderation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.Moderation" - }, - { - "type": "null" - } - ] - }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.", "default": true }, "conversation": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" - }, - { - "type": "null" } - ] - }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" - } - ] + ], + "nullable": true }, "agent": { "allOf": [ @@ -16384,14 +15560,13 @@ "description": "The session identifier for this response. Currently only relevant for hosted agents.\nAlways returned for hosted agents — either the caller-provided value, the auto-derived value,\nor an auto-generated UUID. Use for session-scoped operations and to maintain sandbox\naffinity in follow-up calls." }, "agent_reference": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/AgentReference" - }, - { - "type": "null" } ], + "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -16454,45 +15629,41 @@ "type": "object", "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_logprobs": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "user": { @@ -16502,8 +15673,7 @@ }, "safety_identifier": { "type": "string", - "maxLength": 64, - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -16513,62 +15683,51 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "background": { - "anyOf": [ - { - "type": "boolean" - }, + "type": "boolean", + "nullable": true + }, + "max_output_tokens": { + "type": "integer", + "allOf": [ { - "type": "null" + "$ref": "#/components/schemas/OpenAI.integer" } - ] + ], + "nullable": true }, "max_tool_calls": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -16590,132 +15749,67 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "disabled" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "auto", + "disabled" ], + "nullable": true, "default": "disabled" }, "input": { "$ref": "#/components/schemas/OpenAI.InputParam" }, "include": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.IncludeEnum" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.IncludeEnum" + }, + "nullable": true }, "parallel_tool_calls": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "type": "boolean", + "nullable": true, "default": true }, "store": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "type": "boolean", + "nullable": true, "default": true }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "moderation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationParam" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "stream": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true }, "stream_options": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "conversation": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationParam" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "context_management": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContextManagementParam" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ContextManagementParam" + }, + "nullable": true, "description": "Context management configuration for this request." }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" - } - ] - }, "agent": { "allOf": [ { @@ -16738,7 +15832,7 @@ }, "structured_inputs": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." } } @@ -19245,7 +18339,8 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" + "type": "string", + "format": "binary" } } } @@ -19775,7 +18870,8 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" + "type": "string", + "format": "binary" } } } @@ -20271,7 +19367,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the toolbox." @@ -20854,7 +19950,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -21270,17 +20366,13 @@ "type": "integer", "format": "int32", "description": "The maximum number of replicas for the container. Default is 1.", - "examples": [ - 10 - ] + "example": 10 }, "min_replicas": { "type": "integer", "format": "int32", "description": "The minimum number of replicas for the container. Default is 1.", - "examples": [ - 1 - ] + "example": 1 }, "error_message": { "type": "string", @@ -21704,7 +20796,7 @@ }, "evaluators": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -21781,7 +20873,7 @@ }, "additionalDetails": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties relevant to the evaluator. These will differ between evaluators." @@ -21969,23 +21061,6 @@ } } }, - "AgentIdentifier": { - "type": "object", - "required": [ - "agent_name" - ], - "properties": { - "agent_name": { - "type": "string", - "description": "Registered Foundry agent name (required)." - }, - "agent_version": { - "type": "string", - "description": "Pinned agent version. Defaults to latest if omitted." - } - }, - "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." - }, "AgentIdentity": { "type": "object", "required": [ @@ -22340,17 +21415,11 @@ ], "properties": { "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -23123,7 +22192,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23706,7 +22775,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -23777,7 +22846,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23994,7 +23063,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -24184,7 +23253,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -24386,7 +23455,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -24518,160 +23587,6 @@ }, "description": "Definition of input parameters for the Browser Automation Tool." }, - "CandidateDeployConfig": { - "type": "object", - "properties": { - "instructions": { - "type": "string", - "description": "System prompt / instructions." - }, - "model": { - "type": "string", - "description": "Foundry deployment name." - }, - "temperature": { - "type": "number", - "format": "float", - "minimum": 0, - "maximum": 2, - "description": "Optional sampling temperature." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Optional skill overrides." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Optional tool overrides." - } - }, - "description": "Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version." - }, - "CandidateFileInfo": { - "type": "object", - "required": [ - "path", - "type", - "size_bytes" - ], - "properties": { - "path": { - "type": "string", - "description": "Relative path of the file." - }, - "type": { - "type": "string", - "description": "File type category (e.g. 'config', 'results')." - }, - "size_bytes": { - "type": "integer", - "format": "int64", - "description": "File size in bytes." - } - }, - "description": "File entry in a candidate's blob directory." - }, - "CandidateMetadata": { - "type": "object", - "required": [ - "candidate_id", - "job_id", - "candidate_name", - "status", - "has_results", - "created_at", - "updated_at", - "files" - ], - "properties": { - "candidate_id": { - "type": "string", - "description": "Server-assigned candidate identifier." - }, - "job_id": { - "type": "string", - "description": "Owning optimization job id." - }, - "candidate_name": { - "type": "string", - "description": "Display name of the candidate." - }, - "status": { - "type": "string", - "description": "Candidate lifecycle status." - }, - "score": { - "type": "number", - "format": "double", - "description": "Candidate's aggregate score." - }, - "has_results": { - "type": "boolean", - "description": "Whether detailed results are available for this candidate." - }, - "created_at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when the candidate was created, represented in Unix time." - }, - "updated_at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when the candidate was last updated, represented in Unix time." - }, - "promotion": { - "allOf": [ - { - "$ref": "#/components/schemas/PromotionInfo" - } - ], - "description": "Promotion metadata. Null if not promoted." - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CandidateFileInfo" - }, - "description": "Files in the candidate's blob directory." - } - }, - "description": "Candidate metadata returned by GET /candidates/{id}." - }, - "CandidateResults": { - "type": "object", - "required": [ - "candidate_id", - "results" - ], - "properties": { - "candidate_id": { - "type": "string", - "description": "Owning candidate id." - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Per-task evaluation rows." - } - }, - "description": "Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results." - }, "CaptureStructuredOutputsTool": { "type": "object", "required": [ @@ -24696,7 +23611,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -24793,7 +23708,7 @@ }, "coordinates": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ChartCoordinate" }, "description": " Optional mapping of IDs to 2D coordinates used by the UX for visualization.\n\n The map keys are string identifiers (for example, a cluster id or a sample id)\n and the values are the coordinates and visual size for rendering on a 2D chart.\n\n This property is omitted unless the client requests coordinates (for example,\n by passing `includeCoordinates=true` as a query parameter).\n\n Example:\n ```\n {\n \"cluster-1\": { \"x\": 12, \"y\": 34, \"size\": 8 },\n \"sample-123\": { \"x\": 18, \"y\": 22, \"size\": 4 }\n }\n ```\n\n Coordinates are intended only for client-side visualization and do not\n modify the canonical insights results." @@ -25016,7 +23931,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata of the connection", @@ -25069,17 +23984,15 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication of the containers.", - "examples": [ - [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } - ] + "example": [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } ] }, "container_app_resource_id": { @@ -25089,11 +24002,7 @@ "ingress_subdomain_suffix": { "type": "string", "description": "The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app.", - "examples": [ - "--0000001", - "---current", - "" - ] + "example": "--0000001" } }, "allOf": [ @@ -25117,9 +24026,7 @@ "image": { "type": "string", "description": "The container image for the hosted agent.", - "examples": [ - "my-registry.azurecr.io/my-hosted-agent:latest" - ] + "example": "my-registry.azurecr.io/my-hosted-agent:latest" } }, "description": "Container-based deployment configuration for a hosted agent.", @@ -25274,7 +24181,8 @@ "format": "double", "maximum": 100, "description": "Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.", - "exclusiveMinimum": 0, + "minimum": 0, + "exclusiveMinimum": true, "default": 100 } }, @@ -25317,7 +24225,7 @@ }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, which is required for retrieving chat history." @@ -25421,6 +24329,8 @@ "description": "JSON metadata including description and hosted definition." }, "code": { + "type": "string", + "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -25444,7 +24354,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -25461,7 +24371,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -25480,7 +24390,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -25594,6 +24504,8 @@ "description": "JSON metadata including description and hosted definition." }, "code": { + "type": "string", + "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -25615,7 +24527,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -25646,7 +24558,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -25663,7 +24575,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -25676,7 +24588,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -25738,14 +24650,13 @@ "description": "The name of the evaluation." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "data_source_config": { "oneOf": [ @@ -25795,7 +24706,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -25814,14 +24725,13 @@ "description": "The name of the run." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "data_source": { "oneOf": [ @@ -25842,7 +24752,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -25882,7 +24792,10 @@ "properties": { "files": { "type": "array", - "items": {}, + "items": { + "type": "string", + "format": "binary" + }, "description": "Skill files to upload. Upload a single zip file or multiple individual files with relative paths." }, "default": { @@ -25983,7 +24896,7 @@ "readOnly": true } }, - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "allOf": [ @@ -26020,7 +24933,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Provider-specific trigger parameters." } }, @@ -26265,7 +25178,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs." @@ -26451,15 +25364,13 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The overall object JSON schema for the run data source items." } }, "discriminator": { "propertyName": "type", - "mapping": { - "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" - } + "mapping": {} }, "description": "Base class for run data sources with discriminator support." }, @@ -26498,7 +25409,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary of the output dataset.", @@ -26580,50 +25491,6 @@ ], "description": "Dataset source for evaluator generation jobs — reference to a dataset." }, - "DatasetInfo": { - "type": "object", - "required": [ - "task_count", - "is_inline" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name when using a registered dataset reference. Null for inline datasets." - }, - "version": { - "type": "string", - "description": "Dataset version when using a registered dataset reference. Null for inline datasets." - }, - "task_count": { - "type": "integer", - "format": "int32", - "description": "Number of tasks/rows in the dataset." - }, - "is_inline": { - "type": "boolean", - "description": "True when the dataset was provided inline in the request body." - } - }, - "description": "Metadata about the dataset used for optimization, surfaced in the response." - }, - "DatasetRef": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name." - }, - "version": { - "type": "string", - "description": "Dataset version. If not specified, the latest version is used." - } - }, - "description": "Reference to a registered dataset in the Foundry Dataset Service." - }, "DatasetReference": { "type": "object", "required": [ @@ -26734,7 +25601,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -27322,14 +26189,13 @@ "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "modified_at": { "allOf": [ @@ -27345,7 +26211,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -27537,14 +26403,13 @@ "description": "Information about the run's data source." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "error": { "$ref": "#/components/schemas/OpenAI.EvalApiError" @@ -27563,7 +26428,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -27667,7 +26532,7 @@ }, "datasource_item": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Details of the input data source item." }, "results": { @@ -27723,15 +26588,9 @@ "description": "Whether the grader considered the output a pass." }, "sample": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": {}, + "nullable": true, "description": "Optional sample or intermediate data produced by the grader." }, "status": { @@ -27761,13 +26620,13 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional details about the test criteria metric." } }, - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "A single grader result for an evaluation run output item.", "title": "EvalRunOutputItemResult" }, @@ -27983,21 +26842,21 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Evaluation's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "evaluators": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -28227,7 +27086,7 @@ }, "systemData": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "System metadata for the evaluation rule.", @@ -28392,7 +27251,7 @@ }, "evalRun": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The evaluation run payload." } }, @@ -28565,7 +27424,7 @@ }, "initialization_parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Optional initialization parameters applied to all generated evaluators.\nFor example, deployment_name for LLM judge model, default threshold." }, "data_generation_options": { @@ -28954,7 +27813,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29048,7 +27907,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29133,7 +27992,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -29153,7 +28012,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29175,7 +28034,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -29253,7 +28112,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29275,7 +28134,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -29311,12 +28170,12 @@ }, "initParams": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Initialization parameters of the evaluator." }, "dataMapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Data parameters of the evaluator." @@ -29359,17 +28218,17 @@ }, "init_parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required." }, "data_schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required." }, "metrics": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorMetric" }, "description": "List of output metrics produced by this evaluator" @@ -29734,7 +28593,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -29828,7 +28687,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -29872,7 +28731,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29889,7 +28748,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -29917,7 +28776,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -30079,13 +28938,17 @@ "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - }, - { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { - "type": "null" + "type": "string", + "nullable": true } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -30101,7 +28964,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -30540,23 +29403,17 @@ "header_name": { "type": "string", "description": "The name of the HTTP header to inject the secret value into.", - "examples": [ - "X-Otlp-Api-Key" - ] + "example": "X-Otlp-Api-Key" }, "secret_id": { "type": "string", "description": "The identifier of the secret store or connection.", - "examples": [ - "my-secret-store" - ] + "example": "my-secret-store" }, "secret_key": { "type": "string", "description": "The key within the secret to retrieve the authentication value.", - "examples": [ - "OTLP_KEY" - ] + "example": "OTLP_KEY" } }, "allOf": [ @@ -30595,29 +29452,23 @@ "cpu": { "type": "string", "description": "The CPU configuration for the hosted agent.", - "examples": [ - "0.25" - ] + "example": "0.25" }, "memory": { "type": "string", "description": "The memory configuration for the hosted agent.", - "examples": [ - "0.5Gi" - ] + "example": "0.5Gi" }, "environment_variables": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Environment variables to set in the hosted agent container.", - "examples": [ - { - "name": "LOG_LEVEL", - "value": "debug" - } - ] + "example": { + "name": "LOG_LEVEL", + "value": "debug" + } }, "container_configuration": { "allOf": [ @@ -30638,17 +29489,15 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication.", - "examples": [ - [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } - ] + "example": [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } ], "x-ms-foundry-meta": { "required_previews": [ @@ -30845,7 +29694,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -31101,12 +29950,12 @@ }, "features": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Features to help with additional filtering of data in UX." }, "correlationInfo": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Info about the correlation for the analysis sample." } }, @@ -31434,8 +30283,7 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", - "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -31851,7 +30699,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -31911,7 +30759,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -31968,17 +30816,11 @@ "description": "The status of the tool call." }, "memories": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemoryItem" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/MemoryItem" + }, + "nullable": true, "description": "The results returned from the memory search." } }, @@ -32206,7 +31048,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -32485,7 +31327,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -32555,7 +31397,7 @@ }, "capabilities": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Capabilities of deployed model", @@ -32776,7 +31618,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -32983,7 +31825,8 @@ "create_file" ], "description": "Create a new file with the provided diff.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "create_file" }, "path": { "type": "string", @@ -33016,7 +31859,8 @@ "create_file" ], "description": "The operation type. Always `create_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "create_file" }, "path": { "type": "string", @@ -33050,7 +31894,8 @@ "delete_file" ], "description": "Delete the specified file.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "delete_file" }, "path": { "type": "string", @@ -33078,7 +31923,8 @@ "delete_file" ], "description": "The operation type. Always `delete_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "delete_file" }, "path": { "type": "string", @@ -33178,7 +32024,8 @@ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "apply_patch" } }, "allOf": [ @@ -33203,7 +32050,8 @@ "update_file" ], "description": "Update an existing file with the provided diff.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "update_file" }, "path": { "type": "string", @@ -33236,7 +32084,8 @@ "update_file" ], "description": "The operation type. Always `update_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "update_file" }, "path": { "type": "string", @@ -33273,44 +32122,20 @@ "default": "approximate" }, "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "timezone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -33338,14 +32163,12 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "network_policy": { "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyParam" @@ -33379,12 +32202,6 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ - "gpt-5.4", - "gpt-5.4-mini", - "gpt-5.4-nano", - "gpt-5.4-mini-2026-03-17", - "gpt-5.4-nano-2026-03-17", - "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -33484,7 +32301,8 @@ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "click" }, "button": { "allOf": [ @@ -33509,19 +32327,6 @@ } ], "description": "The y-coordinate where the click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -33605,7 +32410,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -33695,61 +32500,17 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "prompt_cache_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "prompt_cache_retention": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" - }, - { - "type": "null" - } - ] - }, - "service_tier": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -33769,9 +32530,7 @@ "gt", "gte", "lt", - "lte", - "in", - "nin" + "lte" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -33873,14 +32632,6 @@ } } }, - "OpenAI.ComputerActionList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerAction" - }, - "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", - "title": "Computer Action List" - }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -33913,24 +32664,12 @@ "description": "The ID of the pending safety check." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "A pending safety check for the computer call." @@ -33950,8 +32689,7 @@ "required": [ "type", "image_url", - "file_id", - "detail" + "file_id" ], "properties": { "type": { @@ -33960,36 +32698,17 @@ "computer_screenshot" ], "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "computer_screenshot" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ImageDetail" - } - ], - "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "type": "string", + "nullable": true } }, "allOf": [ @@ -34027,29 +32746,6 @@ }, "description": "A computer screenshot image used with the computer use tool." }, - "OpenAI.ComputerTool": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer" - ], - "description": "The type of the computer tool. Always `computer`.", - "x-stainless-const": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", - "title": "Computer" - }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -34065,7 +32761,8 @@ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "computer_use_preview" }, "environment": { "allOf": [ @@ -34112,7 +32809,8 @@ "container_auto" ], "description": "Automatically creates a container for this request", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_auto" }, "file_ids": { "type": "array", @@ -34123,14 +32821,12 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "skills": { "type": "array", @@ -34167,7 +32863,8 @@ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_file_citation" }, "container_id": { "type": "string", @@ -34228,7 +32925,8 @@ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "allowlist" }, "allowed_domains": { "type": "array", @@ -34237,6 +32935,14 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." + }, + "domain_secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" + }, + "minItems": 1, + "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -34257,7 +32963,8 @@ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "disabled" } }, "allOf": [ @@ -34266,6 +32973,32 @@ } ] }, + "OpenAI.ContainerNetworkPolicyDomainSecretParam": { + "type": "object", + "required": [ + "domain", + "name", + "value" + ], + "properties": { + "domain": { + "type": "string", + "minLength": 1, + "description": "The domain associated with the secret." + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The name of the secret to inject for the domain." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 10485760, + "description": "The secret value to inject for the domain." + } + } + }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -34312,7 +33045,8 @@ "container_reference" ], "description": "The environment type. Always `container_reference`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_reference" }, "container_id": { "type": "string" @@ -34369,14 +33103,13 @@ "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } } }, @@ -34394,18 +33127,14 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", - "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", - "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -34417,57 +33146,13 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", "title": "Conversation item" }, - "OpenAI.ConversationItemAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, "OpenAI.ConversationItemApplyPatchToolCall": { "type": "object", "required": [ @@ -34560,14 +33245,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -34622,34 +33301,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -34660,50 +33327,13 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, - "OpenAI.ConversationItemCompactionBody": { - "type": "object", - "required": [ - "type", - "id", - "encrypted_content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "compaction" - ], - "description": "The type of the item. Always `compaction`.", - "x-stainless-const": true, - "default": "compaction" - }, - "id": { - "type": "string", - "description": "The unique ID of the compaction item." - }, - "encrypted_content": { - "type": "string", - "description": "The encrypted content that was produced by compaction." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ], - "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", - "title": "Compaction item" - }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -34727,9 +33357,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -34755,11 +33382,10 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutput": { + "OpenAI.ConversationItemComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -34775,8 +33401,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -34806,60 +33431,40 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, - "OpenAI.ConversationItemCustomToolCallOutputResource": { + "OpenAI.ConversationItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", - "output", - "status" + "name", + "input" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call_output" + "custom_tool_call" ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "description": "The type of the custom tool call. Always `custom_tool_call`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." + "description": "The unique ID of the custom tool call in the OpenAI platform." }, "call_id": { "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + "name": { + "type": "string", + "description": "The name of the custom tool being called." }, - "created_by": { + "input": { "type": "string", - "description": "The identifier of the actor that created the item." + "description": "The input for the custom tool call generated by the model." } }, "allOf": [ @@ -34867,57 +33472,46 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallOutputItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, - "OpenAI.ConversationItemCustomToolCallResource": { + "OpenAI.ConversationItemCustomToolCallOutput": { "type": "object", "required": [ "type", "call_id", - "name", - "input", - "status" + "output" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call" + "custom_tool_call_output" ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." + "description": "The unique ID of the custom tool call output in the OpenAI platform." }, "call_id": { "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." - }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." - }, - "input": { - "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "status": { - "allOf": [ + "output": { + "oneOf": [ + { + "type": "string" + }, { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } } ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." } }, "allOf": [ @@ -34925,7 +33519,8 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "The output of a custom tool call from your code, being sent back to the model.", + "title": "Custom tool call output" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -34967,17 +33562,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -35027,20 +33616,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -35086,7 +33674,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -35099,14 +33687,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -35121,44 +33708,43 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCall": { + "OpenAI.ConversationItemFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -35174,49 +33760,40 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", - "title": "Function tool call" + ] }, - "OpenAI.ConversationItemFunctionToolCallOutput": { + "OpenAI.ConversationItemFunctionToolCallResource": { "type": "object", "required": [ - "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -35232,9 +33809,7 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -35268,14 +33843,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -35405,19 +33974,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -35501,14 +34064,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -35552,7 +34109,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -35598,18 +34156,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -35620,14 +34172,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -35683,16 +34229,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -35724,14 +34260,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -35765,138 +34295,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.ConversationItemToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, - "OpenAI.ConversationItemToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -35913,11 +34311,7 @@ "image_generation_call", "computer_call", "computer_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", - "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -36106,8 +34500,7 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", - "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -36177,27 +34570,20 @@ "type": "object", "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "items": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + }, + "nullable": true } } }, @@ -36375,7 +34761,7 @@ }, "item_schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The json schema for each row in the data source." }, "include_sample_schema": { @@ -36444,7 +34830,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Metadata filters for the logs data source." } }, @@ -36639,7 +35025,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Metadata filters for the stored completions data source." } }, @@ -36691,52 +35077,33 @@ "deprecated": true }, "suffix": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "minLength": 1, "maxLength": 64, "description": "A string of up to 64 characters that will be added to your fine-tuned model name.\n For example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`." }, "validation_file": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "description": "The ID of an uploaded file that contains validation data.\n If you provide this file, the data is used to generate validation\n metrics periodically during fine-tuning. These metrics can be viewed in\n the fine-tuning results file.\n The same data should not be present in both train and validation files.\n Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n See the [fine-tuning guide](/docs/guides/model-optimization) for more details." }, "integrations": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" + }, + "nullable": true, "description": "A list of integrations to enable for your fine-tuning job." }, "seed": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } ], + "nullable": true, "minimum": 0, "maximum": 2147483647, "description": "The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\n If a seed is not specified, one will be generated for you." @@ -36745,14 +35112,13 @@ "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true } } }, @@ -36832,24 +35198,12 @@ "type": "string" }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "entity": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "tags": { "type": "array", @@ -37036,7 +35390,8 @@ "grammar" ], "description": "Grammar format. Always `grammar`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "grammar" }, "syntax": { "allOf": [ @@ -37071,7 +35426,8 @@ "text" ], "description": "Unconstrained text format. Always `text`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "text" } }, "allOf": [ @@ -37095,7 +35451,8 @@ "custom" ], "description": "The type of the custom tool. Always `custom`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "custom" }, "name": { "type": "string", @@ -37112,10 +35469,6 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." - }, - "defer_loading": { - "type": "boolean", - "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -37188,8 +35541,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.DoubleClickAction": { @@ -37197,8 +35549,7 @@ "required": [ "type", "x", - "y", - "keys" + "y" ], "properties": { "type": { @@ -37207,7 +35558,8 @@ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "double_click" }, "x": { "allOf": [ @@ -37224,19 +35576,6 @@ } ], "description": "The y-coordinate where the double click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -37260,7 +35599,8 @@ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "drag" }, "path": { "type": "array", @@ -37268,19 +35608,6 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -37320,16 +35647,6 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "type": { "type": "string", "enum": [ @@ -37356,9 +35673,6 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, - "OpenAI.EmptyModelParam": { - "type": "object" - }, "OpenAI.Error": { "type": "object", "required": [ @@ -37367,27 +35681,15 @@ ], "properties": { "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { "type": "string" }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string" @@ -37400,11 +35702,11 @@ }, "additionalInfo": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "debugInfo": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } }, @@ -37583,45 +35885,41 @@ "type": "object", "properties": { "seed": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_completions_tokens": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "reasoning_effort": { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" @@ -37962,11 +36260,11 @@ "properties": { "item": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "sample": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } }, @@ -38007,111 +36305,75 @@ "description": "The type of run data source. Always `responses`." }, "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": {}, + "nullable": true }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "instructions_search": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_after": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_before": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "reasoning_effort": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "users": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, "tools": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "description": "A EvalResponsesSource object describing a run data source configuration.", @@ -38311,54 +36573,44 @@ "default": "stored_completions" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_after": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_before": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "limit": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "A StoredCompletionsRunDataSource configuration describing a set of filters", @@ -38384,7 +36636,8 @@ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "file_citation" }, "file_id": { "type": "string", @@ -38411,13 +36664,6 @@ "description": "A citation to a file.", "title": "File citation" }, - "OpenAI.FileInputDetail": { - "type": "string", - "enum": [ - "low", - "high" - ] - }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -38468,7 +36714,8 @@ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "file_search" }, "vector_store_ids": { "type": "array", @@ -38494,14 +36741,12 @@ "description": "Ranking options for search." }, "filters": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "name": { "type": "string", @@ -38513,7 +36758,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -38540,14 +36785,13 @@ "type": "string" }, "attributes": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.VectorStoreFileAttributes" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "score": { "type": "number", @@ -38902,24 +37146,12 @@ "type": "string" }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "entity": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "tags": { "type": "array", @@ -38959,37 +37191,22 @@ "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created." }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FineTuningJobError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "fine_tuned_model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "hyperparameters": { "allOf": [ @@ -39035,41 +37252,28 @@ "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`." }, "trained_tokens": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "training_file": { "type": "string", "description": "The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents)." }, "validation_file": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "integrations": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" + }, + "nullable": true }, "seed": { "allOf": [ @@ -39080,30 +37284,21 @@ "description": "The seed used for the fine-tuning job." }, "estimated_finish": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "method": { "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.", @@ -39215,14 +37410,8 @@ "type": "string" }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -39301,13 +37490,17 @@ "type": "string", "enum": [ "auto" - ] + ], + "nullable": true }, { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true } ], "default": "auto" @@ -39377,35 +37570,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -39433,25 +37612,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -39459,7 +37626,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -39522,22 +37689,6 @@ "incomplete" ] }, - "OpenAI.FunctionCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.FunctionCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -39556,20 +37707,14 @@ "$ref": "#/components/schemas/OpenAI.FunctionParameters" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } } }, "OpenAI.FunctionParameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\nOmitting `parameters` defines a function with an empty parameter list." }, "OpenAI.FunctionShellAction": { @@ -39587,24 +37732,22 @@ } }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Execute a shell command.", @@ -39624,24 +37767,22 @@ "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Commands and limits describing how to run the shell tool call.", @@ -39855,7 +37996,8 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "exit" }, "exit_code": { "allOf": [ @@ -39887,7 +38029,8 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "exit" }, "exit_code": { "allOf": [ @@ -39974,14 +38117,6 @@ } ] }, - "OpenAI.FunctionShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -39994,7 +38129,8 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "timeout" } }, "allOf": [ @@ -40017,7 +38153,8 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "timeout" } }, "allOf": [ @@ -40028,14 +38165,6 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, - "OpenAI.FunctionShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -40048,17 +38177,17 @@ "shell" ], "description": "The type of the shell tool. Always `shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "shell" }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellToolParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "name": { "type": "string", @@ -40070,7 +38199,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -40190,46 +38319,25 @@ "function" ], "description": "The type of the function tool. Always `function`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "function" }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "parameters": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": {}, + "nullable": true }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "defer_loading": { "type": "boolean", - "description": "Whether this function is deferred and loaded via tool search." + "nullable": true } }, "allOf": [ @@ -40240,62 +38348,61 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolParam": { + "OpenAI.FunctionToolCallOutput": { "type": "object", "required": [ - "name", - "type" + "type", + "call_id", + "output" ], "properties": { - "name": { + "id": { "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_-]+$" + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - }, - { - "type": "null" - } - ] + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." }, - "strict": { - "anyOf": [ + "output": { + "oneOf": [ { - "type": "boolean" + "type": "string" }, { - "type": "null" + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } } - ] + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, - "type": { + "status": { "type": "string", "enum": [ - "function" + "in_progress", + "completed", + "incomplete" ], - "x-stainless-const": true, - "default": "function" - }, - "defer_loading": { - "type": "boolean", - "description": "Whether this function should be deferred and discovered via tool search." + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." } - } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.GraderLabelModel": { "type": "object", @@ -40643,8 +38750,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.ImageGenActionEnum": { @@ -40667,7 +38773,8 @@ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "image_generation" }, "model": { "anyOf": [ @@ -40697,21 +38804,14 @@ "default": "auto" }, "size": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" - ] - } + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" ], - "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", + "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", "default": "auto" }, "output_format": { @@ -40755,14 +38855,12 @@ "default": "auto" }, "input_fidelity": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.InputFidelity" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "input_image_mask": { "allOf": [ @@ -40800,7 +38898,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -40846,7 +38944,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -40863,7 +38961,8 @@ "inline" ], "description": "Defines an inline skill for this request.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "inline" }, "name": { "type": "string", @@ -41004,35 +39103,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -41060,25 +39145,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -41086,7 +39159,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -41165,35 +39238,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "description": "A file input to the model.", @@ -41215,53 +39274,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "file_data": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "file_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] - }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "type": "string", + "format": "uri", + "nullable": true } }, "description": "A file input to the model.", @@ -41284,25 +39311,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -41310,7 +39325,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -41332,35 +39347,21 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.DetailEnum" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", @@ -41388,9 +39389,6 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", - "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", - "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", - "additional_tools": "#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -41411,56 +39409,6 @@ }, "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs." }, - "OpenAI.InputItemAdditionalToolsItemParam": { - "type": "object", - "required": [ - "type", - "role", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The item type. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "role": { - "type": "string", - "enum": [ - "developer" - ], - "description": "The role that provided the additional tools. Only `developer` is supported.", - "x-stainless-const": true, - "default": "developer" - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "A list of additional tools made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - ] - }, "OpenAI.InputItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -41480,14 +39428,8 @@ "default": "apply_patch_call" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41538,14 +39480,8 @@ "default": "apply_patch_call_output" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41562,14 +39498,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -41620,34 +39550,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -41666,14 +39584,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string", @@ -41707,14 +39619,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41735,27 +39641,19 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "nullable": true }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -41772,6 +39670,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -41795,9 +39694,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -41848,10 +39744,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -41956,17 +39848,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -41986,14 +39872,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -42035,14 +39915,12 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -42062,14 +39940,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -42095,24 +39967,21 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -42132,14 +40001,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -42164,24 +40027,21 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -42195,7 +40055,6 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -42204,8 +40063,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -42219,10 +40077,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -42281,14 +40135,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -42371,19 +40219,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -42454,14 +40296,8 @@ "x-stainless-const": true }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "approval_request_id": { "type": "string", @@ -42472,14 +40308,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -42523,7 +40353,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -42569,18 +40400,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -42591,14 +40416,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -42646,16 +40465,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -42695,14 +40504,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -42736,143 +40539,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.InputItemToolSearchCallItemParam": { - "type": "object", - "required": [ - "type", - "arguments" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The item type. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - } - ], - "description": "The arguments supplied to the tool search call." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - ] - }, - "OpenAI.InputItemToolSearchOutputItemParam": { - "type": "object", - "required": [ - "type", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The item type. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by the tool search output." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - ] - }, "OpenAI.InputItemType": { "anyOf": [ { @@ -42889,9 +40555,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -42967,6 +40630,52 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.InputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -42975,6 +40684,55 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, + "OpenAI.InputMessageResource": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.InputParam": { "oneOf": [ { @@ -43051,7 +40809,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemInputMessage", + "message": "#/components/schemas/OpenAI.InputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -43059,9 +40817,6 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", - "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", - "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", - "additional_tools": "#/components/schemas/OpenAI.ItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -43082,56 +40837,6 @@ }, "description": "Content item used to generate a response." }, - "OpenAI.ItemAdditionalToolsItemParam": { - "type": "object", - "required": [ - "type", - "role", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The item type. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "role": { - "type": "string", - "enum": [ - "developer" - ], - "description": "The role that provided the additional tools. Only `developer` is supported.", - "x-stainless-const": true, - "default": "developer" - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "A list of additional tools made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ] - }, "OpenAI.ItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -43151,14 +40856,8 @@ "default": "apply_patch_call" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -43209,14 +40908,8 @@ "default": "apply_patch_call_output" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -43233,14 +40926,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -43291,34 +40978,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -43337,14 +41012,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string", @@ -43378,14 +41047,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -43406,27 +41069,19 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "nullable": true }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -43443,6 +41098,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -43466,9 +41122,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -43519,10 +41172,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -43600,17 +41249,14 @@ "discriminator": { "propertyName": "type", "mapping": { + "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", - "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ItemFieldAdditionalTools", - "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -43630,50 +41276,6 @@ }, "description": "An item representing a message, tool call, tool output, reasoning, or other response element." }, - "OpenAI.ItemFieldAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ] - }, "OpenAI.ItemFieldApplyPatchToolCall": { "type": "object", "required": [ @@ -43766,14 +41368,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -43828,34 +41424,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -43910,6 +41494,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -43933,9 +41518,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -43961,11 +41543,10 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutput": { + "OpenAI.ItemFieldComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -43981,8 +41562,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -44012,9 +41592,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -44041,10 +41619,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -44149,17 +41723,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -44209,20 +41777,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -44268,7 +41835,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -44281,14 +41848,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -44306,7 +41872,6 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -44315,8 +41880,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -44330,10 +41894,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -44360,64 +41920,6 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, - "OpenAI.ItemFieldFunctionToolCallOutput": { - "type": "object", - "required": [ - "id", - "type", - "call_id", - "output" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true - }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true - }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" - }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -44450,14 +41952,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44540,19 +42036,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -44636,14 +42126,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44687,7 +42171,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -44733,18 +42218,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -44755,14 +42234,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44818,16 +42291,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -44859,14 +42322,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -44900,138 +42357,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.ItemFieldToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ] - }, - "OpenAI.ItemFieldToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" - } - ] - }, "OpenAI.ItemFieldType": { "anyOf": [ { @@ -45042,9 +42367,6 @@ "enum": [ "message", "function_call", - "tool_search_call", - "tool_search_output", - "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -45164,17 +42486,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -45194,14 +42510,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -45243,14 +42553,12 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -45270,14 +42578,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -45303,24 +42605,21 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -45340,14 +42639,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -45372,24 +42665,21 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -45403,7 +42693,6 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -45412,8 +42701,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -45427,10 +42715,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -45489,14 +42773,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -45507,59 +42785,6 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, - "OpenAI.ItemInputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true, - "default": "message" - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -45632,19 +42857,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -45715,14 +42934,8 @@ "x-stainless-const": true }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "approval_request_id": { "type": "string", @@ -45733,14 +42946,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -45784,7 +42991,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -45830,18 +43038,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -45852,14 +43054,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -45907,16 +43103,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -45956,14 +43142,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -46010,7 +43190,8 @@ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "item_reference" }, "id": { "type": "string", @@ -46038,19 +43219,14 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", + "message": "#/components/schemas/OpenAI.InputMessageResource", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", - "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ItemResourceAdditionalTools", - "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", - "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -46062,57 +43238,11 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" } }, "description": "Content item used to generate a response." }, - "OpenAI.ItemResourceAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.ItemResourceApplyPatchToolCall": { "type": "object", "required": [ @@ -46205,14 +43335,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -46267,34 +43391,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -46305,50 +43417,13 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, - "OpenAI.ItemResourceCompactionBody": { - "type": "object", - "required": [ - "type", - "id", - "encrypted_content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "compaction" - ], - "description": "The type of the item. Always `compaction`.", - "x-stainless-const": true, - "default": "compaction" - }, - "id": { - "type": "string", - "description": "The unique ID of the compaction item." - }, - "encrypted_content": { - "type": "string", - "description": "The encrypted content that was produced by compaction." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", - "title": "Compaction item" - }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -46372,9 +43447,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -46400,11 +43472,10 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutput": { + "OpenAI.ItemResourceComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -46420,8 +43491,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -46451,126 +43521,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" - }, - "OpenAI.ItemResourceCustomToolCallOutputResource": { - "type": "object", - "required": [ - "type", - "call_id", - "output", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call_output" - ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "title": "ResponseCustomToolCallOutputItem" - }, - "OpenAI.ItemResourceCustomToolCallResource": { - "type": "object", - "required": [ - "type", - "call_id", - "name", - "input", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call" - ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." - }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." - }, - "input": { - "type": "string", - "description": "The input for the custom tool call generated by the model." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "title": "ResponseCustomToolCallItem" + ] }, "OpenAI.ItemResourceFileSearchToolCall": { "type": "object", @@ -46612,17 +43563,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -46672,20 +43617,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -46731,7 +43675,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -46744,14 +43688,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -46766,44 +43709,43 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCall": { + "OpenAI.ItemResourceFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -46819,49 +43761,40 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", - "title": "Function tool call" + ] }, - "OpenAI.ItemResourceFunctionToolCallOutput": { + "OpenAI.ItemResourceFunctionToolCallResource": { "type": "object", "required": [ - "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -46877,9 +43810,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, "OpenAI.ItemResourceImageGenToolCall": { "type": "object", @@ -46913,14 +43844,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -46931,59 +43856,6 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, - "OpenAI.ItemResourceInputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true, - "default": "message" - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", "required": [ @@ -47056,19 +43928,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -47152,14 +44018,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -47203,7 +44063,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -47249,18 +44110,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -47271,14 +44126,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -47326,16 +44175,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -47354,200 +44193,6 @@ "description": "An output message from the model.", "title": "Output message" }, - "OpenAI.ItemResourceReasoningItem": { - "type": "object", - "required": [ - "type", - "id", - "summary" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "reasoning" - ], - "description": "The type of the object. Always `reasoning`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique identifier of the reasoning content." - }, - "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "summary": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.SummaryTextContent" - }, - "description": "Reasoning summary content." - }, - "content": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" - }, - "description": "Reasoning text content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ], - "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", - "title": "Reasoning" - }, - "OpenAI.ItemResourceToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, - "OpenAI.ItemResourceToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.ItemResourceType": { "anyOf": [ { @@ -47564,11 +44209,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", - "reasoning", - "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -47581,8 +44221,6 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", - "custom_tool_call", - "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -47665,143 +44303,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.ItemToolSearchCallItemParam": { - "type": "object", - "required": [ - "type", - "arguments" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The item type. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - } - ], - "description": "The arguments supplied to the tool search call." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ] - }, - "OpenAI.ItemToolSearchOutputItemParam": { - "type": "object", - "required": [ - "type", - "tools" - ], - "properties": { - "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The item type. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by the tool search output." - }, - "status": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ] - }, "OpenAI.ItemType": { "anyOf": [ { @@ -47818,9 +44319,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -47932,7 +44430,8 @@ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "keypress" }, "keys": { "type": "array", @@ -47973,24 +44472,12 @@ "x-stainless-const": true }, "first_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "last_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "x-ms-list-continuation-token": true }, "has_more": { @@ -48064,7 +44551,8 @@ "local" ], "description": "The environment type. Always `local`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "local" } }, "allOf": [ @@ -48075,13 +44563,29 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellExecAction": { - "type": "object", - "required": [ - "type", - "command", - "env" - ], + "OpenAI.LocalShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.LocalShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.LocalShellExecAction": { + "type": "object", + "required": [ + "type", + "command", + "env" + ], "properties": { "type": { "type": "string", @@ -48100,42 +44604,29 @@ "description": "The command to run." }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "working_directory": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "env": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Environment variables to set for the command.", "x-oaiTypeLabel": "map" }, "user": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "Execute a shell command on the server.", @@ -48153,7 +44644,8 @@ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "local_shell" }, "name": { "type": "string", @@ -48165,7 +44657,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -48244,14 +44736,8 @@ "description": "The name of the tool." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "input_schema": { "allOf": [ @@ -48262,14 +44748,13 @@ "description": "The JSON schema describing the tool's input." }, "annotations": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.MCPListToolsToolAnnotations" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "A tool available on an MCP server.", @@ -48328,17 +44813,11 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true }, "allowed_tools": { "anyOf": [ @@ -48346,45 +44825,49 @@ "type": "array", "items": { "type": "string" - } - }, - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + "nullable": true }, { - "type": "null" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true } ] }, "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { "type": "string", "enum": [ "always", "never" - ] - }, - { - "type": "null" + ], + "nullable": true } ], "default": "always" }, - "defer_loading": { - "type": "boolean", - "description": "Whether this MCP tool is deferred and discovered via tool search." - }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -48458,8 +44941,7 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", - "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" } }, "description": "A content part that makes up an input or output item." @@ -48480,35 +44962,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." - }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "detail": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FileInputDetail" - } - ], - "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -48536,25 +45004,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -48562,7 +45018,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -48725,14 +45181,6 @@ } ] }, - "OpenAI.MessagePhase": { - "type": "string", - "enum": [ - "commentary", - "final_answer" - ], - "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." - }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -48756,7 +45204,7 @@ }, "OpenAI.Metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -48765,13 +45213,18 @@ "OpenAI.ModelIdsCompaction": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" - }, - { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" + } + ], + "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", + "nullable": true }, { - "type": "null" + "type": "string", + "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", + "nullable": true } ], "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models." @@ -48812,182 +45265,6 @@ } ] }, - "OpenAI.Moderation": { - "type": "object", - "required": [ - "input", - "output" - ], - "properties": { - "input": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationEntry" - } - ], - "description": "Moderation for the response input." - }, - "output": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationEntry" - } - ], - "description": "Moderation for the response output." - } - }, - "description": "Moderation results or errors for the response input and output.", - "title": "Moderation" - }, - "OpenAI.ModerationEntry": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/OpenAI.ModerationEntryType" - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "moderation_result": "#/components/schemas/OpenAI.ModerationResultBody", - "error": "#/components/schemas/OpenAI.ModerationErrorBody" - } - }, - "description": "Moderation results or an error for a response moderation check." - }, - "OpenAI.ModerationEntryType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "moderation_result", - "error" - ] - } - ] - }, - "OpenAI.ModerationErrorBody": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "error" - ], - "description": "The object type, which was always `error` for moderation failures.", - "x-stainless-const": true - }, - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationEntry" - } - ], - "description": "An error produced while attempting moderation for the response input or output.", - "title": "Moderation error" - }, - "OpenAI.ModerationInputType": { - "type": "string", - "enum": [ - "text", - "image" - ] - }, - "OpenAI.ModerationParam": { - "type": "object", - "required": [ - "model" - ], - "properties": { - "model": { - "type": "string", - "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'." - } - }, - "description": "Configuration for running moderation on the input and output of this response." - }, - "OpenAI.ModerationResultBody": { - "type": "object", - "required": [ - "type", - "model", - "flagged", - "categories", - "category_scores", - "category_applied_input_types" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "moderation_result" - ], - "description": "The object type, which was always `moderation_result` for successful moderation results.", - "x-stainless-const": true - }, - "model": { - "type": "string", - "description": "The moderation model that produced this result." - }, - "flagged": { - "type": "boolean", - "description": "A boolean indicating whether the content was flagged by any category." - }, - "categories": { - "type": "object", - "unevaluatedProperties": { - "type": "boolean" - }, - "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.", - "x-oaiTypeLabel": "map" - }, - "category_scores": { - "type": "object", - "unevaluatedProperties": { - "$ref": "#/components/schemas/OpenAI.numeric" - }, - "description": "A dictionary of moderation categories to scores.", - "x-oaiTypeLabel": "map" - }, - "category_applied_input_types": { - "type": "object", - "unevaluatedProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ModerationInputType" - } - }, - "description": "Which modalities of input are reflected by the score for each category.", - "x-oaiTypeLabel": "map" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationEntry" - } - ], - "description": "A moderation result produced for the response input or output.", - "title": "Moderation result" - }, "OpenAI.MoveParam": { "type": "object", "required": [ @@ -49002,7 +45279,8 @@ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "move" }, "x": { "allOf": [ @@ -49019,19 +45297,6 @@ } ], "description": "The y-coordinate to move to." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -49042,57 +45307,6 @@ "description": "A mouse move action.", "title": "Move" }, - "OpenAI.NamespaceToolParam": { - "type": "object", - "required": [ - "type", - "name", - "description", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "namespace" - ], - "description": "The type of the tool. Always `namespace`.", - "x-stainless-const": true - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The namespace name used in tool calls (for example, `crm`)." - }, - "description": { - "type": "string", - "minLength": 1, - "description": "A description of the namespace shown to the model." - }, - "tools": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionToolParam" - }, - { - "$ref": "#/components/schemas/OpenAI.CustomToolParam" - } - ] - }, - "minItems": 1, - "description": "The function/custom tools available inside this namespace." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "Groups function/custom tools under a shared namespace.", - "title": "Namespace" - }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -49292,19 +45506,13 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", - "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.OutputItemAdditionalTools", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", - "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -49312,56 +45520,10 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" } } }, - "OpenAI.OutputItemAdditionalTools": { - "type": "object", - "required": [ - "type", - "id", - "role", - "tools" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "additional_tools" - ], - "description": "The type of the item. Always `additional_tools`.", - "x-stainless-const": true, - "default": "additional_tools" - }, - "id": { - "type": "string", - "description": "The unique ID of the additional tools item." - }, - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessageRole" - } - ], - "description": "The role that provided the additional tools." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The additional tool definitions made available at this item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ] - }, "OpenAI.OutputItemApplyPatchToolCall": { "type": "object", "required": [ @@ -49454,14 +45616,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -49516,34 +45672,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -49598,6 +45742,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -49621,9 +45766,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -49649,128 +45791,13 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemComputerToolCallOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "output" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer_call_output" - ], - "description": "The type of the computer tool call output. Always `computer_call_output`.", - "x-stainless-const": true, - "default": "computer_call_output" - }, - "id": { - "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true - }, - "call_id": { - "type": "string", - "description": "The ID of the computer tool call that produced the output." - }, - "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "description": "The safety checks reported by the API that have been acknowledged by the\n developer." - }, - "output": { - "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" - }, - "OpenAI.OutputItemCustomToolCallOutputResource": { - "type": "object", - "required": [ - "type", - "call_id", - "output", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call_output" - ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "title": "ResponseCustomToolCallOutputItem" - }, - "OpenAI.OutputItemCustomToolCallResource": { + "OpenAI.OutputItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", "name", - "input", - "status" + "input" ], "properties": { "type": { @@ -49789,10 +45816,6 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, - "namespace": { - "type": "string", - "description": "The namespace of the custom tool being called." - }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -49800,18 +45823,6 @@ "input": { "type": "string", "description": "The input for the custom tool call generated by the model." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -49819,7 +45830,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -49861,17 +45873,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -49921,20 +45927,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -49980,7 +45985,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -49993,14 +45998,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -50018,7 +46022,6 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -50027,8 +46030,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -50042,10 +46044,6 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "namespace": { - "type": "string", - "description": "The namespace of the function to run." - }, "name": { "type": "string", "description": "The name of the function to run." @@ -50072,64 +46070,6 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, - "OpenAI.OutputItemFunctionToolCallOutput": { - "type": "object", - "required": [ - "id", - "type", - "call_id", - "output" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", - "readOnly": true - }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true - }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" - }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", "required": [ @@ -50162,14 +46102,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -50227,54 +46161,6 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, - "OpenAI.OutputItemLocalShellToolCallOutput": { - "type": "object", - "required": [ - "type", - "id", - "output" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "local_shell_call_output" - ], - "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the local shell tool call generated by the model." - }, - "output": { - "type": "string", - "description": "A JSON string of the output of the local shell tool call." - }, - "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a local shell tool call.", - "title": "Local shell call output" - }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -50318,54 +46204,6 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, - "OpenAI.OutputItemMcpApprovalResponseResource": { - "type": "object", - "required": [ - "type", - "id", - "approval_request_id", - "approve" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "mcp_approval_response" - ], - "description": "The type of the item. Always `mcp_approval_response`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the approval response" - }, - "approval_request_id": { - "type": "string", - "description": "The ID of the approval request being answered." - }, - "approve": { - "type": "boolean", - "description": "Whether the request was approved." - }, - "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "A response to an MCP approval request.", - "title": "MCP approval response" - }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -50399,7 +46237,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -50445,18 +46284,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -50467,14 +46300,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -50522,16 +46349,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -50571,14 +46388,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -50612,138 +46423,6 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.OutputItemToolSearchCall": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_call" - ], - "description": "The type of the item. Always `tool_search_call`.", - "x-stainless-const": true, - "default": "tool_search_call" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search call item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "arguments": { - "description": "Arguments used for the tool search call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" - } - ], - "description": "The status of the tool search call item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ] - }, - "OpenAI.OutputItemToolSearchOutput": { - "type": "object", - "required": [ - "type", - "id", - "call_id", - "execution", - "tools", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search_output" - ], - "description": "The type of the item. Always `tool_search_output`.", - "x-stainless-const": true, - "default": "tool_search_output" - }, - "id": { - "type": "string", - "description": "The unique ID of the tool search output item." - }, - "call_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search was executed by the server or by the client." - }, - "tools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.Tool" - }, - "description": "The loaded tool definitions returned by tool search." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" - } - ], - "description": "The status of the tool search output item that was recorded." - }, - "created_by": { - "type": "string", - "description": "The identifier of the actor that created the item." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ] - }, "OpenAI.OutputItemType": { "anyOf": [ { @@ -50755,19 +46434,13 @@ "output_message", "file_search_call", "function_call", - "function_call_output", "web_search_call", "computer_call", - "computer_call_output", "reasoning", - "tool_search_call", - "tool_search_output", - "additional_tools", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", - "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -50775,9 +46448,7 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", - "mcp_approval_response", "custom_tool_call", - "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -50976,35 +46647,21 @@ "description": "The unique identifier of the prompt template to use." }, "version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "variables": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponsePromptVariables" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, - "OpenAI.PromptCacheRetentionEnum": { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -51041,181 +46698,46 @@ } } }, - "OpenAI.RealtimeMCPError": { + "OpenAI.Reasoning": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", - "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", - "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" - } - } - }, - "OpenAI.RealtimeMCPHTTPError": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "http_error" - ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" + "effort": { + "$ref": "#/components/schemas/OpenAI.ReasoningEffort" }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP HTTP error" - }, - "OpenAI.RealtimeMCPProtocolError": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { + "summary": { "type": "string", "enum": [ - "protocol_error" + "auto", + "concise", + "detailed" ], - "x-stainless-const": true + "nullable": true }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" - }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP protocol error" - }, - "OpenAI.RealtimeMCPToolExecutionError": { - "type": "object", - "required": [ - "type", - "message" - ], - "properties": { - "type": { + "generate_summary": { "type": "string", "enum": [ - "tool_execution_error" + "auto", + "concise", + "detailed" ], - "x-stainless-const": true - }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP tool execution error" - }, - "OpenAI.RealtimeMcpErrorType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "protocol_error", - "tool_execution_error", - "http_error" - ] - } - ] - }, - "OpenAI.Reasoning": { - "type": "object", - "properties": { - "effort": { - "$ref": "#/components/schemas/OpenAI.ReasoningEffort" - }, - "summary": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "concise", - "detailed" - ] - }, - { - "type": "null" - } - ] - }, - "generate_summary": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "concise", - "detailed" - ] - }, - { - "type": "null" - } - ] + "nullable": true } }, "description": "**gpt-5 and o-series models only**\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).", "title": "Reasoning" }, "OpenAI.ReasoningEffort": { - "anyOf": [ - { - "type": "string", - "enum": [ - "none", - "minimal", - "low", - "medium", - "high", - "xhigh" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh" ], - "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`." + "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`.", + "nullable": true }, "OpenAI.ReasoningTextContent": { "type": "object", @@ -51256,45 +46778,41 @@ ], "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_logprobs": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "user": { @@ -51304,8 +46822,7 @@ }, "safety_identifier": { "type": "string", - "maxLength": 64, - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -51315,62 +46832,51 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "background": { - "anyOf": [ - { - "type": "boolean" - }, + "type": "boolean", + "nullable": true + }, + "max_output_tokens": { + "type": "integer", + "allOf": [ { - "type": "null" + "$ref": "#/components/schemas/OpenAI.integer" } - ] + ], + "nullable": true }, "max_tool_calls": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -51392,18 +46898,12 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "disabled" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "auto", + "disabled" ], + "nullable": true, "default": "disabled" }, "id": { @@ -51436,37 +46936,27 @@ "description": "Unix timestamp (in seconds) of when this Response was created." }, "completed_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "incomplete_details": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output": { "type": "array", @@ -51485,59 +46975,30 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "usage": { "$ref": "#/components/schemas/OpenAI.ResponseUsage" }, - "moderation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.Moderation" - }, - { - "type": "null" - } - ] - }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.", "default": true }, "conversation": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" - }, - { - "type": "null" - } - ] - }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "agent": { "allOf": [ @@ -51552,14 +47013,13 @@ "description": "The session identifier for this response. Currently only relevant for hosted agents.\nAlways returned for hosted agents — either the caller-provided value, the auto-derived value,\nor an auto-generated UUID. Use for session-scoped operations and to maintain sandbox\naffinity in follow-up calls." }, "agent_reference": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/AgentReference" - }, - { - "type": "null" } ], + "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -51598,15 +47058,10 @@ }, "delta": { "type": "string", - "contentEncoding": "base64", + "format": "base64", "description": "A chunk of Base64 encoded response audio bytes." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -51638,11 +47093,6 @@ "description": "The sequence number of the delta." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -51679,11 +47129,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -51715,11 +47160,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -51770,11 +47210,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -51825,11 +47260,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -51875,11 +47305,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -51925,11 +47350,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -51975,11 +47395,6 @@ "description": "The sequence number of this event, used to order streaming events." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -52020,11 +47435,6 @@ "description": "The sequence number for this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -52088,11 +47498,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -52156,11 +47561,6 @@ "description": "The content part that is done." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -52201,11 +47601,6 @@ "description": "The sequence number for this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -52256,11 +47651,6 @@ "description": "The incremental input data (delta) for the custom tool call." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -52312,11 +47702,6 @@ "description": "The complete input data for the custom tool call." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -52385,28 +47770,16 @@ "x-stainless-const": true }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { "type": "string", "description": "The error message." }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "sequence_number": { "allOf": [ @@ -52417,11 +47790,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -52462,11 +47830,6 @@ "description": "The response that failed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -52512,11 +47875,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -52562,11 +47920,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -52612,11 +47965,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -52691,20 +48039,14 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } } }, "OpenAI.ResponseFormatJsonSchemaSchema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "title": "JSON schema" }, @@ -52769,11 +48111,6 @@ "description": "The function-call arguments delta that is added." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -52828,11 +48165,6 @@ "description": "The function-call arguments." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -52878,11 +48210,6 @@ "description": "The unique identifier of the image generation item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -52929,11 +48256,6 @@ "description": "The sequence number of the image generation item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -52980,11 +48302,6 @@ "description": "The sequence number of the image generation item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -53045,11 +48362,6 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -53091,11 +48403,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -53148,11 +48455,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -53184,7 +48486,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probabilities of up to 20 of the most likely tokens." + "description": "The log probability of the top 20 most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -53243,11 +48545,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -53299,11 +48596,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -53350,11 +48642,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -53401,11 +48688,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -53452,11 +48734,6 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -53503,11 +48780,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -53554,11 +48826,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -53605,11 +48872,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -53660,11 +48922,6 @@ "description": "The output item that was added." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -53714,11 +48971,6 @@ "description": "The output item that was marked done." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -53791,11 +49043,6 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -53806,7 +49053,7 @@ }, "OpenAI.ResponsePromptVariables": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "anyOf": [ { "type": "string" @@ -53860,11 +49107,6 @@ "description": "The sequence number for this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -53929,11 +49171,6 @@ "description": "The summary part that was added." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -54016,11 +49253,6 @@ "description": "The completed summary part." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -54099,11 +49331,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -54163,11 +49390,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -54227,11 +49449,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -54291,11 +49508,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -54355,11 +49567,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -54419,11 +49626,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -54431,140 +49633,6 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, - "OpenAI.ResponseStreamEvent": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", - "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", - "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", - "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", - "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", - "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", - "error": "#/components/schemas/OpenAI.ResponseErrorEvent", - "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", - "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", - "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", - "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", - "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", - "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", - "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", - "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", - "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", - "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", - "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", - "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", - "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", - "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", - "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", - "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", - "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", - "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", - "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", - "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", - "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", - "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", - "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", - "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", - "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", - "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", - "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", - "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", - "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", - "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", - "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", - "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", - "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", - "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", - "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", - "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", - "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", - "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", - "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", - "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", - "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", - "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", - "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", - "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", - "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", - "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" - } - } - }, - "OpenAI.ResponseStreamEventType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "response.audio.delta", - "response.audio.done", - "response.audio.transcript.delta", - "response.audio.transcript.done", - "response.code_interpreter_call_code.delta", - "response.code_interpreter_call_code.done", - "response.code_interpreter_call.completed", - "response.code_interpreter_call.in_progress", - "response.code_interpreter_call.interpreting", - "response.completed", - "response.content_part.added", - "response.content_part.done", - "response.created", - "error", - "response.file_search_call.completed", - "response.file_search_call.in_progress", - "response.file_search_call.searching", - "response.function_call_arguments.delta", - "response.function_call_arguments.done", - "response.in_progress", - "response.failed", - "response.incomplete", - "response.output_item.added", - "response.output_item.done", - "response.reasoning_summary_part.added", - "response.reasoning_summary_part.done", - "response.reasoning_summary_text.delta", - "response.reasoning_summary_text.done", - "response.reasoning_text.delta", - "response.reasoning_text.done", - "response.refusal.delta", - "response.refusal.done", - "response.output_text.delta", - "response.output_text.done", - "response.web_search_call.completed", - "response.web_search_call.in_progress", - "response.web_search_call.searching", - "response.image_generation_call.completed", - "response.image_generation_call.generating", - "response.image_generation_call.in_progress", - "response.image_generation_call.partial_image", - "response.mcp_call_arguments.delta", - "response.mcp_call_arguments.done", - "response.mcp_call.completed", - "response.mcp_call.failed", - "response.mcp_call.in_progress", - "response.mcp_list_tools.completed", - "response.mcp_list_tools.failed", - "response.mcp_list_tools.in_progress", - "response.output_text.annotation.added", - "response.queued", - "response.custom_tool_call_input.delta", - "response.custom_tool_call_input.done" - ] - } - ] - }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -54635,11 +49703,6 @@ "description": "The log probabilities of the tokens in the delta." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -54707,11 +49770,6 @@ "description": "The log probabilities of the tokens in the delta." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -54844,11 +49902,6 @@ "description": "The sequence number of the web search call being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -54894,11 +49947,6 @@ "description": "The sequence number of the web search call being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -54944,11 +49992,6 @@ "description": "The sequence number of the web search call being processed." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -54968,7 +50011,8 @@ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "screenshot" } }, "allOf": [ @@ -54995,7 +50039,8 @@ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "scroll" }, "x": { "allOf": [ @@ -55028,19 +50073,6 @@ } ], "description": "The vertical scroll distance." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -55051,13 +50083,6 @@ "description": "A scroll action.", "title": "Scroll" }, - "OpenAI.SearchContentType": { - "type": "string", - "enum": [ - "text", - "image" - ] - }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -55067,31 +50092,16 @@ ] }, "OpenAI.ServiceTier": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "default", - "flex", - "scale", - "priority" - ] - }, - { - "type": "null" - } - ], - "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter." - }, - "OpenAI.ServiceTierEnum": { "type": "string", "enum": [ "auto", "default", "flex", + "scale", "priority" - ] + ], + "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", + "nullable": true }, "OpenAI.SkillReferenceParam": { "type": "object", @@ -55106,7 +50116,8 @@ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "skill_reference" }, "skill_id": { "type": "string", @@ -55137,7 +50148,8 @@ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "apply_patch" } }, "allOf": [ @@ -55160,7 +50172,8 @@ "shell" ], "description": "The tool to call. Always `shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "shell" } }, "allOf": [ @@ -55184,7 +50197,8 @@ "summary_text" ], "description": "The type of the object. Always `summary_text`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "summary_text" }, "text": { "type": "string", @@ -55211,7 +50225,8 @@ "enum": [ "text" ], - "x-stainless-const": true + "x-stainless-const": true, + "default": "text" }, "text": { "type": "string" @@ -55334,14 +50349,8 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } }, "allOf": [ @@ -55391,10 +50400,7 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", - "computer": "#/components/schemas/OpenAI.ComputerTool", - "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", - "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -55427,7 +50433,7 @@ "type": "array", "items": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "description": "A list of tool definitions that the model should be allowed to call.\n For the Responses API, the list of tool definitions might look like:\n ```json\n [\n { \"type\": \"function\", \"name\": \"get_weather\" },\n { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n { \"type\": \"image_generation\" }\n ]\n ```" } @@ -55460,46 +50466,6 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, - "OpenAI.ToolChoiceComputer": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ], - "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." - }, - "OpenAI.ToolChoiceComputerUse": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "computer_use" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ], - "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." - }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -55636,14 +50602,8 @@ "description": "The label of the MCP server to use." }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -55688,9 +50648,7 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", - "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", - "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -55714,9 +50672,7 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter", - "computer", - "computer_use" + "code_interpreter" ] } ] @@ -55761,64 +50717,6 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, - "OpenAI.ToolSearchExecutionType": { - "type": "string", - "enum": [ - "server", - "client" - ] - }, - "OpenAI.ToolSearchToolParam": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tool_search" - ], - "description": "The type of the tool. Always `tool_search`.", - "x-stainless-const": true - }, - "execution": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" - } - ], - "description": "Whether tool search is executed by the server or by the client." - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - }, - { - "type": "null" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "Hosted or BYOT tool search configuration for deferred tools.", - "title": "Tool search tool" - }, "OpenAI.ToolType": { "anyOf": [ { @@ -55829,7 +50727,6 @@ "enum": [ "function", "file_search", - "computer", "computer_use_preview", "web_search", "mcp", @@ -55838,8 +50735,6 @@ "local_shell", "shell", "custom", - "namespace", - "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -55905,7 +50800,8 @@ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "type" }, "text": { "type": "string", @@ -55927,14 +50823,13 @@ ], "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } ], + "nullable": true, "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." } } @@ -55955,7 +50850,8 @@ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "url_citation" }, "url": { "type": "string", @@ -55993,7 +50889,7 @@ }, "OpenAI.VectorStoreFileAttributes": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "anyOf": [ { "type": "string" @@ -56010,20 +50906,14 @@ "x-oaiTypeLabel": "map" }, "OpenAI.Verbosity": { - "anyOf": [ - { - "type": "string", - "enum": [ - "low", - "medium", - "high" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "low", + "medium", + "high" ], - "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`." + "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`.", + "nullable": true }, "OpenAI.WaitParam": { "type": "object", @@ -56037,7 +50927,8 @@ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "wait" } }, "allOf": [ @@ -56092,15 +50983,9 @@ "x-stainless-const": true }, "url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ], + "type": "string", + "format": "uri", + "nullable": true, "description": "The URL opened by the model." } }, @@ -56110,7 +50995,8 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type" + "type", + "query" ], "properties": { "type": { @@ -56123,7 +51009,7 @@ }, "query": { "type": "string", - "description": "The search query.", + "description": "[DEPRECATED] The search query.", "deprecated": true }, "queries": { @@ -56161,8 +51047,7 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri" + "type": "string" } } }, @@ -56182,44 +51067,20 @@ "default": "approximate" }, "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "timezone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "The approximate location of the user.", @@ -56237,17 +51098,17 @@ "web_search_preview" ], "description": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "web_search_preview" }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "allOf": [ @@ -56256,12 +51117,6 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." - }, - "search_content_types": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.SearchContentType" - } } }, "allOf": [ @@ -56283,27 +51138,26 @@ "enum": [ "web_search" ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`." + "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", + "default": "web_search" }, "filters": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "type": "string", @@ -56325,7 +51179,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -56351,17 +51205,11 @@ "type": "object", "properties": { "allowed_domains": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } } }, @@ -56453,7 +51301,7 @@ }, "spec": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The openapi function shape, described as a JSON Schema object." }, "auth": { @@ -56486,7 +51334,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -56611,7 +51459,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -56715,55 +51563,29 @@ ], "description": "The output of an OpenAPI tool call." }, - "OptimizationAgentDefinition": { + "OptimizationAgentIdentifier": { "type": "object", + "required": [ + "agent_name" + ], "properties": { "agent_name": { "type": "string", - "description": "Agent name." + "description": "Registered Foundry agent name (required)." }, "agent_version": { "type": "string", - "description": "Agent version." - }, - "model": { - "type": "string", - "description": "Model deployment name." - }, - "system_prompt": { - "type": "string", - "description": "System prompt / instructions." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Agent skills." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "unevaluatedProperties": {} - }, - "description": "Agent tools." + "description": "Pinned agent version. Defaults to latest if omitted." } }, - "description": "Agent definition returned in response payloads (includes resolved config)." + "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." }, "OptimizationCandidate": { "type": "object", "required": [ "name", - "config", - "mutations", "avg_score", - "avg_tokens", - "pass_rate", - "task_scores", - "is_pareto_optimal" + "avg_tokens" ], "properties": { "candidate_id": { @@ -56774,17 +51596,9 @@ "type": "string", "description": "Display name of the candidate (e.g., 'baseline', 'instruction-v2')." }, - "config": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationAgentDefinition" - } - ], - "description": "The agent configuration that produced this candidate." - }, "mutations": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." }, "avg_score": { @@ -56797,22 +51611,6 @@ "format": "double", "description": "Average token usage across all tasks." }, - "pass_rate": { - "type": "number", - "format": "double", - "description": "Fraction of tasks that met the pass threshold." - }, - "task_scores": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Individual task-level scores." - }, - "is_pareto_optimal": { - "type": "boolean", - "description": "Whether this candidate is on the Pareto frontier (score vs cost)." - }, "eval_id": { "type": "string", "description": "Foundry evaluation identifier used to score this candidate." @@ -56832,12 +51630,144 @@ }, "description": "Aggregated evaluation result for a single candidate agent configuration across all tasks." }, + "OptimizationDatasetCriterion": { + "type": "object", + "required": [ + "name", + "instruction" + ], + "properties": { + "name": { + "type": "string", + "description": "Criterion name." + }, + "instruction": { + "type": "string", + "description": "Criterion instruction / description." + } + }, + "description": "Evaluation criterion: a name + instruction pair used for per-item scoring." + }, + "OptimizationDatasetInput": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInputType" + } + ], + "description": "Dataset input type discriminator." + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "inline": "#/components/schemas/OptimizationInlineDatasetInput", + "reference": "#/components/schemas/OptimizationReferenceDatasetInput" + } + }, + "description": "Base discriminated model for dataset input. Either inline items or a registered reference." + }, + "OptimizationDatasetInputType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "inline", + "reference" + ] + } + ], + "description": "Discriminator values for the dataset input union." + }, + "OptimizationDatasetItem": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "The user query / prompt." + }, + "ground_truth": { + "type": "string", + "description": "Expected ground truth answer." + }, + "desired_num_turns": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "description": "Desired number of conversation turns for simulation mode (1-20)." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetCriterion" + }, + "description": "Per-item evaluation criteria." + } + }, + "description": "A single item in an inline dataset." + }, + "OptimizationEvaluatorRef": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Evaluator name." + }, + "version": { + "type": "string", + "description": "Evaluator version. If not specified, the latest version is used." + } + }, + "description": "Reference to a named evaluator, optionally pinned to a version." + }, + "OptimizationInlineDatasetInput": { + "type": "object", + "required": [ + "type", + "items" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "inline" + ], + "description": "Dataset input type discriminator." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetItem" + }, + "description": "Dataset items." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Inline dataset — items supplied directly in the request body." + }, "OptimizationJob": { "type": "object", "required": [ "id", "status", - "created_at" + "created_at", + "updated_at" ], "properties": { "id": { @@ -56845,40 +51775,40 @@ "description": "Server-assigned unique identifier.", "readOnly": true }, - "status": { + "inputs": { "allOf": [ { - "$ref": "#/components/schemas/JobStatus" + "$ref": "#/components/schemas/OptimizationJobInputs" } ], - "description": "Current lifecycle status.", - "readOnly": true + "description": "Caller-supplied inputs." }, - "error": { + "result": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.Error" + "$ref": "#/components/schemas/OptimizationJobResult" } ], - "description": "Error details — populated only on failure.", + "description": "Result produced on success.", "readOnly": true }, - "result": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobResult" + "$ref": "#/components/schemas/JobStatus" } ], - "description": "Result produced on success.", + "description": "Current lifecycle status.", "readOnly": true }, - "inputs": { + "error": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OpenAI.Error" } ], - "description": "Caller-supplied inputs." + "description": "Error details — populated only on failure.", + "readOnly": true }, "created_at": { "allOf": [ @@ -56895,7 +51825,7 @@ "$ref": "#/components/schemas/FoundryTimestamp" } ], - "description": "The timestamp when the job was last updated (status, progress, or result change), represented in Unix time.", + "description": "The timestamp when the job was last updated, represented in Unix time.", "readOnly": true }, "progress": { @@ -56904,16 +51834,15 @@ "$ref": "#/components/schemas/OptimizationJobProgress" } ], - "description": "Progress while in flight. Absent in terminal states.", + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", "readOnly": true }, - "dataset": { - "allOf": [ - { - "$ref": "#/components/schemas/DatasetInfo" - } - ], - "description": "Metadata about the dataset used for this optimization job.", + "warnings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Non-fatal warnings emitted at any point during optimization.", "readOnly": true } }, @@ -56923,29 +51852,30 @@ "type": "object", "required": [ "agent", - "train_dataset_reference" + "train_dataset", + "evaluators" ], "properties": { "agent": { "allOf": [ { - "$ref": "#/components/schemas/AgentIdentifier" + "$ref": "#/components/schemas/OptimizationAgentIdentifier" } ], "description": "The agent (and pinned version) being optimized." }, - "train_dataset_reference": { + "train_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], - "description": "Reference to a registered training dataset (required)." + "description": "Training dataset — either inline items or a reference to a registered dataset. Required." }, - "validation_dataset_reference": { + "validation_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], "description": "Optional held-out validation dataset for measuring generalization of the final candidate." @@ -56953,9 +51883,9 @@ "evaluators": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/OptimizationEvaluatorRef" }, - "description": "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + "description": "Job-level evaluators referenced by name and optional version. Required; at least one must be provided." }, "options": { "allOf": [ @@ -56968,18 +51898,89 @@ }, "description": "Caller-supplied inputs for an optimization job." }, + "OptimizationJobListItem": { + "type": "object", + "required": [ + "id", + "status", + "created_at", + "updated_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Server-assigned unique identifier.", + "readOnly": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/JobStatus" + } + ], + "description": "Current lifecycle status.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was created, represented in Unix time.", + "readOnly": true + }, + "updated_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was last updated, represented in Unix time.", + "readOnly": true + }, + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationAgentIdentifier" + } + ], + "description": "The agent targeted by this optimization job.", + "readOnly": true + }, + "progress": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationJobProgress" + } + ], + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", + "readOnly": true + }, + "error": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Error" + } + ], + "description": "Error details — populated only on failure.", + "readOnly": true + } + }, + "description": "Slim job representation returned by the LIST endpoint." + }, "OptimizationJobProgress": { "type": "object", "required": [ - "current_iteration", + "candidates_completed", "best_score", "elapsed_seconds" ], "properties": { - "current_iteration": { + "candidates_completed": { "type": "integer", "format": "int32", - "description": "1-based current iteration index." + "description": "Number of candidates whose evaluation has completed so far." }, "best_score": { "type": "number", @@ -56998,20 +51999,12 @@ "type": "object", "properties": { "baseline": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "Evaluation scores for the original (un-optimized) agent configuration." + "type": "string", + "description": "Candidate ID of the original (un-optimized) baseline evaluation." }, "best": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "The highest-scoring candidate found during optimization." + "type": "string", + "description": "Candidate ID of the highest-scoring candidate found during optimization." }, "candidates": { "type": "array", @@ -57019,25 +52012,6 @@ "$ref": "#/components/schemas/OptimizationCandidate" }, "description": "All evaluated candidates including baseline." - }, - "options": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationOptions" - } - ], - "description": "The options used for this optimization run." - }, - "warnings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped)." - }, - "all_target_attributes_failed": { - "type": "boolean", - "description": "True when all target attributes failed — only the baseline was evaluated." } }, "description": "Terminal-state result body. Populated when status is succeeded or failed." @@ -57045,15 +52019,15 @@ "OptimizationOptions": { "type": "object", "properties": { - "max_iterations": { + "max_candidates": { "type": "integer", "format": "int32", - "description": "Maximum optimization iterations per strategy. Must be >= 1. Default: 5.", + "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", "default": 5 }, "optimization_config": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization." }, "eval_model": { @@ -57075,73 +52049,35 @@ }, "description": "Tuning knobs and run-mode for an optimization job." }, - "OptimizationTaskResult": { + "OptimizationReferenceDatasetInput": { "type": "object", "required": [ - "task_name", - "scores", - "composite_score", - "tokens", - "duration_seconds", - "passed" + "type", + "name" ], "properties": { - "task_name": { - "type": "string", - "description": "Task name (from the dataset)." - }, - "query": { - "type": "string", - "description": "The user query / input for the task." - }, - "scores": { - "type": "object", - "unevaluatedProperties": { - "type": "number", - "format": "double" - }, - "description": "Per-evaluator scores keyed by evaluator name." - }, - "composite_score": { - "type": "number", - "format": "double", - "description": "Composite score combining all evaluator scores." - }, - "tokens": { - "type": "integer", - "format": "int64", - "description": "Total tokens consumed during the agent run for this task." - }, - "duration_seconds": { - "type": "number", - "format": "double", - "description": "Wall-clock seconds for this task's agent execution." - }, - "passed": { - "type": "boolean", - "description": "Whether the task met the pass threshold." - }, - "error_message": { + "type": { "type": "string", - "description": "Error message if the task failed during execution." - }, - "rationales": { - "type": "object", - "unevaluatedProperties": { - "type": "string" - }, - "description": "Per-evaluator reasoning keyed by evaluator name." + "enum": [ + "reference" + ], + "description": "Dataset input type discriminator." }, - "response": { + "name": { "type": "string", - "description": "Raw agent response text." + "description": "Registered dataset name." }, - "run_id": { + "version": { "type": "string", - "description": "Identifier of the agent run that produced this result." + "description": "Dataset version. If not specified, the latest version is used." } }, - "description": "Per-task evaluation result for a single candidate." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Reference to a registered Foundry dataset." }, "OtlpTelemetryEndpoint": { "type": "object", @@ -57161,9 +52097,7 @@ "endpoint": { "type": "string", "description": "The OTLP collector endpoint URL.", - "examples": [ - "https://my-collector.example.com/otlp" - ] + "example": "https://my-collector.example.com/otlp" }, "protocol": { "allOf": [ @@ -57172,9 +52106,7 @@ } ], "description": "The transport protocol for the OTLP endpoint.", - "examples": [ - "Http" - ] + "example": "Http" } }, "allOf": [ @@ -57621,61 +52553,6 @@ ] } }, - "PromoteCandidateRequest": { - "type": "object", - "required": [ - "agent_name", - "agent_version" - ], - "properties": { - "agent_name": { - "type": "string", - "description": "Name of the Foundry agent to promote to." - }, - "agent_version": { - "type": "string", - "description": "Version of the Foundry agent to promote to." - } - }, - "description": "Request body for promoting a candidate to a Foundry agent version." - }, - "PromoteCandidateResponse": { - "type": "object", - "required": [ - "candidate_id", - "status", - "promoted_at", - "agent_name", - "agent_version" - ], - "properties": { - "candidate_id": { - "type": "string", - "description": "The promoted candidate id." - }, - "status": { - "type": "string", - "description": "Status after promotion." - }, - "promoted_at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when promotion occurred, represented in Unix time." - }, - "agent_name": { - "type": "string", - "description": "Name of the Foundry agent promoted to." - }, - "agent_version": { - "type": "string", - "description": "Version of the Foundry agent promoted to." - } - }, - "description": "Response after successfully promoting a candidate." - }, "PromotionInfo": { "type": "object", "required": [ @@ -57721,55 +52598,36 @@ "description": "The model deployment to use for this agent." }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "description": "A system (or developer) message inserted into the model's context." }, "temperature": { - "anyOf": [ - { - "type": "number", - "format": "float" - }, - { - "type": "null" - } - ], + "type": "number", + "format": "float", + "nullable": true, "minimum": 0, "maximum": 2, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both. Defaults to `1`.", "default": 1 }, "top_p": { - "anyOf": [ - { - "type": "number", - "format": "float" - }, - { - "type": "null" - } - ], + "type": "number", + "format": "float", + "nullable": true, "minimum": 0, "maximum": 1, "description": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered. We generally recommend altering this or `temperature` but not both.\nDefaults to `1`.", "default": 1 }, "reasoning": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "tools": { "type": "array", @@ -57799,7 +52657,7 @@ }, "structured_inputs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/StructuredInputDefinition" }, "description": "Set of structured inputs that can participate in prompt template substitution or tool argument bindings." @@ -58109,14 +52967,14 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Red team's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." @@ -58344,7 +53202,7 @@ }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, required for retrieving chat history." @@ -58413,7 +53271,7 @@ }, "triggers": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine." @@ -58536,7 +53394,7 @@ }, "triggers": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine. In v1, exactly one trigger entry is supported." @@ -58984,21 +53842,21 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Schedule's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "systemData": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "System metadata for the resource.", @@ -59095,7 +53953,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Properties of the schedule run.", @@ -59120,7 +53978,7 @@ }, "configuration": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Configuration for the task." @@ -59247,16 +54105,12 @@ } ], "description": "The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types.", - "examples": [ - "log" - ] + "example": "log" }, "data": { "type": "string", "description": "The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change.", - "examples": [ - "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" - ] + "example": "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" } }, "description": "A single Server-Sent Event frame emitted by the hosted agent session log stream.\n\nEach frame contains an `event` field identifying the event type and a `data`\nfield carrying the payload as plain text. Although the current `data` payload\nis JSON-formatted, its schema is not contractual — additional keys may appear\nand the format may change over time. Clients should treat `data` as an\nopaque string and optionally attempt JSON parsing.\n\nNew event types may be added in the future. Clients should gracefully\nignore unrecognized event types.\n\nWire format:\n```\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.121Z\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:34:52.714Z\",\"stream\":\"status\",\"message\":\"Successfully connected to container\"}\n```", @@ -59404,7 +54258,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -59542,7 +54396,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata for additional properties." @@ -59656,7 +54510,7 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema for the structured input (optional)." }, "required": { @@ -59686,18 +54540,12 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema for the structured output." }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "type": "boolean", + "nullable": true, "description": "Whether to enforce strict validation. Default `true`." } }, @@ -60018,7 +54866,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the taxonomy category." @@ -60052,7 +54900,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the taxonomy sub-category." @@ -60125,12 +54973,10 @@ "$ref": "#/components/schemas/TelemetryDataKind" }, "description": "Data types to export to this endpoint. Use an empty array to export no data.", - "examples": [ - [ - "ContainerStdoutStderr", - "ContainerOtel", - "Metrics" - ] + "example": [ + "ContainerStdoutStderr", + "ContainerOtel", + "Metrics" ] }, "auth": { @@ -60270,12 +55116,12 @@ }, "initialization_parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The initialization parameters for the evaluation. Must support structured outputs." }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "The model to use for the evaluation. Must support structured outputs." @@ -60319,7 +55165,7 @@ "anyOf": [ { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, { "type": "string" @@ -60465,7 +55311,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -60543,17 +55389,11 @@ ], "properties": { "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -60995,7 +55835,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -61012,7 +55852,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -61025,7 +55865,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -61074,18 +55914,17 @@ "type": "string" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -61101,7 +55940,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -61406,7 +56245,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -61529,7 +56368,7 @@ }, "modelParams": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Optional parameters passed to the model for evaluation." } }, diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml index b1db07e45268..8e4f626b4313 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml @@ -1,126 +1,42 @@ -openapi: 3.2.0 +openapi: 3.0.0 info: title: Microsoft Foundry version: virtual-public-preview tags: - - name: EvaluationSuiteGenerationJobs - - name: Fine-Tuning - - name: Responses Root - description: Responses - - name: Responses - parent: Responses Root - description: Responses (OpenAI) - - name: Conversations - parent: Responses Root - description: Conversations (OpenAI) - - name: Agents Root - description: Agents - name: Agents - parent: Agents Root - description: Agent Management + - name: Agent Containers + - name: Agent Session Files - name: Agent Invocations - parent: Agents Root - name: Agent Invocations WebSocket - parent: Agents Root - description: Agent Invocations (WebSocket) - - name: Agent Sessions - parent: Agents Root - - name: Agent Session Files - parent: Agents Root - - name: Agent Versions - parent: Agents Root - - name: Agent Containers - parent: Agents Root - - name: Platform APIs + - name: Connections - name: Datasets - parent: Platform APIs + - name: Deployments + - name: Evaluation Taxonomies + - name: Evaluation Rules + - name: EvaluationSuiteGenerationJobs + - name: Evaluators + - name: EvaluatorGenerationJobs - name: Indexes - parent: Platform APIs - - name: Connections - parent: Platform APIs - - name: Scheduler - parent: Platform APIs - - name: Fine-tuning - parent: Platform APIs - summary: Fine-Tuning + - name: Insights - name: Models - parent: Platform APIs - name: Memory Stores - parent: Platform APIs - - name: Chat - parent: Platform APIs - - name: Assistants - parent: Platform APIs - - name: Audio - parent: Platform APIs - - name: Batch - parent: Platform APIs - - name: Completions - parent: Platform APIs - - name: Containers - parent: Platform APIs - - name: Embeddings - parent: Platform APIs - - name: Files - parent: Platform APIs - - name: Images - parent: Platform APIs - - name: Moderations - parent: Platform APIs - - name: Realtime - parent: Platform APIs - - name: Threads - parent: Platform APIs - - name: Uploads - parent: Platform APIs - - name: Vector stores - parent: Platform APIs - summary: Vector Stores - - name: Videos - parent: Platform APIs + - name: Conversations + - name: Evals + - name: Fine-Tuning + - name: Responses + - name: Redteams - name: Routines - parent: Platform APIs - name: Schedules - parent: Platform APIs - name: Skills - parent: Platform APIs - name: Toolboxes - parent: Platform APIs - - name: Deployments - parent: Platform APIs - name: DataGenerationJobs - parent: Platform APIs - summary: Data generation jobs - name: AgentOptimizationJobs - parent: Platform APIs - summary: Agent optimization jobs - - name: EvaluatorGenerationJobs - parent: Platform APIs - summary: Evaluator generation jobs - - name: Evaluations - - name: Evals - parent: Evaluations - - name: Evaluation Rules - parent: Evaluations - - name: Evaluators - parent: Evaluations - - name: Evaluation Taxonomies - parent: Evaluations - - name: Redteams - parent: Evaluations - summary: Red Teaming - - name: Evalsuite - parent: Evaluations - - name: Insights - parent: Evaluations paths: /agent_optimization_jobs: post: operationId: AgentOptimizationJobs_create - summary: Create an agent optimization job - description: |- - Creates an agent optimization job and returns the queued job. - Honors `Operation-Id` for idempotent retry. + summary: Creates an agent optimization job. + description: Create an optimization job. Returns 201 with the queued job. Honours `Operation-Id` for idempotent retry. parameters: - name: Foundry-Features in: header @@ -129,7 +45,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: Operation-Id in: header required: false @@ -180,15 +96,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OptimizationJobInputs' - description: The optimization job inputs. + $ref: '#/components/schemas/OptimizationJob' + description: The job to create. x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview get: operationId: AgentOptimizationJobs_list - summary: List agent optimization jobs - description: Returns agent optimization jobs with cursor pagination and optional lifecycle or agent filters. + summary: Returns a list of agent optimization jobs. + description: List optimization jobs. Supports cursor pagination and optional status / agent_name filters. parameters: - name: Foundry-Features in: header @@ -197,7 +113,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: limit in: query required: false @@ -273,7 +189,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/OptimizationJob' + $ref: '#/components/schemas/OptimizationJobListItem' description: The requested list of items. first_id: type: string @@ -301,14 +217,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}: get: operationId: AgentOptimizationJobs_get - summary: Get an agent optimization job - description: |- - Retrieves the specified agent optimization job. - Returns 202 while the job is in progress and 200 after it reaches a terminal state. + summary: Get info about an agent optimization job. + description: Get an optimization job by id. parameters: - name: Foundry-Features in: header @@ -317,7 +231,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -337,18 +251,7 @@ paths: headers: Retry-After: required: false - schema: - type: integer - format: int32 - content: - application/json: - schema: - $ref: '#/components/schemas/OptimizationJob' - '202': - description: The request has been accepted for processing, but processing has not yet completed. - headers: - Retry-After: - required: false + description: Recommended number of seconds to wait before polling again. schema: type: integer format: int32 @@ -372,13 +275,11 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview delete: operationId: AgentOptimizationJobs_delete - summary: Delete an agent optimization job - description: |- - Deletes the specified agent optimization job and its candidate artifacts. - Cancels the job first when it is still in a non-terminal state. + summary: Deletes an agent optimization job. + description: Delete the job and its candidate artifacts. Cancels first if non-terminal. parameters: - name: Foundry-Features in: header @@ -387,20 +288,13 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true description: The ID of the job to delete. schema: type: string - - name: force - in: query - required: false - description: When true, force-delete even if the job is in a non-terminal state. - schema: - type: boolean - explode: false - name: api-version in: query required: true @@ -427,425 +321,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates: - get: - operationId: AgentOptimizationJobs_listCandidates - summary: List optimization job candidates - description: Returns the candidates produced by the specified optimization job. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - type: object - required: - - data - - has_more - properties: - data: - type: array - items: - $ref: '#/components/schemas/OptimizationCandidate' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}: - get: - operationId: AgentOptimizationJobs_getCandidate - summary: Get an optimization candidate - description: Retrieves metadata, manifest information, and promotion details for the specified candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateMetadata' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/config: - get: - operationId: AgentOptimizationJobs_getCandidateConfig - summary: Get an optimization candidate config - description: |- - Retrieves the deploy configuration JSON for the specified candidate. - Clients can use it to compose `agents.create_version(...)` requests. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateDeployConfig' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/files: - get: - operationId: AgentOptimizationJobs_getCandidateFile - summary: Get an optimization candidate file - description: Streams the specified file from the candidate's blob directory. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: path - in: query - required: true - description: Relative path of the file to download (e.g. 'files/examples.jsonl'). - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/octet-stream: - schema: - contentMediaType: application/octet-stream - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/results: - get: - operationId: AgentOptimizationJobs_getCandidateResults - summary: Get optimization candidate results - description: Retrieves full per-task evaluation results for the specified candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateResults' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote: - post: - operationId: AgentOptimizationJobs_promoteCandidate - summary: Promote an optimization candidate - description: Promotes the specified candidate and records the deployment timestamp and target agent version. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id to promote. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateRequest' - description: Promotion details. - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}:cancel: post: operationId: AgentOptimizationJobs_cancel - summary: Cancel an agent optimization job - description: |- - Requests cancellation of the specified agent optimization job. - The operation remains idempotent after the job reaches a terminal state. + summary: Cancels an agent optimization job. + description: Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state. parameters: - name: Foundry-Features in: header @@ -854,7 +335,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -891,7 +372,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agents: post: operationId: Agents_createAgent_Agents_createAgentFromCode @@ -1440,7 +921,8 @@ paths: content: application/zip: schema: - contentMediaType: application/zip + type: string + format: binary 4XX: description: Client error content: @@ -1574,7 +1056,7 @@ paths: application/json: schema: type: object - unevaluatedProperties: {} + additionalProperties: {} 4XX: description: Client error content: @@ -1794,7 +1276,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents requestBody: required: true content: @@ -1915,7 +1397,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2180,7 +1662,8 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream + type: string + format: binary x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -2237,7 +1720,8 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream + type: string + format: binary 4XX: description: Client error content: @@ -2314,7 +1798,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2374,7 +1858,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2427,7 +1911,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2712,7 +2196,7 @@ paths: required_previews: - CodeAgents=V1Preview tags: - - Agent Versions + - Agents requestBody: required: true content: @@ -2822,7 +2306,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion @@ -2868,7 +2352,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents delete: operationId: Agents_deleteAgentVersion summary: Delete an agent version @@ -2924,7 +2408,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}/containers/default: get: operationId: AgentContainers_getAgentContainer @@ -3554,7 +3038,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -3602,7 +3086,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents requestBody: required: true content: @@ -7646,7 +7130,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -7823,7 +7307,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -8940,10 +8424,9 @@ paths: format: uri description: URL to poll for operation status. operationResult: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: URL to the operation result, or null if the operation is still in progress. 4XX: description: Client error @@ -9660,7 +9143,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -9888,7 +9372,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -10137,7 +9622,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -10643,22 +10129,26 @@ paths: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -10669,41 +10159,44 @@ paths: deprecated: true safety_identifier: type: string - maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -10715,12 +10208,11 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled id: type: string @@ -10748,20 +10240,19 @@ paths: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - - type: 'null' + nullable: true incomplete_details: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - - type: 'null' + nullable: true output: type: array items: @@ -10780,29 +10271,21 @@ paths: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true output_text: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' - moderation: - anyOf: - - $ref: '#/components/schemas/OpenAI.Moderation' - - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - - type: 'null' - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true agent: allOf: - $ref: '#/components/schemas/AgentId' @@ -10817,9 +10300,10 @@ paths: or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox affinity in follow-up calls. agent_reference: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/AgentReference' - - type: 'null' + nullable: true description: The agent used for this response content_filters: type: array @@ -10861,22 +10345,26 @@ paths: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -10887,41 +10375,44 @@ paths: deprecated: true safety_identifier: type: string - maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -10933,62 +10424,48 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled input: $ref: '#/components/schemas/OpenAI.InputParam' include: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.IncludeEnum' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.IncludeEnum' + nullable: true parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true default: true store: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true default: true instructions: - anyOf: - - type: string - - type: 'null' - moderation: - anyOf: - - $ref: '#/components/schemas/OpenAI.ModerationParam' - - type: 'null' + type: string + nullable: true stream: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true stream_options: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - - type: 'null' + nullable: true conversation: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ConversationParam' - - type: 'null' + nullable: true context_management: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ContextManagementParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ContextManagementParam' + nullable: true description: Context management configuration for this request. - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' agent: allOf: - $ref: '#/components/schemas/AgentReference' @@ -11007,7 +10484,7 @@ paths: description: The agent to use for generating the response. structured_inputs: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. get: operationId: listResponses @@ -12639,7 +12116,8 @@ paths: content: application/zip: schema: - contentMediaType: application/zip + type: string + format: binary 4XX: description: Client error content: @@ -12993,7 +12471,8 @@ paths: content: application/zip: schema: - contentMediaType: application/zip + type: string + format: binary 4XX: description: Client error content: @@ -13325,7 +12804,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -13742,7 +13221,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -14029,14 +13508,12 @@ components: type: integer format: int32 description: The maximum number of replicas for the container. Default is 1. - examples: - - 10 + example: 10 min_replicas: type: integer format: int32 description: The minimum number of replicas for the container. Default is 1. - examples: - - 1 + example: 1 error_message: type: string description: The error message if the container failed to operate, if any. @@ -14320,7 +13797,7 @@ components: description: Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future. evaluators: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. samplingConfiguration: @@ -14374,7 +13851,7 @@ components: description: A string explaining why there was an error, if applicable. additionalDetails: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties relevant to the evaluator. These will differ between evaluators. description: Result for the agent evaluation evaluator run. @@ -14499,18 +13976,6 @@ components: version: type: string description: The version identifier of the agent. - AgentIdentifier: - type: object - required: - - agent_name - properties: - agent_name: - type: string - description: Registered Foundry agent name (required). - agent_version: - type: string - description: Pinned agent version. Defaults to latest if omitted. - description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config. AgentIdentity: type: object required: @@ -14742,11 +14207,10 @@ components: - definition properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -15260,7 +14724,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15639,7 +15103,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -15684,7 +15148,7 @@ components: description: The Azure Function Tool definition. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15832,7 +15296,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15964,7 +15428,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -16093,7 +15557,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -16175,116 +15639,6 @@ components: - $ref: '#/components/schemas/BrowserAutomationToolConnectionParameters' description: The project connection parameters associated with the Browser Automation Tool. description: Definition of input parameters for the Browser Automation Tool. - CandidateDeployConfig: - type: object - properties: - instructions: - type: string - description: System prompt / instructions. - model: - type: string - description: Foundry deployment name. - temperature: - type: number - format: float - minimum: 0 - maximum: 2 - description: Optional sampling temperature. - skills: - type: array - items: - type: object - unevaluatedProperties: {} - description: Optional skill overrides. - tools: - type: array - items: - type: object - unevaluatedProperties: {} - description: Optional tool overrides. - description: Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version. - CandidateFileInfo: - type: object - required: - - path - - type - - size_bytes - properties: - path: - type: string - description: Relative path of the file. - type: - type: string - description: File type category (e.g. 'config', 'results'). - size_bytes: - type: integer - format: int64 - description: File size in bytes. - description: File entry in a candidate's blob directory. - CandidateMetadata: - type: object - required: - - candidate_id - - job_id - - candidate_name - - status - - has_results - - created_at - - updated_at - - files - properties: - candidate_id: - type: string - description: Server-assigned candidate identifier. - job_id: - type: string - description: Owning optimization job id. - candidate_name: - type: string - description: Display name of the candidate. - status: - type: string - description: Candidate lifecycle status. - score: - type: number - format: double - description: Candidate's aggregate score. - has_results: - type: boolean - description: Whether detailed results are available for this candidate. - created_at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was created, represented in Unix time. - updated_at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was last updated, represented in Unix time. - promotion: - allOf: - - $ref: '#/components/schemas/PromotionInfo' - description: Promotion metadata. Null if not promoted. - files: - type: array - items: - $ref: '#/components/schemas/CandidateFileInfo' - description: Files in the candidate's blob directory. - description: Candidate metadata returned by GET /candidates/{id}. - CandidateResults: - type: object - required: - - candidate_id - - results - properties: - candidate_id: - type: string - description: Owning candidate id. - results: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Per-task evaluation rows. - description: Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results. CaptureStructuredOutputsTool: type: object required: @@ -16304,7 +15658,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -16370,7 +15724,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -16544,7 +15898,7 @@ components: readOnly: true metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata of the connection readOnly: true @@ -16582,21 +15936,18 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication of the containers. - examples: - - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + example: + - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 container_app_resource_id: type: string description: The resource ID of the Azure Container App that hosts this agent. Not mutable across versions. ingress_subdomain_suffix: type: string description: The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app. - examples: - - --0000001 - - ---current - - '' + example: --0000001 allOf: - $ref: '#/components/schemas/AgentDefinition' description: The container app agent definition. @@ -16611,8 +15962,7 @@ components: image: type: string description: The container image for the hosted agent. - examples: - - my-registry.azurecr.io/my-hosted-agent:latest + example: my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -16723,7 +16073,8 @@ components: format: double maximum: 100 description: Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100. - exclusiveMinimum: 0 + minimum: 0 + exclusiveMinimum: true default: 100 allOf: - $ref: '#/components/schemas/EvaluationRuleAction' @@ -16754,7 +16105,7 @@ components: default: 5 data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -16817,6 +16168,8 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: + type: string + format: binary description: The code zip file (max 250 MB). required: - metadata @@ -16838,7 +16191,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16857,7 +16210,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -16875,7 +16228,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16950,6 +16303,8 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: + type: string + format: binary description: The code zip file (max 250 MB). required: - metadata @@ -16965,7 +16320,7 @@ components: description: A human-readable description of the agent. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16995,7 +16350,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -17014,7 +16369,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -17023,7 +16378,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -17070,9 +16425,10 @@ components: type: string description: The name of the evaluation. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -17094,7 +16450,7 @@ components: description: A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`). properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -17109,9 +16465,10 @@ components: type: string description: The name of the run. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -17121,7 +16478,7 @@ components: description: Details about the run's data source. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -17154,7 +16511,9 @@ components: properties: files: type: array - items: {} + items: + type: string + format: binary description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -17220,7 +16579,7 @@ components: - CustomKeys description: The credential type readOnly: true - unevaluatedProperties: + additionalProperties: type: string allOf: - $ref: '#/components/schemas/BaseCredentials' @@ -17247,7 +16606,7 @@ components: description: The provider-specific event name that fires the routine. parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Provider-specific trigger parameters. allOf: - $ref: '#/components/schemas/RoutineTrigger' @@ -17402,7 +16761,7 @@ components: description: Description to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. description: Output options for data generation job. @@ -17524,12 +16883,11 @@ components: description: The data source type discriminator. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: - azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' + mapping: {} description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -17559,7 +16917,7 @@ components: readOnly: true tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -17612,38 +16970,6 @@ components: allOf: - $ref: '#/components/schemas/EvaluatorGenerationJobSource' description: Dataset source for evaluator generation jobs — reference to a dataset. - DatasetInfo: - type: object - required: - - task_count - - is_inline - properties: - name: - type: string - description: Dataset name when using a registered dataset reference. Null for inline datasets. - version: - type: string - description: Dataset version when using a registered dataset reference. Null for inline datasets. - task_count: - type: integer - format: int32 - description: Number of tasks/rows in the dataset. - is_inline: - type: boolean - description: True when the dataset was provided inline in the request body. - description: Metadata about the dataset used for optimization, surfaced in the response. - DatasetRef: - type: object - required: - - name - properties: - name: - type: string - description: Dataset name. - version: - type: string - description: Dataset version. If not specified, the latest version is used. - description: Reference to a registered dataset in the Foundry Dataset Service. DatasetReference: type: object required: @@ -17721,7 +17047,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -18110,9 +17436,10 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -18122,7 +17449,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -18293,9 +17620,10 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -18307,7 +17635,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -18566,7 +17894,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Details of the input data source item. results: type: array @@ -18656,10 +17984,9 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -18680,10 +18007,10 @@ components: description: The reason for the test criteria metric. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional details about the test criteria metric. - unevaluatedProperties: {} + additionalProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -18835,17 +18162,17 @@ components: readOnly: true tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Evaluation's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. evaluators: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. target: @@ -18996,7 +18323,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -19102,7 +18429,7 @@ components: description: Identifier of the evaluation group. evalRun: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -19208,7 +18535,7 @@ components: default: quality initialization_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- Optional initialization parameters applied to all generated evaluators. For example, deployment_name for LLM judge model, default threshold. @@ -19483,7 +18810,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -19552,7 +18879,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -19610,7 +18937,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19624,7 +18951,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -19638,7 +18965,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19686,7 +19013,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -19700,7 +19027,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19723,11 +19050,11 @@ components: description: Identifier of the evaluator. initParams: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Initialization parameters of the evaluator. dataMapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Data parameters of the evaluator. description: Evaluator Configuration @@ -19755,15 +19082,15 @@ components: description: The type of evaluator definition init_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -20000,7 +19327,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -20065,7 +19392,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -20093,7 +19420,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -20105,7 +19432,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator categories: @@ -20125,7 +19452,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -20240,9 +19567,12 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string - - type: 'null' + nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -20253,7 +19583,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -20532,18 +19862,15 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - examples: - - X-Otlp-Api-Key + example: X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - examples: - - my-secret-store + example: my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - examples: - - OTLP_KEY + example: OTLP_KEY allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' description: Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. @@ -20571,21 +19898,19 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - examples: - - '0.25' + example: '0.25' memory: type: string description: The memory configuration for the hosted agent. - examples: - - 0.5Gi + example: 0.5Gi environment_variables: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set in the hosted agent container. - examples: - - name: LOG_LEVEL - value: debug + example: + name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -20598,11 +19923,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - examples: - - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + example: + - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -20721,7 +20046,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -20894,11 +20219,11 @@ components: description: Sample type features: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -21114,7 +20439,6 @@ components: red_team_taxonomy: '#/components/schemas/RedTeamTaxonomyItemGenerationParams' response_retrieval: '#/components/schemas/ResponseRetrievalItemGenerationParams' conversation_gen_preview: '#/components/schemas/ConversationGenPreviewItemGenerationParams' - synthetic_data_gen_preview: '#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams' description: Represents the set of parameters used to control item generation operations. ItemGenerationParamsType: anyOf: @@ -21380,7 +20704,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -21427,7 +20751,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -21469,11 +20793,10 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - anyOf: - - type: array - items: - $ref: '#/components/schemas/MemoryItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/MemoryItem' + nullable: true description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -21625,7 +20948,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -21800,7 +21123,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -21852,7 +21175,7 @@ components: readOnly: true capabilities: type: object - unevaluatedProperties: + additionalProperties: type: string description: Capabilities of deployed model readOnly: true @@ -22001,7 +21324,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -22143,6 +21466,7 @@ components: - create_file description: Create a new file with the provided diff. x-stainless-const: true + default: create_file path: type: string description: Path of the file to create. @@ -22166,6 +21490,7 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true + default: create_file path: type: string minLength: 1 @@ -22190,6 +21515,7 @@ components: - delete_file description: Delete the specified file. x-stainless-const: true + default: delete_file path: type: string description: Path of the file to delete. @@ -22209,6 +21535,7 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true + default: delete_file path: type: string minLength: 1 @@ -22274,6 +21601,7 @@ components: - apply_patch description: The type of the tool. Always `apply_patch`. x-stainless-const: true + default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Allows the assistant to create, delete, or update files using unified diffs. @@ -22291,6 +21619,7 @@ components: - update_file description: Update an existing file with the provided diff. x-stainless-const: true + default: update_file path: type: string description: Path of the file to update. @@ -22314,6 +21643,7 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true + default: update_file path: type: string minLength: 1 @@ -22339,21 +21669,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -22373,9 +21699,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true network_policy: $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' description: Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. @@ -22399,12 +21725,6 @@ components: OpenAI.ChatModel: type: string enum: - - gpt-5.4 - - gpt-5.4-mini - - gpt-5.4-nano - - gpt-5.4-mini-2026-03-17 - - gpt-5.4-nano-2026-03-17 - - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest @@ -22499,6 +21819,7 @@ components: - click description: Specifies the event type. For a click action, this property is always `click`. x-stainless-const: true + default: click button: allOf: - $ref: '#/components/schemas/OpenAI.ClickButtonType' @@ -22511,12 +21832,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the click occurred. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A click action. @@ -22577,7 +21892,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -22642,27 +21957,13 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions: - anyOf: - - type: string - - type: 'null' - prompt_cache_key: - anyOf: - - type: string - - type: 'null' - prompt_cache_retention: - anyOf: - - $ref: '#/components/schemas/OpenAI.PromptCacheRetentionEnum' - - type: 'null' - service_tier: - anyOf: - - $ref: '#/components/schemas/OpenAI.ServiceTierEnum' - - type: 'null' + type: string + nullable: true OpenAI.ComparisonFilter: type: object required: @@ -22679,8 +21980,6 @@ components: - gte - lt - lte - - in - - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -22752,14 +22051,6 @@ components: scroll: '#/components/schemas/OpenAI.ScrollParam' type: '#/components/schemas/OpenAI.TypeParam' wait: '#/components/schemas/OpenAI.WaitParam' - OpenAI.ComputerActionList: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerAction' - description: |- - Flattened batched actions for `computer_use`. Each action includes an - `type` discriminator and action-specific fields. - title: Computer Action List OpenAI.ComputerActionType: anyOf: - type: string @@ -22783,13 +22074,11 @@ components: type: string description: The ID of the pending safety check. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -22805,7 +22094,6 @@ components: - type - image_url - file_id - - detail properties: type: type: string @@ -22813,19 +22101,14 @@ components: - computer_screenshot description: Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`. x-stainless-const: true + default: computer_screenshot image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -22852,21 +22135,6 @@ components: type: string description: The identifier of an uploaded file that contains the screenshot. description: A computer screenshot image used with the computer use tool. - OpenAI.ComputerTool: - type: object - required: - - type - properties: - type: - type: string - enum: - - computer - description: The type of the computer tool. Always `computer`. - x-stainless-const: true - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - title: Computer OpenAI.ComputerUsePreviewTool: type: object required: @@ -22881,6 +22149,7 @@ components: - computer_use_preview description: The type of the computer use tool. Always `computer_use_preview`. x-stainless-const: true + default: computer_use_preview environment: allOf: - $ref: '#/components/schemas/OpenAI.ComputerEnvironment' @@ -22908,6 +22177,7 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true + default: container_auto file_ids: type: array items: @@ -22915,9 +22185,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true skills: type: array items: @@ -22944,6 +22214,7 @@ components: - container_file_citation description: The type of the container file citation. Always `container_file_citation`. x-stainless-const: true + default: container_file_citation container_id: type: string description: The ID of the container file. @@ -22984,12 +22255,19 @@ components: - allowlist description: Allow outbound network access only to specified domains. Always `allowlist`. x-stainless-const: true + default: allowlist allowed_domains: type: array items: type: string minItems: 1 description: A list of allowed domains when type is `allowlist`. + domain_secrets: + type: array + items: + $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam' + minItems: 1 + description: Optional domain-scoped secrets for allowlisted domains. allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' OpenAI.ContainerNetworkPolicyDisabledParam: @@ -23003,8 +22281,29 @@ components: - disabled description: Disable outbound network access. Always `disabled`. x-stainless-const: true + default: disabled allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' + OpenAI.ContainerNetworkPolicyDomainSecretParam: + type: object + required: + - domain + - name + - value + properties: + domain: + type: string + minLength: 1 + description: The domain associated with the secret. + name: + type: string + minLength: 1 + description: The name of the secret to inject for the domain. + value: + type: string + minLength: 1 + maxLength: 10485760 + description: The secret value to inject for the domain. OpenAI.ContainerNetworkPolicyParam: type: object required: @@ -23037,6 +22336,7 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true + default: container_reference container_id: type: string allOf: @@ -23071,9 +22371,10 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true OpenAI.ConversationItem: type: object required: @@ -23085,18 +22386,14 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' file_search_call: '#/components/schemas/OpenAI.ConversationItemFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ConversationItemWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ConversationItemImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ConversationItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput' - tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' reasoning: '#/components/schemas/OpenAI.ConversationItemReasoningItem' - compaction: '#/components/schemas/OpenAI.ConversationItemCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCall' local_shell_call_output: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput' @@ -23108,39 +22405,10 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ConversationItemMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output). title: Conversation item - OpenAI.ConversationItemAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemApplyPatchToolCall: type: object required: @@ -23205,9 +22473,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -23248,54 +22515,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A tool call to run code. title: Code interpreter tool call - OpenAI.ConversationItemCompactionBody: - type: object - required: - - type - - id - - encrypted_content - properties: - type: - type: string - enum: - - compaction - description: The type of the item. Always `compaction`. - x-stainless-const: true - default: compaction - id: - type: string - description: The unique ID of the compaction item. - encrypted_content: - type: string - description: The encrypted content that was produced by compaction. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - title: Compaction item OpenAI.ConversationItemComputerToolCall: type: object required: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -23313,8 +22552,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -23335,11 +22572,10 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ConversationItemComputerToolCallOutput: + OpenAI.ConversationItemComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -23353,7 +22589,6 @@ components: id: type: string description: The ID of the computer tool call output. - readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -23377,91 +22612,68 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.ConversationItemCustomToolCallOutputResource: + OpenAI.ConversationItemCustomToolCall: type: object required: - type - call_id - - output - - status + - name + - input properties: type: type: string enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call output in the OpenAI platform. + description: The unique ID of the custom tool call in the OpenAI platform. call_id: type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: + description: An identifier used to map this custom tool call to a tool call output. + name: type: string - description: The identifier of the actor that created the item. + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallOutputItem - OpenAI.ConversationItemCustomToolCallResource: + description: A call to a custom tool created by the model. + title: Custom tool call + OpenAI.ConversationItemCustomToolCallOutput: type: object required: - type - call_id - - name - - input - - status + - output properties: type: type: string enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call in the OpenAI platform. + description: The unique ID of the custom tool call output in the OpenAI platform. call_id: type: string - description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. - name: - type: string - description: The name of the custom tool being called. - input: - type: string - description: The input for the custom tool call generated by the model. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. + The output from the custom tool call generated by your code. + Can be a string or an list of output content. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallItem + description: The output of a custom tool call from your code, being sent back to the model. + title: Custom tool call output OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -23496,11 +22708,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -23536,12 +22747,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -23574,7 +22786,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -23582,9 +22794,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -23592,37 +22805,36 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCall: + OpenAI.ConversationItemFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -23634,42 +22846,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: |- - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. - title: Function tool call - OpenAI.ConversationItemFunctionToolCallOutput: + OpenAI.ConversationItemFunctionToolCallResource: type: object required: - - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true + description: The unique ID of the function tool call. type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -23681,8 +22883,6 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a function tool call. - title: Function tool call output OpenAI.ConversationItemImageGenToolCall: type: object required: @@ -23709,9 +22909,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -23806,13 +23005,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -23872,9 +23070,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -23905,7 +23102,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -23938,20 +23136,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -23988,10 +23184,6 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A message to or from the model. @@ -24013,9 +23205,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -24043,87 +23234,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.ConversationItemToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemType: anyOf: - type: string @@ -24137,11 +23247,7 @@ components: - image_generation_call - computer_call - computer_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - - compaction - code_interpreter_call - local_shell_call - local_shell_call_output @@ -24277,7 +23383,6 @@ components: mapping: text: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText' json_object: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject' - json_schema: '#/components/schemas/OpenAI.ResponseFormatJsonSchema' description: |- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables @@ -24333,15 +23438,15 @@ components: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true items: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + nullable: true OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -24462,7 +23567,7 @@ components: default: custom item_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -24534,7 +23639,7 @@ components: default: logs metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -24679,7 +23784,7 @@ components: default: stored_completions metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -24729,18 +23834,16 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true minLength: 1 maxLength: 64 description: |- A string of up to 64 characters that will be added to your fine-tuned model name. For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. validation_file: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -24750,16 +23853,16 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/model-optimization) for more details. integrations: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + nullable: true description: A list of integrations to enable for your fine-tuning job. seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true minimum: 0 maximum: 2147483647 description: |- @@ -24768,9 +23871,10 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -24816,13 +23920,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -24895,6 +23997,7 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true + default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -24917,6 +24020,7 @@ components: - text description: Unconstrained text format. Always `text`. x-stainless-const: true + default: text allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: Unconstrained free-form text. @@ -24933,6 +24037,7 @@ components: - custom description: The type of the custom tool. Always `custom`. x-stainless-const: true + default: custom name: type: string description: The name of the custom tool, used to identify it in tool calls. @@ -24943,9 +24048,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: The input format for the custom tool. Default is unconstrained text. - defer_loading: - type: boolean - description: Whether this tool should be deferred and discovered via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) @@ -24993,14 +24095,12 @@ components: - low - high - auto - - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' - - keys properties: type: type: string @@ -25008,6 +24108,7 @@ components: - double_click description: Specifies the event type. For a double click action, this property is always set to `double_click`. x-stainless-const: true + default: double_click x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -25016,12 +24117,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the double click occurred. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A double click action. @@ -25038,6 +24133,7 @@ components: - drag description: Specifies the event type. For a drag action, this property is always set to `drag`. x-stainless-const: true + default: drag path: type: array items: @@ -25050,12 +24146,6 @@ components: { x: 200, y: 300 } ] ``` - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -25084,10 +24174,6 @@ components: description: |- Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' type: type: string enum: @@ -25112,8 +24198,6 @@ components: `assistant` role are presumed to have been generated by the model in previous interactions. title: Input message - OpenAI.EmptyModelParam: - type: object OpenAI.Error: type: object required: @@ -25121,15 +24205,13 @@ components: - message properties: code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string details: @@ -25138,10 +24220,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} debugInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalApiError: type: object required: @@ -25271,22 +24353,26 @@ components: type: object properties: seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true max_completions_tokens: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -25539,10 +24625,10 @@ components: properties: item: type: object - unevaluatedProperties: {} + additionalProperties: {} sample: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -25571,50 +24657,49 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions_search: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true users: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true tools: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -25760,25 +24845,28 @@ components: x-stainless-const: true default: stored_completions metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true limit: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -25807,6 +24895,7 @@ components: - file_citation description: The type of the file citation. Always `file_citation`. x-stainless-const: true + default: file_citation file_id: type: string description: The ID of the file. @@ -25821,11 +24910,6 @@ components: - $ref: '#/components/schemas/OpenAI.Annotation' description: A citation to a file. title: File citation - OpenAI.FileInputDetail: - type: string - enum: - - low - - high OpenAI.FilePath: type: object required: @@ -25862,6 +24946,7 @@ components: - file_search description: The type of the file search tool. Always `file_search`. x-stainless-const: true + default: file_search vector_store_ids: type: array items: @@ -25876,9 +24961,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.Filters' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -25887,7 +24972,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -25907,9 +24992,10 @@ components: filename: type: string attributes: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - - type: 'null' + nullable: true score: type: number format: float @@ -26117,13 +25203,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -26155,20 +25239,17 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - - type: 'null' + nullable: true fine_tuned_model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true finished_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -26201,39 +25282,36 @@ components: - cancelled description: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. trained_tokens: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true training_file: type: string description: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents). validation_file: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true integrations: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + nullable: true seed: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The seed used for the fine-tuning job. estimated_finish: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. title: FineTuningJob x-oaiMeta: @@ -26365,9 +25443,8 @@ components: message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.FineTuningJobEvent: type: object required: @@ -26433,8 +25510,11 @@ components: - type: string enum: - auto - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true + - type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true default: auto learning_rate_multiplier: oneOf: @@ -26476,23 +25556,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -26511,18 +25586,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -26561,18 +25634,6 @@ components: - in_progress - completed - incomplete - OpenAI.FunctionCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete - OpenAI.FunctionCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionObject: type: object required: @@ -26587,12 +25648,11 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.FunctionParameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. @@ -26608,13 +25668,15 @@ components: items: type: string timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -26628,13 +25690,15 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -26778,6 +25842,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -26798,6 +25863,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -26848,12 +25914,6 @@ components: enum: - timeout - exit - OpenAI.FunctionShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -26865,6 +25925,7 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true + default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcome' description: Indicates that the shell call exceeded its configured time limit. @@ -26880,16 +25941,11 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true + default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcomeParam' description: Indicates that the shell call exceeded its configured time limit. title: Shell call timeout outcome - OpenAI.FunctionShellCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionShellToolParam: type: object required: @@ -26901,10 +25957,12 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true + default: shell environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -26913,7 +25971,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -26996,61 +26054,67 @@ components: - function description: The type of the function tool. Always `function`. x-stainless-const: true + default: function name: type: string description: The name of the function to call. description: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true parameters: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true strict: - anyOf: - - type: boolean - - type: 'null' - defer_loading: type: boolean - description: Whether this function is deferred and loaded via tool search. + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). title: Function - OpenAI.FunctionToolParam: + OpenAI.FunctionToolCallOutput: type: object required: - - name - type + - call_id + - output properties: - name: + id: type: string - minLength: 1 - maxLength: 128 - pattern: ^[a-zA-Z0-9_-]+$ - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true - default: function - defer_loading: - type: boolean - description: Whether this function should be deferred and discovered via tool search. + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a function tool call. + title: Function tool call output OpenAI.GraderLabelModel: type: object required: @@ -27427,7 +26491,6 @@ components: - low - high - auto - - original OpenAI.ImageGenActionEnum: type: string enum: @@ -27445,6 +26508,7 @@ components: - image_generation description: The type of the image generation tool. Always `image_generation`. x-stainless-const: true + default: image_generation model: anyOf: - type: string @@ -27466,15 +26530,15 @@ components: or `auto`. Default: `auto`. default: auto size: - anyOf: - - type: string - - type: string - enum: - - 1024x1024 - - 1024x1536 - - 1536x1024 - - auto - description: The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. + type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: |- + The size of the generated image. One of `1024x1024`, `1024x1536`, + `1536x1024`, or `auto`. Default: `auto`. default: auto output_format: type: string @@ -27511,9 +26575,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - - type: 'null' + nullable: true input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -27538,7 +26602,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -27572,7 +26636,6 @@ components: - memory_search_call.results description: |- Specify additional output data to include in the model response. Currently supported values are: - - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. @@ -27594,6 +26657,7 @@ components: - inline description: Defines an inline skill for this request. x-stainless-const: true + default: inline name: type: string description: The name of the skill. @@ -27690,23 +26754,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -27725,18 +26784,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -27788,23 +26845,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -27820,26 +26872,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_data: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_url: - anyOf: - - type: string - format: uri - - type: 'null' - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + type: string + format: uri + nullable: true description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -27856,18 +26900,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -27883,18 +26925,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - - type: 'null' + nullable: true description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -27916,9 +26956,6 @@ components: web_search_call: '#/components/schemas/OpenAI.InputItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.InputItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam' - tool_search_call: '#/components/schemas/OpenAI.InputItemToolSearchCallItemParam' - tool_search_output: '#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam' - additional_tools: '#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.InputItemReasoningItem' compaction: '#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.InputItemImageGenToolCall' @@ -27939,38 +26976,6 @@ components: An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs. - OpenAI.InputItemAdditionalToolsItemParam: - type: object - required: - - type - - role - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - additional_tools - description: The item type. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - role: - type: string - enum: - - developer - description: The role that provided the additional tools. Only `developer` is supported. - x-stainless-const: true - default: developer - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: A list of additional tools made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemApplyPatchToolCallItemParam: type: object required: @@ -27987,9 +26992,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28022,9 +27026,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28035,9 +27038,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -28075,17 +27077,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -28097,9 +27097,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -28123,9 +27122,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28141,15 +27139,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -28160,6 +27157,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -28177,8 +27175,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -28219,9 +27215,6 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -28298,11 +27291,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -28317,9 +27309,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28343,9 +27334,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -28358,9 +27349,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28378,13 +27368,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -28397,9 +27388,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28418,13 +27408,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -28432,7 +27423,6 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -28441,7 +27431,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -28451,9 +27440,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -28501,9 +27487,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -28562,13 +27547,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -28618,9 +27602,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -28628,9 +27611,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -28661,7 +27643,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -28694,20 +27677,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -28741,10 +27722,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -28775,9 +27752,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -28805,77 +27781,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.InputItemToolSearchCallItemParam: - type: object - required: - - type - - arguments - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_call - description: The item type. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - allOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - description: The arguments supplied to the tool search call. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.InputItem' - OpenAI.InputItemToolSearchOutputItemParam: - type: object - required: - - type - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_output - description: The item type. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by the tool search output. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemType: anyOf: - type: string @@ -28889,9 +27794,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -28948,6 +27850,44 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call + OpenAI.InputMessage: + type: object + required: + - type + - role + - content + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.InputMessageContentList: type: array items: @@ -28956,6 +27896,43 @@ components: A list of one or many input items to the model, containing different content types. title: Input item content list + OpenAI.InputMessageResource: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.InputParam: oneOf: - type: string @@ -29017,7 +27994,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemInputMessage' + message: '#/components/schemas/OpenAI.InputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -29025,9 +28002,6 @@ components: web_search_call: '#/components/schemas/OpenAI.ItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.ItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam' - tool_search_call: '#/components/schemas/OpenAI.ItemToolSearchCallItemParam' - tool_search_output: '#/components/schemas/OpenAI.ItemToolSearchOutputItemParam' - additional_tools: '#/components/schemas/OpenAI.ItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.ItemReasoningItem' compaction: '#/components/schemas/OpenAI.ItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.ItemImageGenToolCall' @@ -29045,38 +28019,6 @@ components: custom_tool_call_output: '#/components/schemas/OpenAI.ItemCustomToolCallOutput' custom_tool_call: '#/components/schemas/OpenAI.ItemCustomToolCall' description: Content item used to generate a response. - OpenAI.ItemAdditionalToolsItemParam: - type: object - required: - - type - - role - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - additional_tools - description: The item type. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - role: - type: string - enum: - - developer - description: The role that provided the additional tools. Only `developer` is supported. - x-stainless-const: true - default: developer - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: A list of additional tools made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemApplyPatchToolCallItemParam: type: object required: @@ -29093,9 +28035,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -29128,9 +28069,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -29141,9 +28081,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -29181,17 +28120,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -29203,9 +28140,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -29229,9 +28165,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -29247,15 +28182,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -29266,6 +28200,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -29283,8 +28218,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -29325,9 +28258,6 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -29380,17 +28310,14 @@ components: discriminator: propertyName: type mapping: + function_call_output: '#/components/schemas/OpenAI.FunctionToolCallOutput' message: '#/components/schemas/OpenAI.ItemFieldMessage' function_call: '#/components/schemas/OpenAI.ItemFieldFunctionToolCall' - tool_search_call: '#/components/schemas/OpenAI.ItemFieldToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ItemFieldToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ItemFieldAdditionalTools' - function_call_output: '#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ItemFieldFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ItemFieldWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ItemFieldImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ItemFieldComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -29407,35 +28334,6 @@ components: custom_tool_call: '#/components/schemas/OpenAI.ItemFieldCustomToolCall' custom_tool_call_output: '#/components/schemas/OpenAI.ItemFieldCustomToolCallOutput' description: An item representing a message, tool call, tool output, reasoning, or other response element. - OpenAI.ItemFieldAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldApplyPatchToolCall: type: object required: @@ -29500,9 +28398,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -29543,17 +28440,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -29591,6 +28486,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -29608,8 +28504,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -29630,11 +28524,10 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemFieldComputerToolCallOutput: + OpenAI.ItemFieldComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -29648,7 +28541,6 @@ components: id: type: string description: The ID of the computer tool call output. - readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -29672,8 +28564,6 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a computer tool call. - title: Computer tool call output OpenAI.ItemFieldCustomToolCall: type: object required: @@ -29694,9 +28584,6 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -29773,11 +28660,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -29813,12 +28699,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -29851,7 +28738,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -29859,9 +28746,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -29872,7 +28760,6 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: - - id - type - call_id - name @@ -29881,7 +28768,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -29891,9 +28777,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -29915,51 +28798,6 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call - OpenAI.ItemFieldFunctionToolCallOutput: - type: object - required: - - id - - type - - call_id - - output - properties: - id: - type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true - type: - type: string - enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. - x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a function tool call. - title: Function tool call output OpenAI.ItemFieldImageGenToolCall: type: object required: @@ -29986,9 +28824,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -30047,13 +28884,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -30113,9 +28949,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -30146,7 +28981,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -30179,20 +29015,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -30229,10 +29063,6 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A message to or from the model. @@ -30254,9 +29084,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -30284,87 +29113,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.ItemFieldToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - OpenAI.ItemFieldToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldType: anyOf: - type: string @@ -30372,9 +29120,6 @@ components: enum: - message - function_call - - tool_search_call - - tool_search_output - - additional_tools - function_call_output - file_search_call - web_search_call @@ -30469,11 +29214,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -30488,9 +29232,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -30514,9 +29257,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -30529,9 +29272,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -30549,13 +29291,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -30568,9 +29311,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -30589,13 +29331,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -30603,7 +29346,6 @@ components: OpenAI.ItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -30612,7 +29354,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -30622,9 +29363,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -30672,57 +29410,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An image generation request made by the model. title: Image generation call - OpenAI.ItemInputMessage: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - default: message - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - readOnly: true - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.ItemLocalShellToolCall: type: object required: @@ -30777,13 +29470,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -30833,9 +29525,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -30843,9 +29534,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -30876,7 +29566,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -30909,20 +29600,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -30956,10 +29645,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -30990,9 +29675,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -31032,6 +29716,7 @@ components: - item_reference description: The type of item to reference. Always `item_reference`. x-stainless-const: true + default: item_reference id: type: string description: The ID of the item to reference. @@ -31049,19 +29734,14 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemResourceInputMessage' + message: '#/components/schemas/OpenAI.InputMessageResource' output_message: '#/components/schemas/OpenAI.ItemResourceOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemResourceFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemResourceComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput' - tool_search_call: '#/components/schemas/OpenAI.ItemResourceToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ItemResourceToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ItemResourceAdditionalTools' - reasoning: '#/components/schemas/OpenAI.ItemResourceReasoningItem' - compaction: '#/components/schemas/OpenAI.ItemResourceCompactionBody' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -31074,38 +29754,7 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ItemResourceMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ItemResourceCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource' description: Content item used to generate a response. - OpenAI.ItemResourceAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceApplyPatchToolCall: type: object required: @@ -31170,9 +29819,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -31213,54 +29861,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A tool call to run code. title: Code interpreter tool call - OpenAI.ItemResourceCompactionBody: - type: object - required: - - type - - id - - encrypted_content - properties: - type: - type: string - enum: - - compaction - description: The type of the item. Always `compaction`. - x-stainless-const: true - default: compaction - id: - type: string - description: The unique ID of the compaction item. - encrypted_content: - type: string - description: The encrypted content that was produced by compaction. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - title: Compaction item OpenAI.ItemResourceComputerToolCall: type: object required: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -31278,8 +29898,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -31300,11 +29918,10 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemResourceComputerToolCallOutput: + OpenAI.ItemResourceComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -31318,7 +29935,6 @@ components: id: type: string description: The ID of the computer tool call output. - readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -31342,91 +29958,6 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.ItemResourceCustomToolCallOutputResource: - type: object - required: - - type - - call_id - - output - - status - properties: - type: - type: string - enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. - x-stainless-const: true - id: - type: string - description: The unique ID of the custom tool call output in the OpenAI platform. - call_id: - type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - title: ResponseCustomToolCallOutputItem - OpenAI.ItemResourceCustomToolCallResource: - type: object - required: - - type - - call_id - - name - - input - - status - properties: - type: - type: string - enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. - x-stainless-const: true - id: - type: string - description: The unique ID of the custom tool call in the OpenAI platform. - call_id: - type: string - description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. - name: - type: string - description: The name of the custom tool being called. - input: - type: string - description: The input for the custom tool call generated by the model. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - title: ResponseCustomToolCallItem OpenAI.ItemResourceFileSearchToolCall: type: object required: @@ -31461,11 +29992,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -31501,12 +30031,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -31539,7 +30070,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -31547,9 +30078,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -31557,37 +30089,36 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCall: + OpenAI.ItemResourceFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -31599,42 +30130,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: |- - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. - title: Function tool call - OpenAI.ItemResourceFunctionToolCallOutput: + OpenAI.ItemResourceFunctionToolCallResource: type: object required: - - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true + description: The unique ID of the function tool call. type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -31646,8 +30167,6 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: The output of a function tool call. - title: Function tool call output OpenAI.ItemResourceImageGenToolCall: type: object required: @@ -31674,57 +30193,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An image generation request made by the model. title: Image generation call - OpenAI.ItemResourceInputMessage: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - default: message - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - readOnly: true - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.ItemResourceLocalShellToolCall: type: object required: @@ -31779,13 +30253,12 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -31845,9 +30318,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -31878,7 +30350,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -31911,20 +30384,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -31958,10 +30429,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -31975,134 +30442,6 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An output message from the model. title: Output message - OpenAI.ItemResourceReasoningItem: - type: object - required: - - type - - id - - summary - properties: - type: - type: string - enum: - - reasoning - description: The type of the object. Always `reasoning`. - x-stainless-const: true - id: - type: string - description: The unique identifier of the reasoning content. - encrypted_content: - anyOf: - - type: string - - type: 'null' - summary: - type: array - items: - $ref: '#/components/schemas/OpenAI.SummaryTextContent' - description: Reasoning summary content. - content: - type: array - items: - $ref: '#/components/schemas/OpenAI.ReasoningTextContent' - description: Reasoning text content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - description: |- - A description of the chain of thought used by a reasoning model while generating - a response. Be sure to include these items in your `input` to the Responses API - for subsequent turns of a conversation if you are manually - [managing context](/docs/guides/conversation-state). - title: Reasoning - OpenAI.ItemResourceToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceType: anyOf: - type: string @@ -32116,11 +30455,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - - reasoning - - compaction - image_generation_call - code_interpreter_call - local_shell_call @@ -32133,8 +30467,6 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call - - custom_tool_call - - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -32198,77 +30530,6 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call - OpenAI.ItemToolSearchCallItemParam: - type: object - required: - - type - - arguments - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_call - description: The item type. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - allOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - description: The arguments supplied to the tool search call. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - OpenAI.ItemToolSearchOutputItemParam: - type: object - required: - - type - - tools - properties: - id: - anyOf: - - type: string - - type: 'null' - call_id: - anyOf: - - type: string - - type: 'null' - type: - type: string - enum: - - tool_search_output - description: The item type. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by the tool search output. - status: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemType: anyOf: - type: string @@ -32282,9 +30543,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -32376,6 +30634,7 @@ components: - keypress description: Specifies the event type. For a keypress action, this property is always set to `keypress`. x-stainless-const: true + default: keypress keys: type: array items: @@ -32403,13 +30662,11 @@ components: - list x-stainless-const: true first_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true last_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true x-ms-list-continuation-token: true has_more: type: boolean @@ -32462,10 +30719,23 @@ components: - local description: The environment type. Always `local`. x-stainless-const: true + default: local allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' description: Represents the use of a local environment to perform shell actions. title: Local Environment + OpenAI.LocalShellCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete + OpenAI.LocalShellCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.LocalShellExecAction: type: object required: @@ -32486,23 +30756,22 @@ components: type: string description: The command to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true working_directory: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true env: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -32516,6 +30785,7 @@ components: - local_shell description: The type of the local shell tool. Always `local_shell`. x-stainless-const: true + default: local_shell name: type: string description: Optional user-defined name for this tool or configuration. @@ -32524,7 +30794,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -32582,17 +30852,17 @@ components: type: string description: The name of the tool. description: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - - type: 'null' + nullable: true description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -32654,36 +30924,38 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true allowed_tools: anyOf: - type: array items: type: string - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - - type: 'null' + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string enum: - always - never - - type: 'null' + nullable: true default: always - defer_loading: - type: boolean - description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -32745,7 +31017,6 @@ components: refusal: '#/components/schemas/OpenAI.MessageContentRefusalContent' input_image: '#/components/schemas/OpenAI.MessageContentInputImageContent' input_file: '#/components/schemas/OpenAI.MessageContentInputFileContent' - summary_text: '#/components/schemas/OpenAI.SummaryTextContent' description: A content part that makes up an input or output item. OpenAI.MessageContentInputFileContent: type: object @@ -32760,23 +31031,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: type: string description: The name of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - detail: - allOf: - - $ref: '#/components/schemas/OpenAI.FileInputDetail' - description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -32795,18 +31061,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -32916,15 +31180,6 @@ components: - input_image - computer_screenshot - input_file - OpenAI.MessagePhase: - type: string - enum: - - commentary - - final_answer - description: |- - Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). - For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend - phase on all assistant messages — dropping it can degrade performance. Not used for user messages. OpenAI.MessageRole: type: string enum: @@ -32944,7 +31199,7 @@ components: - incomplete OpenAI.Metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -32955,9 +31210,13 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' + - allOf: + - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' + description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. + nullable: true - type: string - - type: 'null' + description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. + nullable: true description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. OpenAI.ModelIdsResponses: anyOf: @@ -32982,125 +31241,6 @@ components: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.ChatModel' - OpenAI.Moderation: - type: object - required: - - input - - output - properties: - input: - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: Moderation for the response input. - output: - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: Moderation for the response output. - description: Moderation results or errors for the response input and output. - title: Moderation - OpenAI.ModerationEntry: - type: object - required: - - type - properties: - type: - $ref: '#/components/schemas/OpenAI.ModerationEntryType' - discriminator: - propertyName: type - mapping: - moderation_result: '#/components/schemas/OpenAI.ModerationResultBody' - error: '#/components/schemas/OpenAI.ModerationErrorBody' - description: Moderation results or an error for a response moderation check. - OpenAI.ModerationEntryType: - anyOf: - - type: string - - type: string - enum: - - moderation_result - - error - OpenAI.ModerationErrorBody: - type: object - required: - - type - - code - - message - properties: - type: - type: string - enum: - - error - description: The object type, which was always `error` for moderation failures. - x-stainless-const: true - code: - type: string - description: The error code. - message: - type: string - description: The error message. - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: An error produced while attempting moderation for the response input or output. - title: Moderation error - OpenAI.ModerationInputType: - type: string - enum: - - text - - image - OpenAI.ModerationParam: - type: object - required: - - model - properties: - model: - type: string - description: The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. - description: Configuration for running moderation on the input and output of this response. - OpenAI.ModerationResultBody: - type: object - required: - - type - - model - - flagged - - categories - - category_scores - - category_applied_input_types - properties: - type: - type: string - enum: - - moderation_result - description: The object type, which was always `moderation_result` for successful moderation results. - x-stainless-const: true - model: - type: string - description: The moderation model that produced this result. - flagged: - type: boolean - description: A boolean indicating whether the content was flagged by any category. - categories: - type: object - unevaluatedProperties: - type: boolean - description: A dictionary of moderation categories to booleans, True if the input is flagged under this category. - x-oaiTypeLabel: map - category_scores: - type: object - unevaluatedProperties: - $ref: '#/components/schemas/OpenAI.numeric' - description: A dictionary of moderation categories to scores. - x-oaiTypeLabel: map - category_applied_input_types: - type: object - unevaluatedProperties: - type: array - items: - $ref: '#/components/schemas/OpenAI.ModerationInputType' - description: Which modalities of input are reflected by the score for each category. - x-oaiTypeLabel: map - allOf: - - $ref: '#/components/schemas/OpenAI.ModerationEntry' - description: A moderation result produced for the response input or output. - title: Moderation result OpenAI.MoveParam: type: object required: @@ -33114,6 +31254,7 @@ components: - move description: Specifies the event type. For a move action, this property is always set to `move`. x-stainless-const: true + default: move x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -33122,50 +31263,10 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate to move to. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A mouse move action. title: Move - OpenAI.NamespaceToolParam: - type: object - required: - - type - - name - - description - - tools - properties: - type: - type: string - enum: - - namespace - description: The type of the tool. Always `namespace`. - x-stainless-const: true - name: - type: string - minLength: 1 - description: The namespace name used in tool calls (for example, `crm`). - description: - type: string - minLength: 1 - description: A description of the namespace shown to the model. - tools: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.FunctionToolParam' - - $ref: '#/components/schemas/OpenAI.CustomToolParam' - minItems: 1 - description: The function/custom tools available inside this namespace. - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: Groups function/custom tools under a shared namespace. - title: Namespace OpenAI.OutputContent: type: object required: @@ -33307,19 +31408,13 @@ components: output_message: '#/components/schemas/OpenAI.OutputItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.OutputItemFileSearchToolCall' function_call: '#/components/schemas/OpenAI.OutputItemFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput' web_search_call: '#/components/schemas/OpenAI.OutputItemWebSearchToolCall' computer_call: '#/components/schemas/OpenAI.OutputItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.OutputItemComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.OutputItemReasoningItem' - tool_search_call: '#/components/schemas/OpenAI.OutputItemToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.OutputItemToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.OutputItemAdditionalTools' compaction: '#/components/schemas/OpenAI.OutputItemCompactionBody' image_generation_call: '#/components/schemas/OpenAI.OutputItemImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.OutputItemLocalShellToolCall' - local_shell_call_output: '#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput' shell_call: '#/components/schemas/OpenAI.OutputItemFunctionShellCall' shell_call_output: '#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput' apply_patch_call: '#/components/schemas/OpenAI.OutputItemApplyPatchToolCall' @@ -33327,38 +31422,7 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource' - custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource' - OpenAI.OutputItemAdditionalTools: - type: object - required: - - type - - id - - role - - tools - properties: - type: - type: string - enum: - - additional_tools - description: The type of the item. Always `additional_tools`. - x-stainless-const: true - default: additional_tools - id: - type: string - description: The unique ID of the additional tools item. - role: - allOf: - - $ref: '#/components/schemas/OpenAI.MessageRole' - description: The role that provided the additional tools. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The additional tool definitions made available at this item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -33423,9 +31487,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -33466,17 +31529,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -33514,6 +31575,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -33531,8 +31593,6 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' - actions: - $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -33553,99 +31613,13 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.OutputItemComputerToolCallOutput: - type: object - required: - - type - - id - - call_id - - output - properties: - type: - type: string - enum: - - computer_call_output - description: The type of the computer tool call output. Always `computer_call_output`. - x-stainless-const: true - default: computer_call_output - id: - type: string - description: The ID of the computer tool call output. - readOnly: true - call_id: - type: string - description: The ID of the computer tool call that produced the output. - acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - description: |- - The safety checks reported by the API that have been acknowledged by the - developer. - output: - $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the message input. One of `in_progress`, `completed`, or - `incomplete`. Populated when input items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.OutputItemCustomToolCallOutputResource: - type: object - required: - - type - - call_id - - output - - status - properties: - type: - type: string - enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. - x-stainless-const: true - id: - type: string - description: The unique ID of the custom tool call output in the OpenAI platform. - call_id: - type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - title: ResponseCustomToolCallOutputItem - OpenAI.OutputItemCustomToolCallResource: + OpenAI.OutputItemCustomToolCall: type: object required: - type - call_id - name - input - - status properties: type: type: string @@ -33659,27 +31633,16 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. - namespace: - type: string - description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. input: type: string description: The input for the custom tool call generated by the model. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - created_by: - type: string - description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' - title: ResponseCustomToolCallItem + description: A call to a custom tool created by the model. + title: Custom tool call OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -33714,11 +31677,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -33754,12 +31716,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -33792,7 +31755,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -33800,9 +31763,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -33813,7 +31777,6 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -33822,7 +31785,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -33832,9 +31794,6 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. - namespace: - type: string - description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -33856,51 +31815,6 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call - OpenAI.OutputItemFunctionToolCallOutput: - type: object - required: - - id - - type - - call_id - - output - properties: - id: - type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. - readOnly: true - type: - type: string - enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. - x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: The output of a function tool call. - title: Function tool call output OpenAI.OutputItemImageGenToolCall: type: object required: @@ -33927,9 +31841,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -33968,37 +31881,6 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run a command on the local shell. title: Local shell call - OpenAI.OutputItemLocalShellToolCallOutput: - type: object - required: - - type - - id - - output - properties: - type: - type: string - enum: - - local_shell_call_output - description: The type of the local shell tool call output. Always `local_shell_call_output`. - x-stainless-const: true - id: - type: string - description: The unique ID of the local shell tool call generated by the model. - output: - type: string - description: A JSON string of the output of the local shell tool call. - status: - anyOf: - - type: string - enum: - - in_progress - - completed - - incomplete - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: The output of a local shell tool call. - title: Local shell call output OpenAI.OutputItemMcpApprovalRequest: type: object required: @@ -34030,37 +31912,6 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A request for human approval of a tool invocation. title: MCP approval request - OpenAI.OutputItemMcpApprovalResponseResource: - type: object - required: - - type - - id - - approval_request_id - - approve - properties: - type: - type: string - enum: - - mcp_approval_response - description: The type of the item. Always `mcp_approval_response`. - x-stainless-const: true - id: - type: string - description: The unique ID of the approval response - approval_request_id: - type: string - description: The ID of the approval request being answered. - approve: - type: boolean - description: Whether the request was approved. - reason: - anyOf: - - type: string - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - description: A response to an MCP approval request. - title: MCP approval response OpenAI.OutputItemMcpListTools: type: object required: @@ -34087,7 +31938,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -34120,20 +31972,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -34167,10 +32017,6 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. - phase: - anyOf: - - $ref: '#/components/schemas/OpenAI.MessagePhase' - - type: 'null' status: type: string enum: @@ -34201,9 +32047,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -34231,87 +32076,6 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning - OpenAI.OutputItemToolSearchCall: - type: object - required: - - type - - id - - call_id - - execution - - arguments - - status - properties: - type: - type: string - enum: - - tool_search_call - description: The type of the item. Always `tool_search_call`. - x-stainless-const: true - default: tool_search_call - id: - type: string - description: The unique ID of the tool search call item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - arguments: - description: Arguments used for the tool search call. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' - description: The status of the tool search call item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' - OpenAI.OutputItemToolSearchOutput: - type: object - required: - - type - - id - - call_id - - execution - - tools - - status - properties: - type: - type: string - enum: - - tool_search_output - description: The type of the item. Always `tool_search_output`. - x-stainless-const: true - default: tool_search_output - id: - type: string - description: The unique ID of the tool search output item. - call_id: - anyOf: - - type: string - - type: 'null' - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search was executed by the server or by the client. - tools: - type: array - items: - $ref: '#/components/schemas/OpenAI.Tool' - description: The loaded tool definitions returned by tool search. - status: - allOf: - - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' - description: The status of the tool search output item that was recorded. - created_by: - type: string - description: The identifier of the actor that created the item. - allOf: - - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemType: anyOf: - type: string @@ -34320,19 +32084,13 @@ components: - output_message - file_search_call - function_call - - function_call_output - web_search_call - computer_call - - computer_call_output - reasoning - - tool_search_call - - tool_search_output - - additional_tools - compaction - image_generation_call - code_interpreter_call - local_shell_call - - local_shell_call_output - shell_call - shell_call_output - apply_patch_call @@ -34340,9 +32098,7 @@ components: - mcp_call - mcp_list_tools - mcp_approval_request - - mcp_approval_response - custom_tool_call - - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -34485,21 +32241,16 @@ components: type: string description: The unique identifier of the prompt template to use. version: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true variables: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - - type: 'null' + nullable: true description: |- Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). - OpenAI.PromptCacheRetentionEnum: - type: string - enum: - - in_memory - - 24h OpenAI.RankerVersionType: type: string enum: @@ -34520,118 +32271,39 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.HybridSearchOptions' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - OpenAI.RealtimeMCPError: - type: object - required: - - type - properties: - type: - $ref: '#/components/schemas/OpenAI.RealtimeMcpErrorType' - discriminator: - propertyName: type - mapping: - protocol_error: '#/components/schemas/OpenAI.RealtimeMCPProtocolError' - tool_execution_error: '#/components/schemas/OpenAI.RealtimeMCPToolExecutionError' - http_error: '#/components/schemas/OpenAI.RealtimeMCPHTTPError' - OpenAI.RealtimeMCPHTTPError: - type: object - required: - - type - - code - - message - properties: - type: - type: string - enum: - - http_error - x-stainless-const: true - code: - $ref: '#/components/schemas/OpenAI.integer' - message: - type: string - allOf: - - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' - title: Realtime MCP HTTP error - OpenAI.RealtimeMCPProtocolError: - type: object - required: - - type - - code - - message - properties: - type: - type: string - enum: - - protocol_error - x-stainless-const: true - code: - $ref: '#/components/schemas/OpenAI.integer' - message: - type: string - allOf: - - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' - title: Realtime MCP protocol error - OpenAI.RealtimeMCPToolExecutionError: - type: object - required: - - type - - message - properties: - type: - type: string - enum: - - tool_execution_error - x-stainless-const: true - message: - type: string - allOf: - - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' - title: Realtime MCP tool execution error - OpenAI.RealtimeMcpErrorType: - anyOf: - - type: string - - type: string - enum: - - protocol_error - - tool_execution_error - - http_error OpenAI.Reasoning: type: object properties: effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' summary: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true generate_summary: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - anyOf: - - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh - - type: 'null' + type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -34642,6 +32314,7 @@ components: - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + nullable: true OpenAI.ReasoningTextContent: type: object required: @@ -34674,22 +32347,26 @@ components: - agent_reference properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -34700,41 +32377,44 @@ components: deprecated: true safety_identifier: type: string - maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -34746,12 +32426,11 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled id: type: string @@ -34779,20 +32458,19 @@ components: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - - type: 'null' + nullable: true incomplete_details: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - - type: 'null' + nullable: true output: type: array items: @@ -34811,29 +32489,21 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true output_text: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' - moderation: - anyOf: - - $ref: '#/components/schemas/OpenAI.Moderation' - - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - - type: 'null' - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true agent: allOf: - $ref: '#/components/schemas/AgentId' @@ -34848,9 +32518,10 @@ components: or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox affinity in follow-up calls. agent_reference: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/AgentReference' - - type: 'null' + nullable: true description: The agent used for this response content_filters: type: array @@ -34877,10 +32548,8 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - contentEncoding: base64 + format: base64 description: A chunk of Base64 encoded response audio bytes. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial audio response. x-oaiMeta: name: response.audio.delta @@ -34908,8 +32577,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the delta. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the audio response is complete. x-oaiMeta: name: response.audio.done @@ -34940,8 +32607,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial transcript of audio. x-oaiMeta: name: response.audio.transcript.delta @@ -34969,8 +32634,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the full audio transcript is completed. x-oaiMeta: name: response.audio.transcript.done @@ -35010,8 +32673,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial code snippet is streamed by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.delta @@ -35053,8 +32714,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code snippet is finalized by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.done @@ -35092,8 +32751,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter call is completed. x-oaiMeta: name: response.code_interpreter_call.completed @@ -35130,8 +32787,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a code interpreter call is in progress. x-oaiMeta: name: response.code_interpreter_call.in_progress @@ -35168,8 +32823,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter is actively interpreting the code snippet. x-oaiMeta: name: response.code_interpreter_call.interpreting @@ -35202,8 +32855,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the model response is complete. x-oaiMeta: name: response.completed @@ -35298,8 +32949,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new content part is added. x-oaiMeta: name: response.content_part.added @@ -35352,8 +33001,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputContent' description: The content part that is done. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a content part is done. x-oaiMeta: name: response.content_part.done @@ -35392,8 +33039,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response is created. x-oaiMeta: name: response.created @@ -35465,8 +33110,6 @@ components: delta: type: string description: The incremental input data (delta) for the custom tool call. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event representing a delta (partial update) to the input of a custom tool call. title: ResponseCustomToolCallInputDelta x-oaiMeta: @@ -35508,8 +33151,6 @@ components: input: type: string description: The complete input data for the custom tool call. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event indicating that input for a custom tool call is complete. title: ResponseCustomToolCallInputDone x-oaiMeta: @@ -35572,22 +33213,18 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string description: The error message. param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true sequence_number: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an error occurs. x-oaiMeta: name: error @@ -35621,8 +33258,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Response' description: The response that failed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response fails. x-oaiMeta: name: response.failed @@ -35688,8 +33323,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is completed (results found). x-oaiMeta: name: response.file_search_call.completed @@ -35726,8 +33359,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is initiated. x-oaiMeta: name: response.file_search_call.in_progress @@ -35764,8 +33395,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search is currently searching. x-oaiMeta: name: response.file_search_call.searching @@ -35829,12 +33458,11 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.ResponseFormatJsonSchemaSchema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -35881,8 +33509,6 @@ components: delta: type: string description: The function-call arguments delta that is added. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial function-call arguments delta. x-oaiMeta: name: response.function_call_arguments.delta @@ -35927,8 +33553,6 @@ components: arguments: type: string description: The function-call arguments. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when function-call arguments are finalized. x-oaiMeta: name: response.function_call_arguments.done @@ -35967,8 +33591,6 @@ components: item_id: type: string description: The unique identifier of the image generation item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call has completed and the final image is available. title: ResponseImageGenCallCompletedEvent x-oaiMeta: @@ -36006,8 +33628,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is actively generating an image (intermediate state). title: ResponseImageGenCallGeneratingEvent x-oaiMeta: @@ -36045,8 +33665,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is in progress. title: ResponseImageGenCallInProgressEvent x-oaiMeta: @@ -36093,8 +33711,6 @@ components: partial_image_b64: type: string description: Base64-encoded partial image data, suitable for rendering as an image. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial image is available during image generation streaming. title: ResponseImageGenCallPartialImageEvent x-oaiMeta: @@ -36130,8 +33746,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the response is in progress. x-oaiMeta: name: response.in_progress @@ -36203,8 +33817,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response finishes as incomplete. x-oaiMeta: name: response.incomplete @@ -36262,7 +33874,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probabilities of up to 20 of the most likely tokens. + description: The log probability of the top 20 most likely tokens. description: |- A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) @@ -36303,8 +33915,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a delta (partial update) to the arguments of an MCP tool call. title: ResponseMCPCallArgumentsDeltaEvent x-oaiMeta: @@ -36347,8 +33957,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the arguments for an MCP tool call are finalized. title: ResponseMCPCallArgumentsDoneEvent x-oaiMeta: @@ -36387,8 +33995,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has completed successfully. title: ResponseMCPCallCompletedEvent x-oaiMeta: @@ -36426,8 +34032,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has failed. title: ResponseMCPCallFailedEvent x-oaiMeta: @@ -36465,8 +34069,6 @@ components: item_id: type: string description: The unique identifier of the MCP tool call item being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call is in progress. title: ResponseMCPCallInProgressEvent x-oaiMeta: @@ -36504,8 +34106,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the list of available MCP tools has been successfully retrieved. title: ResponseMCPListToolsCompletedEvent x-oaiMeta: @@ -36543,8 +34143,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the attempt to list available MCP tools has failed. title: ResponseMCPListToolsFailedEvent x-oaiMeta: @@ -36582,8 +34180,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the system is in the process of retrieving the list of available MCP tools. title: ResponseMCPListToolsInProgressEvent x-oaiMeta: @@ -36622,8 +34218,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was added. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new output item is added. x-oaiMeta: name: response.output_item.added @@ -36667,8 +34261,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was marked done. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an output item is marked done. x-oaiMeta: name: response.output_item.done @@ -36732,8 +34324,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Annotation' description: The annotation object being added. (See annotation schema for details.) - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an annotation is added to output text content. title: ResponseOutputTextAnnotationAddedEvent x-oaiMeta: @@ -36756,7 +34346,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -36790,8 +34380,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a response is queued and waiting to be processed. title: ResponseQueuedEvent x-oaiMeta: @@ -36843,8 +34431,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEventPart' description: The summary part that was added. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new reasoning summary part is added. x-oaiMeta: name: response.reasoning_summary_part.added @@ -36909,8 +34495,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEventPart' description: The completed summary part. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary part is completed. x-oaiMeta: name: response.reasoning_summary_part.done @@ -36976,8 +34560,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning summary text. x-oaiMeta: name: response.reasoning_summary_text.delta @@ -37027,8 +34609,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary text is completed. x-oaiMeta: name: response.reasoning_summary_text.done @@ -37078,8 +34658,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning text. x-oaiMeta: name: response.reasoning_text.delta @@ -37127,8 +34705,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning text is completed. x-oaiMeta: name: response.reasoning_text.done @@ -37176,8 +34752,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial refusal text. x-oaiMeta: name: response.refusal.delta @@ -37225,8 +34799,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when refusal text is finalized. x-oaiMeta: name: response.refusal.done @@ -37240,127 +34812,6 @@ components: "refusal": "final refusal text", "sequence_number": 1 } - OpenAI.ResponseStreamEvent: - type: object - required: - - type - properties: - type: - $ref: '#/components/schemas/OpenAI.ResponseStreamEventType' - discriminator: - propertyName: type - mapping: - response.audio.transcript.delta: '#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent' - response.code_interpreter_call_code.delta: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent' - response.code_interpreter_call.in_progress: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent' - response.code_interpreter_call.interpreting: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent' - response.content_part.added: '#/components/schemas/OpenAI.ResponseContentPartAddedEvent' - response.created: '#/components/schemas/OpenAI.ResponseCreatedEvent' - error: '#/components/schemas/OpenAI.ResponseErrorEvent' - response.file_search_call.in_progress: '#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent' - response.file_search_call.searching: '#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent' - response.function_call_arguments.delta: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent' - response.in_progress: '#/components/schemas/OpenAI.ResponseInProgressEvent' - response.failed: '#/components/schemas/OpenAI.ResponseFailedEvent' - response.incomplete: '#/components/schemas/OpenAI.ResponseIncompleteEvent' - response.output_item.added: '#/components/schemas/OpenAI.ResponseOutputItemAddedEvent' - response.reasoning_summary_part.added: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent' - response.reasoning_summary_text.delta: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent' - response.reasoning_text.delta: '#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent' - response.refusal.delta: '#/components/schemas/OpenAI.ResponseRefusalDeltaEvent' - response.output_text.delta: '#/components/schemas/OpenAI.ResponseTextDeltaEvent' - response.web_search_call.in_progress: '#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent' - response.web_search_call.searching: '#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent' - response.image_generation_call.generating: '#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent' - response.image_generation_call.in_progress: '#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent' - response.image_generation_call.partial_image: '#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent' - response.mcp_call_arguments.delta: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent' - response.mcp_call.failed: '#/components/schemas/OpenAI.ResponseMCPCallFailedEvent' - response.mcp_call.in_progress: '#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent' - response.mcp_list_tools.failed: '#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent' - response.mcp_list_tools.in_progress: '#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent' - response.output_text.annotation.added: '#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent' - response.queued: '#/components/schemas/OpenAI.ResponseQueuedEvent' - response.custom_tool_call_input.delta: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent' - response.audio.done: '#/components/schemas/OpenAI.ResponseAudioDoneEvent' - response.audio.transcript.done: '#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent' - response.code_interpreter_call_code.done: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent' - response.code_interpreter_call.completed: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent' - response.completed: '#/components/schemas/OpenAI.ResponseCompletedEvent' - response.content_part.done: '#/components/schemas/OpenAI.ResponseContentPartDoneEvent' - response.file_search_call.completed: '#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent' - response.function_call_arguments.done: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent' - response.output_item.done: '#/components/schemas/OpenAI.ResponseOutputItemDoneEvent' - response.reasoning_summary_part.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent' - response.reasoning_summary_text.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent' - response.reasoning_text.done: '#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent' - response.refusal.done: '#/components/schemas/OpenAI.ResponseRefusalDoneEvent' - response.output_text.done: '#/components/schemas/OpenAI.ResponseTextDoneEvent' - response.web_search_call.completed: '#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent' - response.image_generation_call.completed: '#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent' - response.mcp_call_arguments.done: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent' - response.mcp_call.completed: '#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent' - response.mcp_list_tools.completed: '#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent' - response.custom_tool_call_input.done: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent' - response.audio.delta: '#/components/schemas/OpenAI.ResponseAudioDeltaEvent' - OpenAI.ResponseStreamEventType: - anyOf: - - type: string - - type: string - enum: - - response.audio.delta - - response.audio.done - - response.audio.transcript.delta - - response.audio.transcript.done - - response.code_interpreter_call_code.delta - - response.code_interpreter_call_code.done - - response.code_interpreter_call.completed - - response.code_interpreter_call.in_progress - - response.code_interpreter_call.interpreting - - response.completed - - response.content_part.added - - response.content_part.done - - response.created - - error - - response.file_search_call.completed - - response.file_search_call.in_progress - - response.file_search_call.searching - - response.function_call_arguments.delta - - response.function_call_arguments.done - - response.in_progress - - response.failed - - response.incomplete - - response.output_item.added - - response.output_item.done - - response.reasoning_summary_part.added - - response.reasoning_summary_part.done - - response.reasoning_summary_text.delta - - response.reasoning_summary_text.done - - response.reasoning_text.delta - - response.reasoning_text.done - - response.refusal.delta - - response.refusal.done - - response.output_text.delta - - response.output_text.done - - response.web_search_call.completed - - response.web_search_call.in_progress - - response.web_search_call.searching - - response.image_generation_call.completed - - response.image_generation_call.generating - - response.image_generation_call.in_progress - - response.image_generation_call.partial_image - - response.mcp_call_arguments.delta - - response.mcp_call_arguments.done - - response.mcp_call.completed - - response.mcp_call.failed - - response.mcp_call.in_progress - - response.mcp_list_tools.completed - - response.mcp_list_tools.failed - - response.mcp_list_tools.in_progress - - response.output_text.annotation.added - - response.queued - - response.custom_tool_call_input.delta - - response.custom_tool_call_input.done OpenAI.ResponseStreamOptions: type: object properties: @@ -37415,8 +34866,6 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is an additional text delta. x-oaiMeta: name: response.output_text.delta @@ -37470,8 +34919,6 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when text content is finalized. x-oaiMeta: name: response.output_text.done @@ -37568,8 +35015,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is completed. x-oaiMeta: name: response.web_search_call.completed @@ -37606,8 +35051,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is initiated. x-oaiMeta: name: response.web_search_call.in_progress @@ -37644,8 +35087,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is executing. x-oaiMeta: name: response.web_search_call.searching @@ -37668,6 +35109,7 @@ components: - screenshot description: Specifies the event type. For a screenshot action, this property is always set to `screenshot`. x-stainless-const: true + default: screenshot allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A screenshot action. @@ -37687,6 +35129,7 @@ components: - scroll description: Specifies the event type. For a scroll action, this property is always set to `scroll`. x-stainless-const: true + default: scroll x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -37703,21 +35146,10 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The vertical scroll distance. - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A scroll action. title: Scroll - OpenAI.SearchContentType: - type: string - enum: - - text - - image OpenAI.SearchContextSize: type: string enum: @@ -37725,15 +35157,13 @@ components: - medium - high OpenAI.ServiceTier: - anyOf: - - type: string - enum: - - auto - - default - - flex - - scale - - priority - - type: 'null' + type: string + enum: + - auto + - default + - flex + - scale + - priority description: |- Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. @@ -37741,13 +35171,7 @@ components: - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - OpenAI.ServiceTierEnum: - type: string - enum: - - auto - - default - - flex - - priority + nullable: true OpenAI.SkillReferenceParam: type: object required: @@ -37760,6 +35184,7 @@ components: - skill_reference description: References a skill created with the /v1/skills endpoint. x-stainless-const: true + default: skill_reference skill_id: type: string minLength: 1 @@ -37781,6 +35206,7 @@ components: - apply_patch description: The tool to call. Always `apply_patch`. x-stainless-const: true + default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the apply_patch tool when executing a tool call. @@ -37796,6 +35222,7 @@ components: - shell description: The tool to call. Always `shell`. x-stainless-const: true + default: shell allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the shell tool when a tool call is required. @@ -37812,6 +35239,7 @@ components: - summary_text description: The type of the object. Always `summary_text`. x-stainless-const: true + default: summary_text text: type: string description: A summary of the reasoning output from the model so far. @@ -37830,6 +35258,7 @@ components: enum: - text x-stainless-const: true + default: text text: type: string allOf: @@ -37927,9 +35356,8 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -37973,9 +35401,6 @@ components: custom: '#/components/schemas/OpenAI.CustomToolParam' web_search_preview: '#/components/schemas/OpenAI.WebSearchPreviewTool' apply_patch: '#/components/schemas/OpenAI.ApplyPatchToolParam' - computer: '#/components/schemas/OpenAI.ComputerTool' - namespace: '#/components/schemas/OpenAI.NamespaceToolParam' - tool_search: '#/components/schemas/OpenAI.ToolSearchToolParam' description: A tool that can be used to generate a response. OpenAI.ToolChoiceAllowed: type: object @@ -38004,7 +35429,7 @@ components: type: array items: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: @@ -38033,34 +35458,6 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). - OpenAI.ToolChoiceComputer: - type: object - required: - - type - properties: - type: - type: string - enum: - - computer - allOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - description: |- - Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). - OpenAI.ToolChoiceComputerUse: - type: object - required: - - type - properties: - type: - type: string - enum: - - computer_use - allOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - description: |- - Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). OpenAI.ToolChoiceComputerUsePreview: type: object required: @@ -38157,9 +35554,8 @@ components: type: string description: The label of the MCP server to use. name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -38199,8 +35595,6 @@ components: web_search_preview_2025_03_11: '#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311' image_generation: '#/components/schemas/OpenAI.ToolChoiceImageGeneration' code_interpreter: '#/components/schemas/OpenAI.ToolChoiceCodeInterpreter' - computer: '#/components/schemas/OpenAI.ToolChoiceComputer' - computer_use: '#/components/schemas/OpenAI.ToolChoiceComputerUse' description: |- How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools @@ -38222,8 +35616,6 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter - - computer - - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -38252,38 +35644,6 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). - OpenAI.ToolSearchExecutionType: - type: string - enum: - - server - - client - OpenAI.ToolSearchToolParam: - type: object - required: - - type - properties: - type: - type: string - enum: - - tool_search - description: The type of the tool. Always `tool_search`. - x-stainless-const: true - execution: - allOf: - - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' - description: Whether tool search is executed by the server or by the client. - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - $ref: '#/components/schemas/OpenAI.EmptyModelParam' - - type: 'null' - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: Hosted or BYOT tool search configuration for deferred tools. - title: Tool search tool OpenAI.ToolType: anyOf: - type: string @@ -38291,7 +35651,6 @@ components: enum: - function - file_search - - computer - computer_use_preview - web_search - mcp @@ -38300,8 +35659,6 @@ components: - local_shell - shell - custom - - namespace - - tool_search - web_search_preview - apply_patch - a2a_preview @@ -38368,6 +35725,7 @@ components: - type description: Specifies the event type. For a type action, this property is always set to `type`. x-stainless-const: true + default: type text: type: string description: The text to type. @@ -38381,9 +35739,10 @@ components: - metadata properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -38402,6 +35761,7 @@ components: - url_citation description: The type of the URL citation. Always `url_citation`. x-stainless-const: true + default: url_citation url: type: string format: uri @@ -38423,7 +35783,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -38436,17 +35796,16 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - anyOf: - - type: string - enum: - - low - - medium - - high - - type: 'null' + type: string + enum: + - low + - medium + - high description: |- Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. + nullable: true OpenAI.WaitParam: type: object required: @@ -38458,6 +35817,7 @@ components: - wait description: Specifies the event type. For a wait action, this property is always set to `wait`. x-stainless-const: true + default: wait allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A wait action. @@ -38496,10 +35856,9 @@ components: description: The action type. x-stainless-const: true url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -38507,6 +35866,7 @@ components: type: object required: - type + - query properties: type: type: string @@ -38516,7 +35876,7 @@ components: x-stainless-const: true query: type: string - description: The search query. + description: '[DEPRECATED] The search query.' deprecated: true queries: type: array @@ -38545,7 +35905,6 @@ components: x-stainless-const: true url: type: string - format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -38559,21 +35918,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -38587,18 +35942,16 @@ components: - web_search_preview description: The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. x-stainless-const: true + default: web_search_preview user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - - type: 'null' + nullable: true search_context_size: allOf: - $ref: '#/components/schemas/OpenAI.SearchContextSize' description: High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - search_content_types: - type: array - items: - $ref: '#/components/schemas/OpenAI.SearchContentType' allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). @@ -38613,14 +35966,17 @@ components: enum: - web_search description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. + default: web_search filters: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - - type: 'null' + nullable: true user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - - type: 'null' + nullable: true search_context_size: type: string enum: @@ -38637,7 +35993,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -38659,11 +36015,10 @@ components: type: object properties: allowed_domains: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true OpenAI.integer: type: integer format: int64 @@ -38727,7 +36082,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. spec: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -38751,7 +36106,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -38830,7 +36185,7 @@ components: description: The openapi function definition. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -38897,45 +36252,24 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output of an OpenAPI tool call. - OptimizationAgentDefinition: + OptimizationAgentIdentifier: type: object + required: + - agent_name properties: agent_name: type: string - description: Agent name. + description: Registered Foundry agent name (required). agent_version: type: string - description: Agent version. - model: - type: string - description: Model deployment name. - system_prompt: - type: string - description: System prompt / instructions. - skills: - type: array - items: - type: object - unevaluatedProperties: {} - description: Agent skills. - tools: - type: array - items: - type: object - unevaluatedProperties: {} - description: Agent tools. - description: Agent definition returned in response payloads (includes resolved config). + description: Pinned agent version. Defaults to latest if omitted. + description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config. OptimizationCandidate: type: object required: - name - - config - - mutations - avg_score - avg_tokens - - pass_rate - - task_scores - - is_pareto_optimal properties: candidate_id: type: string @@ -38943,13 +36277,9 @@ components: name: type: string description: Display name of the candidate (e.g., 'baseline', 'instruction-v2'). - config: - allOf: - - $ref: '#/components/schemas/OptimizationAgentDefinition' - description: The agent configuration that produced this candidate. mutations: type: object - unevaluatedProperties: {} + additionalProperties: {} description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." avg_score: type: number @@ -38959,18 +36289,6 @@ components: type: number format: double description: Average token usage across all tasks. - pass_rate: - type: number - format: double - description: Fraction of tasks that met the pass threshold. - task_scores: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Individual task-level scores. - is_pareto_optimal: - type: boolean - description: Whether this candidate is on the Pareto frontier (score vs cost). eval_id: type: string description: Foundry evaluation identifier used to score this candidate. @@ -38982,17 +36300,115 @@ components: - $ref: '#/components/schemas/PromotionInfo' description: Promotion metadata. Null if the candidate has not been promoted. description: Aggregated evaluation result for a single candidate agent configuration across all tasks. + OptimizationDatasetCriterion: + type: object + required: + - name + - instruction + properties: + name: + type: string + description: Criterion name. + instruction: + type: string + description: Criterion instruction / description. + description: 'Evaluation criterion: a name + instruction pair used for per-item scoring.' + OptimizationDatasetInput: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInputType' + description: Dataset input type discriminator. + discriminator: + propertyName: type + mapping: + inline: '#/components/schemas/OptimizationInlineDatasetInput' + reference: '#/components/schemas/OptimizationReferenceDatasetInput' + description: Base discriminated model for dataset input. Either inline items or a registered reference. + OptimizationDatasetInputType: + anyOf: + - type: string + - type: string + enum: + - inline + - reference + description: Discriminator values for the dataset input union. + OptimizationDatasetItem: + type: object + properties: + query: + type: string + description: The user query / prompt. + ground_truth: + type: string + description: Expected ground truth answer. + desired_num_turns: + type: integer + format: int32 + minimum: 1 + maximum: 20 + description: Desired number of conversation turns for simulation mode (1-20). + criteria: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetCriterion' + description: Per-item evaluation criteria. + description: A single item in an inline dataset. + OptimizationEvaluatorRef: + type: object + required: + - name + properties: + name: + type: string + description: Evaluator name. + version: + type: string + description: Evaluator version. If not specified, the latest version is used. + description: Reference to a named evaluator, optionally pinned to a version. + OptimizationInlineDatasetInput: + type: object + required: + - type + - items + properties: + type: + type: string + enum: + - inline + description: Dataset input type discriminator. + items: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetItem' + description: Dataset items. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Inline dataset — items supplied directly in the request body. OptimizationJob: type: object required: - id - status - created_at + - updated_at properties: id: type: string description: Server-assigned unique identifier. readOnly: true + inputs: + allOf: + - $ref: '#/components/schemas/OptimizationJobInputs' + description: Caller-supplied inputs. + result: + allOf: + - $ref: '#/components/schemas/OptimizationJobResult' + description: Result produced on success. + readOnly: true status: allOf: - $ref: '#/components/schemas/JobStatus' @@ -39003,15 +36419,6 @@ components: - $ref: '#/components/schemas/OpenAI.Error' description: Error details — populated only on failure. readOnly: true - result: - allOf: - - $ref: '#/components/schemas/OptimizationJobResult' - description: Result produced on success. - readOnly: true - inputs: - allOf: - - $ref: '#/components/schemas/OptimizationJobInputs' - description: Caller-supplied inputs. created_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' @@ -39020,58 +36427,103 @@ components: updated_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' - description: The timestamp when the job was last updated (status, progress, or result change), represented in Unix time. + description: The timestamp when the job was last updated, represented in Unix time. readOnly: true progress: allOf: - $ref: '#/components/schemas/OptimizationJobProgress' - description: Progress while in flight. Absent in terminal states. + description: Progress snapshot. May be present in terminal states reflecting last-known progress. readOnly: true - dataset: - allOf: - - $ref: '#/components/schemas/DatasetInfo' - description: Metadata about the dataset used for this optimization job. + warnings: + type: array + items: + type: string + description: Non-fatal warnings emitted at any point during optimization. readOnly: true description: Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates. OptimizationJobInputs: type: object required: - agent - - train_dataset_reference + - train_dataset + - evaluators properties: agent: allOf: - - $ref: '#/components/schemas/AgentIdentifier' + - $ref: '#/components/schemas/OptimizationAgentIdentifier' description: The agent (and pinned version) being optimized. - train_dataset_reference: + train_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' - description: Reference to a registered training dataset (required). - validation_dataset_reference: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Training dataset — either inline items or a reference to a registered dataset. Required. + validation_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' + - $ref: '#/components/schemas/OptimizationDatasetInput' description: Optional held-out validation dataset for measuring generalization of the final candidate. evaluators: type: array items: - type: string - description: "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + $ref: '#/components/schemas/OptimizationEvaluatorRef' + description: Job-level evaluators referenced by name and optional version. Required; at least one must be provided. options: allOf: - $ref: '#/components/schemas/OptimizationOptions' description: Tuning knobs and run-mode. description: Caller-supplied inputs for an optimization job. + OptimizationJobListItem: + type: object + required: + - id + - status + - created_at + - updated_at + properties: + id: + type: string + description: Server-assigned unique identifier. + readOnly: true + status: + allOf: + - $ref: '#/components/schemas/JobStatus' + description: Current lifecycle status. + readOnly: true + created_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was created, represented in Unix time. + readOnly: true + updated_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was last updated, represented in Unix time. + readOnly: true + agent: + allOf: + - $ref: '#/components/schemas/OptimizationAgentIdentifier' + description: The agent targeted by this optimization job. + readOnly: true + progress: + allOf: + - $ref: '#/components/schemas/OptimizationJobProgress' + description: Progress snapshot. May be present in terminal states reflecting last-known progress. + readOnly: true + error: + allOf: + - $ref: '#/components/schemas/OpenAI.Error' + description: Error details — populated only on failure. + readOnly: true + description: Slim job representation returned by the LIST endpoint. OptimizationJobProgress: type: object required: - - current_iteration + - candidates_completed - best_score - elapsed_seconds properties: - current_iteration: + candidates_completed: type: integer format: int32 - description: 1-based current iteration index. + description: Number of candidates whose evaluation has completed so far. best_score: type: number format: double @@ -39085,42 +36537,28 @@ components: type: object properties: baseline: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: Evaluation scores for the original (un-optimized) agent configuration. + type: string + description: Candidate ID of the original (un-optimized) baseline evaluation. best: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: The highest-scoring candidate found during optimization. + type: string + description: Candidate ID of the highest-scoring candidate found during optimization. candidates: type: array items: $ref: '#/components/schemas/OptimizationCandidate' description: All evaluated candidates including baseline. - options: - allOf: - - $ref: '#/components/schemas/OptimizationOptions' - description: The options used for this optimization run. - warnings: - type: array - items: - type: string - description: Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped). - all_target_attributes_failed: - type: boolean - description: True when all target attributes failed — only the baseline was evaluated. description: Terminal-state result body. Populated when status is succeeded or failed. OptimizationOptions: type: object properties: - max_iterations: + max_candidates: type: integer format: int32 - description: 'Maximum optimization iterations per strategy. Must be >= 1. Default: 5.' + description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' default: 5 optimization_config: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. eval_model: type: string @@ -39133,58 +36571,26 @@ components: - $ref: '#/components/schemas/EvaluationLevel' description: Evaluation granularity. Null/omitted means per-item single-turn. Set to 'conversation' for per-conversation multi-turn simulation scoring. description: Tuning knobs and run-mode for an optimization job. - OptimizationTaskResult: + OptimizationReferenceDatasetInput: type: object required: - - task_name - - scores - - composite_score - - tokens - - duration_seconds - - passed + - type + - name properties: - task_name: - type: string - description: Task name (from the dataset). - query: - type: string - description: The user query / input for the task. - scores: - type: object - unevaluatedProperties: - type: number - format: double - description: Per-evaluator scores keyed by evaluator name. - composite_score: - type: number - format: double - description: Composite score combining all evaluator scores. - tokens: - type: integer - format: int64 - description: Total tokens consumed during the agent run for this task. - duration_seconds: - type: number - format: double - description: Wall-clock seconds for this task's agent execution. - passed: - type: boolean - description: Whether the task met the pass threshold. - error_message: + type: type: string - description: Error message if the task failed during execution. - rationales: - type: object - unevaluatedProperties: - type: string - description: Per-evaluator reasoning keyed by evaluator name. - response: + enum: + - reference + description: Dataset input type discriminator. + name: type: string - description: Raw agent response text. - run_id: + description: Registered dataset name. + version: type: string - description: Identifier of the agent run that produced this result. - description: Per-task evaluation result for a single candidate. + description: Dataset version. If not specified, the latest version is used. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Reference to a registered Foundry dataset. OtlpTelemetryEndpoint: type: object required: @@ -39200,14 +36606,12 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - examples: - - https://my-collector.example.com/otlp + example: https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - examples: - - Http + example: Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -39514,45 +36918,6 @@ components: x-ms-foundry-meta: required_previews: - MemoryStores=V1Preview - PromoteCandidateRequest: - type: object - required: - - agent_name - - agent_version - properties: - agent_name: - type: string - description: Name of the Foundry agent to promote to. - agent_version: - type: string - description: Version of the Foundry agent to promote to. - description: Request body for promoting a candidate to a Foundry agent version. - PromoteCandidateResponse: - type: object - required: - - candidate_id - - status - - promoted_at - - agent_name - - agent_version - properties: - candidate_id: - type: string - description: The promoted candidate id. - status: - type: string - description: Status after promotion. - promoted_at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when promotion occurred, represented in Unix time. - agent_name: - type: string - description: Name of the Foundry agent promoted to. - agent_version: - type: string - description: Version of the Foundry agent promoted to. - description: Response after successfully promoting a candidate. PromotionInfo: type: object required: @@ -39585,15 +36950,13 @@ components: type: string description: The model deployment to use for this agent. instructions: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A system (or developer) message inserted into the model's context. temperature: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 2 description: |- @@ -39601,10 +36964,9 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 1 description: |- @@ -39615,9 +36977,10 @@ components: Defaults to `1`. default: 1 reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true tools: type: array items: @@ -39638,7 +37001,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -39845,12 +37208,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -40002,7 +37365,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -40047,7 +37410,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -40121,7 +37484,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -40403,17 +37766,17 @@ components: description: Task for the schedule. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the resource. readOnly: true @@ -40481,7 +37844,7 @@ components: readOnly: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Properties of the schedule run. readOnly: true @@ -40497,7 +37860,7 @@ components: description: Type of the task. configuration: type: object - unevaluatedProperties: + additionalProperties: type: string description: Configuration for the task. discriminator: @@ -40586,13 +37949,11 @@ components: allOf: - $ref: '#/components/schemas/SessionLogEventType' description: The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types. - examples: - - log + example: log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - examples: - - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + example: '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' description: |- A single Server-Sent Event frame emitted by the hosted agent session log stream. @@ -40709,7 +38070,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -40802,7 +38163,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -40884,7 +38245,7 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean @@ -40907,12 +38268,11 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured output. strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -41117,7 +38477,7 @@ components: description: List of taxonomy sub categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -41142,7 +38502,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -41189,10 +38549,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - examples: - - - ContainerStdoutStderr - - ContainerOtel - - Metrics + example: + - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -41276,11 +38636,11 @@ components: description: The version of the evaluator. Latest version if not specified. initialization_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The initialization parameters for the evaluation. Must support structured outputs. data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: The model to use for the evaluation. Must support structured outputs. description: An Azure AI Evaluator grader used as testing criterion in evaluations. @@ -41308,7 +38668,7 @@ components: ToolCallOutputContent: anyOf: - type: object - unevaluatedProperties: {} + additionalProperties: {} - type: string - type: array items: {} @@ -41412,7 +38772,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -41469,11 +38829,10 @@ components: - tools properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -41768,7 +39127,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -41787,7 +39146,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -41796,7 +39155,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -41833,12 +39192,13 @@ components: name: type: string metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -41851,7 +39211,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Request body for updating a model version. Only description and tags can be modified. @@ -42046,7 +39406,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -42133,7 +39493,7 @@ components: description: The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'. modelParams: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Optional parameters passed to the model for evaluation. allOf: - $ref: '#/components/schemas/EvaluationTarget' diff --git a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp index 9158a685d176..5742270a94fb 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp @@ -1,5 +1,5 @@ // Models for the AgentsOptimization data-plane surface. -// Aligned with in-tree C# DTOs (Contracts/V1/Models/). +// Aligned with in-tree C# DTOs (Contracts/V2Preview/Models/). // // Uses shared Foundry job infrastructure from servicepatterns.tsp: // JobLike — base job shape (id, status, inputs, result, error) @@ -44,12 +44,94 @@ union OptimizationMode { optimize: "optimize", } +// --------------------------------------------------------------------------- +// Dataset input — discriminated union (inline items or registered reference) +// --------------------------------------------------------------------------- + +/** Discriminator values for the dataset input union. */ +union OptimizationDatasetInputType { + string, + + @doc("Inline dataset — items are provided directly in the request body.") + inline: "inline", + + @doc("Reference to a registered Foundry dataset by name and version.") + reference: "reference", +} + +/** Base discriminated model for dataset input. Either inline items or a registered reference. */ +@discriminator("type") +model OptimizationDatasetInput { + @doc("Dataset input type discriminator.") + type: OptimizationDatasetInputType; +} + +/** Inline dataset — items supplied directly in the request body. */ +model OptimizationInlineDatasetInput extends OptimizationDatasetInput { + @doc("Dataset input type discriminator.") + type: "inline"; + + @doc("Dataset items.") + items: OptimizationDatasetItem[]; +} + +/** Reference to a registered Foundry dataset. */ +model OptimizationReferenceDatasetInput extends OptimizationDatasetInput { + @doc("Dataset input type discriminator.") + type: "reference"; + + @doc("Registered dataset name.") + name: string; + + @doc("Dataset version. If not specified, the latest version is used.") + version?: string; +} + +/** A single item in an inline dataset. */ +model OptimizationDatasetItem { + @doc("The user query / prompt.") + query?: string; + + @doc("Expected ground truth answer.") + ground_truth?: string; + + @doc("Desired number of conversation turns for simulation mode (1-20).") + @minValue(1) + @maxValue(20) + desired_num_turns?: int32; + + @doc("Per-item evaluation criteria.") + criteria?: OptimizationDatasetCriterion[]; +} + +/** Evaluation criterion: a name + instruction pair used for per-item scoring. */ +model OptimizationDatasetCriterion { + @doc("Criterion name.") + name: string; + + @doc("Criterion instruction / description.") + instruction: string; +} + +// --------------------------------------------------------------------------- +// Evaluator reference +// --------------------------------------------------------------------------- + +/** Reference to a named evaluator, optionally pinned to a version. */ +model OptimizationEvaluatorRef { + @doc("Evaluator name.") + name: string; + + @doc("Evaluator version. If not specified, the latest version is used.") + version?: string; +} + // --------------------------------------------------------------------------- // Input models // --------------------------------------------------------------------------- @doc("Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.") -model AgentIdentifier { +model OptimizationAgentIdentifier { @doc("Registered Foundry agent name (required).") agent_name: string; @@ -78,19 +160,10 @@ model OptimizationAgentDefinition { tools?: Record[]; } -@doc("Reference to a registered dataset in the Foundry Dataset Service.") -model DatasetRef { - @doc("Dataset name.") - name: string; - - @doc("Dataset version. If not specified, the latest version is used.") - version?: string; -} - @doc("Tuning knobs and run-mode for an optimization job.") model OptimizationOptions { - @doc("Maximum optimization iterations per strategy. Must be >= 1. Default: 5.") - max_iterations?: int32 = 5; + @doc("Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.") + max_candidates?: int32 = 5; @doc("Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization.") optimization_config?: Record; @@ -108,16 +181,16 @@ model OptimizationOptions { @doc("Caller-supplied inputs for an optimization job.") model OptimizationJobInputs { @doc("The agent (and pinned version) being optimized.") - agent: AgentIdentifier; + agent: OptimizationAgentIdentifier; - @doc("Reference to a registered training dataset (required).") - train_dataset_reference: DatasetRef; + @doc("Training dataset — either inline items or a reference to a registered dataset. Required.") + train_dataset: OptimizationDatasetInput; @doc("Optional held-out validation dataset for measuring generalization of the final candidate.") - validation_dataset_reference?: DatasetRef; + validation_dataset?: OptimizationDatasetInput; - @doc("Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence'].") - evaluators?: string[]; + @doc("Job-level evaluators referenced by name and optional version. Required; at least one must be provided.") + evaluators: OptimizationEvaluatorRef[]; @doc("Tuning knobs and run-mode.") options?: OptimizationOptions; @@ -129,8 +202,8 @@ model OptimizationJobInputs { @doc("In-flight progress; only populated while status is queued or in_progress.") model OptimizationJobProgress { - @doc("1-based current iteration index.") - current_iteration: int32; + @doc("Number of candidates whose evaluation has completed so far.") + candidates_completed: int32; @doc("Best score observed so far across all candidates.") best_score: float64; @@ -147,11 +220,8 @@ model OptimizationCandidate { @doc("Display name of the candidate (e.g., 'baseline', 'instruction-v2').") name: string; - @doc("The agent configuration that produced this candidate.") - config: OptimizationAgentDefinition; - @doc("What was mutated from the baseline (e.g., {system_prompt: 'new prompt'}).") - mutations: Record; + mutations?: Record; @doc("Average composite score across all tasks.") avg_score: float64; @@ -159,15 +229,6 @@ model OptimizationCandidate { @doc("Average token usage across all tasks.") avg_tokens: float64; - @doc("Fraction of tasks that met the pass threshold.") - pass_rate: float64; - - @doc("Individual task-level scores.") - task_scores: OptimizationTaskResult[]; - - @doc("Whether this candidate is on the Pareto frontier (score vs cost).") - is_pareto_optimal: boolean; - @doc("Foundry evaluation identifier used to score this candidate.") eval_id?: string; @@ -217,31 +278,45 @@ model OptimizationTaskResult { @doc("Terminal-state result body. Populated when status is succeeded or failed.") model OptimizationJobResult { - @doc("Evaluation scores for the original (un-optimized) agent configuration.") - baseline?: OptimizationCandidate; + @doc("Candidate ID of the original (un-optimized) baseline evaluation.") + baseline?: string; - @doc("The highest-scoring candidate found during optimization.") - best?: OptimizationCandidate; + @doc("Candidate ID of the highest-scoring candidate found during optimization.") + best?: string; @doc("All evaluated candidates including baseline.") candidates?: OptimizationCandidate[]; +} - @doc("The options used for this optimization run.") - options?: OptimizationOptions; +// --------------------------------------------------------------------------- +// Job resource — extends JobLike per Foundry job guidelines +// --------------------------------------------------------------------------- - @doc("Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped).") - warnings?: string[]; +@doc("Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates.") +model OptimizationJob is JobLike { + @doc("The timestamp when the job was created, represented in Unix time.") + @visibility(Lifecycle.Read) + created_at: FoundryTimestamp; - @doc("True when all target attributes failed — only the baseline was evaluated.") - all_target_attributes_failed?: boolean; + @doc("The timestamp when the job was last updated, represented in Unix time.") + @visibility(Lifecycle.Read) + updated_at: FoundryTimestamp; + + @doc("Progress snapshot. May be present in terminal states reflecting last-known progress.") + @visibility(Lifecycle.Read) + progress?: OptimizationJobProgress; + + @doc("Non-fatal warnings emitted at any point during optimization.") + @visibility(Lifecycle.Read) + warnings?: string[]; } // --------------------------------------------------------------------------- -// Job resource — flat request body (no `inputs` wrapper) to match vienna contract +// Slim list item — returned by LIST // --------------------------------------------------------------------------- -@doc("Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates.") -model OptimizationJob { +@doc("Slim job representation returned by the LIST endpoint.") +model OptimizationJobListItem { @doc("Server-assigned unique identifier.") @visibility(Lifecycle.Read) id: string; @@ -250,33 +325,25 @@ model OptimizationJob { @visibility(Lifecycle.Read) status: JobStatus; - @doc("Error details — populated only on failure.") - @visibility(Lifecycle.Read) - error?: ApiError; - - @doc("Result produced on success.") - @visibility(Lifecycle.Read) - result?: OptimizationJobResult; - - // --- Inputs (nested in response, echoing caller-supplied config) --- - @doc("Caller-supplied inputs.") - inputs?: OptimizationJobInputs; - @doc("The timestamp when the job was created, represented in Unix time.") @visibility(Lifecycle.Read) created_at: FoundryTimestamp; - @doc("The timestamp when the job was last updated (status, progress, or result change), represented in Unix time.") + @doc("The timestamp when the job was last updated, represented in Unix time.") @visibility(Lifecycle.Read) - updated_at?: FoundryTimestamp; + updated_at: FoundryTimestamp; - @doc("Progress while in flight. Absent in terminal states.") + @doc("The agent targeted by this optimization job.") + @visibility(Lifecycle.Read) + agent?: OptimizationAgentIdentifier; + + @doc("Progress snapshot. May be present in terminal states reflecting last-known progress.") @visibility(Lifecycle.Read) progress?: OptimizationJobProgress; - @doc("Metadata about the dataset used for this optimization job.") + @doc("Error details — populated only on failure.") @visibility(Lifecycle.Read) - dataset?: DatasetInfo; + error?: ApiError; } // --------------------------------------------------------------------------- @@ -293,128 +360,4 @@ model PromotionInfo { @doc("Version of the Foundry agent this candidate was promoted to.") agent_version: string; -} - -@doc("Request body for promoting a candidate to a Foundry agent version.") -model PromoteCandidateRequest { - @doc("Name of the Foundry agent to promote to.") - agent_name: string; - - @doc("Version of the Foundry agent to promote to.") - agent_version: string; -} - -@doc("Response after successfully promoting a candidate.") -model PromoteCandidateResponse { - @doc("The promoted candidate id.") - candidate_id: string; - - @doc("Status after promotion.") - status: string; - - @doc("Timestamp when promotion occurred, represented in Unix time.") - promoted_at: FoundryTimestamp; - - @doc("Name of the Foundry agent promoted to.") - agent_name: string; - - @doc("Version of the Foundry agent promoted to.") - agent_version: string; -} - -// --------------------------------------------------------------------------- -// Dataset info model -// --------------------------------------------------------------------------- - -@doc("Metadata about the dataset used for optimization, surfaced in the response.") -model DatasetInfo { - @doc("Dataset name when using a registered dataset reference. Null for inline datasets.") - name?: string; - - @doc("Dataset version when using a registered dataset reference. Null for inline datasets.") - version?: string; - - @doc("Number of tasks/rows in the dataset.") - task_count: int32; - - @doc("True when the dataset was provided inline in the request body.") - is_inline: boolean; -} - -// --------------------------------------------------------------------------- -// Candidate sub-resource bodies -// --------------------------------------------------------------------------- - -@doc("Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version.") -model CandidateDeployConfig { - @doc("System prompt / instructions.") - instructions?: string; - - @doc("Foundry deployment name.") - `model`?: string; - - @doc("Optional sampling temperature.") - @minValue(0) - @maxValue(2) - temperature?: float32; - - @doc("Optional skill overrides.") - skills?: Record[]; - - @doc("Optional tool overrides.") - tools?: Record[]; -} - -@doc("Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results.") -model CandidateResults { - @doc("Owning candidate id.") - candidate_id: string; - - @doc("Per-task evaluation rows.") - results: OptimizationTaskResult[]; -} - -@doc("Candidate metadata returned by GET /candidates/{id}.") -model CandidateMetadata { - @doc("Server-assigned candidate identifier.") - candidate_id: string; - - @doc("Owning optimization job id.") - job_id: string; - - @doc("Display name of the candidate.") - candidate_name: string; - - @doc("Candidate lifecycle status.") - status: string; - - @doc("Candidate's aggregate score.") - score?: float64; - - @doc("Whether detailed results are available for this candidate.") - has_results: boolean; - - @doc("Timestamp when the candidate was created, represented in Unix time.") - created_at: FoundryTimestamp; - - @doc("Timestamp when the candidate was last updated, represented in Unix time.") - updated_at: FoundryTimestamp; - - @doc("Promotion metadata. Null if not promoted.") - promotion?: PromotionInfo; - - @doc("Files in the candidate's blob directory.") - files: CandidateFileInfo[]; -} - -@doc("File entry in a candidate's blob directory.") -model CandidateFileInfo { - @doc("Relative path of the file.") - path: string; - - @doc("File type category (e.g. 'config', 'results').") - type: string; - - @doc("File size in bytes.") - size_bytes: int64; -} +} \ No newline at end of file diff --git a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/routes.tsp b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/routes.tsp index ebfe2af1ae8f..c7e64d82aa3b 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/routes.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/routes.tsp @@ -15,7 +15,7 @@ namespace Azure.AI.Projects; const AgentOptimizationRequiredPreviews = #{ conditional_previews: #[ - FoundryFeaturesOptInKeys.agents_optimization_v1_preview + FoundryFeaturesOptInKeys.agents_optimization_v2_preview ], }; @@ -28,55 +28,31 @@ const AgentOptimizationRequiredPreviews = #{ #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "LRO polling is handled by the client via Operation-Location" @tag("AgentOptimizationJobs") interface AgentOptimizationJobs { - /** - * Creates an agent optimization job and returns the queued job. - * Honors `Operation-Id` for idempotent retry. - */ - @summary("Create an agent optimization job") + @summary("Creates an agent optimization job.") + @doc("Create an optimization job. Returns 201 with the queued job. Honours `Operation-Id` for idempotent retry.") @route("agent_optimization_jobs") @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @post - create is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - ...WithOperationId; - - @doc("The optimization job inputs.") - @body - inputs: OptimizationJobInputs; - }, - JobCreatedResponse + create is postJobPreview< + FoundryFeaturesOptInKeys.agents_optimization_v2_preview, + OptimizationJob >; - /** - * Retrieves the specified agent optimization job. - * Returns 202 while the job is in progress and 200 after it reaches a terminal state. - */ - @summary("Get an agent optimization job") + @summary("Get info about an agent optimization job.") + @doc("Get an optimization job by id.") @route("agent_optimization_jobs/{jobId}") @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @get - get is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - /** The ID of the job. */ - @path jobId: string; - }, - OptimizationJob & { - @statusCode _: 200 | 202; - @header("Retry-After") retryAfter?: int32; - } + get is queryJobStatusPreview< + FoundryFeaturesOptInKeys.agents_optimization_v2_preview, + OptimizationJob >; - /** - * Returns agent optimization jobs with cursor pagination and optional lifecycle or agent filters. - */ - @summary("List agent optimization jobs") + @summary("Returns a list of agent optimization jobs.") + @doc("List optimization jobs. Supports cursor pagination and optional status / agent_name filters.") @route("agent_optimization_jobs") @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) list is listJobsPreview< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - OptimizationJob, + FoundryFeaturesOptInKeys.agents_optimization_v2_preview, + OptimizationJobListItem, { @doc("Filter to jobs in this lifecycle state.") @query @@ -88,175 +64,19 @@ interface AgentOptimizationJobs { } >; - /** - * Requests cancellation of the specified agent optimization job. - * The operation remains idempotent after the job reaches a terminal state. - */ - @summary("Cancel an agent optimization job") + @summary("Cancels an agent optimization job.") + @doc("Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.") @route("agent_optimization_jobs/{jobId}:cancel") @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) cancel is cancelJobPreview< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, + FoundryFeaturesOptInKeys.agents_optimization_v2_preview, OptimizationJob >; - /** - * Deletes the specified agent optimization job and its candidate artifacts. - * Cancels the job first when it is still in a non-terminal state. - */ - @summary("Delete an agent optimization job") + @summary("Deletes an agent optimization job.") + @doc("Delete the job and its candidate artifacts. Cancels first if non-terminal.") @route("agent_optimization_jobs/{jobId}") @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @delete - delete is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The ID of the job to delete.") - @path - jobId: string; - - @doc("When true, force-delete even if the job is in a non-terminal state.") - @query - force?: boolean; - }, - NoContentResponse - >; - - // --------------------------------------------------------------------------- - // Candidate sub-resource operations - // --------------------------------------------------------------------------- - - /** - * Returns the candidates produced by the specified optimization job. - */ - @summary("List optimization job candidates") - @route("agent_optimization_jobs/{jobId}/candidates") - @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @get - @list - listCandidates is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The optimization job id.") - @path - jobId: string; + delete is deleteJobPreview; - ...CommonPageQueryParameters; - }, - AgentsPagedResult - >; - - /** - * Retrieves metadata, manifest information, and promotion details for the specified candidate. - */ - @summary("Get an optimization candidate") - @route("agent_optimization_jobs/{jobId}/candidates/{candidateId}") - @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @get - getCandidate is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The optimization job id.") - @path - jobId: string; - - @doc("The candidate id.") - @path - candidateId: string; - }, - CandidateMetadata - >; - - /** - * Retrieves the deploy configuration JSON for the specified candidate. - * Clients can use it to compose `agents.create_version(...)` requests. - */ - @summary("Get an optimization candidate config") - @route("agent_optimization_jobs/{jobId}/candidates/{candidateId}/config") - @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @get - getCandidateConfig is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The optimization job id.") - @path - jobId: string; - - @doc("The candidate id.") - @path - candidateId: string; - }, - CandidateDeployConfig - >; - - /** - * Retrieves full per-task evaluation results for the specified candidate. - */ - @summary("Get optimization candidate results") - @route("agent_optimization_jobs/{jobId}/candidates/{candidateId}/results") - @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @get - getCandidateResults is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The optimization job id.") - @path - jobId: string; - - @doc("The candidate id.") - @path - candidateId: string; - }, - CandidateResults - >; - - /** - * Streams the specified file from the candidate's blob directory. - */ - @summary("Get an optimization candidate file") - @route("agent_optimization_jobs/{jobId}/candidates/{candidateId}/files") - @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @get - getCandidateFile is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The optimization job id.") - @path - jobId: string; - - @doc("The candidate id.") - @path - candidateId: string; - - @doc("Relative path of the file to download (e.g. 'files/examples.jsonl').") - @query - path: string; - }, - bytes - >; - - /** - * Promotes the specified candidate and records the deployment timestamp and target agent version. - */ - @summary("Promote an optimization candidate") - @route("agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote") - @extension("x-ms-foundry-meta", AgentOptimizationRequiredPreviews) - @post - promoteCandidate is FoundryDataPlanePreviewOperation< - FoundryFeaturesOptInKeys.agents_optimization_v1_preview, - { - @doc("The optimization job id.") - @path - jobId: string; - - @doc("The candidate id to promote.") - @path - candidateId: string; - - @doc("Promotion details.") - @body - candidate_request: PromoteCandidateRequest; - }, - PromoteCandidateResponse - >; } diff --git a/specification/ai-foundry/data-plane/Foundry/src/servicepatterns.tsp b/specification/ai-foundry/data-plane/Foundry/src/servicepatterns.tsp index 7092b5c8bc8b..23e480d4cb0d 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/servicepatterns.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/servicepatterns.tsp @@ -125,7 +125,7 @@ union FoundryFeaturesOptInKeys { skills_v1_preview: "Skills=V1Preview", data_generation_jobs_v1_preview: "DataGenerationJobs=V1Preview", models_v1_preview: "Models=V1Preview", - agents_optimization_v1_preview: "AgentsOptimization=V1Preview", + agents_optimization_v2_preview: "AgentsOptimization=V2Preview", } alias WithRequiredFoundryPreviewHeader Date: Thu, 11 Jun 2026 16:53:36 -0700 Subject: [PATCH 2/5] resolve missing file --- .../Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml diff --git a/.github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml b/.github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml new file mode 100644 index 000000000000..a73ff4c971fd --- /dev/null +++ b/.github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSql/lease.yaml @@ -0,0 +1,5 @@ +lease: + resource-provider: Microsoft.DBforPostgreSQL + startdate: "2026-06-05" + duration: P180D + reviewer: "@vikeshi26" From ac5641ee6687e85ce994c513b8ecc5b0e5b5fb21 Mon Sep 17 00:00:00 2001 From: jessli Date: Thu, 11 Jun 2026 17:13:12 -0700 Subject: [PATCH 3/5] address comment for minValue of max_candidates --- .../v1/microsoft-foundry-openapi3.json | 3826 +++++++- .../v1/microsoft-foundry-openapi3.yaml | 4793 +++++++--- .../microsoft-foundry-openapi3.json | 7766 +++++++++++++---- .../microsoft-foundry-openapi3.yaml | 4840 +++++++--- .../src/agents-optimization/models.tsp | 1 + 5 files changed, 16284 insertions(+), 4942 deletions(-) diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json index b0bff6ecd0e6..ff7cf40bb8bb 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json @@ -12499,7 +12499,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -12509,12 +12510,18 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { "anyOf": [ @@ -12550,15 +12557,6 @@ } ] }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "anyOf": [ { @@ -12726,6 +12724,16 @@ } ] }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, "agent_reference": { "anyOf": [ { @@ -12845,7 +12853,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -12855,12 +12864,18 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { "anyOf": [ @@ -12896,15 +12911,6 @@ } ] }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "anyOf": [ { @@ -13051,6 +13057,16 @@ ], "description": "Context management configuration for this request." }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, "agent_reference": { "allOf": [ { @@ -21961,7 +21977,9 @@ }, "discriminator": { "propertyName": "type", - "mapping": {} + "mapping": { + "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" + } }, "description": "Base class for run data sources with discriminator support." }, @@ -25938,7 +25956,8 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", + "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -27775,6 +27794,12 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ + "gpt-5.4", + "gpt-5.4-mini", + "gpt-5.4-nano", + "gpt-5.4-mini-2026-03-17", + "gpt-5.4-nano-2026-03-17", + "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -27899,6 +27924,19 @@ } ], "description": "The y-coordinate where the click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -28089,8 +28127,44 @@ ] }, "instructions": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_key": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_retention": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" + }, + { + "type": "null" + } + ] + }, + "service_tier": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" + }, + { + "type": "null" + } + ] } } }, @@ -28110,7 +28184,9 @@ "gt", "gte", "lt", - "lte" + "lte", + "in", + "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -28212,6 +28288,14 @@ } } }, + "OpenAI.ComputerActionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerAction" + }, + "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", + "title": "Computer Action List" + }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -28281,7 +28365,8 @@ "required": [ "type", "image_url", - "file_id" + "file_id", + "detail" ], "properties": { "type": { @@ -28304,8 +28389,22 @@ ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ImageDetail" + } + ], + "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -28343,6 +28442,29 @@ }, "description": "A computer screenshot image used with the computer use tool." }, + "OpenAI.ComputerTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ], + "description": "The type of the computer tool. Always `computer`.", + "x-stainless-const": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", + "title": "Computer" + }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -28530,14 +28652,6 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." - }, - "domain_secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" - }, - "minItems": 1, - "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -28567,32 +28681,6 @@ } ] }, - "OpenAI.ContainerNetworkPolicyDomainSecretParam": { - "type": "object", - "required": [ - "domain", - "name", - "value" - ], - "properties": { - "domain": { - "type": "string", - "minLength": 1, - "description": "The domain associated with the secret." - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the secret to inject for the domain." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 10485760, - "description": "The secret value to inject for the domain." - } - } - }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -28721,14 +28809,18 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", + "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -28740,13 +28832,57 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", "title": "Conversation item" }, + "OpenAI.ConversationItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemApplyPatchToolCall": { "type": "object", "required": [ @@ -28939,13 +29075,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ConversationItemCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -28969,6 +29142,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -28994,10 +29170,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutputResource": { + "OpenAI.ConversationItemComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -29013,7 +29190,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -29043,56 +29221,17 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] - }, - "OpenAI.ConversationItemCustomToolCall": { - "type": "object", - "required": [ - "type", - "call_id", - "name", - "input" ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call" - ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." - }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." - }, - "input": { - "type": "string", - "description": "The input for the custom tool call generated by the model." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ConversationItemCustomToolCallOutput": { + "OpenAI.ConversationItemCustomToolCallOutputResource": { "type": "object", "required": [ "type", "call_id", - "output" + "output", + "status" ], "properties": { "type": { @@ -29124,6 +29263,18 @@ } ], "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -29131,8 +29282,65 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "The output of a custom tool call from your code, being sent back to the model.", - "title": "Custom tool call output" + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ConversationItemCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "title": "ResponseCustomToolCallItem" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -29234,7 +29442,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -29293,7 +29501,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -29328,43 +29536,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCallOutputResource": { + "OpenAI.ConversationItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -29380,40 +29589,49 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ConversationItemFunctionToolCallResource": { + "OpenAI.ConversationItemFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -29429,7 +29647,9 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -29747,8 +29967,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -29879,6 +30098,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -29951,6 +30180,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ConversationItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, + "OpenAI.ConversationItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -29967,7 +30328,11 @@ "image_generation_call", "computer_call", "computer_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", + "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -30156,7 +30521,8 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", + "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -31161,6 +31527,10 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -31233,7 +31603,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.DoubleClickAction": { @@ -31241,7 +31612,8 @@ "required": [ "type", "x", - "y" + "y", + "keys" ], "properties": { "type": { @@ -31267,6 +31639,19 @@ } ], "description": "The y-coordinate where the double click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -31298,6 +31683,19 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -31337,6 +31735,16 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "type": { "type": "string", "enum": [ @@ -31363,6 +31771,9 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, + "OpenAI.EmptyModelParam": { + "type": "object" + }, "OpenAI.Error": { "type": "object", "required": [ @@ -32415,6 +32826,13 @@ "description": "A citation to a file.", "title": "File citation" }, + "OpenAI.FileInputDetail": { + "type": "string", + "enum": [ + "low", + "high" + ] + }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -33387,14 +33805,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -33448,7 +33874,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -33511,6 +33937,22 @@ "incomplete" ] }, + "OpenAI.FunctionCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -33947,6 +34389,14 @@ } ] }, + "OpenAI.FunctionShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -33993,6 +34443,14 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, + "OpenAI.FunctionShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -34175,8 +34633,18 @@ ] }, "strict": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "defer_loading": { "type": "boolean", - "nullable": true + "description": "Whether this function is deferred and loaded via tool search." } }, "allOf": [ @@ -34187,61 +34655,62 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolCallOutput": { + "OpenAI.FunctionToolParam": { "type": "object", "required": [ - "type", - "call_id", - "output" + "name", + "type" ], "properties": { - "id": { + "name": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_-]+$" }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] }, - "output": { - "oneOf": [ + "strict": { + "anyOf": [ { - "type": "string" + "type": "boolean" }, { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "type": "null" } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + ] }, - "status": { + "type": { "type": "string", "enum": [ - "in_progress", - "completed", - "incomplete" + "function" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" + "x-stainless-const": true, + "default": "function" + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function should be deferred and discovered via tool search." } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + } }, "OpenAI.GraderLabelModel": { "type": "object", @@ -34589,7 +35058,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.ImageGenActionEnum": { @@ -34642,14 +35112,21 @@ "default": "auto" }, "size": { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" + ] + } ], - "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", + "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { @@ -34784,7 +35261,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -34955,14 +35432,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -35016,7 +35501,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -35108,14 +35593,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -35167,9 +35660,23 @@ ] }, "file_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -35218,7 +35725,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -35296,6 +35803,9 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -35316,6 +35826,56 @@ }, "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs." }, + "OpenAI.InputItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -35627,7 +36187,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -35651,6 +36210,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -35701,6 +36263,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -36044,6 +36610,7 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -36052,7 +36619,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -36066,6 +36634,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -36366,8 +36938,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -36490,6 +37061,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -36570,6 +37151,143 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.InputItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, + "OpenAI.InputItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemType": { "anyOf": [ { @@ -36586,6 +37304,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -36661,52 +37382,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.InputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -36715,55 +37390,6 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, - "OpenAI.InputMessageResource": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.InputParam": { "oneOf": [ { @@ -36840,7 +37466,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessage", + "message": "#/components/schemas/OpenAI.ItemInputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -36848,6 +37474,9 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.ItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -36868,6 +37497,56 @@ }, "description": "Content item used to generate a response." }, + "OpenAI.ItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -37179,7 +37858,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -37203,6 +37881,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -37253,6 +37934,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -37330,14 +38015,17 @@ "discriminator": { "propertyName": "type", "mapping": { - "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", + "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemFieldAdditionalTools", + "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -37357,6 +38045,50 @@ }, "description": "An item representing a message, tool call, tool output, reasoning, or other response element." }, + "OpenAI.ItemFieldAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldApplyPatchToolCall": { "type": "object", "required": [ @@ -37593,7 +38325,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -37617,6 +38348,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -37642,10 +38376,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutputResource": { + "OpenAI.ItemFieldComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -37661,7 +38396,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -37691,7 +38427,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -37718,6 +38456,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -37882,7 +38624,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -37941,7 +38683,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -37979,6 +38721,7 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -37987,7 +38730,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -38001,6 +38745,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -38027,6 +38775,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.ItemFieldFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -38296,8 +39102,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -38428,6 +39233,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38500,6 +39315,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ItemFieldToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, + "OpenAI.ItemFieldToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldType": { "anyOf": [ { @@ -38510,6 +39457,9 @@ "enum": [ "message", "function_call", + "tool_search_call", + "tool_search_output", + "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -38868,6 +39818,7 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -38876,7 +39827,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -38890,6 +39842,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -38966,6 +39922,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -39190,8 +40199,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -39314,6 +40322,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -39435,14 +40453,19 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessageResource", + "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemResourceAdditionalTools", + "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", + "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -39454,11 +40477,57 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", + "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" } }, "description": "Content item used to generate a response." }, + "OpenAI.ItemResourceAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceApplyPatchToolCall": { "type": "object", "required": [ @@ -39651,13 +40720,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ItemResourceCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -39681,6 +40787,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -39706,10 +40815,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutputResource": { + "OpenAI.ItemResourceComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -39725,7 +40835,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -39755,7 +40866,126 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.ItemResourceCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ItemResourceCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallItem" }, "OpenAI.ItemResourceFileSearchToolCall": { "type": "object", @@ -39857,7 +41087,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -39916,7 +41146,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -39951,63 +41181,10 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCallOutputResource": { - "type": "object", - "required": [ - "type", - "call_id", - "output" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." - }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true - }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, - "OpenAI.ItemResourceFunctionToolCallResource": { + "OpenAI.ItemResourceFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -40016,7 +41193,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -40030,6 +41208,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -40052,7 +41234,67 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" + }, + "OpenAI.ItemResourceFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ItemResourceImageGenToolCall": { "type": "object", @@ -40104,6 +41346,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemResourceInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", "required": [ @@ -40323,8 +41618,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -40447,6 +41741,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -40465,6 +41769,200 @@ "description": "An output message from the model.", "title": "Output message" }, + "OpenAI.ItemResourceReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.ItemResourceToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceType": { "anyOf": [ { @@ -40481,6 +41979,11 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", + "reasoning", + "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -40493,6 +41996,8 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", + "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -40575,6 +42080,143 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.ItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, + "OpenAI.ItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemType": { "anyOf": [ { @@ -40591,6 +42233,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -40845,22 +42490,6 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.LocalShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -41160,6 +42789,10 @@ ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -41240,7 +42873,8 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", + "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" } }, "description": "A content part that makes up an input or output item." @@ -41274,14 +42908,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -41335,7 +42977,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -41498,6 +43140,14 @@ } ] }, + "OpenAI.MessagePhase": { + "type": "string", + "enum": [ + "commentary", + "final_answer" + ], + "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." + }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -41784,6 +43434,19 @@ } ], "description": "The y-coordinate to move to." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41794,6 +43457,57 @@ "description": "A mouse move action.", "title": "Move" }, + "OpenAI.NamespaceToolParam": { + "type": "object", + "required": [ + "type", + "name", + "description", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "namespace" + ], + "description": "The type of the tool. Always `namespace`.", + "x-stainless-const": true + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The namespace name used in tool calls (for example, `crm`)." + }, + "description": { + "type": "string", + "minLength": 1, + "description": "A description of the namespace shown to the model." + }, + "tools": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionToolParam" + }, + { + "$ref": "#/components/schemas/OpenAI.CustomToolParam" + } + ] + }, + "minItems": 1, + "description": "The function/custom tools available inside this namespace." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Groups function/custom tools under a shared namespace.", + "title": "Namespace" + }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -41982,13 +43696,19 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", + "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", + "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.OutputItemAdditionalTools", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", + "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -41996,10 +43716,56 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" + "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" } } }, + "OpenAI.OutputItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemApplyPatchToolCall": { "type": "object", "required": [ @@ -42236,7 +44002,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -42260,6 +44025,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -42285,13 +44053,128 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemCustomToolCall": { + "OpenAI.OutputItemComputerToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_call_output" + ], + "description": "The type of the computer tool call output. Always `computer_call_output`.", + "x-stainless-const": true, + "default": "computer_call_output" + }, + "id": { + "type": "string", + "description": "The ID of the computer tool call output.", + "readOnly": true + }, + "call_id": { + "type": "string", + "description": "The ID of the computer tool call that produced the output." + }, + "acknowledged_safety_checks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "description": "The safety checks reported by the API that have been acknowledged by the\n developer." + }, + "output": { + "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.OutputItemCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.OutputItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", "name", - "input" + "input", + "status" ], "properties": { "type": { @@ -42310,6 +44193,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -42317,6 +44204,18 @@ "input": { "type": "string", "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -42324,8 +44223,7 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallItem" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -42427,7 +44325,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -42486,7 +44384,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -42524,6 +44422,7 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -42532,7 +44431,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -42546,6 +44446,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -42572,6 +44476,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.OutputItemFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", "required": [ @@ -42669,6 +44631,54 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, + "OpenAI.OutputItemLocalShellToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "local_shell_call_output" + ], + "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the local shell tool call generated by the model." + }, + "output": { + "type": "string", + "description": "A JSON string of the output of the local shell tool call." + }, + "status": { + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a local shell tool call.", + "title": "Local shell call output" + }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -42712,6 +44722,54 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, + "OpenAI.OutputItemMcpApprovalResponseResource": { + "type": "object", + "required": [ + "type", + "id", + "approval_request_id", + "approve" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_approval_response" + ], + "description": "The type of the item. Always `mcp_approval_response`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the approval response" + }, + "approval_request_id": { + "type": "string", + "description": "The ID of the approval request being answered." + }, + "approve": { + "type": "boolean", + "description": "Whether the request was approved." + }, + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A response to an MCP approval request.", + "title": "MCP approval response" + }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -42745,8 +44803,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -42869,6 +44926,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -42949,6 +45016,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.OutputItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, + "OpenAI.OutputItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemType": { "anyOf": [ { @@ -42960,13 +45159,19 @@ "output_message", "file_search_call", "function_call", + "function_call_output", "web_search_call", "computer_call", + "computer_call_output", "reasoning", + "tool_search_call", + "tool_search_output", + "additional_tools", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", + "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -42974,7 +45179,9 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", + "mcp_approval_response", "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -43195,6 +45402,13 @@ }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, + "OpenAI.PromptCacheRetentionEnum": { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -43231,6 +45445,123 @@ } } }, + "OpenAI.RealtimeMCPError": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", + "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", + "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" + } + } + }, + "OpenAI.RealtimeMCPHTTPError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "http_error" + ], + "x-stainless-const": true + }, + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP HTTP error" + }, + "OpenAI.RealtimeMCPProtocolError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "protocol_error" + ], + "x-stainless-const": true + }, + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP protocol error" + }, + "OpenAI.RealtimeMCPToolExecutionError": { + "type": "object", + "required": [ + "type", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_execution_error" + ], + "x-stainless-const": true + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP tool execution error" + }, + "OpenAI.RealtimeMcpErrorType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "protocol_error", + "tool_execution_error", + "http_error" + ] + } + ] + }, "OpenAI.Reasoning": { "type": "object", "properties": { @@ -43377,7 +45708,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -43387,12 +45719,18 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { "anyOf": [ @@ -43428,15 +45766,6 @@ } ] }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "anyOf": [ { @@ -43604,6 +45933,16 @@ } ] }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, "agent_reference": { "anyOf": [ { @@ -43655,6 +45994,11 @@ "description": "A chunk of Base64 encoded response audio bytes." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -43686,6 +46030,11 @@ "description": "The sequence number of the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -43722,6 +46071,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -43753,6 +46107,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -43803,6 +46162,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -43853,6 +46217,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -43898,6 +46267,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -43943,6 +46317,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -43988,6 +46367,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -44028,6 +46412,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -44091,6 +46480,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -44154,6 +46548,11 @@ "description": "The content part that is done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -44194,6 +46593,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -44244,6 +46648,11 @@ "description": "The incremental input data (delta) for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -44295,6 +46704,11 @@ "description": "The complete input data for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -44395,6 +46809,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -44435,6 +46854,11 @@ "description": "The response that failed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -44480,6 +46904,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -44525,6 +46954,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -44570,6 +47004,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -44722,6 +47161,11 @@ "description": "The function-call arguments delta that is added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -44776,6 +47220,11 @@ "description": "The function-call arguments." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -44821,6 +47270,11 @@ "description": "The unique identifier of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -44867,6 +47321,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -44913,6 +47372,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -44973,6 +47437,11 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -45014,6 +47483,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -45066,6 +47540,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -45097,7 +47576,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probability of the top 20 most likely tokens." + "description": "The log probabilities of up to 20 of the most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -45156,6 +47635,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -45207,6 +47691,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -45253,6 +47742,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -45299,6 +47793,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -45345,6 +47844,11 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -45391,6 +47895,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -45437,6 +47946,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -45483,6 +47997,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -45533,6 +48052,11 @@ "description": "The output item that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -45582,6 +48106,11 @@ "description": "The output item that was marked done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -45654,6 +48183,11 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -45718,6 +48252,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -45782,6 +48321,11 @@ "description": "The summary part that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -45864,6 +48408,11 @@ "description": "The completed summary part." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -45942,6 +48491,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -46001,6 +48555,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -46060,6 +48619,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -46119,6 +48683,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -46178,6 +48747,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -46237,6 +48811,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -46244,6 +48823,140 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, + "OpenAI.ResponseStreamEvent": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", + "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", + "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", + "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", + "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", + "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", + "error": "#/components/schemas/OpenAI.ResponseErrorEvent", + "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", + "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", + "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", + "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", + "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", + "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", + "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", + "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", + "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", + "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", + "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", + "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", + "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", + "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", + "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", + "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", + "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", + "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", + "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", + "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", + "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", + "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", + "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", + "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", + "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", + "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", + "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", + "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", + "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", + "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", + "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", + "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", + "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", + "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", + "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", + "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", + "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", + "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", + "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", + "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", + "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", + "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", + "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", + "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", + "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", + "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" + } + } + }, + "OpenAI.ResponseStreamEventType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "response.audio.delta", + "response.audio.done", + "response.audio.transcript.delta", + "response.audio.transcript.done", + "response.code_interpreter_call_code.delta", + "response.code_interpreter_call_code.done", + "response.code_interpreter_call.completed", + "response.code_interpreter_call.in_progress", + "response.code_interpreter_call.interpreting", + "response.completed", + "response.content_part.added", + "response.content_part.done", + "response.created", + "error", + "response.file_search_call.completed", + "response.file_search_call.in_progress", + "response.file_search_call.searching", + "response.function_call_arguments.delta", + "response.function_call_arguments.done", + "response.in_progress", + "response.failed", + "response.incomplete", + "response.output_item.added", + "response.output_item.done", + "response.reasoning_summary_part.added", + "response.reasoning_summary_part.done", + "response.reasoning_summary_text.delta", + "response.reasoning_summary_text.done", + "response.reasoning_text.delta", + "response.reasoning_text.done", + "response.refusal.delta", + "response.refusal.done", + "response.output_text.delta", + "response.output_text.done", + "response.web_search_call.completed", + "response.web_search_call.in_progress", + "response.web_search_call.searching", + "response.image_generation_call.completed", + "response.image_generation_call.generating", + "response.image_generation_call.in_progress", + "response.image_generation_call.partial_image", + "response.mcp_call_arguments.delta", + "response.mcp_call_arguments.done", + "response.mcp_call.completed", + "response.mcp_call.failed", + "response.mcp_call.in_progress", + "response.mcp_list_tools.completed", + "response.mcp_list_tools.failed", + "response.mcp_list_tools.in_progress", + "response.output_text.annotation.added", + "response.queued", + "response.custom_tool_call_input.delta", + "response.custom_tool_call_input.done" + ] + } + ] + }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -46314,6 +49027,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -46381,6 +49099,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -46513,6 +49236,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -46558,6 +49286,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -46603,6 +49336,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -46682,6 +49420,19 @@ } ], "description": "The vertical scroll distance." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -46692,6 +49443,13 @@ "description": "A scroll action.", "title": "Scroll" }, + "OpenAI.SearchContentType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -46718,6 +49476,15 @@ ], "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter." }, + "OpenAI.ServiceTierEnum": { + "type": "string", + "enum": [ + "auto", + "default", + "flex", + "priority" + ] + }, "OpenAI.SkillReferenceParam": { "type": "object", "required": [ @@ -47015,7 +49782,10 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", + "computer": "#/components/schemas/OpenAI.ComputerTool", + "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", + "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -47081,6 +49851,46 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolChoiceComputer": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, + "OpenAI.ToolChoiceComputerUse": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_use" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -47269,7 +50079,9 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", + "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", + "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -47293,7 +50105,9 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter" + "code_interpreter", + "computer", + "computer_use" ] } ] @@ -47338,6 +50152,64 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolSearchExecutionType": { + "type": "string", + "enum": [ + "server", + "client" + ] + }, + "OpenAI.ToolSearchToolParam": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search" + ], + "description": "The type of the tool. Always `tool_search`.", + "x-stainless-const": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search is executed by the server or by the client." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Hosted or BYOT tool search configuration for deferred tools.", + "title": "Tool search tool" + }, "OpenAI.ToolType": { "anyOf": [ { @@ -47348,6 +50220,7 @@ "enum": [ "function", "file_search", + "computer", "computer_use_preview", "web_search", "mcp", @@ -47356,6 +50229,8 @@ "local_shell", "shell", "custom", + "namespace", + "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -47625,8 +50500,7 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type", - "query" + "type" ], "properties": { "type": { @@ -47639,7 +50513,7 @@ }, "query": { "type": "string", - "description": "[DEPRECATED] The search query.", + "description": "The search query.", "deprecated": true }, "queries": { @@ -47677,7 +50551,8 @@ "x-stainless-const": true }, "url": { - "type": "string" + "type": "string", + "format": "uri" } } }, @@ -47771,6 +50646,12 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." + }, + "search_content_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SearchContentType" + } } }, "allOf": [ @@ -48683,6 +51564,7 @@ "max_candidates": { "type": "integer", "format": "int32", + "minimum": 1, "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", "default": 5 }, diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml index 04878c37b0c2..4db528f145d3 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml @@ -1,33 +1,117 @@ -openapi: 3.0.0 +openapi: 3.2.0 info: title: Microsoft Foundry version: v1 tags: + - name: Fine-Tuning + - name: Responses Root + description: Responses + - name: Responses + parent: Responses Root + description: Responses (OpenAI) + - name: Conversations + parent: Responses Root + description: Conversations (OpenAI) + - name: Agents Root + description: Agents - name: Agents - - name: Agent Session Files + parent: Agents Root + description: Agent Management - name: Agent Invocations - - name: Connections + parent: Agents Root + - name: Agent Invocations WebSocket + parent: Agents Root + description: Agent Invocations (WebSocket) + - name: Agent Sessions + parent: Agents Root + - name: Agent Session Files + parent: Agents Root + - name: Agent Versions + parent: Agents Root + - name: Agent Containers + parent: Agents Root + - name: Platform APIs - name: Datasets - - name: Deployments - - name: Evaluation Taxonomies - - name: Evaluation Rules - - name: Evaluators - - name: EvaluatorGenerationJobs + parent: Platform APIs - name: Indexes - - name: Insights + parent: Platform APIs + - name: Connections + parent: Platform APIs + - name: Scheduler + parent: Platform APIs + - name: Fine-tuning + parent: Platform APIs + summary: Fine-Tuning - name: Models + parent: Platform APIs - name: Memory Stores - - name: Conversations - - name: Evals - - name: Fine-Tuning - - name: Responses - - name: Redteams + parent: Platform APIs + - name: Chat + parent: Platform APIs + - name: Assistants + parent: Platform APIs + - name: Audio + parent: Platform APIs + - name: Batch + parent: Platform APIs + - name: Completions + parent: Platform APIs + - name: Containers + parent: Platform APIs + - name: Embeddings + parent: Platform APIs + - name: Files + parent: Platform APIs + - name: Images + parent: Platform APIs + - name: Moderations + parent: Platform APIs + - name: Realtime + parent: Platform APIs + - name: Threads + parent: Platform APIs + - name: Uploads + parent: Platform APIs + - name: Vector stores + parent: Platform APIs + summary: Vector Stores + - name: Videos + parent: Platform APIs - name: Routines + parent: Platform APIs - name: Schedules + parent: Platform APIs - name: Skills + parent: Platform APIs - name: Toolboxes + parent: Platform APIs + - name: Deployments + parent: Platform APIs - name: DataGenerationJobs + parent: Platform APIs + summary: Data generation jobs - name: AgentOptimizationJobs + parent: Platform APIs + summary: Agent optimization jobs + - name: EvaluatorGenerationJobs + parent: Platform APIs + summary: Evaluator generation jobs + - name: Evaluations + - name: Evals + parent: Evaluations + - name: Evaluation Rules + parent: Evaluations + - name: Evaluators + parent: Evaluations + - name: Evaluation Taxonomies + parent: Evaluations + - name: Redteams + parent: Evaluations + summary: Red Teaming + - name: Evalsuite + parent: Evaluations + - name: Insights + parent: Evaluations paths: /agent_optimization_jobs: post: @@ -824,8 +908,7 @@ paths: content: application/zip: schema: - type: string - format: binary + contentMediaType: application/zip 4XX: description: Client error content: @@ -959,7 +1042,7 @@ paths: application/json: schema: type: object - additionalProperties: {} + unevaluatedProperties: {} 4XX: description: Client error content: @@ -1179,7 +1262,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions requestBody: required: true content: @@ -1300,7 +1383,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1565,8 +1648,7 @@ paths: content: application/octet-stream: schema: - type: string - format: binary + contentMediaType: application/octet-stream x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -1623,8 +1705,7 @@ paths: content: application/octet-stream: schema: - type: string - format: binary + contentMediaType: application/octet-stream 4XX: description: Client error content: @@ -1701,7 +1782,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1761,7 +1842,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1814,7 +1895,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1932,7 +2013,7 @@ paths: required_previews: - CodeAgents=V1Preview tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -2042,7 +2123,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion @@ -2088,7 +2169,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions delete: operationId: Agents_deleteAgentVersion summary: Delete an agent version @@ -2144,7 +2225,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream: get: operationId: Agents_getSessionLogStream @@ -2230,7 +2311,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -2278,7 +2359,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -5149,7 +5230,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -5326,7 +5407,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -6443,9 +6524,10 @@ paths: format: uri description: URL to poll for operation status. operationResult: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: URL to the operation result, or null if the operation is still in progress. 4XX: description: Client error @@ -7162,8 +7244,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -7391,8 +7472,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -7641,8 +7721,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -8148,26 +8227,22 @@ paths: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -8178,44 +8253,41 @@ paths: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -8227,11 +8299,12 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled id: type: string @@ -8259,19 +8332,20 @@ paths: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - nullable: true + - type: 'null' incomplete_details: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - nullable: true + - type: 'null' output: type: array items: @@ -8290,26 +8364,33 @@ paths: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' output_text: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - nullable: true + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent_reference: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/AgentReference' - nullable: true + - type: 'null' description: The agent used for this response content_filters: type: array @@ -8351,26 +8432,22 @@ paths: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -8381,44 +8458,41 @@ paths: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -8430,55 +8504,69 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled input: $ref: '#/components/schemas/OpenAI.InputParam' include: - type: array - items: - $ref: '#/components/schemas/OpenAI.IncludeEnum' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.IncludeEnum' + - type: 'null' parallel_tool_calls: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' default: true store: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' default: true instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ModerationParam' + - type: 'null' stream: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' stream_options: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - nullable: true + - type: 'null' conversation: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationParam' - nullable: true + - type: 'null' context_management: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContextManagementParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ContextManagementParam' + - type: 'null' description: Context management configuration for this request. + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent_reference: allOf: - $ref: '#/components/schemas/AgentReference' description: The agent to use for generating the response. structured_inputs: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. get: operationId: listResponses @@ -10110,8 +10198,7 @@ paths: content: application/zip: schema: - type: string - format: binary + contentMediaType: application/zip 4XX: description: Client error content: @@ -10465,8 +10552,7 @@ paths: content: application/zip: schema: - type: string - format: binary + contentMediaType: application/zip 4XX: description: Client error content: @@ -10798,7 +10884,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -11215,7 +11301,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -11900,10 +11986,11 @@ components: - definition properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -12396,7 +12483,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -12775,7 +12862,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -12820,7 +12907,7 @@ components: description: The Azure Function Tool definition. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -12968,7 +13055,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13100,7 +13187,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13229,7 +13316,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13330,7 +13417,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13396,7 +13483,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -13570,7 +13657,7 @@ components: readOnly: true metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata of the connection readOnly: true @@ -13599,7 +13686,8 @@ components: image: type: string description: The container image for the hosted agent. - example: my-registry.azurecr.io/my-hosted-agent:latest + examples: + - my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -13647,8 +13735,7 @@ components: format: double maximum: 100 description: Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100. - minimum: 0 - exclusiveMinimum: true + exclusiveMinimum: 0 default: 100 allOf: - $ref: '#/components/schemas/EvaluationRuleAction' @@ -13679,7 +13766,7 @@ components: default: 5 data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -13742,8 +13829,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -13765,7 +13850,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13784,7 +13869,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -13802,7 +13887,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13877,8 +13962,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -13894,7 +13977,7 @@ components: description: A human-readable description of the agent. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13924,7 +14007,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13943,7 +14026,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -13952,7 +14035,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13999,10 +14082,9 @@ components: type: string description: The name of the evaluation. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -14024,7 +14106,7 @@ components: description: A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`). properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14039,10 +14121,9 @@ components: type: string description: The name of the run. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -14052,7 +14133,7 @@ components: description: Details about the run's data source. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14068,9 +14149,7 @@ components: properties: files: type: array - items: - type: string - format: binary + items: {} description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -14126,7 +14205,7 @@ components: - CustomKeys description: The credential type readOnly: true - additionalProperties: + unevaluatedProperties: type: string allOf: - $ref: '#/components/schemas/BaseCredentials' @@ -14153,7 +14232,7 @@ components: description: The provider-specific event name that fires the routine. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Provider-specific trigger parameters. allOf: - $ref: '#/components/schemas/RoutineTrigger' @@ -14308,7 +14387,7 @@ components: description: Description to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. description: Output options for data generation job. @@ -14430,11 +14509,12 @@ components: description: The data source type discriminator. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: {} + mapping: + azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -14464,7 +14544,7 @@ components: readOnly: true tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -14571,7 +14651,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -14943,10 +15023,9 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -14956,7 +15035,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15127,10 +15206,9 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -15142,7 +15220,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15401,7 +15479,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Details of the input data source item. results: type: array @@ -15491,9 +15569,10 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -15514,10 +15593,10 @@ components: description: The reason for the test criteria metric. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional details about the test criteria metric. - additionalProperties: {} + unevaluatedProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -15757,7 +15836,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -15861,7 +15940,7 @@ components: description: Identifier of the evaluation group. evalRun: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -15896,7 +15975,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -15910,7 +15989,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -15924,7 +16003,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -15972,7 +16051,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -15986,7 +16065,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -16023,15 +16102,15 @@ components: description: The type of evaluator definition init_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -16268,7 +16347,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -16333,7 +16412,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -16361,7 +16440,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -16373,7 +16452,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator categories: @@ -16393,7 +16472,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -16508,12 +16587,9 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string - nullable: true + - type: 'null' description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -16524,7 +16600,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -16803,15 +16879,18 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - example: X-Otlp-Api-Key + examples: + - X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - example: my-secret-store + examples: + - my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - example: OTLP_KEY + examples: + - OTLP_KEY allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' description: Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. @@ -16839,19 +16918,21 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - example: '0.25' + examples: + - '0.25' memory: type: string description: The memory configuration for the hosted agent. - example: 0.5Gi + examples: + - 0.5Gi environment_variables: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set in the hosted agent container. - example: - name: LOG_LEVEL - value: debug + examples: + - name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -16864,11 +16945,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - example: - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + examples: + - - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -16970,7 +17051,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -17114,11 +17195,11 @@ components: description: Sample type features: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -17334,6 +17415,7 @@ components: red_team_taxonomy: '#/components/schemas/RedTeamTaxonomyItemGenerationParams' response_retrieval: '#/components/schemas/ResponseRetrievalItemGenerationParams' conversation_gen_preview: '#/components/schemas/ConversationGenPreviewItemGenerationParams' + synthetic_data_gen_preview: '#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams' description: Represents the set of parameters used to control item generation operations. ItemGenerationParamsType: anyOf: @@ -17591,7 +17673,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -17633,10 +17715,11 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - type: array - items: - $ref: '#/components/schemas/MemoryItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/MemoryItem' + - type: 'null' description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -17788,7 +17871,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -17940,7 +18023,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -17992,7 +18075,7 @@ components: readOnly: true capabilities: type: object - additionalProperties: + unevaluatedProperties: type: string description: Capabilities of deployed model readOnly: true @@ -18141,7 +18224,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -18283,7 +18366,6 @@ components: - create_file description: Create a new file with the provided diff. x-stainless-const: true - default: create_file path: type: string description: Path of the file to create. @@ -18307,7 +18389,6 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true - default: create_file path: type: string minLength: 1 @@ -18332,7 +18413,6 @@ components: - delete_file description: Delete the specified file. x-stainless-const: true - default: delete_file path: type: string description: Path of the file to delete. @@ -18352,7 +18432,6 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true - default: delete_file path: type: string minLength: 1 @@ -18418,7 +18497,6 @@ components: - apply_patch description: The type of the tool. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Allows the assistant to create, delete, or update files using unified diffs. @@ -18436,7 +18514,6 @@ components: - update_file description: Update an existing file with the provided diff. x-stainless-const: true - default: update_file path: type: string description: Path of the file to update. @@ -18460,7 +18537,6 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true - default: update_file path: type: string minLength: 1 @@ -18486,17 +18562,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -18516,9 +18596,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' network_policy: $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' description: Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. @@ -18542,6 +18622,12 @@ components: OpenAI.ChatModel: type: string enum: + - gpt-5.4 + - gpt-5.4-mini + - gpt-5.4-nano + - gpt-5.4-mini-2026-03-17 + - gpt-5.4-nano-2026-03-17 + - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest @@ -18636,7 +18722,6 @@ components: - click description: Specifies the event type. For a click action, this property is always `click`. x-stainless-const: true - default: click button: allOf: - $ref: '#/components/schemas/OpenAI.ClickButtonType' @@ -18649,6 +18734,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A click action. @@ -18709,7 +18800,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -18774,13 +18865,27 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + prompt_cache_key: + anyOf: + - type: string + - type: 'null' + prompt_cache_retention: + anyOf: + - $ref: '#/components/schemas/OpenAI.PromptCacheRetentionEnum' + - type: 'null' + service_tier: + anyOf: + - $ref: '#/components/schemas/OpenAI.ServiceTierEnum' + - type: 'null' OpenAI.ComparisonFilter: type: object required: @@ -18797,6 +18902,8 @@ components: - gte - lt - lte + - in + - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -18868,6 +18975,14 @@ components: scroll: '#/components/schemas/OpenAI.ScrollParam' type: '#/components/schemas/OpenAI.TypeParam' wait: '#/components/schemas/OpenAI.WaitParam' + OpenAI.ComputerActionList: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerAction' + description: |- + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + title: Computer Action List OpenAI.ComputerActionType: anyOf: - type: string @@ -18891,11 +19006,13 @@ components: type: string description: The ID of the pending safety check. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -18911,6 +19028,7 @@ components: - type - image_url - file_id + - detail properties: type: type: string @@ -18918,14 +19036,19 @@ components: - computer_screenshot description: Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`. x-stainless-const: true - default: computer_screenshot image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.ImageDetail' + description: The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -18952,6 +19075,21 @@ components: type: string description: The identifier of an uploaded file that contains the screenshot. description: A computer screenshot image used with the computer use tool. + OpenAI.ComputerTool: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + description: The type of the computer tool. Always `computer`. + x-stainless-const: true + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + title: Computer OpenAI.ComputerUsePreviewTool: type: object required: @@ -18966,7 +19104,6 @@ components: - computer_use_preview description: The type of the computer use tool. Always `computer_use_preview`. x-stainless-const: true - default: computer_use_preview environment: allOf: - $ref: '#/components/schemas/OpenAI.ComputerEnvironment' @@ -18994,7 +19131,6 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true - default: container_auto file_ids: type: array items: @@ -19002,9 +19138,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' skills: type: array items: @@ -19031,7 +19167,6 @@ components: - container_file_citation description: The type of the container file citation. Always `container_file_citation`. x-stainless-const: true - default: container_file_citation container_id: type: string description: The ID of the container file. @@ -19072,19 +19207,12 @@ components: - allowlist description: Allow outbound network access only to specified domains. Always `allowlist`. x-stainless-const: true - default: allowlist allowed_domains: type: array items: type: string minItems: 1 description: A list of allowed domains when type is `allowlist`. - domain_secrets: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam' - minItems: 1 - description: Optional domain-scoped secrets for allowlisted domains. allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' OpenAI.ContainerNetworkPolicyDisabledParam: @@ -19098,29 +19226,8 @@ components: - disabled description: Disable outbound network access. Always `disabled`. x-stainless-const: true - default: disabled allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' - OpenAI.ContainerNetworkPolicyDomainSecretParam: - type: object - required: - - domain - - name - - value - properties: - domain: - type: string - minLength: 1 - description: The domain associated with the secret. - name: - type: string - minLength: 1 - description: The name of the secret to inject for the domain. - value: - type: string - minLength: 1 - maxLength: 10485760 - description: The secret value to inject for the domain. OpenAI.ContainerNetworkPolicyParam: type: object required: @@ -19153,7 +19260,6 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true - default: container_reference container_id: type: string allOf: @@ -19188,10 +19294,9 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' OpenAI.ConversationItem: type: object required: @@ -19203,14 +19308,18 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ConversationItemFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ConversationItemWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ConversationItemImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ConversationItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' reasoning: '#/components/schemas/OpenAI.ConversationItemReasoningItem' + compaction: '#/components/schemas/OpenAI.ConversationItemCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCall' local_shell_call_output: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput' @@ -19222,10 +19331,39 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ConversationItemMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output). title: Conversation item + OpenAI.ConversationItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemApplyPatchToolCall: type: object required: @@ -19290,8 +19428,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -19332,26 +19471,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ConversationItemCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ConversationItemComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -19369,6 +19536,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -19389,10 +19558,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ConversationItemComputerToolCallOutputResource: + OpenAI.ConversationItemComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -19406,6 +19576,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -19429,68 +19600,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemCustomToolCall: + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ConversationItemCustomToolCallOutputResource: type: object required: - type - call_id - - name - - input + - output + - status properties: type: type: string enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call in the OpenAI platform. + description: The unique ID of the custom tool call output in the OpenAI platform. call_id: type: string - description: An identifier used to map this custom tool call to a tool call output. - name: - type: string - description: The name of the custom tool being called. - input: + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: type: string - description: The input for the custom tool call generated by the model. + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: A call to a custom tool created by the model. - title: Custom tool call - OpenAI.ConversationItemCustomToolCallOutput: + title: ResponseCustomToolCallOutputItem + OpenAI.ConversationItemCustomToolCallResource: type: object required: - type - call_id - - output + - name + - input + - status properties: type: type: string enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call output in the OpenAI platform. + description: The unique ID of the custom tool call in the OpenAI platform. call_id: type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a custom tool call from your code, being sent back to the model. - title: Custom tool call output + title: ResponseCustomToolCallItem OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -19525,10 +19719,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -19564,13 +19759,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -19603,7 +19797,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -19611,10 +19805,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -19622,36 +19815,37 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCallOutputResource: + OpenAI.ConversationItemFunctionToolCall: type: object required: + - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + description: The unique ID of the function tool call. + readOnly: true type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -19663,32 +19857,42 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemFunctionToolCallResource: + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ConversationItemFunctionToolCallOutput: type: object required: + - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -19700,6 +19904,8 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.ConversationItemImageGenToolCall: type: object required: @@ -19726,8 +19932,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -19822,12 +20029,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -19887,8 +20095,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -19919,8 +20128,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -19953,18 +20161,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -20001,6 +20211,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A message to or from the model. @@ -20022,8 +20236,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -20051,6 +20266,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ConversationItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + OpenAI.ConversationItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemType: anyOf: - type: string @@ -20064,7 +20360,11 @@ components: - image_generation_call - computer_call - computer_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning + - compaction - code_interpreter_call - local_shell_call - local_shell_call_output @@ -20200,6 +20500,7 @@ components: mapping: text: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText' json_object: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject' + json_schema: '#/components/schemas/OpenAI.ResponseFormatJsonSchema' description: |- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables @@ -20255,15 +20556,15 @@ components: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' items: - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + - type: 'null' OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -20384,7 +20685,7 @@ components: default: custom item_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -20456,7 +20757,7 @@ components: default: logs metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -20601,7 +20902,7 @@ components: default: stored_completions metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -20651,16 +20952,18 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' minLength: 1 maxLength: 64 description: |- A string of up to 64 characters that will be added to your fine-tuned model name. For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -20670,16 +20973,16 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/model-optimization) for more details. integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + - type: 'null' description: A list of integrations to enable for your fine-tuning job. seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' minimum: 0 maximum: 2147483647 description: |- @@ -20688,10 +20991,9 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -20737,11 +21039,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -20814,7 +21118,6 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true - default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -20837,7 +21140,6 @@ components: - text description: Unconstrained text format. Always `text`. x-stainless-const: true - default: text allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: Unconstrained free-form text. @@ -20854,7 +21156,6 @@ components: - custom description: The type of the custom tool. Always `custom`. x-stainless-const: true - default: custom name: type: string description: The name of the custom tool, used to identify it in tool calls. @@ -20865,6 +21166,9 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: The input format for the custom tool. Default is unconstrained text. + defer_loading: + type: boolean + description: Whether this tool should be deferred and discovered via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) @@ -20912,12 +21216,14 @@ components: - low - high - auto + - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' + - keys properties: type: type: string @@ -20925,7 +21231,6 @@ components: - double_click description: Specifies the event type. For a double click action, this property is always set to `double_click`. x-stainless-const: true - default: double_click x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -20934,6 +21239,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the double click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A double click action. @@ -20950,7 +21261,6 @@ components: - drag description: Specifies the event type. For a drag action, this property is always set to `drag`. x-stainless-const: true - default: drag path: type: array items: @@ -20963,6 +21273,12 @@ components: { x: 200, y: 300 } ] ``` + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -20991,6 +21307,10 @@ components: description: |- Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' type: type: string enum: @@ -21015,6 +21335,8 @@ components: `assistant` role are presumed to have been generated by the model in previous interactions. title: Input message + OpenAI.EmptyModelParam: + type: object OpenAI.Error: type: object required: @@ -21022,13 +21344,15 @@ components: - message properties: code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string details: @@ -21037,10 +21361,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} debugInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalApiError: type: object required: @@ -21170,26 +21494,22 @@ components: type: object properties: seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' max_completions_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -21442,10 +21762,10 @@ components: properties: item: type: object - additionalProperties: {} + unevaluatedProperties: {} sample: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -21474,49 +21794,50 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions_search: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' users: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' tools: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -21662,28 +21983,25 @@ components: x-stainless-const: true default: stored_completions metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' limit: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -21712,7 +22030,6 @@ components: - file_citation description: The type of the file citation. Always `file_citation`. x-stainless-const: true - default: file_citation file_id: type: string description: The ID of the file. @@ -21727,6 +22044,11 @@ components: - $ref: '#/components/schemas/OpenAI.Annotation' description: A citation to a file. title: File citation + OpenAI.FileInputDetail: + type: string + enum: + - low + - high OpenAI.FilePath: type: object required: @@ -21763,7 +22085,6 @@ components: - file_search description: The type of the file search tool. Always `file_search`. x-stainless-const: true - default: file_search vector_store_ids: type: array items: @@ -21778,9 +22099,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Filters' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -21789,7 +22110,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -21809,10 +22130,9 @@ components: filename: type: string attributes: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - nullable: true + - type: 'null' score: type: number format: float @@ -22020,11 +22340,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -22056,17 +22378,20 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - nullable: true + - type: 'null' fine_tuned_model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' finished_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -22099,36 +22424,39 @@ components: - cancelled description: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. trained_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' training_file: type: string description: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents). validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + - type: 'null' seed: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The seed used for the fine-tuning job. estimated_finish: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. title: FineTuningJob x-oaiMeta: @@ -22260,8 +22588,9 @@ components: message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.FineTuningJobEvent: type: object required: @@ -22327,11 +22656,8 @@ components: - type: string enum: - auto - nullable: true - - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' default: auto learning_rate_multiplier: oneOf: @@ -22373,18 +22699,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -22403,16 +22734,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -22451,6 +22784,18 @@ components: - in_progress - completed - incomplete + OpenAI.FunctionCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete + OpenAI.FunctionCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionObject: type: object required: @@ -22465,11 +22810,12 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.FunctionParameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. @@ -22485,15 +22831,13 @@ components: items: type: string timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -22507,15 +22851,13 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -22659,7 +23001,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -22680,7 +23021,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -22731,6 +23071,12 @@ components: enum: - timeout - exit + OpenAI.FunctionShellCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -22742,7 +23088,6 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcome' description: Indicates that the shell call exceeded its configured time limit. @@ -22758,11 +23103,16 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcomeParam' description: Indicates that the shell call exceeded its configured time limit. title: Shell call timeout outcome + OpenAI.FunctionShellCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellToolParam: type: object required: @@ -22774,12 +23124,10 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true - default: shell environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -22788,7 +23136,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -22871,67 +23219,61 @@ components: - function description: The type of the function tool. Always `function`. x-stainless-const: true - default: function name: type: string description: The name of the function to call. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' parameters: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' strict: + anyOf: + - type: boolean + - type: 'null' + defer_loading: type: boolean - nullable: true + description: Whether this function is deferred and loaded via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). title: Function - OpenAI.FunctionToolCallOutput: + OpenAI.FunctionToolParam: type: object required: + - name - type - - call_id - - output properties: - id: + name: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_-]+$ + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a function tool call. - title: Function tool call output + default: function + defer_loading: + type: boolean + description: Whether this function should be deferred and discovered via tool search. OpenAI.GraderLabelModel: type: object required: @@ -23308,6 +23650,7 @@ components: - low - high - auto + - original OpenAI.ImageGenActionEnum: type: string enum: @@ -23325,7 +23668,6 @@ components: - image_generation description: The type of the image generation tool. Always `image_generation`. x-stainless-const: true - default: image_generation model: anyOf: - type: string @@ -23347,15 +23689,15 @@ components: or `auto`. Default: `auto`. default: auto size: - type: string - enum: - - 1024x1024 - - 1024x1536 - - 1536x1024 - - auto - description: |- - The size of the generated image. One of `1024x1024`, `1024x1536`, - `1536x1024`, or `auto`. Default: `auto`. + anyOf: + - type: string + - type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. default: auto output_format: type: string @@ -23392,9 +23734,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - nullable: true + - type: 'null' input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -23419,7 +23761,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -23453,6 +23795,7 @@ components: - memory_search_call.results description: |- Specify additional output data to include in the model response. Currently supported values are: + - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. @@ -23474,7 +23817,6 @@ components: - inline description: Defines an inline skill for this request. x-stainless-const: true - default: inline name: type: string description: The name of the skill. @@ -23571,18 +23913,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -23601,16 +23948,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -23662,18 +24011,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -23689,18 +24043,26 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_data: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -23717,16 +24079,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -23742,16 +24106,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - nullable: true + - type: 'null' description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -23773,6 +24139,9 @@ components: web_search_call: '#/components/schemas/OpenAI.InputItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.InputItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.InputItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.InputItemReasoningItem' compaction: '#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.InputItemImageGenToolCall' @@ -23793,6 +24162,38 @@ components: An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs. + OpenAI.InputItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemApplyPatchToolCallItemParam: type: object required: @@ -23809,8 +24210,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23843,8 +24245,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23855,8 +24258,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -23894,15 +24298,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -23914,8 +24320,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -23939,8 +24346,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23956,14 +24364,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -23974,7 +24383,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -23992,6 +24400,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -24032,6 +24442,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -24108,10 +24521,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -24126,8 +24540,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24151,9 +24566,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -24166,8 +24581,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24185,14 +24601,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -24205,8 +24620,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24225,14 +24641,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -24240,6 +24655,7 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -24248,6 +24664,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -24257,6 +24674,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -24304,8 +24724,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -24364,12 +24785,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -24419,8 +24841,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -24428,8 +24851,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -24460,8 +24884,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -24494,18 +24917,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -24539,6 +24964,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -24569,8 +24998,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -24598,6 +25028,77 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.InputItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' + OpenAI.InputItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemType: anyOf: - type: string @@ -24611,6 +25112,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -24667,44 +25171,6 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call - OpenAI.InputMessage: - type: object - required: - - type - - role - - content - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.InputMessageContentList: type: array items: @@ -24713,43 +25179,6 @@ components: A list of one or many input items to the model, containing different content types. title: Input item content list - OpenAI.InputMessageResource: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.InputParam: oneOf: - type: string @@ -24811,7 +25240,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessage' + message: '#/components/schemas/OpenAI.ItemInputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -24819,6 +25248,9 @@ components: web_search_call: '#/components/schemas/OpenAI.ItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.ItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.ItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.ItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.ItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.ItemReasoningItem' compaction: '#/components/schemas/OpenAI.ItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.ItemImageGenToolCall' @@ -24836,6 +25268,38 @@ components: custom_tool_call_output: '#/components/schemas/OpenAI.ItemCustomToolCallOutput' custom_tool_call: '#/components/schemas/OpenAI.ItemCustomToolCall' description: Content item used to generate a response. + OpenAI.ItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemApplyPatchToolCallItemParam: type: object required: @@ -24852,8 +25316,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24886,8 +25351,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24898,8 +25364,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -24937,15 +25404,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -24957,8 +25426,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -24982,8 +25452,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24999,14 +25470,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -25017,7 +25489,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -25035,6 +25506,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -25075,6 +25548,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -25127,14 +25603,17 @@ components: discriminator: propertyName: type mapping: - function_call_output: '#/components/schemas/OpenAI.FunctionToolCallOutput' message: '#/components/schemas/OpenAI.ItemFieldMessage' function_call: '#/components/schemas/OpenAI.ItemFieldFunctionToolCall' + tool_search_call: '#/components/schemas/OpenAI.ItemFieldToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemFieldToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemFieldAdditionalTools' + function_call_output: '#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ItemFieldFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ItemFieldWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ItemFieldImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ItemFieldComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -25151,6 +25630,35 @@ components: custom_tool_call: '#/components/schemas/OpenAI.ItemFieldCustomToolCall' custom_tool_call_output: '#/components/schemas/OpenAI.ItemFieldCustomToolCallOutput' description: An item representing a message, tool call, tool output, reasoning, or other response element. + OpenAI.ItemFieldAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldApplyPatchToolCall: type: object required: @@ -25215,8 +25723,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -25257,15 +25766,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -25303,7 +25814,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -25321,6 +25831,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -25341,10 +25853,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemFieldComputerToolCallOutputResource: + OpenAI.ItemFieldComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -25358,6 +25871,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -25381,6 +25895,8 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a computer tool call. + title: Computer tool call output OpenAI.ItemFieldCustomToolCall: type: object required: @@ -25401,6 +25917,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -25477,10 +25996,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -25516,13 +26036,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -25555,7 +26074,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -25563,10 +26082,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -25577,6 +26095,7 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: + - id - type - call_id - name @@ -25585,6 +26104,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -25594,6 +26114,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -25615,6 +26138,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.ItemFieldFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a function tool call. + title: Function tool call output OpenAI.ItemFieldImageGenToolCall: type: object required: @@ -25641,8 +26209,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -25701,12 +26270,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -25766,8 +26336,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -25798,8 +26369,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -25832,18 +26402,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -25880,6 +26452,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A message to or from the model. @@ -25901,8 +26477,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -25930,6 +26507,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ItemFieldToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + OpenAI.ItemFieldToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldType: anyOf: - type: string @@ -25937,6 +26595,9 @@ components: enum: - message - function_call + - tool_search_call + - tool_search_output + - additional_tools - function_call_output - file_search_call - web_search_call @@ -26031,10 +26692,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -26049,8 +26711,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26074,9 +26737,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -26089,8 +26752,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26108,14 +26772,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -26128,8 +26791,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26148,14 +26812,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -26163,6 +26826,7 @@ components: OpenAI.ItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -26171,6 +26835,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -26180,6 +26845,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -26227,12 +26895,57 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An image generation request made by the model. title: Image generation call + OpenAI.ItemInputMessage: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + default: message + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + readOnly: true + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemLocalShellToolCall: type: object required: @@ -26287,12 +27000,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -26342,8 +27056,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -26351,8 +27066,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -26383,8 +27099,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -26417,18 +27132,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -26462,6 +27179,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -26492,8 +27213,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -26533,7 +27255,6 @@ components: - item_reference description: The type of item to reference. Always `item_reference`. x-stainless-const: true - default: item_reference id: type: string description: The ID of the item to reference. @@ -26551,14 +27272,19 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessageResource' + message: '#/components/schemas/OpenAI.ItemResourceInputMessage' output_message: '#/components/schemas/OpenAI.ItemResourceOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemResourceFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemResourceComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ItemResourceToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemResourceToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemResourceAdditionalTools' + reasoning: '#/components/schemas/OpenAI.ItemResourceReasoningItem' + compaction: '#/components/schemas/OpenAI.ItemResourceCompactionBody' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -26571,7 +27297,38 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ItemResourceMcpToolCall' + custom_tool_call: '#/components/schemas/OpenAI.ItemResourceCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource' description: Content item used to generate a response. + OpenAI.ItemResourceAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceApplyPatchToolCall: type: object required: @@ -26636,8 +27393,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -26678,26 +27436,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ItemResourceCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ItemResourceComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -26715,6 +27501,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -26735,10 +27523,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemResourceComputerToolCallOutputResource: + OpenAI.ItemResourceComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -26752,6 +27541,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -26775,6 +27565,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ItemResourceCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallOutputItem + OpenAI.ItemResourceCustomToolCallResource: + type: object + required: + - type + - call_id + - name + - input + - status + properties: + type: + type: string + enum: + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call in the OpenAI platform. + call_id: + type: string + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallItem OpenAI.ItemResourceFileSearchToolCall: type: object required: @@ -26809,10 +27684,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -26848,13 +27724,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -26887,7 +27762,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -26895,10 +27770,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -26906,9 +27780,56 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCallOutputResource: + OpenAI.ItemResourceFunctionToolCall: type: object required: + - id + - type + - call_id + - name + - arguments + properties: + id: + type: string + description: The unique ID of the function tool call. + readOnly: true + type: + type: string + enum: + - function_call + description: The type of the function tool call. Always `function_call`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ItemResourceFunctionToolCallOutput: + type: object + required: + - id - type - call_id - output @@ -26918,6 +27839,7 @@ components: description: |- The unique ID of the function tool call output. Populated when this item is returned via API. + readOnly: true type: type: string enum: @@ -26947,75 +27869,85 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceFunctionToolCallResource: + description: The output of a function tool call. + title: Function tool call output + OpenAI.ItemResourceImageGenToolCall: type: object required: - type - - call_id - - name - - arguments + - id + - status + - result properties: - id: - type: string - description: The unique ID of the function tool call. type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - image_generation_call + description: The type of the image generation call. Always `image_generation_call`. x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: + id: type: string - description: A JSON string of the arguments to pass to the function. + description: The unique ID of the image generation call. status: type: string enum: - in_progress - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. + - generating + - failed + description: The status of the image generation call. + result: + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceImageGenToolCall: + description: An image generation request made by the model. + title: Image generation call + OpenAI.ItemResourceInputMessage: type: object required: - type + - role + - content - id - - status - - result properties: type: type: string enum: - - image_generation_call - description: The type of the image generation call. Always `image_generation_call`. + - message + description: The type of the message input. Always set to `message`. x-stainless-const: true - id: + default: message + role: type: string - description: The unique ID of the image generation call. + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. status: type: string enum: - in_progress - completed - - generating - - failed - description: The status of the image generation call. - result: + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: type: string - nullable: true + description: The unique ID of the message input. + readOnly: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: An image generation request made by the model. - title: Image generation call + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemResourceLocalShellToolCall: type: object required: @@ -27070,12 +28002,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -27135,8 +28068,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -27167,8 +28101,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -27201,18 +28134,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -27246,6 +28181,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -27259,6 +28198,134 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An output message from the model. title: Output message + OpenAI.ItemResourceReasoningItem: + type: object + required: + - type + - id + - summary + properties: + type: + type: string + enum: + - reasoning + description: The type of the object. Always `reasoning`. + x-stainless-const: true + id: + type: string + description: The unique identifier of the reasoning content. + encrypted_content: + anyOf: + - type: string + - type: 'null' + summary: + type: array + items: + $ref: '#/components/schemas/OpenAI.SummaryTextContent' + description: Reasoning summary content. + content: + type: array + items: + $ref: '#/components/schemas/OpenAI.ReasoningTextContent' + description: Reasoning text content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A description of the chain of thought used by a reasoning model while generating + a response. Be sure to include these items in your `input` to the Responses API + for subsequent turns of a conversation if you are manually + [managing context](/docs/guides/conversation-state). + title: Reasoning + OpenAI.ItemResourceToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + OpenAI.ItemResourceToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceType: anyOf: - type: string @@ -27272,6 +28339,11 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools + - reasoning + - compaction - image_generation_call - code_interpreter_call - local_shell_call @@ -27284,6 +28356,8 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call + - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -27347,6 +28421,77 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call + OpenAI.ItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + OpenAI.ItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemType: anyOf: - type: string @@ -27360,6 +28505,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -27451,7 +28599,6 @@ components: - keypress description: Specifies the event type. For a keypress action, this property is always set to `keypress`. x-stainless-const: true - default: keypress keys: type: array items: @@ -27479,11 +28626,13 @@ components: - list x-stainless-const: true first_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' last_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' x-ms-list-continuation-token: true has_more: type: boolean @@ -27536,23 +28685,10 @@ components: - local description: The environment type. Always `local`. x-stainless-const: true - default: local allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' description: Represents the use of a local environment to perform shell actions. title: Local Environment - OpenAI.LocalShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete - OpenAI.LocalShellCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.LocalShellExecAction: type: object required: @@ -27573,22 +28709,23 @@ components: type: string description: The command to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' working_directory: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' env: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -27602,7 +28739,6 @@ components: - local_shell description: The type of the local shell tool. Always `local_shell`. x-stainless-const: true - default: local_shell name: type: string description: Optional user-defined name for this tool or configuration. @@ -27611,7 +28747,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -27669,17 +28805,17 @@ components: type: string description: The name of the tool. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - nullable: true + - type: 'null' description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -27741,38 +28877,36 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' allowed_tools: anyOf: - type: array items: type: string - nullable: true - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + - type: 'null' require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string enum: - always - never - nullable: true + - type: 'null' default: always + defer_loading: + type: boolean + description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -27834,6 +28968,7 @@ components: refusal: '#/components/schemas/OpenAI.MessageContentRefusalContent' input_image: '#/components/schemas/OpenAI.MessageContentInputImageContent' input_file: '#/components/schemas/OpenAI.MessageContentInputFileContent' + summary_text: '#/components/schemas/OpenAI.SummaryTextContent' description: A content part that makes up an input or output item. OpenAI.MessageContentInputFileContent: type: object @@ -27848,18 +28983,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -27878,16 +29018,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -27997,6 +29139,15 @@ components: - input_image - computer_screenshot - input_file + OpenAI.MessagePhase: + type: string + enum: + - commentary + - final_answer + description: |- + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. OpenAI.MessageRole: type: string enum: @@ -28016,7 +29167,7 @@ components: - incomplete OpenAI.Metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -28027,13 +29178,9 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - allOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - type: string - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - type: 'null' description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. OpenAI.ModelIdsResponses: anyOf: @@ -28058,6 +29205,125 @@ components: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.ChatModel' + OpenAI.Moderation: + type: object + required: + - input + - output + properties: + input: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response input. + output: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response output. + description: Moderation results or errors for the response input and output. + title: Moderation + OpenAI.ModerationEntry: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ModerationEntryType' + discriminator: + propertyName: type + mapping: + moderation_result: '#/components/schemas/OpenAI.ModerationResultBody' + error: '#/components/schemas/OpenAI.ModerationErrorBody' + description: Moderation results or an error for a response moderation check. + OpenAI.ModerationEntryType: + anyOf: + - type: string + - type: string + enum: + - moderation_result + - error + OpenAI.ModerationErrorBody: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - error + description: The object type, which was always `error` for moderation failures. + x-stainless-const: true + code: + type: string + description: The error code. + message: + type: string + description: The error message. + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: An error produced while attempting moderation for the response input or output. + title: Moderation error + OpenAI.ModerationInputType: + type: string + enum: + - text + - image + OpenAI.ModerationParam: + type: object + required: + - model + properties: + model: + type: string + description: The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. + description: Configuration for running moderation on the input and output of this response. + OpenAI.ModerationResultBody: + type: object + required: + - type + - model + - flagged + - categories + - category_scores + - category_applied_input_types + properties: + type: + type: string + enum: + - moderation_result + description: The object type, which was always `moderation_result` for successful moderation results. + x-stainless-const: true + model: + type: string + description: The moderation model that produced this result. + flagged: + type: boolean + description: A boolean indicating whether the content was flagged by any category. + categories: + type: object + unevaluatedProperties: + type: boolean + description: A dictionary of moderation categories to booleans, True if the input is flagged under this category. + x-oaiTypeLabel: map + category_scores: + type: object + unevaluatedProperties: + $ref: '#/components/schemas/OpenAI.numeric' + description: A dictionary of moderation categories to scores. + x-oaiTypeLabel: map + category_applied_input_types: + type: object + unevaluatedProperties: + type: array + items: + $ref: '#/components/schemas/OpenAI.ModerationInputType' + description: Which modalities of input are reflected by the score for each category. + x-oaiTypeLabel: map + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: A moderation result produced for the response input or output. + title: Moderation result OpenAI.MoveParam: type: object required: @@ -28071,7 +29337,6 @@ components: - move description: Specifies the event type. For a move action, this property is always set to `move`. x-stainless-const: true - default: move x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -28080,10 +29345,50 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate to move to. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A mouse move action. title: Move + OpenAI.NamespaceToolParam: + type: object + required: + - type + - name + - description + - tools + properties: + type: + type: string + enum: + - namespace + description: The type of the tool. Always `namespace`. + x-stainless-const: true + name: + type: string + minLength: 1 + description: The namespace name used in tool calls (for example, `crm`). + description: + type: string + minLength: 1 + description: A description of the namespace shown to the model. + tools: + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionToolParam' + - $ref: '#/components/schemas/OpenAI.CustomToolParam' + minItems: 1 + description: The function/custom tools available inside this namespace. + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Groups function/custom tools under a shared namespace. + title: Namespace OpenAI.OutputContent: type: object required: @@ -28220,13 +29525,19 @@ components: output_message: '#/components/schemas/OpenAI.OutputItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.OutputItemFileSearchToolCall' function_call: '#/components/schemas/OpenAI.OutputItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput' web_search_call: '#/components/schemas/OpenAI.OutputItemWebSearchToolCall' computer_call: '#/components/schemas/OpenAI.OutputItemComputerToolCall' + computer_call_output: '#/components/schemas/OpenAI.OutputItemComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.OutputItemReasoningItem' + tool_search_call: '#/components/schemas/OpenAI.OutputItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.OutputItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.OutputItemAdditionalTools' compaction: '#/components/schemas/OpenAI.OutputItemCompactionBody' image_generation_call: '#/components/schemas/OpenAI.OutputItemImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.OutputItemLocalShellToolCall' + local_shell_call_output: '#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput' shell_call: '#/components/schemas/OpenAI.OutputItemFunctionShellCall' shell_call_output: '#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput' apply_patch_call: '#/components/schemas/OpenAI.OutputItemApplyPatchToolCall' @@ -28234,7 +29545,38 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' + mcp_approval_response: '#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource' + OpenAI.OutputItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -28299,8 +29641,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -28341,15 +29684,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -28387,7 +29732,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -28405,6 +29749,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -28425,13 +29771,99 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.OutputItemCustomToolCall: + OpenAI.OutputItemComputerToolCallOutput: + type: object + required: + - type + - id + - call_id + - output + properties: + type: + type: string + enum: + - computer_call_output + description: The type of the computer tool call output. Always `computer_call_output`. + x-stainless-const: true + default: computer_call_output + id: + type: string + description: The ID of the computer tool call output. + readOnly: true + call_id: + type: string + description: The ID of the computer tool call that produced the output. + acknowledged_safety_checks: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + description: |- + The safety checks reported by the API that have been acknowledged by the + developer. + output: + $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.OutputItemCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + title: ResponseCustomToolCallOutputItem + OpenAI.OutputItemCustomToolCallResource: type: object required: - type - call_id - name - input + - status properties: type: type: string @@ -28445,16 +29877,27 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. input: type: string description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' - description: A call to a custom tool created by the model. - title: Custom tool call + title: ResponseCustomToolCallItem OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -28489,10 +29932,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -28528,13 +29972,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -28567,7 +30010,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -28575,10 +30018,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -28589,6 +30031,7 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -28597,6 +30040,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -28606,6 +30050,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -28627,6 +30074,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.OutputItemFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.OutputItemImageGenToolCall: type: object required: @@ -28653,8 +30145,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -28693,6 +30186,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run a command on the local shell. title: Local shell call + OpenAI.OutputItemLocalShellToolCallOutput: + type: object + required: + - type + - id + - output + properties: + type: + type: string + enum: + - local_shell_call_output + description: The type of the local shell tool call output. Always `local_shell_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the local shell tool call generated by the model. + output: + type: string + description: A JSON string of the output of the local shell tool call. + status: + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a local shell tool call. + title: Local shell call output OpenAI.OutputItemMcpApprovalRequest: type: object required: @@ -28724,6 +30248,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A request for human approval of a tool invocation. title: MCP approval request + OpenAI.OutputItemMcpApprovalResponseResource: + type: object + required: + - type + - id + - approval_request_id + - approve + properties: + type: + type: string + enum: + - mcp_approval_response + description: The type of the item. Always `mcp_approval_response`. + x-stainless-const: true + id: + type: string + description: The unique ID of the approval response + approval_request_id: + type: string + description: The ID of the approval request being answered. + approve: + type: boolean + description: Whether the request was approved. + reason: + anyOf: + - type: string + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: A response to an MCP approval request. + title: MCP approval response OpenAI.OutputItemMcpListTools: type: object required: @@ -28750,8 +30305,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -28784,18 +30338,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -28829,6 +30385,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -28859,8 +30419,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -28888,6 +30449,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.OutputItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + OpenAI.OutputItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemType: anyOf: - type: string @@ -28896,13 +30538,19 @@ components: - output_message - file_search_call - function_call + - function_call_output - web_search_call - computer_call + - computer_call_output - reasoning + - tool_search_call + - tool_search_output + - additional_tools - compaction - image_generation_call - code_interpreter_call - local_shell_call + - local_shell_call_output - shell_call - shell_call_output - apply_patch_call @@ -28910,7 +30558,9 @@ components: - mcp_call - mcp_list_tools - mcp_approval_request + - mcp_approval_response - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -29053,16 +30703,21 @@ components: type: string description: The unique identifier of the prompt template to use. version: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' variables: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - nullable: true + - type: 'null' description: |- Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). + OpenAI.PromptCacheRetentionEnum: + type: string + enum: + - in_memory + - 24h OpenAI.RankerVersionType: type: string enum: @@ -29083,39 +30738,118 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.HybridSearchOptions' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + OpenAI.RealtimeMCPError: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.RealtimeMcpErrorType' + discriminator: + propertyName: type + mapping: + protocol_error: '#/components/schemas/OpenAI.RealtimeMCPProtocolError' + tool_execution_error: '#/components/schemas/OpenAI.RealtimeMCPToolExecutionError' + http_error: '#/components/schemas/OpenAI.RealtimeMCPHTTPError' + OpenAI.RealtimeMCPHTTPError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - http_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP HTTP error + OpenAI.RealtimeMCPProtocolError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - protocol_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP protocol error + OpenAI.RealtimeMCPToolExecutionError: + type: object + required: + - type + - message + properties: + type: + type: string + enum: + - tool_execution_error + x-stainless-const: true + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP tool execution error + OpenAI.RealtimeMcpErrorType: + anyOf: + - type: string + - type: string + enum: + - protocol_error + - tool_execution_error + - http_error OpenAI.Reasoning: type: object properties: effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' generate_summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh + anyOf: + - type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh + - type: 'null' description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -29126,7 +30860,6 @@ components: - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - nullable: true OpenAI.ReasoningTextContent: type: object required: @@ -29159,26 +30892,22 @@ components: - agent_reference properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -29189,44 +30918,41 @@ components: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -29238,11 +30964,12 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled id: type: string @@ -29270,19 +30997,20 @@ components: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - nullable: true + - type: 'null' incomplete_details: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - nullable: true + - type: 'null' output: type: array items: @@ -29301,26 +31029,33 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' output_text: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - nullable: true + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent_reference: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/AgentReference' - nullable: true + - type: 'null' description: The agent used for this response content_filters: type: array @@ -29347,8 +31082,10 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - format: base64 + contentEncoding: base64 description: A chunk of Base64 encoded response audio bytes. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial audio response. x-oaiMeta: name: response.audio.delta @@ -29376,6 +31113,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the audio response is complete. x-oaiMeta: name: response.audio.done @@ -29406,6 +31145,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial transcript of audio. x-oaiMeta: name: response.audio.transcript.delta @@ -29433,6 +31174,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the full audio transcript is completed. x-oaiMeta: name: response.audio.transcript.done @@ -29472,6 +31215,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial code snippet is streamed by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.delta @@ -29513,6 +31258,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code snippet is finalized by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.done @@ -29550,6 +31297,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter call is completed. x-oaiMeta: name: response.code_interpreter_call.completed @@ -29586,6 +31335,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a code interpreter call is in progress. x-oaiMeta: name: response.code_interpreter_call.in_progress @@ -29622,6 +31373,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter is actively interpreting the code snippet. x-oaiMeta: name: response.code_interpreter_call.interpreting @@ -29654,6 +31407,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the model response is complete. x-oaiMeta: name: response.completed @@ -29748,6 +31503,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new content part is added. x-oaiMeta: name: response.content_part.added @@ -29800,6 +31557,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputContent' description: The content part that is done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a content part is done. x-oaiMeta: name: response.content_part.done @@ -29838,6 +31597,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response is created. x-oaiMeta: name: response.created @@ -29909,6 +31670,8 @@ components: delta: type: string description: The incremental input data (delta) for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event representing a delta (partial update) to the input of a custom tool call. title: ResponseCustomToolCallInputDelta x-oaiMeta: @@ -29950,6 +31713,8 @@ components: input: type: string description: The complete input data for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event indicating that input for a custom tool call is complete. title: ResponseCustomToolCallInputDone x-oaiMeta: @@ -30012,18 +31777,22 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string description: The error message. param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' sequence_number: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an error occurs. x-oaiMeta: name: error @@ -30057,6 +31826,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Response' description: The response that failed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response fails. x-oaiMeta: name: response.failed @@ -30122,6 +31893,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is completed (results found). x-oaiMeta: name: response.file_search_call.completed @@ -30158,6 +31931,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is initiated. x-oaiMeta: name: response.file_search_call.in_progress @@ -30194,6 +31969,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search is currently searching. x-oaiMeta: name: response.file_search_call.searching @@ -30257,11 +32034,12 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.ResponseFormatJsonSchemaSchema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -30308,6 +32086,8 @@ components: delta: type: string description: The function-call arguments delta that is added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial function-call arguments delta. x-oaiMeta: name: response.function_call_arguments.delta @@ -30352,6 +32132,8 @@ components: arguments: type: string description: The function-call arguments. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when function-call arguments are finalized. x-oaiMeta: name: response.function_call_arguments.done @@ -30390,6 +32172,8 @@ components: item_id: type: string description: The unique identifier of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call has completed and the final image is available. title: ResponseImageGenCallCompletedEvent x-oaiMeta: @@ -30427,6 +32211,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is actively generating an image (intermediate state). title: ResponseImageGenCallGeneratingEvent x-oaiMeta: @@ -30464,6 +32250,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is in progress. title: ResponseImageGenCallInProgressEvent x-oaiMeta: @@ -30510,6 +32298,8 @@ components: partial_image_b64: type: string description: Base64-encoded partial image data, suitable for rendering as an image. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial image is available during image generation streaming. title: ResponseImageGenCallPartialImageEvent x-oaiMeta: @@ -30545,6 +32335,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the response is in progress. x-oaiMeta: name: response.in_progress @@ -30616,6 +32408,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response finishes as incomplete. x-oaiMeta: name: response.incomplete @@ -30673,7 +32467,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probability of the top 20 most likely tokens. + description: The log probabilities of up to 20 of the most likely tokens. description: |- A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) @@ -30714,6 +32508,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a delta (partial update) to the arguments of an MCP tool call. title: ResponseMCPCallArgumentsDeltaEvent x-oaiMeta: @@ -30756,6 +32552,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the arguments for an MCP tool call are finalized. title: ResponseMCPCallArgumentsDoneEvent x-oaiMeta: @@ -30794,6 +32592,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has completed successfully. title: ResponseMCPCallCompletedEvent x-oaiMeta: @@ -30831,6 +32631,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has failed. title: ResponseMCPCallFailedEvent x-oaiMeta: @@ -30868,6 +32670,8 @@ components: item_id: type: string description: The unique identifier of the MCP tool call item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call is in progress. title: ResponseMCPCallInProgressEvent x-oaiMeta: @@ -30905,6 +32709,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the list of available MCP tools has been successfully retrieved. title: ResponseMCPListToolsCompletedEvent x-oaiMeta: @@ -30942,6 +32748,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the attempt to list available MCP tools has failed. title: ResponseMCPListToolsFailedEvent x-oaiMeta: @@ -30979,6 +32787,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the system is in the process of retrieving the list of available MCP tools. title: ResponseMCPListToolsInProgressEvent x-oaiMeta: @@ -31017,6 +32827,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new output item is added. x-oaiMeta: name: response.output_item.added @@ -31060,6 +32872,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was marked done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an output item is marked done. x-oaiMeta: name: response.output_item.done @@ -31123,6 +32937,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Annotation' description: The annotation object being added. (See annotation schema for details.) + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an annotation is added to output text content. title: ResponseOutputTextAnnotationAddedEvent x-oaiMeta: @@ -31145,7 +32961,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -31179,6 +32995,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a response is queued and waiting to be processed. title: ResponseQueuedEvent x-oaiMeta: @@ -31230,6 +33048,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEventPart' description: The summary part that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new reasoning summary part is added. x-oaiMeta: name: response.reasoning_summary_part.added @@ -31294,6 +33114,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEventPart' description: The completed summary part. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary part is completed. x-oaiMeta: name: response.reasoning_summary_part.done @@ -31359,6 +33181,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning summary text. x-oaiMeta: name: response.reasoning_summary_text.delta @@ -31408,6 +33232,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary text is completed. x-oaiMeta: name: response.reasoning_summary_text.done @@ -31457,6 +33283,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning text. x-oaiMeta: name: response.reasoning_text.delta @@ -31504,6 +33332,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning text is completed. x-oaiMeta: name: response.reasoning_text.done @@ -31551,6 +33381,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial refusal text. x-oaiMeta: name: response.refusal.delta @@ -31598,6 +33430,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when refusal text is finalized. x-oaiMeta: name: response.refusal.done @@ -31611,6 +33445,127 @@ components: "refusal": "final refusal text", "sequence_number": 1 } + OpenAI.ResponseStreamEvent: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ResponseStreamEventType' + discriminator: + propertyName: type + mapping: + response.audio.transcript.delta: '#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent' + response.code_interpreter_call_code.delta: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent' + response.code_interpreter_call.in_progress: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent' + response.code_interpreter_call.interpreting: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent' + response.content_part.added: '#/components/schemas/OpenAI.ResponseContentPartAddedEvent' + response.created: '#/components/schemas/OpenAI.ResponseCreatedEvent' + error: '#/components/schemas/OpenAI.ResponseErrorEvent' + response.file_search_call.in_progress: '#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent' + response.file_search_call.searching: '#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent' + response.function_call_arguments.delta: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent' + response.in_progress: '#/components/schemas/OpenAI.ResponseInProgressEvent' + response.failed: '#/components/schemas/OpenAI.ResponseFailedEvent' + response.incomplete: '#/components/schemas/OpenAI.ResponseIncompleteEvent' + response.output_item.added: '#/components/schemas/OpenAI.ResponseOutputItemAddedEvent' + response.reasoning_summary_part.added: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent' + response.reasoning_summary_text.delta: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent' + response.reasoning_text.delta: '#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent' + response.refusal.delta: '#/components/schemas/OpenAI.ResponseRefusalDeltaEvent' + response.output_text.delta: '#/components/schemas/OpenAI.ResponseTextDeltaEvent' + response.web_search_call.in_progress: '#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent' + response.web_search_call.searching: '#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent' + response.image_generation_call.generating: '#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent' + response.image_generation_call.in_progress: '#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent' + response.image_generation_call.partial_image: '#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent' + response.mcp_call_arguments.delta: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent' + response.mcp_call.failed: '#/components/schemas/OpenAI.ResponseMCPCallFailedEvent' + response.mcp_call.in_progress: '#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent' + response.mcp_list_tools.failed: '#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent' + response.mcp_list_tools.in_progress: '#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent' + response.output_text.annotation.added: '#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent' + response.queued: '#/components/schemas/OpenAI.ResponseQueuedEvent' + response.custom_tool_call_input.delta: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent' + response.audio.done: '#/components/schemas/OpenAI.ResponseAudioDoneEvent' + response.audio.transcript.done: '#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent' + response.code_interpreter_call_code.done: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent' + response.code_interpreter_call.completed: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent' + response.completed: '#/components/schemas/OpenAI.ResponseCompletedEvent' + response.content_part.done: '#/components/schemas/OpenAI.ResponseContentPartDoneEvent' + response.file_search_call.completed: '#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent' + response.function_call_arguments.done: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent' + response.output_item.done: '#/components/schemas/OpenAI.ResponseOutputItemDoneEvent' + response.reasoning_summary_part.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent' + response.reasoning_summary_text.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent' + response.reasoning_text.done: '#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent' + response.refusal.done: '#/components/schemas/OpenAI.ResponseRefusalDoneEvent' + response.output_text.done: '#/components/schemas/OpenAI.ResponseTextDoneEvent' + response.web_search_call.completed: '#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent' + response.image_generation_call.completed: '#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent' + response.mcp_call_arguments.done: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent' + response.mcp_call.completed: '#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent' + response.mcp_list_tools.completed: '#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent' + response.custom_tool_call_input.done: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent' + response.audio.delta: '#/components/schemas/OpenAI.ResponseAudioDeltaEvent' + OpenAI.ResponseStreamEventType: + anyOf: + - type: string + - type: string + enum: + - response.audio.delta + - response.audio.done + - response.audio.transcript.delta + - response.audio.transcript.done + - response.code_interpreter_call_code.delta + - response.code_interpreter_call_code.done + - response.code_interpreter_call.completed + - response.code_interpreter_call.in_progress + - response.code_interpreter_call.interpreting + - response.completed + - response.content_part.added + - response.content_part.done + - response.created + - error + - response.file_search_call.completed + - response.file_search_call.in_progress + - response.file_search_call.searching + - response.function_call_arguments.delta + - response.function_call_arguments.done + - response.in_progress + - response.failed + - response.incomplete + - response.output_item.added + - response.output_item.done + - response.reasoning_summary_part.added + - response.reasoning_summary_part.done + - response.reasoning_summary_text.delta + - response.reasoning_summary_text.done + - response.reasoning_text.delta + - response.reasoning_text.done + - response.refusal.delta + - response.refusal.done + - response.output_text.delta + - response.output_text.done + - response.web_search_call.completed + - response.web_search_call.in_progress + - response.web_search_call.searching + - response.image_generation_call.completed + - response.image_generation_call.generating + - response.image_generation_call.in_progress + - response.image_generation_call.partial_image + - response.mcp_call_arguments.delta + - response.mcp_call_arguments.done + - response.mcp_call.completed + - response.mcp_call.failed + - response.mcp_call.in_progress + - response.mcp_list_tools.completed + - response.mcp_list_tools.failed + - response.mcp_list_tools.in_progress + - response.output_text.annotation.added + - response.queued + - response.custom_tool_call_input.delta + - response.custom_tool_call_input.done OpenAI.ResponseStreamOptions: type: object properties: @@ -31665,6 +33620,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is an additional text delta. x-oaiMeta: name: response.output_text.delta @@ -31718,6 +33675,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when text content is finalized. x-oaiMeta: name: response.output_text.done @@ -31814,6 +33773,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is completed. x-oaiMeta: name: response.web_search_call.completed @@ -31850,6 +33811,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is initiated. x-oaiMeta: name: response.web_search_call.in_progress @@ -31886,6 +33849,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is executing. x-oaiMeta: name: response.web_search_call.searching @@ -31908,7 +33873,6 @@ components: - screenshot description: Specifies the event type. For a screenshot action, this property is always set to `screenshot`. x-stainless-const: true - default: screenshot allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A screenshot action. @@ -31928,7 +33892,6 @@ components: - scroll description: Specifies the event type. For a scroll action, this property is always set to `scroll`. x-stainless-const: true - default: scroll x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -31945,10 +33908,21 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The vertical scroll distance. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A scroll action. title: Scroll + OpenAI.SearchContentType: + type: string + enum: + - text + - image OpenAI.SearchContextSize: type: string enum: @@ -31956,13 +33930,15 @@ components: - medium - high OpenAI.ServiceTier: - type: string - enum: - - auto - - default - - flex - - scale - - priority + anyOf: + - type: string + enum: + - auto + - default + - flex + - scale + - priority + - type: 'null' description: |- Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. @@ -31970,7 +33946,13 @@ components: - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - nullable: true + OpenAI.ServiceTierEnum: + type: string + enum: + - auto + - default + - flex + - priority OpenAI.SkillReferenceParam: type: object required: @@ -31983,7 +33965,6 @@ components: - skill_reference description: References a skill created with the /v1/skills endpoint. x-stainless-const: true - default: skill_reference skill_id: type: string minLength: 1 @@ -32005,7 +33986,6 @@ components: - apply_patch description: The tool to call. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the apply_patch tool when executing a tool call. @@ -32021,7 +34001,6 @@ components: - shell description: The tool to call. Always `shell`. x-stainless-const: true - default: shell allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the shell tool when a tool call is required. @@ -32038,7 +34017,6 @@ components: - summary_text description: The type of the object. Always `summary_text`. x-stainless-const: true - default: summary_text text: type: string description: A summary of the reasoning output from the model so far. @@ -32057,7 +34035,6 @@ components: enum: - text x-stainless-const: true - default: text text: type: string allOf: @@ -32155,8 +34132,9 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -32199,6 +34177,9 @@ components: custom: '#/components/schemas/OpenAI.CustomToolParam' web_search_preview: '#/components/schemas/OpenAI.WebSearchPreviewTool' apply_patch: '#/components/schemas/OpenAI.ApplyPatchToolParam' + computer: '#/components/schemas/OpenAI.ComputerTool' + namespace: '#/components/schemas/OpenAI.NamespaceToolParam' + tool_search: '#/components/schemas/OpenAI.ToolSearchToolParam' description: A tool that can be used to generate a response. OpenAI.ToolChoiceAllowed: type: object @@ -32227,7 +34208,7 @@ components: type: array items: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: @@ -32256,6 +34237,34 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputer: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputerUse: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer_use + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). OpenAI.ToolChoiceComputerUsePreview: type: object required: @@ -32352,8 +34361,9 @@ components: type: string description: The label of the MCP server to use. name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -32393,6 +34403,8 @@ components: web_search_preview_2025_03_11: '#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311' image_generation: '#/components/schemas/OpenAI.ToolChoiceImageGeneration' code_interpreter: '#/components/schemas/OpenAI.ToolChoiceCodeInterpreter' + computer: '#/components/schemas/OpenAI.ToolChoiceComputer' + computer_use: '#/components/schemas/OpenAI.ToolChoiceComputerUse' description: |- How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools @@ -32414,6 +34426,8 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter + - computer + - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -32442,6 +34456,38 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolSearchExecutionType: + type: string + enum: + - server + - client + OpenAI.ToolSearchToolParam: + type: object + required: + - type + properties: + type: + type: string + enum: + - tool_search + description: The type of the tool. Always `tool_search`. + x-stainless-const: true + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search is executed by the server or by the client. + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Hosted or BYOT tool search configuration for deferred tools. + title: Tool search tool OpenAI.ToolType: anyOf: - type: string @@ -32449,6 +34495,7 @@ components: enum: - function - file_search + - computer - computer_use_preview - web_search - mcp @@ -32457,6 +34504,8 @@ components: - local_shell - shell - custom + - namespace + - tool_search - web_search_preview - apply_patch - a2a_preview @@ -32522,7 +34571,6 @@ components: - type description: Specifies the event type. For a type action, this property is always set to `type`. x-stainless-const: true - default: type text: type: string description: The text to type. @@ -32536,10 +34584,9 @@ components: - metadata properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -32558,7 +34605,6 @@ components: - url_citation description: The type of the URL citation. Always `url_citation`. x-stainless-const: true - default: url_citation url: type: string format: uri @@ -32580,7 +34626,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -32593,16 +34639,17 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - type: string - enum: - - low - - medium - - high + anyOf: + - type: string + enum: + - low + - medium + - high + - type: 'null' description: |- Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. - nullable: true OpenAI.WaitParam: type: object required: @@ -32614,7 +34661,6 @@ components: - wait description: Specifies the event type. For a wait action, this property is always set to `wait`. x-stainless-const: true - default: wait allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A wait action. @@ -32653,9 +34699,10 @@ components: description: The action type. x-stainless-const: true url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -32663,7 +34710,6 @@ components: type: object required: - type - - query properties: type: type: string @@ -32673,7 +34719,7 @@ components: x-stainless-const: true query: type: string - description: '[DEPRECATED] The search query.' + description: The search query. deprecated: true queries: type: array @@ -32702,6 +34748,7 @@ components: x-stainless-const: true url: type: string + format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -32715,17 +34762,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -32739,16 +34790,18 @@ components: - web_search_preview description: The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. x-stainless-const: true - default: web_search_preview user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - nullable: true + - type: 'null' search_context_size: allOf: - $ref: '#/components/schemas/OpenAI.SearchContextSize' description: High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. + search_content_types: + type: array + items: + $ref: '#/components/schemas/OpenAI.SearchContentType' allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). @@ -32763,17 +34816,14 @@ components: enum: - web_search description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - default: web_search filters: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - nullable: true + - type: 'null' user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - nullable: true + - type: 'null' search_context_size: type: string enum: @@ -32790,7 +34840,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -32812,10 +34862,11 @@ components: type: object properties: allowed_domains: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' OpenAI.integer: type: integer format: int64 @@ -32879,7 +34930,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. spec: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -32903,7 +34954,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -32982,7 +35033,7 @@ components: description: The openapi function definition. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -33076,7 +35127,7 @@ components: description: Display name of the candidate (e.g., 'baseline', 'instruction-v2'). mutations: type: object - additionalProperties: {} + unevaluatedProperties: {} description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." avg_score: type: number @@ -33351,11 +35402,12 @@ components: max_candidates: type: integer format: int32 + minimum: 1 description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' default: 5 optimization_config: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. eval_model: type: string @@ -33403,12 +35455,14 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - example: https://my-collector.example.com/otlp + examples: + - https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - example: Http + examples: + - Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -33702,13 +35756,15 @@ components: type: string description: The model deployment to use for this agent. instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A system (or developer) message inserted into the model's context. temperature: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 2 description: |- @@ -33716,9 +35772,10 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 1 description: |- @@ -33729,10 +35786,9 @@ components: Defaults to `1`. default: 1 reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' tools: type: array items: @@ -33753,7 +35809,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -33940,12 +35996,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -34097,7 +36153,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -34142,7 +36198,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -34216,7 +36272,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -34498,17 +36554,17 @@ components: description: Task for the schedule. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the resource. readOnly: true @@ -34576,7 +36632,7 @@ components: readOnly: true properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Properties of the schedule run. readOnly: true @@ -34592,7 +36648,7 @@ components: description: Type of the task. configuration: type: object - additionalProperties: + unevaluatedProperties: type: string description: Configuration for the task. discriminator: @@ -34681,11 +36737,13 @@ components: allOf: - $ref: '#/components/schemas/SessionLogEventType' description: The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types. - example: log + examples: + - log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - example: '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + examples: + - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' description: |- A single Server-Sent Event frame emitted by the hosted agent session log stream. @@ -34802,7 +36860,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -34895,7 +36953,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -34977,7 +37035,7 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean @@ -35000,11 +37058,12 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured output. strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -35192,7 +37251,7 @@ components: description: List of taxonomy sub categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -35217,7 +37276,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -35264,10 +37323,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - example: - - ContainerStdoutStderr - - ContainerOtel - - Metrics + examples: + - - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -35351,11 +37410,11 @@ components: description: The version of the evaluator. Latest version if not specified. initialization_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The initialization parameters for the evaluation. Must support structured outputs. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: The model to use for the evaluation. Must support structured outputs. description: An Azure AI Evaluator grader used as testing criterion in evaluations. @@ -35383,7 +37442,7 @@ components: ToolCallOutputContent: anyOf: - type: object - additionalProperties: {} + unevaluatedProperties: {} - type: string - type: array items: {} @@ -35487,7 +37546,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -35544,10 +37603,11 @@ components: - tools properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -35808,7 +37868,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -35827,7 +37887,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -35836,7 +37896,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -35873,13 +37933,12 @@ components: name: type: string metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -35892,7 +37951,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Request body for updating a model version. Only description and tags can be modified. @@ -36070,7 +38129,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json index 78f5fd20d96c..a2cf6e38b575 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json @@ -1,93 +1,223 @@ { - "openapi": "3.0.0", + "openapi": "3.2.0", "info": { "title": "Microsoft Foundry", "version": "virtual-public-preview" }, "tags": [ { - "name": "Agents" + "name": "EvaluationSuiteGenerationJobs" }, { - "name": "Agent Containers" + "name": "Fine-Tuning" }, { - "name": "Agent Session Files" + "name": "Responses Root", + "description": "Responses" }, { - "name": "Agent Invocations" + "name": "Responses", + "parent": "Responses Root", + "description": "Responses (OpenAI)" }, { - "name": "Agent Invocations WebSocket" + "name": "Conversations", + "parent": "Responses Root", + "description": "Conversations (OpenAI)" }, { - "name": "Connections" + "name": "Agents Root", + "description": "Agents" }, { - "name": "Datasets" + "name": "Agents", + "parent": "Agents Root", + "description": "Agent Management" }, { - "name": "Deployments" + "name": "Agent Invocations", + "parent": "Agents Root" }, { - "name": "Evaluation Taxonomies" + "name": "Agent Invocations WebSocket", + "parent": "Agents Root", + "description": "Agent Invocations (WebSocket)" }, { - "name": "Evaluation Rules" + "name": "Agent Sessions", + "parent": "Agents Root" }, { - "name": "EvaluationSuiteGenerationJobs" + "name": "Agent Session Files", + "parent": "Agents Root" }, { - "name": "Evaluators" + "name": "Agent Versions", + "parent": "Agents Root" }, { - "name": "EvaluatorGenerationJobs" + "name": "Agent Containers", + "parent": "Agents Root" }, { - "name": "Indexes" + "name": "Platform APIs" }, { - "name": "Insights" + "name": "Datasets", + "parent": "Platform APIs" }, { - "name": "Models" + "name": "Indexes", + "parent": "Platform APIs" }, { - "name": "Memory Stores" + "name": "Connections", + "parent": "Platform APIs" }, { - "name": "Conversations" + "name": "Scheduler", + "parent": "Platform APIs" }, { - "name": "Evals" + "name": "Fine-tuning", + "parent": "Platform APIs", + "summary": "Fine-Tuning" }, { - "name": "Fine-Tuning" + "name": "Models", + "parent": "Platform APIs" + }, + { + "name": "Memory Stores", + "parent": "Platform APIs" + }, + { + "name": "Chat", + "parent": "Platform APIs" + }, + { + "name": "Assistants", + "parent": "Platform APIs" + }, + { + "name": "Audio", + "parent": "Platform APIs" + }, + { + "name": "Batch", + "parent": "Platform APIs" + }, + { + "name": "Completions", + "parent": "Platform APIs" + }, + { + "name": "Containers", + "parent": "Platform APIs" + }, + { + "name": "Embeddings", + "parent": "Platform APIs" + }, + { + "name": "Files", + "parent": "Platform APIs" + }, + { + "name": "Images", + "parent": "Platform APIs" + }, + { + "name": "Moderations", + "parent": "Platform APIs" + }, + { + "name": "Realtime", + "parent": "Platform APIs" + }, + { + "name": "Threads", + "parent": "Platform APIs" + }, + { + "name": "Uploads", + "parent": "Platform APIs" + }, + { + "name": "Vector stores", + "parent": "Platform APIs", + "summary": "Vector Stores" + }, + { + "name": "Videos", + "parent": "Platform APIs" + }, + { + "name": "Routines", + "parent": "Platform APIs" + }, + { + "name": "Schedules", + "parent": "Platform APIs" + }, + { + "name": "Skills", + "parent": "Platform APIs" + }, + { + "name": "Toolboxes", + "parent": "Platform APIs" + }, + { + "name": "Deployments", + "parent": "Platform APIs" + }, + { + "name": "DataGenerationJobs", + "parent": "Platform APIs", + "summary": "Data generation jobs" + }, + { + "name": "AgentOptimizationJobs", + "parent": "Platform APIs", + "summary": "Agent optimization jobs" }, { - "name": "Responses" + "name": "EvaluatorGenerationJobs", + "parent": "Platform APIs", + "summary": "Evaluator generation jobs" }, { - "name": "Redteams" + "name": "Evaluations" }, { - "name": "Routines" + "name": "Evals", + "parent": "Evaluations" }, { - "name": "Schedules" + "name": "Evaluation Rules", + "parent": "Evaluations" }, { - "name": "Skills" + "name": "Evaluators", + "parent": "Evaluations" }, { - "name": "Toolboxes" + "name": "Evaluation Taxonomies", + "parent": "Evaluations" }, { - "name": "DataGenerationJobs" + "name": "Redteams", + "parent": "Evaluations", + "summary": "Red Teaming" }, { - "name": "AgentOptimizationJobs" + "name": "Evalsuite", + "parent": "Evaluations" + }, + { + "name": "Insights", + "parent": "Evaluations" } ], "paths": { @@ -1361,8 +1491,7 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } @@ -1565,7 +1694,7 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } } @@ -1900,7 +2029,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "requestBody": { "required": true, @@ -2065,7 +2194,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2440,8 +2569,7 @@ "content": { "application/octet-stream": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/octet-stream" } } } @@ -2523,8 +2651,7 @@ "content": { "application/octet-stream": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/octet-stream" } } } @@ -2649,7 +2776,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2738,7 +2865,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2820,7 +2947,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3224,7 +3351,7 @@ ] }, "tags": [ - "Agents" + "Agent Versions" ], "requestBody": { "required": true, @@ -3373,7 +3500,7 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] } }, @@ -3445,7 +3572,7 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] }, "delete": { @@ -3526,7 +3653,7 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] } }, @@ -4416,7 +4543,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -4485,7 +4612,7 @@ } }, "tags": [ - "Agents" + "Agent Versions" ], "requestBody": { "required": true, @@ -10774,7 +10901,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -11027,7 +11154,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -12741,9 +12868,15 @@ "description": "URL to poll for operation status." }, "operationResult": { - "type": "string", - "format": "uri", - "nullable": true, + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ], "description": "URL to the operation result, or null if the operation is still in progress." } } @@ -13823,11 +13956,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -14172,11 +14301,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -14559,11 +14684,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -15325,41 +15446,45 @@ "type": "object", "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_logprobs": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "user": { @@ -15369,7 +15494,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -15379,51 +15505,62 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.integer" + "type": "boolean" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_tool_calls": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -15445,12 +15582,18 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } ], - "nullable": true, "default": "disabled" }, "id": { @@ -15483,27 +15626,37 @@ "description": "Unix timestamp (in seconds) of when this Response was created." }, "completed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "incomplete_details": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output": { "type": "array", @@ -15522,30 +15675,59 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output_text": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "usage": { "$ref": "#/components/schemas/OpenAI.ResponseUsage" }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Moderation" + }, + { + "type": "null" + } + ] + }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.", "default": true }, "conversation": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" + }, + { + "type": "null" } - ], - "nullable": true + ] + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] }, "agent": { "allOf": [ @@ -15560,13 +15742,14 @@ "description": "The session identifier for this response. Currently only relevant for hosted agents.\nAlways returned for hosted agents — either the caller-provided value, the auto-derived value,\nor an auto-generated UUID. Use for session-scoped operations and to maintain sandbox\naffinity in follow-up calls." }, "agent_reference": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/AgentReference" + }, + { + "type": "null" } ], - "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -15629,41 +15812,45 @@ "type": "object", "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_logprobs": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "user": { @@ -15673,7 +15860,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -15683,51 +15871,62 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.integer" + "type": "boolean" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_tool_calls": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -15749,67 +15948,132 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } ], - "nullable": true, "default": "disabled" }, "input": { "$ref": "#/components/schemas/OpenAI.InputParam" }, "include": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.IncludeEnum" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.IncludeEnum" + } + }, + { + "type": "null" + } + ] }, "parallel_tool_calls": { - "type": "boolean", - "nullable": true, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "default": true }, "store": { - "type": "boolean", - "nullable": true, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "default": true }, "instructions": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationParam" + }, + { + "type": "null" + } + ] }, "stream": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, "stream_options": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "conversation": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationParam" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "context_management": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContextManagementParam" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ContextManagementParam" + } + }, + { + "type": "null" + } + ], "description": "Context management configuration for this request." }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, "agent": { "allOf": [ { @@ -15832,7 +16096,7 @@ }, "structured_inputs": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." } } @@ -18339,8 +18603,7 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } @@ -18870,8 +19133,7 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } @@ -19367,7 +19629,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the toolbox." @@ -19950,7 +20212,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -20366,13 +20628,17 @@ "type": "integer", "format": "int32", "description": "The maximum number of replicas for the container. Default is 1.", - "example": 10 + "examples": [ + 10 + ] }, "min_replicas": { "type": "integer", "format": "int32", "description": "The minimum number of replicas for the container. Default is 1.", - "example": 1 + "examples": [ + 1 + ] }, "error_message": { "type": "string", @@ -20796,7 +21062,7 @@ }, "evaluators": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -20873,7 +21139,7 @@ }, "additionalDetails": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties relevant to the evaluator. These will differ between evaluators." @@ -21415,11 +21681,17 @@ ], "properties": { "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ], "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -22192,7 +22464,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -22775,7 +23047,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -22846,7 +23118,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23063,7 +23335,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23253,7 +23525,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23455,7 +23727,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23611,7 +23883,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -23708,7 +23980,7 @@ }, "coordinates": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ChartCoordinate" }, "description": " Optional mapping of IDs to 2D coordinates used by the UX for visualization.\n\n The map keys are string identifiers (for example, a cluster id or a sample id)\n and the values are the coordinates and visual size for rendering on a 2D chart.\n\n This property is omitted unless the client requests coordinates (for example,\n by passing `includeCoordinates=true` as a query parameter).\n\n Example:\n ```\n {\n \"cluster-1\": { \"x\": 12, \"y\": 34, \"size\": 8 },\n \"sample-123\": { \"x\": 18, \"y\": 22, \"size\": 4 }\n }\n ```\n\n Coordinates are intended only for client-side visualization and do not\n modify the canonical insights results." @@ -23931,7 +24203,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata of the connection", @@ -23984,15 +24256,17 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication of the containers.", - "example": [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } + "examples": [ + [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } + ] ] }, "container_app_resource_id": { @@ -24002,7 +24276,11 @@ "ingress_subdomain_suffix": { "type": "string", "description": "The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app.", - "example": "--0000001" + "examples": [ + "--0000001", + "---current", + "" + ] } }, "allOf": [ @@ -24026,7 +24304,9 @@ "image": { "type": "string", "description": "The container image for the hosted agent.", - "example": "my-registry.azurecr.io/my-hosted-agent:latest" + "examples": [ + "my-registry.azurecr.io/my-hosted-agent:latest" + ] } }, "description": "Container-based deployment configuration for a hosted agent.", @@ -24181,8 +24461,7 @@ "format": "double", "maximum": 100, "description": "Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.", - "minimum": 0, - "exclusiveMinimum": true, + "exclusiveMinimum": 0, "default": 100 } }, @@ -24225,7 +24504,7 @@ }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, which is required for retrieving chat history." @@ -24329,8 +24608,6 @@ "description": "JSON metadata including description and hosted definition." }, "code": { - "type": "string", - "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -24354,7 +24631,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -24371,7 +24648,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -24390,7 +24667,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -24504,8 +24781,6 @@ "description": "JSON metadata including description and hosted definition." }, "code": { - "type": "string", - "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -24527,7 +24802,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -24558,7 +24833,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -24575,7 +24850,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -24588,7 +24863,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -24650,13 +24925,14 @@ "description": "The name of the evaluation." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "data_source_config": { "oneOf": [ @@ -24706,7 +24982,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -24725,13 +25001,14 @@ "description": "The name of the run." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "data_source": { "oneOf": [ @@ -24752,7 +25029,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -24792,10 +25069,7 @@ "properties": { "files": { "type": "array", - "items": { - "type": "string", - "format": "binary" - }, + "items": {}, "description": "Skill files to upload. Upload a single zip file or multiple individual files with relative paths." }, "default": { @@ -24896,7 +25170,7 @@ "readOnly": true } }, - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "allOf": [ @@ -24933,7 +25207,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Provider-specific trigger parameters." } }, @@ -25178,7 +25452,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs." @@ -25364,13 +25638,15 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The overall object JSON schema for the run data source items." } }, "discriminator": { "propertyName": "type", - "mapping": {} + "mapping": { + "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" + } }, "description": "Base class for run data sources with discriminator support." }, @@ -25409,7 +25685,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary of the output dataset.", @@ -25601,7 +25877,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -26189,13 +26465,14 @@ "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "modified_at": { "allOf": [ @@ -26211,7 +26488,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -26403,13 +26680,14 @@ "description": "Information about the run's data source." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "error": { "$ref": "#/components/schemas/OpenAI.EvalApiError" @@ -26428,7 +26706,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -26532,7 +26810,7 @@ }, "datasource_item": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Details of the input data source item." }, "results": { @@ -26588,9 +26866,15 @@ "description": "Whether the grader considered the output a pass." }, "sample": { - "type": "object", - "additionalProperties": {}, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ], "description": "Optional sample or intermediate data produced by the grader." }, "status": { @@ -26620,13 +26904,13 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional details about the test criteria metric." } }, - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "A single grader result for an evaluation run output item.", "title": "EvalRunOutputItemResult" }, @@ -26842,21 +27126,21 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Evaluation's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "evaluators": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -27086,7 +27370,7 @@ }, "systemData": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "System metadata for the evaluation rule.", @@ -27251,7 +27535,7 @@ }, "evalRun": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The evaluation run payload." } }, @@ -27424,7 +27708,7 @@ }, "initialization_parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Optional initialization parameters applied to all generated evaluators.\nFor example, deployment_name for LLM judge model, default threshold." }, "data_generation_options": { @@ -27813,7 +28097,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -27907,7 +28191,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -27992,7 +28276,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -28012,7 +28296,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28034,7 +28318,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -28112,7 +28396,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28134,7 +28418,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -28170,12 +28454,12 @@ }, "initParams": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Initialization parameters of the evaluator." }, "dataMapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Data parameters of the evaluator." @@ -28218,17 +28502,17 @@ }, "init_parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required." }, "data_schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required." }, "metrics": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorMetric" }, "description": "List of output metrics produced by this evaluator" @@ -28593,7 +28877,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -28687,7 +28971,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -28731,7 +29015,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28748,7 +29032,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -28776,7 +29060,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28938,17 +29222,13 @@ "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { - "type": "string", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -28964,7 +29244,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -29403,17 +29683,23 @@ "header_name": { "type": "string", "description": "The name of the HTTP header to inject the secret value into.", - "example": "X-Otlp-Api-Key" + "examples": [ + "X-Otlp-Api-Key" + ] }, "secret_id": { "type": "string", "description": "The identifier of the secret store or connection.", - "example": "my-secret-store" + "examples": [ + "my-secret-store" + ] }, "secret_key": { "type": "string", "description": "The key within the secret to retrieve the authentication value.", - "example": "OTLP_KEY" + "examples": [ + "OTLP_KEY" + ] } }, "allOf": [ @@ -29452,23 +29738,29 @@ "cpu": { "type": "string", "description": "The CPU configuration for the hosted agent.", - "example": "0.25" + "examples": [ + "0.25" + ] }, "memory": { "type": "string", "description": "The memory configuration for the hosted agent.", - "example": "0.5Gi" + "examples": [ + "0.5Gi" + ] }, "environment_variables": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Environment variables to set in the hosted agent container.", - "example": { - "name": "LOG_LEVEL", - "value": "debug" - } + "examples": [ + { + "name": "LOG_LEVEL", + "value": "debug" + } + ] }, "container_configuration": { "allOf": [ @@ -29489,15 +29781,17 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication.", - "example": [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } + "examples": [ + [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } + ] ], "x-ms-foundry-meta": { "required_previews": [ @@ -29694,7 +29988,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29950,12 +30244,12 @@ }, "features": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Features to help with additional filtering of data in UX." }, "correlationInfo": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Info about the correlation for the analysis sample." } }, @@ -30283,7 +30577,8 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", + "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -30699,7 +30994,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -30759,7 +31054,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -30816,11 +31111,17 @@ "description": "The status of the tool call." }, "memories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemoryItem" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemoryItem" + } + }, + { + "type": "null" + } + ], "description": "The results returned from the memory search." } }, @@ -31048,7 +31349,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -31327,7 +31628,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -31397,7 +31698,7 @@ }, "capabilities": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Capabilities of deployed model", @@ -31618,7 +31919,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -31825,8 +32126,7 @@ "create_file" ], "description": "Create a new file with the provided diff.", - "x-stainless-const": true, - "default": "create_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -31859,8 +32159,7 @@ "create_file" ], "description": "The operation type. Always `create_file`.", - "x-stainless-const": true, - "default": "create_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -31894,8 +32193,7 @@ "delete_file" ], "description": "Delete the specified file.", - "x-stainless-const": true, - "default": "delete_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -31923,8 +32221,7 @@ "delete_file" ], "description": "The operation type. Always `delete_file`.", - "x-stainless-const": true, - "default": "delete_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -32024,8 +32321,7 @@ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", - "x-stainless-const": true, - "default": "apply_patch" + "x-stainless-const": true } }, "allOf": [ @@ -32050,8 +32346,7 @@ "update_file" ], "description": "Update an existing file with the provided diff.", - "x-stainless-const": true, - "default": "update_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -32084,8 +32379,7 @@ "update_file" ], "description": "The operation type. Always `update_file`.", - "x-stainless-const": true, - "default": "update_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -32122,20 +32416,44 @@ "default": "approximate" }, "country": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "region": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "city": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "timezone": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } } }, @@ -32163,12 +32481,14 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "network_policy": { "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyParam" @@ -32202,6 +32522,12 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ + "gpt-5.4", + "gpt-5.4-mini", + "gpt-5.4-nano", + "gpt-5.4-mini-2026-03-17", + "gpt-5.4-nano-2026-03-17", + "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -32301,8 +32627,7 @@ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", - "x-stainless-const": true, - "default": "click" + "x-stainless-const": true }, "button": { "allOf": [ @@ -32327,6 +32652,19 @@ } ], "description": "The y-coordinate where the click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -32410,7 +32748,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -32500,17 +32838,61 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "instructions": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_key": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_retention": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" + }, + { + "type": "null" + } + ] + }, + "service_tier": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" + }, + { + "type": "null" + } + ] } } }, @@ -32530,7 +32912,9 @@ "gt", "gte", "lt", - "lte" + "lte", + "in", + "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -32632,6 +33016,14 @@ } } }, + "OpenAI.ComputerActionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerAction" + }, + "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", + "title": "Computer Action List" + }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -32664,12 +33056,24 @@ "description": "The ID of the pending safety check." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "A pending safety check for the computer call." @@ -32689,7 +33093,8 @@ "required": [ "type", "image_url", - "file_id" + "file_id", + "detail" ], "properties": { "type": { @@ -32698,17 +33103,36 @@ "computer_screenshot" ], "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.", - "x-stainless-const": true, - "default": "computer_screenshot" + "x-stainless-const": true }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ImageDetail" + } + ], + "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -32746,6 +33170,29 @@ }, "description": "A computer screenshot image used with the computer use tool." }, + "OpenAI.ComputerTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ], + "description": "The type of the computer tool. Always `computer`.", + "x-stainless-const": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", + "title": "Computer" + }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -32761,8 +33208,7 @@ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", - "x-stainless-const": true, - "default": "computer_use_preview" + "x-stainless-const": true }, "environment": { "allOf": [ @@ -32809,8 +33255,7 @@ "container_auto" ], "description": "Automatically creates a container for this request", - "x-stainless-const": true, - "default": "container_auto" + "x-stainless-const": true }, "file_ids": { "type": "array", @@ -32821,12 +33266,14 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "skills": { "type": "array", @@ -32863,8 +33310,7 @@ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", - "x-stainless-const": true, - "default": "container_file_citation" + "x-stainless-const": true }, "container_id": { "type": "string", @@ -32925,8 +33371,7 @@ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", - "x-stainless-const": true, - "default": "allowlist" + "x-stainless-const": true }, "allowed_domains": { "type": "array", @@ -32935,14 +33380,6 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." - }, - "domain_secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" - }, - "minItems": 1, - "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -32963,8 +33400,7 @@ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", - "x-stainless-const": true, - "default": "disabled" + "x-stainless-const": true } }, "allOf": [ @@ -32973,32 +33409,6 @@ } ] }, - "OpenAI.ContainerNetworkPolicyDomainSecretParam": { - "type": "object", - "required": [ - "domain", - "name", - "value" - ], - "properties": { - "domain": { - "type": "string", - "minLength": 1, - "description": "The domain associated with the secret." - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the secret to inject for the domain." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 10485760, - "description": "The secret value to inject for the domain." - } - } - }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -33045,8 +33455,7 @@ "container_reference" ], "description": "The environment type. Always `container_reference`.", - "x-stainless-const": true, - "default": "container_reference" + "x-stainless-const": true }, "container_id": { "type": "string" @@ -33103,13 +33512,14 @@ "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } } }, @@ -33127,14 +33537,18 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", + "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -33146,13 +33560,57 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", "title": "Conversation item" }, + "OpenAI.ConversationItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemApplyPatchToolCall": { "type": "object", "required": [ @@ -33245,8 +33703,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -33301,22 +33765,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33327,13 +33803,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ConversationItemCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -33357,6 +33870,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -33382,10 +33898,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutputResource": { + "OpenAI.ConversationItemComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -33401,7 +33918,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -33427,60 +33945,21 @@ "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationItem" - } - ] - }, - "OpenAI.ConversationItemCustomToolCall": { - "type": "object", - "required": [ - "type", - "call_id", - "name", - "input" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "custom_tool_call" - ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", - "x-stainless-const": true - }, - "id": { - "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." - }, - "call_id": { - "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." - }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." - }, - "input": { - "type": "string", - "description": "The input for the custom tool call generated by the model." - } - }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ConversationItemCustomToolCallOutput": { + "OpenAI.ConversationItemCustomToolCallOutputResource": { "type": "object", "required": [ "type", "call_id", - "output" + "output", + "status" ], "properties": { "type": { @@ -33512,6 +33991,18 @@ } ], "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -33519,8 +34010,65 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "The output of a custom tool call from your code, being sent back to the model.", - "title": "Custom tool call output" + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ConversationItemCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "title": "ResponseCustomToolCallItem" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -33562,11 +34110,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33616,19 +34170,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -33674,7 +34229,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -33687,13 +34242,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -33708,43 +34264,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCallOutputResource": { + "OpenAI.ConversationItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -33760,40 +34317,49 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ConversationItemFunctionToolCallResource": { + "OpenAI.ConversationItemFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -33809,7 +34375,9 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -33843,8 +34411,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33974,13 +34548,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34064,8 +34644,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34109,8 +34695,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -34156,12 +34741,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -34172,8 +34763,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34229,6 +34826,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34260,8 +34867,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -34295,6 +34908,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ConversationItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, + "OpenAI.ConversationItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -34311,7 +35056,11 @@ "image_generation_call", "computer_call", "computer_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", + "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -34500,7 +35249,8 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", + "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -34570,20 +35320,27 @@ "type": "object", "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.InputItem" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + }, + { + "type": "null" + } + ] } } }, @@ -34761,7 +35518,7 @@ }, "item_schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The json schema for each row in the data source." }, "include_sample_schema": { @@ -34830,7 +35587,7 @@ }, "metadata": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Metadata filters for the logs data source." } }, @@ -35025,7 +35782,7 @@ }, "metadata": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Metadata filters for the stored completions data source." } }, @@ -35077,33 +35834,52 @@ "deprecated": true }, "suffix": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "minLength": 1, "maxLength": 64, "description": "A string of up to 64 characters that will be added to your fine-tuned model name.\n For example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`." }, "validation_file": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "The ID of an uploaded file that contains validation data.\n If you provide this file, the data is used to generate validation\n metrics periodically during fine-tuning. These metrics can be viewed in\n the fine-tuning results file.\n The same data should not be present in both train and validation files.\n Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n See the [fine-tuning guide](/docs/guides/model-optimization) for more details." }, "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" + } + }, + { + "type": "null" + } + ], "description": "A list of integrations to enable for your fine-tuning job." }, "seed": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } ], - "nullable": true, "minimum": 0, "maximum": 2147483647, "description": "The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\n If a seed is not specified, one will be generated for you." @@ -35112,13 +35888,14 @@ "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] } } }, @@ -35198,12 +35975,24 @@ "type": "string" }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "entity": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "tags": { "type": "array", @@ -35390,8 +36179,7 @@ "grammar" ], "description": "Grammar format. Always `grammar`.", - "x-stainless-const": true, - "default": "grammar" + "x-stainless-const": true }, "syntax": { "allOf": [ @@ -35426,8 +36214,7 @@ "text" ], "description": "Unconstrained text format. Always `text`.", - "x-stainless-const": true, - "default": "text" + "x-stainless-const": true } }, "allOf": [ @@ -35451,8 +36238,7 @@ "custom" ], "description": "The type of the custom tool. Always `custom`.", - "x-stainless-const": true, - "default": "custom" + "x-stainless-const": true }, "name": { "type": "string", @@ -35469,6 +36255,10 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -35541,7 +36331,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.DoubleClickAction": { @@ -35549,7 +36340,8 @@ "required": [ "type", "x", - "y" + "y", + "keys" ], "properties": { "type": { @@ -35558,8 +36350,7 @@ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", - "x-stainless-const": true, - "default": "double_click" + "x-stainless-const": true }, "x": { "allOf": [ @@ -35576,6 +36367,19 @@ } ], "description": "The y-coordinate where the double click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35599,8 +36403,7 @@ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", - "x-stainless-const": true, - "default": "drag" + "x-stainless-const": true }, "path": { "type": "array", @@ -35608,6 +36411,19 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35647,6 +36463,16 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "type": { "type": "string", "enum": [ @@ -35673,6 +36499,9 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, + "OpenAI.EmptyModelParam": { + "type": "object" + }, "OpenAI.Error": { "type": "object", "required": [ @@ -35681,15 +36510,27 @@ ], "properties": { "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { "type": "string" }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string" @@ -35702,11 +36543,11 @@ }, "additionalInfo": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "debugInfo": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } }, @@ -35885,41 +36726,45 @@ "type": "object", "properties": { "seed": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_completions_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "reasoning_effort": { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" @@ -36260,11 +37105,11 @@ "properties": { "item": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "sample": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } }, @@ -36305,75 +37150,111 @@ "description": "The type of run data source. Always `responses`." }, "metadata": { - "type": "object", - "additionalProperties": {}, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ] }, "model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "instructions_search": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_after": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_before": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "reasoning_effort": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "users": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "tools": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "description": "A EvalResponsesSource object describing a run data source configuration.", @@ -36573,44 +37454,54 @@ "default": "stored_completions" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_after": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_before": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "limit": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "A StoredCompletionsRunDataSource configuration describing a set of filters", @@ -36636,8 +37527,7 @@ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", - "x-stainless-const": true, - "default": "file_citation" + "x-stainless-const": true }, "file_id": { "type": "string", @@ -36664,6 +37554,13 @@ "description": "A citation to a file.", "title": "File citation" }, + "OpenAI.FileInputDetail": { + "type": "string", + "enum": [ + "low", + "high" + ] + }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -36714,8 +37611,7 @@ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true, - "default": "file_search" + "x-stainless-const": true }, "vector_store_ids": { "type": "array", @@ -36741,12 +37637,14 @@ "description": "Ranking options for search." }, "filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "name": { "type": "string", @@ -36758,7 +37656,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -36785,13 +37683,14 @@ "type": "string" }, "attributes": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.VectorStoreFileAttributes" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "score": { "type": "number", @@ -37146,12 +38045,24 @@ "type": "string" }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "entity": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "tags": { "type": "array", @@ -37191,22 +38102,37 @@ "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created." }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FineTuningJobError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "fine_tuned_model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "finished_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "hyperparameters": { "allOf": [ @@ -37252,28 +38178,41 @@ "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`." }, "trained_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "training_file": { "type": "string", "description": "The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents)." }, "validation_file": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" + } + }, + { + "type": "null" + } + ] }, "seed": { "allOf": [ @@ -37284,21 +38223,30 @@ "description": "The seed used for the fine-tuning job." }, "estimated_finish": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "method": { "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.", @@ -37410,8 +38358,14 @@ "type": "string" }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } } }, @@ -37490,17 +38444,13 @@ "type": "string", "enum": [ "auto" - ], - "nullable": true + ] }, { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } ], "default": "auto" @@ -37570,21 +38520,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -37612,13 +38576,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -37626,7 +38602,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -37689,6 +38665,22 @@ "incomplete" ] }, + "OpenAI.FunctionCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -37707,14 +38699,20 @@ "$ref": "#/components/schemas/OpenAI.FunctionParameters" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } } }, "OpenAI.FunctionParameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\nOmitting `parameters` defines a function with an empty parameter list." }, "OpenAI.FunctionShellAction": { @@ -37732,22 +38730,24 @@ } }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Execute a shell command.", @@ -37767,22 +38767,24 @@ "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Commands and limits describing how to run the shell tool call.", @@ -37996,8 +38998,7 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true, - "default": "exit" + "x-stainless-const": true }, "exit_code": { "allOf": [ @@ -38029,8 +39030,7 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true, - "default": "exit" + "x-stainless-const": true }, "exit_code": { "allOf": [ @@ -38117,6 +39117,14 @@ } ] }, + "OpenAI.FunctionShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -38129,8 +39137,7 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true, - "default": "timeout" + "x-stainless-const": true } }, "allOf": [ @@ -38153,8 +39160,7 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true, - "default": "timeout" + "x-stainless-const": true } }, "allOf": [ @@ -38165,6 +39171,14 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, + "OpenAI.FunctionShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -38177,17 +39191,17 @@ "shell" ], "description": "The type of the shell tool. Always `shell`.", - "x-stainless-const": true, - "default": "shell" + "x-stainless-const": true }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellToolParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "name": { "type": "string", @@ -38199,7 +39213,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -38319,25 +39333,46 @@ "function" ], "description": "The type of the function tool. Always `function`.", - "x-stainless-const": true, - "default": "function" + "x-stainless-const": true }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "parameters": { - "type": "object", - "additionalProperties": {}, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ] }, "strict": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "defer_loading": { "type": "boolean", - "nullable": true + "description": "Whether this function is deferred and loaded via tool search." } }, "allOf": [ @@ -38348,61 +39383,62 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolCallOutput": { + "OpenAI.FunctionToolParam": { "type": "object", "required": [ - "type", - "call_id", - "output" + "name", + "type" ], "properties": { - "id": { + "name": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_-]+$" }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] }, - "output": { - "oneOf": [ + "strict": { + "anyOf": [ { - "type": "string" + "type": "boolean" }, { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "type": "null" } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + ] }, - "status": { + "type": { "type": "string", "enum": [ - "in_progress", - "completed", - "incomplete" + "function" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" + "x-stainless-const": true, + "default": "function" + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function should be deferred and discovered via tool search." } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + } }, "OpenAI.GraderLabelModel": { "type": "object", @@ -38750,7 +39786,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.ImageGenActionEnum": { @@ -38773,8 +39810,7 @@ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.", - "x-stainless-const": true, - "default": "image_generation" + "x-stainless-const": true }, "model": { "anyOf": [ @@ -38804,14 +39840,21 @@ "default": "auto" }, "size": { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" + ] + } ], - "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", + "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { @@ -38855,12 +39898,14 @@ "default": "auto" }, "input_fidelity": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.InputFidelity" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "input_image_mask": { "allOf": [ @@ -38898,7 +39943,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -38944,7 +39989,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -38961,8 +40006,7 @@ "inline" ], "description": "Defines an inline skill for this request.", - "x-stainless-const": true, - "default": "inline" + "x-stainless-const": true }, "name": { "type": "string", @@ -39103,21 +40147,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -39145,13 +40203,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -39159,7 +40229,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -39238,21 +40308,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -39274,21 +40358,53 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "file_data": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "file_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -39311,13 +40427,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -39325,7 +40453,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -39347,21 +40475,35 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.DetailEnum" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", @@ -39389,6 +40531,9 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -39409,6 +40554,56 @@ }, "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs." }, + "OpenAI.InputItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -39428,8 +40623,14 @@ "default": "apply_patch_call" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -39480,8 +40681,14 @@ "default": "apply_patch_call_output" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -39498,8 +40705,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39550,22 +40763,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39584,8 +40809,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string", @@ -39619,8 +40850,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -39641,19 +40878,27 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + } + }, + { + "type": "null" + } + ] }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -39670,7 +40915,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -39694,6 +40938,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -39744,6 +40991,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -39848,11 +41099,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39872,8 +41129,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -39915,12 +41178,14 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -39940,8 +41205,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -39967,21 +41238,24 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -40001,8 +41275,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -40027,21 +41307,24 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -40055,6 +41338,7 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -40063,7 +41347,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -40077,6 +41362,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -40135,8 +41424,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40219,13 +41514,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40296,8 +41597,14 @@ "x-stainless-const": true }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "approval_request_id": { "type": "string", @@ -40308,8 +41615,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40353,8 +41666,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -40400,12 +41712,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -40416,8 +41734,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40465,6 +41789,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -40504,8 +41838,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -40539,6 +41879,143 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.InputItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, + "OpenAI.InputItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemType": { "anyOf": [ { @@ -40555,6 +42032,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -40630,52 +42110,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.InputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -40684,55 +42118,6 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, - "OpenAI.InputMessageResource": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.InputParam": { "oneOf": [ { @@ -40809,7 +42194,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessage", + "message": "#/components/schemas/OpenAI.ItemInputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -40817,6 +42202,9 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.ItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -40837,6 +42225,56 @@ }, "description": "Content item used to generate a response." }, + "OpenAI.ItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -40856,8 +42294,14 @@ "default": "apply_patch_call" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -40908,8 +42352,14 @@ "default": "apply_patch_call_output" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -40926,8 +42376,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40978,22 +42434,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41012,8 +42480,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string", @@ -41047,8 +42521,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -41069,19 +42549,27 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + } + }, + { + "type": "null" + } + ] }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -41098,7 +42586,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -41122,6 +42609,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -41172,6 +42662,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -41249,14 +42743,17 @@ "discriminator": { "propertyName": "type", "mapping": { - "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", + "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemFieldAdditionalTools", + "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -41276,6 +42773,50 @@ }, "description": "An item representing a message, tool call, tool output, reasoning, or other response element." }, + "OpenAI.ItemFieldAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldApplyPatchToolCall": { "type": "object", "required": [ @@ -41368,8 +42909,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -41424,22 +42971,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41494,7 +43053,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -41518,6 +43076,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -41543,10 +43104,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutputResource": { + "OpenAI.ItemFieldComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -41562,7 +43124,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -41592,7 +43155,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -41619,6 +43184,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -41723,11 +43292,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41777,19 +43352,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -41835,7 +43411,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -41848,13 +43424,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -41872,6 +43449,7 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -41880,7 +43458,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -41894,6 +43473,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -41920,6 +43503,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.ItemFieldFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -41952,8 +43593,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42036,13 +43683,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42126,8 +43779,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42171,8 +43830,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -42218,12 +43876,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -42234,8 +43898,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42291,6 +43961,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42322,8 +44002,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -42357,6 +44043,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ItemFieldToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, + "OpenAI.ItemFieldToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldType": { "anyOf": [ { @@ -42367,6 +44185,9 @@ "enum": [ "message", "function_call", + "tool_search_call", + "tool_search_output", + "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -42486,11 +44307,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42510,8 +44337,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -42553,12 +44386,14 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -42578,8 +44413,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -42605,21 +44446,24 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -42639,8 +44483,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -42665,21 +44515,24 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -42693,6 +44546,7 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -42701,7 +44555,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -42715,6 +44570,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -42773,8 +44632,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42785,6 +44650,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -42857,13 +44775,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42934,8 +44858,14 @@ "x-stainless-const": true }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "approval_request_id": { "type": "string", @@ -42946,8 +44876,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42991,8 +44927,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -43038,12 +44973,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -43054,8 +44995,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43103,6 +45050,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -43142,8 +45099,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -43190,8 +45153,7 @@ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", - "x-stainless-const": true, - "default": "item_reference" + "x-stainless-const": true }, "id": { "type": "string", @@ -43219,14 +45181,19 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessageResource", + "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemResourceAdditionalTools", + "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", + "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -43238,11 +45205,57 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", + "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" } }, "description": "Content item used to generate a response." }, + "OpenAI.ItemResourceAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceApplyPatchToolCall": { "type": "object", "required": [ @@ -43335,8 +45348,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -43391,22 +45410,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43417,13 +45448,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ItemResourceCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -43447,6 +45515,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -43472,10 +45543,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutputResource": { + "OpenAI.ItemResourceComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -43491,7 +45563,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -43521,7 +45594,126 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.ItemResourceCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ItemResourceCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallItem" }, "OpenAI.ItemResourceFileSearchToolCall": { "type": "object", @@ -43563,11 +45755,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43617,19 +45815,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -43675,7 +45874,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -43688,13 +45887,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -43709,43 +45909,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCallOutputResource": { + "OpenAI.ItemResourceFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -43761,40 +45962,49 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ItemResourceFunctionToolCallResource": { + "OpenAI.ItemResourceFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -43810,7 +46020,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ItemResourceImageGenToolCall": { "type": "object", @@ -43844,8 +46056,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43856,6 +46074,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemResourceInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", "required": [ @@ -43928,13 +46199,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -44018,8 +46295,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -44063,8 +46346,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -44110,12 +46392,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -44126,8 +46414,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -44175,6 +46469,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -44193,6 +46497,200 @@ "description": "An output message from the model.", "title": "Output message" }, + "OpenAI.ItemResourceReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.ItemResourceToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceType": { "anyOf": [ { @@ -44209,6 +46707,11 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", + "reasoning", + "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -44221,6 +46724,8 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", + "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -44303,6 +46808,143 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.ItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, + "OpenAI.ItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemType": { "anyOf": [ { @@ -44319,6 +46961,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -44430,8 +47075,7 @@ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", - "x-stainless-const": true, - "default": "keypress" + "x-stainless-const": true }, "keys": { "type": "array", @@ -44472,12 +47116,24 @@ "x-stainless-const": true }, "first_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "last_id": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "x-ms-list-continuation-token": true }, "has_more": { @@ -44551,8 +47207,7 @@ "local" ], "description": "The environment type. Always `local`.", - "x-stainless-const": true, - "default": "local" + "x-stainless-const": true } }, "allOf": [ @@ -44563,22 +47218,6 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.LocalShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -44604,29 +47243,42 @@ "description": "The command to run." }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "working_directory": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "env": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Environment variables to set for the command.", "x-oaiTypeLabel": "map" }, "user": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "Execute a shell command on the server.", @@ -44644,8 +47296,7 @@ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", - "x-stainless-const": true, - "default": "local_shell" + "x-stainless-const": true }, "name": { "type": "string", @@ -44657,7 +47308,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -44736,8 +47387,14 @@ "description": "The name of the tool." }, "description": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "input_schema": { "allOf": [ @@ -44748,13 +47405,14 @@ "description": "The JSON schema describing the tool's input." }, "annotations": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.MCPListToolsToolAnnotations" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "A tool available on an MCP server.", @@ -44813,11 +47471,17 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "allowed_tools": { "anyOf": [ @@ -44825,49 +47489,45 @@ "type": "array", "items": { "type": "string" - }, - "nullable": true + } }, { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + { + "type": "null" } ] }, "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { "type": "string", "enum": [ "always", "never" - ], - "nullable": true + ] + }, + { + "type": "null" } ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -44941,7 +47601,8 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", + "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" } }, "description": "A content part that makes up an input or output item." @@ -44962,21 +47623,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -45004,13 +47679,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -45018,7 +47705,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -45181,6 +47868,14 @@ } ] }, + "OpenAI.MessagePhase": { + "type": "string", + "enum": [ + "commentary", + "final_answer" + ], + "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." + }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -45204,7 +47899,7 @@ }, "OpenAI.Metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -45213,18 +47908,13 @@ "OpenAI.ModelIdsCompaction": { "anyOf": [ { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" - } - ], - "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", - "nullable": true + "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" }, { - "type": "string", - "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models." @@ -45265,6 +47955,182 @@ } ] }, + "OpenAI.Moderation": { + "type": "object", + "required": [ + "input", + "output" + ], + "properties": { + "input": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "Moderation for the response input." + }, + "output": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "Moderation for the response output." + } + }, + "description": "Moderation results or errors for the response input and output.", + "title": "Moderation" + }, + "OpenAI.ModerationEntry": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ModerationEntryType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "moderation_result": "#/components/schemas/OpenAI.ModerationResultBody", + "error": "#/components/schemas/OpenAI.ModerationErrorBody" + } + }, + "description": "Moderation results or an error for a response moderation check." + }, + "OpenAI.ModerationEntryType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "moderation_result", + "error" + ] + } + ] + }, + "OpenAI.ModerationErrorBody": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "error" + ], + "description": "The object type, which was always `error` for moderation failures.", + "x-stainless-const": true + }, + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "An error produced while attempting moderation for the response input or output.", + "title": "Moderation error" + }, + "OpenAI.ModerationInputType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, + "OpenAI.ModerationParam": { + "type": "object", + "required": [ + "model" + ], + "properties": { + "model": { + "type": "string", + "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'." + } + }, + "description": "Configuration for running moderation on the input and output of this response." + }, + "OpenAI.ModerationResultBody": { + "type": "object", + "required": [ + "type", + "model", + "flagged", + "categories", + "category_scores", + "category_applied_input_types" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "moderation_result" + ], + "description": "The object type, which was always `moderation_result` for successful moderation results.", + "x-stainless-const": true + }, + "model": { + "type": "string", + "description": "The moderation model that produced this result." + }, + "flagged": { + "type": "boolean", + "description": "A boolean indicating whether the content was flagged by any category." + }, + "categories": { + "type": "object", + "unevaluatedProperties": { + "type": "boolean" + }, + "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.", + "x-oaiTypeLabel": "map" + }, + "category_scores": { + "type": "object", + "unevaluatedProperties": { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + "description": "A dictionary of moderation categories to scores.", + "x-oaiTypeLabel": "map" + }, + "category_applied_input_types": { + "type": "object", + "unevaluatedProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ModerationInputType" + } + }, + "description": "Which modalities of input are reflected by the score for each category.", + "x-oaiTypeLabel": "map" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "A moderation result produced for the response input or output.", + "title": "Moderation result" + }, "OpenAI.MoveParam": { "type": "object", "required": [ @@ -45279,8 +48145,7 @@ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", - "x-stainless-const": true, - "default": "move" + "x-stainless-const": true }, "x": { "allOf": [ @@ -45297,6 +48162,19 @@ } ], "description": "The y-coordinate to move to." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -45307,6 +48185,57 @@ "description": "A mouse move action.", "title": "Move" }, + "OpenAI.NamespaceToolParam": { + "type": "object", + "required": [ + "type", + "name", + "description", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "namespace" + ], + "description": "The type of the tool. Always `namespace`.", + "x-stainless-const": true + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The namespace name used in tool calls (for example, `crm`)." + }, + "description": { + "type": "string", + "minLength": 1, + "description": "A description of the namespace shown to the model." + }, + "tools": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionToolParam" + }, + { + "$ref": "#/components/schemas/OpenAI.CustomToolParam" + } + ] + }, + "minItems": 1, + "description": "The function/custom tools available inside this namespace." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Groups function/custom tools under a shared namespace.", + "title": "Namespace" + }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -45506,13 +48435,19 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", + "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", + "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.OutputItemAdditionalTools", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", + "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -45520,10 +48455,56 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" + "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" } } }, + "OpenAI.OutputItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemApplyPatchToolCall": { "type": "object", "required": [ @@ -45616,8 +48597,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -45672,22 +48659,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -45742,7 +48741,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -45766,6 +48764,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -45791,13 +48792,128 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemCustomToolCall": { + "OpenAI.OutputItemComputerToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_call_output" + ], + "description": "The type of the computer tool call output. Always `computer_call_output`.", + "x-stainless-const": true, + "default": "computer_call_output" + }, + "id": { + "type": "string", + "description": "The ID of the computer tool call output.", + "readOnly": true + }, + "call_id": { + "type": "string", + "description": "The ID of the computer tool call that produced the output." + }, + "acknowledged_safety_checks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "description": "The safety checks reported by the API that have been acknowledged by the\n developer." + }, + "output": { + "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.OutputItemCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.OutputItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", "name", - "input" + "input", + "status" ], "properties": { "type": { @@ -45816,6 +48932,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -45823,6 +48943,18 @@ "input": { "type": "string", "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -45830,8 +48962,7 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallItem" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -45873,11 +49004,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -45927,19 +49064,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -45985,7 +49123,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -45998,13 +49136,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -46022,6 +49161,7 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -46030,7 +49170,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -46044,6 +49185,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -46070,6 +49215,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.OutputItemFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", "required": [ @@ -46102,8 +49305,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -46161,6 +49370,54 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, + "OpenAI.OutputItemLocalShellToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "local_shell_call_output" + ], + "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the local shell tool call generated by the model." + }, + "output": { + "type": "string", + "description": "A JSON string of the output of the local shell tool call." + }, + "status": { + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a local shell tool call.", + "title": "Local shell call output" + }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -46204,6 +49461,54 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, + "OpenAI.OutputItemMcpApprovalResponseResource": { + "type": "object", + "required": [ + "type", + "id", + "approval_request_id", + "approve" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_approval_response" + ], + "description": "The type of the item. Always `mcp_approval_response`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the approval response" + }, + "approval_request_id": { + "type": "string", + "description": "The ID of the approval request being answered." + }, + "approve": { + "type": "boolean", + "description": "Whether the request was approved." + }, + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A response to an MCP approval request.", + "title": "MCP approval response" + }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -46237,8 +49542,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -46284,12 +49588,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -46300,8 +49610,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -46349,6 +49665,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -46388,8 +49714,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -46423,6 +49755,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.OutputItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, + "OpenAI.OutputItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemType": { "anyOf": [ { @@ -46434,13 +49898,19 @@ "output_message", "file_search_call", "function_call", + "function_call_output", "web_search_call", "computer_call", + "computer_call_output", "reasoning", + "tool_search_call", + "tool_search_output", + "additional_tools", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", + "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -46448,7 +49918,9 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", + "mcp_approval_response", "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -46647,21 +50119,35 @@ "description": "The unique identifier of the prompt template to use." }, "version": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "variables": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponsePromptVariables" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, + "OpenAI.PromptCacheRetentionEnum": { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -46698,46 +50184,181 @@ } } }, - "OpenAI.Reasoning": { + "OpenAI.RealtimeMCPError": { "type": "object", + "required": [ + "type" + ], "properties": { - "effort": { - "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + "type": { + "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", + "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", + "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" + } + } + }, + "OpenAI.RealtimeMCPHTTPError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "http_error" + ], + "x-stainless-const": true }, - "summary": { + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP HTTP error" + }, + "OpenAI.RealtimeMCPProtocolError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { "type": "string", "enum": [ - "auto", - "concise", - "detailed" + "protocol_error" ], - "nullable": true + "x-stainless-const": true }, - "generate_summary": { + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP protocol error" + }, + "OpenAI.RealtimeMCPToolExecutionError": { + "type": "object", + "required": [ + "type", + "message" + ], + "properties": { + "type": { "type": "string", "enum": [ - "auto", - "concise", - "detailed" + "tool_execution_error" ], - "nullable": true + "x-stainless-const": true + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP tool execution error" + }, + "OpenAI.RealtimeMcpErrorType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "protocol_error", + "tool_execution_error", + "http_error" + ] + } + ] + }, + "OpenAI.Reasoning": { + "type": "object", + "properties": { + "effort": { + "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + }, + "summary": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "concise", + "detailed" + ] + }, + { + "type": "null" + } + ] + }, + "generate_summary": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "concise", + "detailed" + ] + }, + { + "type": "null" + } + ] } }, "description": "**gpt-5 and o-series models only**\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).", "title": "Reasoning" }, "OpenAI.ReasoningEffort": { - "type": "string", - "enum": [ - "none", - "minimal", - "low", - "medium", - "high", - "xhigh" + "anyOf": [ + { + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh" + ] + }, + { + "type": "null" + } ], - "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`.", - "nullable": true + "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`." }, "OpenAI.ReasoningTextContent": { "type": "object", @@ -46778,41 +50399,45 @@ ], "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_logprobs": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "user": { @@ -46822,7 +50447,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -46832,51 +50458,62 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.integer" + "type": "boolean" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_tool_calls": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -46898,12 +50535,18 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } ], - "nullable": true, "default": "disabled" }, "id": { @@ -46936,27 +50579,37 @@ "description": "Unix timestamp (in seconds) of when this Response was created." }, "completed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "incomplete_details": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output": { "type": "array", @@ -46975,30 +50628,59 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output_text": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "usage": { "$ref": "#/components/schemas/OpenAI.ResponseUsage" }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Moderation" + }, + { + "type": "null" + } + ] + }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.", "default": true }, "conversation": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" + }, + { + "type": "null" } - ], - "nullable": true + ] + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] }, "agent": { "allOf": [ @@ -47013,13 +50695,14 @@ "description": "The session identifier for this response. Currently only relevant for hosted agents.\nAlways returned for hosted agents — either the caller-provided value, the auto-derived value,\nor an auto-generated UUID. Use for session-scoped operations and to maintain sandbox\naffinity in follow-up calls." }, "agent_reference": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/AgentReference" + }, + { + "type": "null" } ], - "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -47058,10 +50741,15 @@ }, "delta": { "type": "string", - "format": "base64", + "contentEncoding": "base64", "description": "A chunk of Base64 encoded response audio bytes." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -47093,6 +50781,11 @@ "description": "The sequence number of the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -47129,6 +50822,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -47160,6 +50858,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -47210,6 +50913,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -47260,6 +50968,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -47305,6 +51018,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -47350,6 +51068,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -47395,6 +51118,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -47435,6 +51163,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -47498,6 +51231,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -47561,6 +51299,11 @@ "description": "The content part that is done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -47601,6 +51344,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -47651,6 +51399,11 @@ "description": "The incremental input data (delta) for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -47702,6 +51455,11 @@ "description": "The complete input data for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -47770,16 +51528,28 @@ "x-stainless-const": true }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { "type": "string", "description": "The error message." }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "sequence_number": { "allOf": [ @@ -47790,6 +51560,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -47830,6 +51605,11 @@ "description": "The response that failed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -47875,6 +51655,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -47920,6 +51705,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -47965,6 +51755,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -48039,14 +51834,20 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } } }, "OpenAI.ResponseFormatJsonSchemaSchema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "title": "JSON schema" }, @@ -48111,6 +51912,11 @@ "description": "The function-call arguments delta that is added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -48165,6 +51971,11 @@ "description": "The function-call arguments." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -48210,6 +52021,11 @@ "description": "The unique identifier of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -48256,6 +52072,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -48302,6 +52123,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -48362,6 +52188,11 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -48403,6 +52234,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -48455,6 +52291,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -48486,7 +52327,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probability of the top 20 most likely tokens." + "description": "The log probabilities of up to 20 of the most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -48545,6 +52386,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -48596,6 +52442,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -48642,6 +52493,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -48688,6 +52544,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -48734,6 +52595,11 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -48780,6 +52646,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -48826,6 +52697,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -48872,6 +52748,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -48922,6 +52803,11 @@ "description": "The output item that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -48971,6 +52857,11 @@ "description": "The output item that was marked done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -49043,6 +52934,11 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -49053,7 +52949,7 @@ }, "OpenAI.ResponsePromptVariables": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "anyOf": [ { "type": "string" @@ -49107,6 +53003,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -49171,6 +53072,11 @@ "description": "The summary part that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -49253,6 +53159,11 @@ "description": "The completed summary part." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -49331,6 +53242,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -49390,6 +53306,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -49449,6 +53370,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -49508,6 +53434,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -49567,6 +53498,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -49626,6 +53562,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -49633,6 +53574,140 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, + "OpenAI.ResponseStreamEvent": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", + "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", + "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", + "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", + "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", + "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", + "error": "#/components/schemas/OpenAI.ResponseErrorEvent", + "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", + "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", + "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", + "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", + "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", + "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", + "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", + "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", + "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", + "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", + "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", + "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", + "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", + "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", + "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", + "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", + "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", + "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", + "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", + "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", + "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", + "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", + "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", + "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", + "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", + "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", + "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", + "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", + "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", + "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", + "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", + "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", + "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", + "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", + "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", + "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", + "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", + "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", + "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", + "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", + "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", + "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", + "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", + "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", + "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", + "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" + } + } + }, + "OpenAI.ResponseStreamEventType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "response.audio.delta", + "response.audio.done", + "response.audio.transcript.delta", + "response.audio.transcript.done", + "response.code_interpreter_call_code.delta", + "response.code_interpreter_call_code.done", + "response.code_interpreter_call.completed", + "response.code_interpreter_call.in_progress", + "response.code_interpreter_call.interpreting", + "response.completed", + "response.content_part.added", + "response.content_part.done", + "response.created", + "error", + "response.file_search_call.completed", + "response.file_search_call.in_progress", + "response.file_search_call.searching", + "response.function_call_arguments.delta", + "response.function_call_arguments.done", + "response.in_progress", + "response.failed", + "response.incomplete", + "response.output_item.added", + "response.output_item.done", + "response.reasoning_summary_part.added", + "response.reasoning_summary_part.done", + "response.reasoning_summary_text.delta", + "response.reasoning_summary_text.done", + "response.reasoning_text.delta", + "response.reasoning_text.done", + "response.refusal.delta", + "response.refusal.done", + "response.output_text.delta", + "response.output_text.done", + "response.web_search_call.completed", + "response.web_search_call.in_progress", + "response.web_search_call.searching", + "response.image_generation_call.completed", + "response.image_generation_call.generating", + "response.image_generation_call.in_progress", + "response.image_generation_call.partial_image", + "response.mcp_call_arguments.delta", + "response.mcp_call_arguments.done", + "response.mcp_call.completed", + "response.mcp_call.failed", + "response.mcp_call.in_progress", + "response.mcp_list_tools.completed", + "response.mcp_list_tools.failed", + "response.mcp_list_tools.in_progress", + "response.output_text.annotation.added", + "response.queued", + "response.custom_tool_call_input.delta", + "response.custom_tool_call_input.done" + ] + } + ] + }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -49703,6 +53778,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -49770,6 +53850,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -49902,6 +53987,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -49947,6 +54037,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -49992,6 +54087,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -50011,8 +54111,7 @@ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", - "x-stainless-const": true, - "default": "screenshot" + "x-stainless-const": true } }, "allOf": [ @@ -50039,8 +54138,7 @@ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", - "x-stainless-const": true, - "default": "scroll" + "x-stainless-const": true }, "x": { "allOf": [ @@ -50073,6 +54171,19 @@ } ], "description": "The vertical scroll distance." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -50083,6 +54194,13 @@ "description": "A scroll action.", "title": "Scroll" }, + "OpenAI.SearchContentType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -50092,16 +54210,31 @@ ] }, "OpenAI.ServiceTier": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "default", + "flex", + "scale", + "priority" + ] + }, + { + "type": "null" + } + ], + "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter." + }, + "OpenAI.ServiceTierEnum": { "type": "string", "enum": [ "auto", "default", "flex", - "scale", "priority" - ], - "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", - "nullable": true + ] }, "OpenAI.SkillReferenceParam": { "type": "object", @@ -50116,8 +54249,7 @@ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", - "x-stainless-const": true, - "default": "skill_reference" + "x-stainless-const": true }, "skill_id": { "type": "string", @@ -50148,8 +54280,7 @@ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", - "x-stainless-const": true, - "default": "apply_patch" + "x-stainless-const": true } }, "allOf": [ @@ -50172,8 +54303,7 @@ "shell" ], "description": "The tool to call. Always `shell`.", - "x-stainless-const": true, - "default": "shell" + "x-stainless-const": true } }, "allOf": [ @@ -50197,8 +54327,7 @@ "summary_text" ], "description": "The type of the object. Always `summary_text`.", - "x-stainless-const": true, - "default": "summary_text" + "x-stainless-const": true }, "text": { "type": "string", @@ -50225,8 +54354,7 @@ "enum": [ "text" ], - "x-stainless-const": true, - "default": "text" + "x-stainless-const": true }, "text": { "type": "string" @@ -50349,8 +54477,14 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -50400,7 +54534,10 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", + "computer": "#/components/schemas/OpenAI.ComputerTool", + "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", + "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -50433,7 +54570,7 @@ "type": "array", "items": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "description": "A list of tool definitions that the model should be allowed to call.\n For the Responses API, the list of tool definitions might look like:\n ```json\n [\n { \"type\": \"function\", \"name\": \"get_weather\" },\n { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n { \"type\": \"image_generation\" }\n ]\n ```" } @@ -50466,6 +54603,46 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolChoiceComputer": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, + "OpenAI.ToolChoiceComputerUse": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_use" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -50602,8 +54779,14 @@ "description": "The label of the MCP server to use." }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -50648,7 +54831,9 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", + "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", + "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -50672,7 +54857,9 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter" + "code_interpreter", + "computer", + "computer_use" ] } ] @@ -50717,6 +54904,64 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolSearchExecutionType": { + "type": "string", + "enum": [ + "server", + "client" + ] + }, + "OpenAI.ToolSearchToolParam": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search" + ], + "description": "The type of the tool. Always `tool_search`.", + "x-stainless-const": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search is executed by the server or by the client." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Hosted or BYOT tool search configuration for deferred tools.", + "title": "Tool search tool" + }, "OpenAI.ToolType": { "anyOf": [ { @@ -50727,6 +54972,7 @@ "enum": [ "function", "file_search", + "computer", "computer_use_preview", "web_search", "mcp", @@ -50735,6 +54981,8 @@ "local_shell", "shell", "custom", + "namespace", + "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -50800,8 +55048,7 @@ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", - "x-stainless-const": true, - "default": "type" + "x-stainless-const": true }, "text": { "type": "string", @@ -50823,13 +55070,14 @@ ], "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } ], - "nullable": true, "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." } } @@ -50850,8 +55098,7 @@ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", - "x-stainless-const": true, - "default": "url_citation" + "x-stainless-const": true }, "url": { "type": "string", @@ -50889,7 +55136,7 @@ }, "OpenAI.VectorStoreFileAttributes": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "anyOf": [ { "type": "string" @@ -50906,14 +55153,20 @@ "x-oaiTypeLabel": "map" }, "OpenAI.Verbosity": { - "type": "string", - "enum": [ - "low", - "medium", - "high" + "anyOf": [ + { + "type": "string", + "enum": [ + "low", + "medium", + "high" + ] + }, + { + "type": "null" + } ], - "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`.", - "nullable": true + "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`." }, "OpenAI.WaitParam": { "type": "object", @@ -50927,8 +55180,7 @@ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", - "x-stainless-const": true, - "default": "wait" + "x-stainless-const": true } }, "allOf": [ @@ -50983,9 +55235,15 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri", - "nullable": true, + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ], "description": "The URL opened by the model." } }, @@ -50995,8 +55253,7 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type", - "query" + "type" ], "properties": { "type": { @@ -51009,7 +55266,7 @@ }, "query": { "type": "string", - "description": "[DEPRECATED] The search query.", + "description": "The search query.", "deprecated": true }, "queries": { @@ -51047,7 +55304,8 @@ "x-stainless-const": true }, "url": { - "type": "string" + "type": "string", + "format": "uri" } } }, @@ -51067,20 +55325,44 @@ "default": "approximate" }, "country": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "region": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "city": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "timezone": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "The approximate location of the user.", @@ -51098,17 +55380,17 @@ "web_search_preview" ], "description": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.", - "x-stainless-const": true, - "default": "web_search_preview" + "x-stainless-const": true }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "allOf": [ @@ -51117,6 +55399,12 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." + }, + "search_content_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SearchContentType" + } } }, "allOf": [ @@ -51138,26 +55426,27 @@ "enum": [ "web_search" ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", - "default": "web_search" + "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`." }, "filters": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "type": "string", @@ -51179,7 +55468,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -51205,11 +55494,17 @@ "type": "object", "properties": { "allowed_domains": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } } }, @@ -51301,7 +55596,7 @@ }, "spec": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The openapi function shape, described as a JSON Schema object." }, "auth": { @@ -51334,7 +55629,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -51459,7 +55754,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -51598,7 +55893,7 @@ }, "mutations": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." }, "avg_score": { @@ -52022,12 +56317,13 @@ "max_candidates": { "type": "integer", "format": "int32", + "minimum": 1, "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", "default": 5 }, "optimization_config": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization." }, "eval_model": { @@ -52097,7 +56393,9 @@ "endpoint": { "type": "string", "description": "The OTLP collector endpoint URL.", - "example": "https://my-collector.example.com/otlp" + "examples": [ + "https://my-collector.example.com/otlp" + ] }, "protocol": { "allOf": [ @@ -52106,7 +56404,9 @@ } ], "description": "The transport protocol for the OTLP endpoint.", - "example": "Http" + "examples": [ + "Http" + ] } }, "allOf": [ @@ -52598,36 +56898,55 @@ "description": "The model deployment to use for this agent." }, "instructions": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "A system (or developer) message inserted into the model's context." }, "temperature": { - "type": "number", - "format": "float", - "nullable": true, + "anyOf": [ + { + "type": "number", + "format": "float" + }, + { + "type": "null" + } + ], "minimum": 0, "maximum": 2, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both. Defaults to `1`.", "default": 1 }, "top_p": { - "type": "number", - "format": "float", - "nullable": true, + "anyOf": [ + { + "type": "number", + "format": "float" + }, + { + "type": "null" + } + ], "minimum": 0, "maximum": 1, "description": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered. We generally recommend altering this or `temperature` but not both.\nDefaults to `1`.", "default": 1 }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "tools": { "type": "array", @@ -52657,7 +56976,7 @@ }, "structured_inputs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/StructuredInputDefinition" }, "description": "Set of structured inputs that can participate in prompt template substitution or tool argument bindings." @@ -52967,14 +57286,14 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Red team's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." @@ -53202,7 +57521,7 @@ }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, required for retrieving chat history." @@ -53271,7 +57590,7 @@ }, "triggers": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine." @@ -53394,7 +57713,7 @@ }, "triggers": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine. In v1, exactly one trigger entry is supported." @@ -53842,21 +58161,21 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Schedule's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "systemData": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "System metadata for the resource.", @@ -53953,7 +58272,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Properties of the schedule run.", @@ -53978,7 +58297,7 @@ }, "configuration": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Configuration for the task." @@ -54105,12 +58424,16 @@ } ], "description": "The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types.", - "example": "log" + "examples": [ + "log" + ] }, "data": { "type": "string", "description": "The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change.", - "example": "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" + "examples": [ + "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" + ] } }, "description": "A single Server-Sent Event frame emitted by the hosted agent session log stream.\n\nEach frame contains an `event` field identifying the event type and a `data`\nfield carrying the payload as plain text. Although the current `data` payload\nis JSON-formatted, its schema is not contractual — additional keys may appear\nand the format may change over time. Clients should treat `data` as an\nopaque string and optionally attempt JSON parsing.\n\nNew event types may be added in the future. Clients should gracefully\nignore unrecognized event types.\n\nWire format:\n```\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.121Z\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:34:52.714Z\",\"stream\":\"status\",\"message\":\"Successfully connected to container\"}\n```", @@ -54258,7 +58581,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -54396,7 +58719,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata for additional properties." @@ -54510,7 +58833,7 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema for the structured input (optional)." }, "required": { @@ -54540,12 +58863,18 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema for the structured output." }, "strict": { - "type": "boolean", - "nullable": true, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "description": "Whether to enforce strict validation. Default `true`." } }, @@ -54866,7 +59195,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the taxonomy category." @@ -54900,7 +59229,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the taxonomy sub-category." @@ -54973,10 +59302,12 @@ "$ref": "#/components/schemas/TelemetryDataKind" }, "description": "Data types to export to this endpoint. Use an empty array to export no data.", - "example": [ - "ContainerStdoutStderr", - "ContainerOtel", - "Metrics" + "examples": [ + [ + "ContainerStdoutStderr", + "ContainerOtel", + "Metrics" + ] ] }, "auth": { @@ -55116,12 +59447,12 @@ }, "initialization_parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The initialization parameters for the evaluation. Must support structured outputs." }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "The model to use for the evaluation. Must support structured outputs." @@ -55165,7 +59496,7 @@ "anyOf": [ { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, { "type": "string" @@ -55311,7 +59642,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -55389,11 +59720,17 @@ ], "properties": { "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ], "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -55835,7 +60172,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -55852,7 +60189,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -55865,7 +60202,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -55914,17 +60251,18 @@ "type": "string" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -55940,7 +60278,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -56245,7 +60583,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -56368,7 +60706,7 @@ }, "modelParams": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Optional parameters passed to the model for evaluation." } }, diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml index 8e4f626b4313..30ffdf221472 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml @@ -1,36 +1,118 @@ -openapi: 3.0.0 +openapi: 3.2.0 info: title: Microsoft Foundry version: virtual-public-preview tags: + - name: EvaluationSuiteGenerationJobs + - name: Fine-Tuning + - name: Responses Root + description: Responses + - name: Responses + parent: Responses Root + description: Responses (OpenAI) + - name: Conversations + parent: Responses Root + description: Conversations (OpenAI) + - name: Agents Root + description: Agents - name: Agents - - name: Agent Containers - - name: Agent Session Files + parent: Agents Root + description: Agent Management - name: Agent Invocations + parent: Agents Root - name: Agent Invocations WebSocket - - name: Connections + parent: Agents Root + description: Agent Invocations (WebSocket) + - name: Agent Sessions + parent: Agents Root + - name: Agent Session Files + parent: Agents Root + - name: Agent Versions + parent: Agents Root + - name: Agent Containers + parent: Agents Root + - name: Platform APIs - name: Datasets - - name: Deployments - - name: Evaluation Taxonomies - - name: Evaluation Rules - - name: EvaluationSuiteGenerationJobs - - name: Evaluators - - name: EvaluatorGenerationJobs + parent: Platform APIs - name: Indexes - - name: Insights + parent: Platform APIs + - name: Connections + parent: Platform APIs + - name: Scheduler + parent: Platform APIs + - name: Fine-tuning + parent: Platform APIs + summary: Fine-Tuning - name: Models + parent: Platform APIs - name: Memory Stores - - name: Conversations - - name: Evals - - name: Fine-Tuning - - name: Responses - - name: Redteams + parent: Platform APIs + - name: Chat + parent: Platform APIs + - name: Assistants + parent: Platform APIs + - name: Audio + parent: Platform APIs + - name: Batch + parent: Platform APIs + - name: Completions + parent: Platform APIs + - name: Containers + parent: Platform APIs + - name: Embeddings + parent: Platform APIs + - name: Files + parent: Platform APIs + - name: Images + parent: Platform APIs + - name: Moderations + parent: Platform APIs + - name: Realtime + parent: Platform APIs + - name: Threads + parent: Platform APIs + - name: Uploads + parent: Platform APIs + - name: Vector stores + parent: Platform APIs + summary: Vector Stores + - name: Videos + parent: Platform APIs - name: Routines + parent: Platform APIs - name: Schedules + parent: Platform APIs - name: Skills + parent: Platform APIs - name: Toolboxes + parent: Platform APIs + - name: Deployments + parent: Platform APIs - name: DataGenerationJobs + parent: Platform APIs + summary: Data generation jobs - name: AgentOptimizationJobs + parent: Platform APIs + summary: Agent optimization jobs + - name: EvaluatorGenerationJobs + parent: Platform APIs + summary: Evaluator generation jobs + - name: Evaluations + - name: Evals + parent: Evaluations + - name: Evaluation Rules + parent: Evaluations + - name: Evaluators + parent: Evaluations + - name: Evaluation Taxonomies + parent: Evaluations + - name: Redteams + parent: Evaluations + summary: Red Teaming + - name: Evalsuite + parent: Evaluations + - name: Insights + parent: Evaluations paths: /agent_optimization_jobs: post: @@ -921,8 +1003,7 @@ paths: content: application/zip: schema: - type: string - format: binary + contentMediaType: application/zip 4XX: description: Client error content: @@ -1056,7 +1137,7 @@ paths: application/json: schema: type: object - additionalProperties: {} + unevaluatedProperties: {} 4XX: description: Client error content: @@ -1276,7 +1357,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions requestBody: required: true content: @@ -1397,7 +1478,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1662,8 +1743,7 @@ paths: content: application/octet-stream: schema: - type: string - format: binary + contentMediaType: application/octet-stream x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -1720,8 +1800,7 @@ paths: content: application/octet-stream: schema: - type: string - format: binary + contentMediaType: application/octet-stream 4XX: description: Client error content: @@ -1798,7 +1877,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1858,7 +1937,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -1911,7 +1990,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview @@ -2196,7 +2275,7 @@ paths: required_previews: - CodeAgents=V1Preview tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -2306,7 +2385,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion @@ -2352,7 +2431,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions delete: operationId: Agents_deleteAgentVersion summary: Delete an agent version @@ -2408,7 +2487,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}/containers/default: get: operationId: AgentContainers_getAgentContainer @@ -3038,7 +3117,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview @@ -3086,7 +3165,7 @@ paths: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -7130,7 +7209,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -7307,7 +7386,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -8424,9 +8503,10 @@ paths: format: uri description: URL to poll for operation status. operationResult: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: URL to the operation result, or null if the operation is still in progress. 4XX: description: Client error @@ -9143,8 +9223,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -9372,8 +9451,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -9622,8 +9700,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -10129,26 +10206,22 @@ paths: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -10159,44 +10232,41 @@ paths: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -10208,11 +10278,12 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled id: type: string @@ -10240,19 +10311,20 @@ paths: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - nullable: true + - type: 'null' incomplete_details: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - nullable: true + - type: 'null' output: type: array items: @@ -10271,21 +10343,29 @@ paths: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' output_text: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - nullable: true + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent: allOf: - $ref: '#/components/schemas/AgentId' @@ -10300,10 +10380,9 @@ paths: or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox affinity in follow-up calls. agent_reference: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/AgentReference' - nullable: true + - type: 'null' description: The agent used for this response content_filters: type: array @@ -10345,26 +10424,22 @@ paths: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -10375,44 +10450,41 @@ paths: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -10424,48 +10496,62 @@ paths: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled input: $ref: '#/components/schemas/OpenAI.InputParam' include: - type: array - items: - $ref: '#/components/schemas/OpenAI.IncludeEnum' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.IncludeEnum' + - type: 'null' parallel_tool_calls: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' default: true store: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' default: true instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ModerationParam' + - type: 'null' stream: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' stream_options: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - nullable: true + - type: 'null' conversation: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationParam' - nullable: true + - type: 'null' context_management: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContextManagementParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ContextManagementParam' + - type: 'null' description: Context management configuration for this request. + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent: allOf: - $ref: '#/components/schemas/AgentReference' @@ -10484,7 +10570,7 @@ paths: description: The agent to use for generating the response. structured_inputs: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. get: operationId: listResponses @@ -12116,8 +12202,7 @@ paths: content: application/zip: schema: - type: string - format: binary + contentMediaType: application/zip 4XX: description: Client error content: @@ -12471,8 +12556,7 @@ paths: content: application/zip: schema: - type: string - format: binary + contentMediaType: application/zip 4XX: description: Client error content: @@ -12804,7 +12888,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -13221,7 +13305,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -13508,12 +13592,14 @@ components: type: integer format: int32 description: The maximum number of replicas for the container. Default is 1. - example: 10 + examples: + - 10 min_replicas: type: integer format: int32 description: The minimum number of replicas for the container. Default is 1. - example: 1 + examples: + - 1 error_message: type: string description: The error message if the container failed to operate, if any. @@ -13797,7 +13883,7 @@ components: description: Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future. evaluators: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. samplingConfiguration: @@ -13851,7 +13937,7 @@ components: description: A string explaining why there was an error, if applicable. additionalDetails: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties relevant to the evaluator. These will differ between evaluators. description: Result for the agent evaluation evaluator run. @@ -14207,10 +14293,11 @@ components: - definition properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -14724,7 +14811,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15103,7 +15190,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -15148,7 +15235,7 @@ components: description: The Azure Function Tool definition. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15296,7 +15383,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15428,7 +15515,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15557,7 +15644,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15658,7 +15745,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -15724,7 +15811,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -15898,7 +15985,7 @@ components: readOnly: true metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata of the connection readOnly: true @@ -15936,18 +16023,21 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication of the containers. - example: - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + examples: + - - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 container_app_resource_id: type: string description: The resource ID of the Azure Container App that hosts this agent. Not mutable across versions. ingress_subdomain_suffix: type: string description: The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app. - example: --0000001 + examples: + - --0000001 + - ---current + - '' allOf: - $ref: '#/components/schemas/AgentDefinition' description: The container app agent definition. @@ -15962,7 +16052,8 @@ components: image: type: string description: The container image for the hosted agent. - example: my-registry.azurecr.io/my-hosted-agent:latest + examples: + - my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -16073,8 +16164,7 @@ components: format: double maximum: 100 description: Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100. - minimum: 0 - exclusiveMinimum: true + exclusiveMinimum: 0 default: 100 allOf: - $ref: '#/components/schemas/EvaluationRuleAction' @@ -16105,7 +16195,7 @@ components: default: 5 data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -16168,8 +16258,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -16191,7 +16279,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16210,7 +16298,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -16228,7 +16316,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16303,8 +16391,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -16320,7 +16406,7 @@ components: description: A human-readable description of the agent. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16350,7 +16436,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16369,7 +16455,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -16378,7 +16464,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16425,10 +16511,9 @@ components: type: string description: The name of the evaluation. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -16450,7 +16535,7 @@ components: description: A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`). properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16465,10 +16550,9 @@ components: type: string description: The name of the run. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -16478,7 +16562,7 @@ components: description: Details about the run's data source. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16511,9 +16595,7 @@ components: properties: files: type: array - items: - type: string - format: binary + items: {} description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -16579,7 +16661,7 @@ components: - CustomKeys description: The credential type readOnly: true - additionalProperties: + unevaluatedProperties: type: string allOf: - $ref: '#/components/schemas/BaseCredentials' @@ -16606,7 +16688,7 @@ components: description: The provider-specific event name that fires the routine. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Provider-specific trigger parameters. allOf: - $ref: '#/components/schemas/RoutineTrigger' @@ -16761,7 +16843,7 @@ components: description: Description to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. description: Output options for data generation job. @@ -16883,11 +16965,12 @@ components: description: The data source type discriminator. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: {} + mapping: + azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -16917,7 +17000,7 @@ components: readOnly: true tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -17047,7 +17130,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -17436,10 +17519,9 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -17449,7 +17531,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -17620,10 +17702,9 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -17635,7 +17716,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -17894,7 +17975,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Details of the input data source item. results: type: array @@ -17984,9 +18065,10 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -18007,10 +18089,10 @@ components: description: The reason for the test criteria metric. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional details about the test criteria metric. - additionalProperties: {} + unevaluatedProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -18162,17 +18244,17 @@ components: readOnly: true tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Evaluation's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. evaluators: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. target: @@ -18323,7 +18405,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -18429,7 +18511,7 @@ components: description: Identifier of the evaluation group. evalRun: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -18535,7 +18617,7 @@ components: default: quality initialization_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- Optional initialization parameters applied to all generated evaluators. For example, deployment_name for LLM judge model, default threshold. @@ -18810,7 +18892,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -18879,7 +18961,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -18937,7 +19019,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -18951,7 +19033,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -18965,7 +19047,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19013,7 +19095,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -19027,7 +19109,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19050,11 +19132,11 @@ components: description: Identifier of the evaluator. initParams: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Initialization parameters of the evaluator. dataMapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Data parameters of the evaluator. description: Evaluator Configuration @@ -19082,15 +19164,15 @@ components: description: The type of evaluator definition init_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -19327,7 +19409,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -19392,7 +19474,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -19420,7 +19502,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -19432,7 +19514,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator categories: @@ -19452,7 +19534,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -19567,12 +19649,9 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string - nullable: true + - type: 'null' description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -19583,7 +19662,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -19862,15 +19941,18 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - example: X-Otlp-Api-Key + examples: + - X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - example: my-secret-store + examples: + - my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - example: OTLP_KEY + examples: + - OTLP_KEY allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' description: Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. @@ -19898,19 +19980,21 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - example: '0.25' + examples: + - '0.25' memory: type: string description: The memory configuration for the hosted agent. - example: 0.5Gi + examples: + - 0.5Gi environment_variables: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set in the hosted agent container. - example: - name: LOG_LEVEL - value: debug + examples: + - name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -19923,11 +20007,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - example: - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + examples: + - - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -20046,7 +20130,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -20219,11 +20303,11 @@ components: description: Sample type features: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -20439,6 +20523,7 @@ components: red_team_taxonomy: '#/components/schemas/RedTeamTaxonomyItemGenerationParams' response_retrieval: '#/components/schemas/ResponseRetrievalItemGenerationParams' conversation_gen_preview: '#/components/schemas/ConversationGenPreviewItemGenerationParams' + synthetic_data_gen_preview: '#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams' description: Represents the set of parameters used to control item generation operations. ItemGenerationParamsType: anyOf: @@ -20704,7 +20789,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -20751,7 +20836,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -20793,10 +20878,11 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - type: array - items: - $ref: '#/components/schemas/MemoryItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/MemoryItem' + - type: 'null' description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -20948,7 +21034,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -21123,7 +21209,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -21175,7 +21261,7 @@ components: readOnly: true capabilities: type: object - additionalProperties: + unevaluatedProperties: type: string description: Capabilities of deployed model readOnly: true @@ -21324,7 +21410,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -21466,7 +21552,6 @@ components: - create_file description: Create a new file with the provided diff. x-stainless-const: true - default: create_file path: type: string description: Path of the file to create. @@ -21490,7 +21575,6 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true - default: create_file path: type: string minLength: 1 @@ -21515,7 +21599,6 @@ components: - delete_file description: Delete the specified file. x-stainless-const: true - default: delete_file path: type: string description: Path of the file to delete. @@ -21535,7 +21618,6 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true - default: delete_file path: type: string minLength: 1 @@ -21601,7 +21683,6 @@ components: - apply_patch description: The type of the tool. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Allows the assistant to create, delete, or update files using unified diffs. @@ -21619,7 +21700,6 @@ components: - update_file description: Update an existing file with the provided diff. x-stainless-const: true - default: update_file path: type: string description: Path of the file to update. @@ -21643,7 +21723,6 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true - default: update_file path: type: string minLength: 1 @@ -21669,17 +21748,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -21699,9 +21782,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' network_policy: $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' description: Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. @@ -21725,6 +21808,12 @@ components: OpenAI.ChatModel: type: string enum: + - gpt-5.4 + - gpt-5.4-mini + - gpt-5.4-nano + - gpt-5.4-mini-2026-03-17 + - gpt-5.4-nano-2026-03-17 + - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest @@ -21819,7 +21908,6 @@ components: - click description: Specifies the event type. For a click action, this property is always `click`. x-stainless-const: true - default: click button: allOf: - $ref: '#/components/schemas/OpenAI.ClickButtonType' @@ -21832,6 +21920,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A click action. @@ -21892,7 +21986,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -21957,13 +22051,27 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + prompt_cache_key: + anyOf: + - type: string + - type: 'null' + prompt_cache_retention: + anyOf: + - $ref: '#/components/schemas/OpenAI.PromptCacheRetentionEnum' + - type: 'null' + service_tier: + anyOf: + - $ref: '#/components/schemas/OpenAI.ServiceTierEnum' + - type: 'null' OpenAI.ComparisonFilter: type: object required: @@ -21980,6 +22088,8 @@ components: - gte - lt - lte + - in + - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -22051,6 +22161,14 @@ components: scroll: '#/components/schemas/OpenAI.ScrollParam' type: '#/components/schemas/OpenAI.TypeParam' wait: '#/components/schemas/OpenAI.WaitParam' + OpenAI.ComputerActionList: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerAction' + description: |- + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + title: Computer Action List OpenAI.ComputerActionType: anyOf: - type: string @@ -22074,11 +22192,13 @@ components: type: string description: The ID of the pending safety check. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -22094,6 +22214,7 @@ components: - type - image_url - file_id + - detail properties: type: type: string @@ -22101,14 +22222,19 @@ components: - computer_screenshot description: Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`. x-stainless-const: true - default: computer_screenshot image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.ImageDetail' + description: The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -22135,6 +22261,21 @@ components: type: string description: The identifier of an uploaded file that contains the screenshot. description: A computer screenshot image used with the computer use tool. + OpenAI.ComputerTool: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + description: The type of the computer tool. Always `computer`. + x-stainless-const: true + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + title: Computer OpenAI.ComputerUsePreviewTool: type: object required: @@ -22149,7 +22290,6 @@ components: - computer_use_preview description: The type of the computer use tool. Always `computer_use_preview`. x-stainless-const: true - default: computer_use_preview environment: allOf: - $ref: '#/components/schemas/OpenAI.ComputerEnvironment' @@ -22177,7 +22317,6 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true - default: container_auto file_ids: type: array items: @@ -22185,9 +22324,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' skills: type: array items: @@ -22214,7 +22353,6 @@ components: - container_file_citation description: The type of the container file citation. Always `container_file_citation`. x-stainless-const: true - default: container_file_citation container_id: type: string description: The ID of the container file. @@ -22255,19 +22393,12 @@ components: - allowlist description: Allow outbound network access only to specified domains. Always `allowlist`. x-stainless-const: true - default: allowlist allowed_domains: type: array items: type: string minItems: 1 description: A list of allowed domains when type is `allowlist`. - domain_secrets: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam' - minItems: 1 - description: Optional domain-scoped secrets for allowlisted domains. allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' OpenAI.ContainerNetworkPolicyDisabledParam: @@ -22281,29 +22412,8 @@ components: - disabled description: Disable outbound network access. Always `disabled`. x-stainless-const: true - default: disabled allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' - OpenAI.ContainerNetworkPolicyDomainSecretParam: - type: object - required: - - domain - - name - - value - properties: - domain: - type: string - minLength: 1 - description: The domain associated with the secret. - name: - type: string - minLength: 1 - description: The name of the secret to inject for the domain. - value: - type: string - minLength: 1 - maxLength: 10485760 - description: The secret value to inject for the domain. OpenAI.ContainerNetworkPolicyParam: type: object required: @@ -22336,7 +22446,6 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true - default: container_reference container_id: type: string allOf: @@ -22371,10 +22480,9 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' OpenAI.ConversationItem: type: object required: @@ -22386,14 +22494,18 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ConversationItemFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ConversationItemWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ConversationItemImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ConversationItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' reasoning: '#/components/schemas/OpenAI.ConversationItemReasoningItem' + compaction: '#/components/schemas/OpenAI.ConversationItemCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCall' local_shell_call_output: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput' @@ -22405,10 +22517,39 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ConversationItemMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output). title: Conversation item + OpenAI.ConversationItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemApplyPatchToolCall: type: object required: @@ -22473,8 +22614,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -22515,26 +22657,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ConversationItemCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ConversationItemComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -22552,6 +22722,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -22572,10 +22744,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ConversationItemComputerToolCallOutputResource: + OpenAI.ConversationItemComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -22589,6 +22762,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -22612,68 +22786,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemCustomToolCall: + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ConversationItemCustomToolCallOutputResource: type: object required: - type - call_id - - name - - input + - output + - status properties: type: type: string enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call in the OpenAI platform. + description: The unique ID of the custom tool call output in the OpenAI platform. call_id: type: string - description: An identifier used to map this custom tool call to a tool call output. - name: - type: string - description: The name of the custom tool being called. - input: + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: type: string - description: The input for the custom tool call generated by the model. + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: A call to a custom tool created by the model. - title: Custom tool call - OpenAI.ConversationItemCustomToolCallOutput: + title: ResponseCustomToolCallOutputItem + OpenAI.ConversationItemCustomToolCallResource: type: object required: - type - call_id - - output + - name + - input + - status properties: type: type: string enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call output in the OpenAI platform. + description: The unique ID of the custom tool call in the OpenAI platform. call_id: type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a custom tool call from your code, being sent back to the model. - title: Custom tool call output + title: ResponseCustomToolCallItem OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -22708,10 +22905,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -22747,13 +22945,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -22786,7 +22983,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -22794,10 +22991,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -22805,36 +23001,37 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCallOutputResource: + OpenAI.ConversationItemFunctionToolCall: type: object required: + - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + description: The unique ID of the function tool call. + readOnly: true type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -22846,32 +23043,42 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemFunctionToolCallResource: + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ConversationItemFunctionToolCallOutput: type: object required: + - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -22883,6 +23090,8 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.ConversationItemImageGenToolCall: type: object required: @@ -22909,8 +23118,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -23005,12 +23215,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -23070,8 +23281,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -23102,8 +23314,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -23136,18 +23347,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -23184,6 +23397,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A message to or from the model. @@ -23205,8 +23422,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -23234,6 +23452,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ConversationItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + OpenAI.ConversationItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemType: anyOf: - type: string @@ -23247,7 +23546,11 @@ components: - image_generation_call - computer_call - computer_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning + - compaction - code_interpreter_call - local_shell_call - local_shell_call_output @@ -23383,6 +23686,7 @@ components: mapping: text: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText' json_object: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject' + json_schema: '#/components/schemas/OpenAI.ResponseFormatJsonSchema' description: |- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables @@ -23438,15 +23742,15 @@ components: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' items: - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + - type: 'null' OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -23567,7 +23871,7 @@ components: default: custom item_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -23639,7 +23943,7 @@ components: default: logs metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -23784,7 +24088,7 @@ components: default: stored_completions metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -23834,16 +24138,18 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' minLength: 1 maxLength: 64 description: |- A string of up to 64 characters that will be added to your fine-tuned model name. For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -23853,16 +24159,16 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/model-optimization) for more details. integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + - type: 'null' description: A list of integrations to enable for your fine-tuning job. seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' minimum: 0 maximum: 2147483647 description: |- @@ -23871,10 +24177,9 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -23920,11 +24225,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -23997,7 +24304,6 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true - default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -24020,7 +24326,6 @@ components: - text description: Unconstrained text format. Always `text`. x-stainless-const: true - default: text allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: Unconstrained free-form text. @@ -24037,7 +24342,6 @@ components: - custom description: The type of the custom tool. Always `custom`. x-stainless-const: true - default: custom name: type: string description: The name of the custom tool, used to identify it in tool calls. @@ -24048,6 +24352,9 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: The input format for the custom tool. Default is unconstrained text. + defer_loading: + type: boolean + description: Whether this tool should be deferred and discovered via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) @@ -24095,12 +24402,14 @@ components: - low - high - auto + - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' + - keys properties: type: type: string @@ -24108,7 +24417,6 @@ components: - double_click description: Specifies the event type. For a double click action, this property is always set to `double_click`. x-stainless-const: true - default: double_click x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -24117,6 +24425,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the double click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A double click action. @@ -24133,7 +24447,6 @@ components: - drag description: Specifies the event type. For a drag action, this property is always set to `drag`. x-stainless-const: true - default: drag path: type: array items: @@ -24146,6 +24459,12 @@ components: { x: 200, y: 300 } ] ``` + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -24174,6 +24493,10 @@ components: description: |- Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' type: type: string enum: @@ -24198,6 +24521,8 @@ components: `assistant` role are presumed to have been generated by the model in previous interactions. title: Input message + OpenAI.EmptyModelParam: + type: object OpenAI.Error: type: object required: @@ -24205,13 +24530,15 @@ components: - message properties: code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string details: @@ -24220,10 +24547,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} debugInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalApiError: type: object required: @@ -24353,26 +24680,22 @@ components: type: object properties: seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' max_completions_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -24625,10 +24948,10 @@ components: properties: item: type: object - additionalProperties: {} + unevaluatedProperties: {} sample: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -24657,49 +24980,50 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions_search: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' users: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' tools: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -24845,28 +25169,25 @@ components: x-stainless-const: true default: stored_completions metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' limit: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -24895,7 +25216,6 @@ components: - file_citation description: The type of the file citation. Always `file_citation`. x-stainless-const: true - default: file_citation file_id: type: string description: The ID of the file. @@ -24910,6 +25230,11 @@ components: - $ref: '#/components/schemas/OpenAI.Annotation' description: A citation to a file. title: File citation + OpenAI.FileInputDetail: + type: string + enum: + - low + - high OpenAI.FilePath: type: object required: @@ -24946,7 +25271,6 @@ components: - file_search description: The type of the file search tool. Always `file_search`. x-stainless-const: true - default: file_search vector_store_ids: type: array items: @@ -24961,9 +25285,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Filters' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -24972,7 +25296,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -24992,10 +25316,9 @@ components: filename: type: string attributes: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - nullable: true + - type: 'null' score: type: number format: float @@ -25203,11 +25526,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -25239,17 +25564,20 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - nullable: true + - type: 'null' fine_tuned_model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' finished_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -25282,36 +25610,39 @@ components: - cancelled description: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. trained_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' training_file: type: string description: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents). validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + - type: 'null' seed: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The seed used for the fine-tuning job. estimated_finish: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. title: FineTuningJob x-oaiMeta: @@ -25443,8 +25774,9 @@ components: message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.FineTuningJobEvent: type: object required: @@ -25510,11 +25842,8 @@ components: - type: string enum: - auto - nullable: true - - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' default: auto learning_rate_multiplier: oneOf: @@ -25556,18 +25885,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -25586,16 +25920,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -25634,6 +25970,18 @@ components: - in_progress - completed - incomplete + OpenAI.FunctionCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete + OpenAI.FunctionCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionObject: type: object required: @@ -25648,11 +25996,12 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.FunctionParameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. @@ -25668,15 +26017,13 @@ components: items: type: string timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -25690,15 +26037,13 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -25842,7 +26187,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -25863,7 +26207,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -25914,6 +26257,12 @@ components: enum: - timeout - exit + OpenAI.FunctionShellCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -25925,7 +26274,6 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcome' description: Indicates that the shell call exceeded its configured time limit. @@ -25941,11 +26289,16 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcomeParam' description: Indicates that the shell call exceeded its configured time limit. title: Shell call timeout outcome + OpenAI.FunctionShellCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellToolParam: type: object required: @@ -25957,12 +26310,10 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true - default: shell environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -25971,7 +26322,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -26054,67 +26405,61 @@ components: - function description: The type of the function tool. Always `function`. x-stainless-const: true - default: function name: type: string description: The name of the function to call. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' parameters: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' strict: + anyOf: + - type: boolean + - type: 'null' + defer_loading: type: boolean - nullable: true + description: Whether this function is deferred and loaded via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). title: Function - OpenAI.FunctionToolCallOutput: + OpenAI.FunctionToolParam: type: object required: + - name - type - - call_id - - output properties: - id: + name: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_-]+$ + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a function tool call. - title: Function tool call output + default: function + defer_loading: + type: boolean + description: Whether this function should be deferred and discovered via tool search. OpenAI.GraderLabelModel: type: object required: @@ -26491,6 +26836,7 @@ components: - low - high - auto + - original OpenAI.ImageGenActionEnum: type: string enum: @@ -26508,7 +26854,6 @@ components: - image_generation description: The type of the image generation tool. Always `image_generation`. x-stainless-const: true - default: image_generation model: anyOf: - type: string @@ -26530,15 +26875,15 @@ components: or `auto`. Default: `auto`. default: auto size: - type: string - enum: - - 1024x1024 - - 1024x1536 - - 1536x1024 - - auto - description: |- - The size of the generated image. One of `1024x1024`, `1024x1536`, - `1536x1024`, or `auto`. Default: `auto`. + anyOf: + - type: string + - type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. default: auto output_format: type: string @@ -26575,9 +26920,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - nullable: true + - type: 'null' input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -26602,7 +26947,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -26636,6 +26981,7 @@ components: - memory_search_call.results description: |- Specify additional output data to include in the model response. Currently supported values are: + - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. @@ -26657,7 +27003,6 @@ components: - inline description: Defines an inline skill for this request. x-stainless-const: true - default: inline name: type: string description: The name of the skill. @@ -26754,18 +27099,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -26784,16 +27134,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -26845,18 +27197,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -26872,18 +27229,26 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_data: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -26900,16 +27265,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -26925,16 +27292,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - nullable: true + - type: 'null' description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -26956,6 +27325,9 @@ components: web_search_call: '#/components/schemas/OpenAI.InputItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.InputItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.InputItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.InputItemReasoningItem' compaction: '#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.InputItemImageGenToolCall' @@ -26976,6 +27348,38 @@ components: An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs. + OpenAI.InputItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemApplyPatchToolCallItemParam: type: object required: @@ -26992,8 +27396,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27026,8 +27431,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27038,8 +27444,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -27077,15 +27484,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -27097,8 +27506,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -27122,8 +27532,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27139,14 +27550,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -27157,7 +27569,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -27175,6 +27586,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -27215,6 +27628,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -27291,10 +27707,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -27309,8 +27726,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27334,9 +27752,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -27349,8 +27767,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27368,14 +27787,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -27388,8 +27806,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27408,14 +27827,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -27423,6 +27841,7 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -27431,6 +27850,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -27440,6 +27860,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -27487,8 +27910,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -27547,12 +27971,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -27602,8 +28027,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -27611,8 +28037,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -27643,8 +28070,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -27677,18 +28103,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -27722,6 +28150,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -27752,8 +28184,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -27781,6 +28214,77 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.InputItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' + OpenAI.InputItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemType: anyOf: - type: string @@ -27794,6 +28298,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -27850,44 +28357,6 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call - OpenAI.InputMessage: - type: object - required: - - type - - role - - content - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.InputMessageContentList: type: array items: @@ -27896,43 +28365,6 @@ components: A list of one or many input items to the model, containing different content types. title: Input item content list - OpenAI.InputMessageResource: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.InputParam: oneOf: - type: string @@ -27994,7 +28426,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessage' + message: '#/components/schemas/OpenAI.ItemInputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -28002,6 +28434,9 @@ components: web_search_call: '#/components/schemas/OpenAI.ItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.ItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.ItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.ItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.ItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.ItemReasoningItem' compaction: '#/components/schemas/OpenAI.ItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.ItemImageGenToolCall' @@ -28019,6 +28454,38 @@ components: custom_tool_call_output: '#/components/schemas/OpenAI.ItemCustomToolCallOutput' custom_tool_call: '#/components/schemas/OpenAI.ItemCustomToolCall' description: Content item used to generate a response. + OpenAI.ItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemApplyPatchToolCallItemParam: type: object required: @@ -28035,8 +28502,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -28069,8 +28537,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -28081,8 +28550,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -28120,15 +28590,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -28140,8 +28612,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -28165,8 +28638,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -28182,14 +28656,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -28200,7 +28675,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -28218,6 +28692,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -28258,6 +28734,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -28310,14 +28789,17 @@ components: discriminator: propertyName: type mapping: - function_call_output: '#/components/schemas/OpenAI.FunctionToolCallOutput' message: '#/components/schemas/OpenAI.ItemFieldMessage' function_call: '#/components/schemas/OpenAI.ItemFieldFunctionToolCall' + tool_search_call: '#/components/schemas/OpenAI.ItemFieldToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemFieldToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemFieldAdditionalTools' + function_call_output: '#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ItemFieldFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ItemFieldWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ItemFieldImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ItemFieldComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -28334,6 +28816,35 @@ components: custom_tool_call: '#/components/schemas/OpenAI.ItemFieldCustomToolCall' custom_tool_call_output: '#/components/schemas/OpenAI.ItemFieldCustomToolCallOutput' description: An item representing a message, tool call, tool output, reasoning, or other response element. + OpenAI.ItemFieldAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldApplyPatchToolCall: type: object required: @@ -28398,8 +28909,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -28440,15 +28952,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -28486,7 +29000,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -28504,6 +29017,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -28524,10 +29039,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemFieldComputerToolCallOutputResource: + OpenAI.ItemFieldComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -28541,6 +29057,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -28564,6 +29081,8 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a computer tool call. + title: Computer tool call output OpenAI.ItemFieldCustomToolCall: type: object required: @@ -28584,6 +29103,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -28660,10 +29182,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -28699,13 +29222,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -28738,7 +29260,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -28746,10 +29268,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -28760,6 +29281,7 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: + - id - type - call_id - name @@ -28768,6 +29290,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -28777,6 +29300,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -28798,6 +29324,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.ItemFieldFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a function tool call. + title: Function tool call output OpenAI.ItemFieldImageGenToolCall: type: object required: @@ -28824,8 +29395,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -28884,12 +29456,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -28949,8 +29522,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -28981,8 +29555,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -29015,18 +29588,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -29063,6 +29638,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A message to or from the model. @@ -29084,8 +29663,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -29113,6 +29693,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ItemFieldToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + OpenAI.ItemFieldToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldType: anyOf: - type: string @@ -29120,6 +29781,9 @@ components: enum: - message - function_call + - tool_search_call + - tool_search_output + - additional_tools - function_call_output - file_search_call - web_search_call @@ -29214,10 +29878,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -29232,8 +29897,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -29257,9 +29923,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -29272,8 +29938,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -29291,14 +29958,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -29311,8 +29977,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -29331,14 +29998,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -29346,6 +30012,7 @@ components: OpenAI.ItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -29354,6 +30021,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -29363,6 +30031,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -29410,12 +30081,57 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An image generation request made by the model. title: Image generation call + OpenAI.ItemInputMessage: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + default: message + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + readOnly: true + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemLocalShellToolCall: type: object required: @@ -29470,12 +30186,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -29525,8 +30242,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -29534,8 +30252,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -29566,8 +30285,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -29600,18 +30318,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -29645,6 +30365,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -29675,8 +30399,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -29716,7 +30441,6 @@ components: - item_reference description: The type of item to reference. Always `item_reference`. x-stainless-const: true - default: item_reference id: type: string description: The ID of the item to reference. @@ -29734,14 +30458,19 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessageResource' + message: '#/components/schemas/OpenAI.ItemResourceInputMessage' output_message: '#/components/schemas/OpenAI.ItemResourceOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemResourceFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemResourceComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ItemResourceToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemResourceToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemResourceAdditionalTools' + reasoning: '#/components/schemas/OpenAI.ItemResourceReasoningItem' + compaction: '#/components/schemas/OpenAI.ItemResourceCompactionBody' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -29754,7 +30483,38 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ItemResourceMcpToolCall' + custom_tool_call: '#/components/schemas/OpenAI.ItemResourceCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource' description: Content item used to generate a response. + OpenAI.ItemResourceAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceApplyPatchToolCall: type: object required: @@ -29819,8 +30579,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -29861,26 +30622,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ItemResourceCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ItemResourceComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -29898,6 +30687,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -29918,10 +30709,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemResourceComputerToolCallOutputResource: + OpenAI.ItemResourceComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -29935,6 +30727,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -29958,6 +30751,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ItemResourceCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallOutputItem + OpenAI.ItemResourceCustomToolCallResource: + type: object + required: + - type + - call_id + - name + - input + - status + properties: + type: + type: string + enum: + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call in the OpenAI platform. + call_id: + type: string + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallItem OpenAI.ItemResourceFileSearchToolCall: type: object required: @@ -29992,10 +30870,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -30031,13 +30910,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -30070,7 +30948,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -30078,10 +30956,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -30089,9 +30966,56 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCallOutputResource: + OpenAI.ItemResourceFunctionToolCall: type: object required: + - id + - type + - call_id + - name + - arguments + properties: + id: + type: string + description: The unique ID of the function tool call. + readOnly: true + type: + type: string + enum: + - function_call + description: The type of the function tool call. Always `function_call`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ItemResourceFunctionToolCallOutput: + type: object + required: + - id - type - call_id - output @@ -30101,6 +31025,7 @@ components: description: |- The unique ID of the function tool call output. Populated when this item is returned via API. + readOnly: true type: type: string enum: @@ -30130,75 +31055,85 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceFunctionToolCallResource: + description: The output of a function tool call. + title: Function tool call output + OpenAI.ItemResourceImageGenToolCall: type: object required: - type - - call_id - - name - - arguments + - id + - status + - result properties: - id: - type: string - description: The unique ID of the function tool call. type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - image_generation_call + description: The type of the image generation call. Always `image_generation_call`. x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: + id: type: string - description: A JSON string of the arguments to pass to the function. + description: The unique ID of the image generation call. status: type: string enum: - in_progress - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. + - generating + - failed + description: The status of the image generation call. + result: + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceImageGenToolCall: + description: An image generation request made by the model. + title: Image generation call + OpenAI.ItemResourceInputMessage: type: object required: - type + - role + - content - id - - status - - result properties: type: type: string enum: - - image_generation_call - description: The type of the image generation call. Always `image_generation_call`. + - message + description: The type of the message input. Always set to `message`. x-stainless-const: true - id: + default: message + role: type: string - description: The unique ID of the image generation call. + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. status: type: string enum: - in_progress - completed - - generating - - failed - description: The status of the image generation call. - result: + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: type: string - nullable: true + description: The unique ID of the message input. + readOnly: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - description: An image generation request made by the model. - title: Image generation call + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemResourceLocalShellToolCall: type: object required: @@ -30253,12 +31188,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -30318,8 +31254,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -30350,8 +31287,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -30384,18 +31320,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -30429,6 +31367,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -30442,6 +31384,134 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An output message from the model. title: Output message + OpenAI.ItemResourceReasoningItem: + type: object + required: + - type + - id + - summary + properties: + type: + type: string + enum: + - reasoning + description: The type of the object. Always `reasoning`. + x-stainless-const: true + id: + type: string + description: The unique identifier of the reasoning content. + encrypted_content: + anyOf: + - type: string + - type: 'null' + summary: + type: array + items: + $ref: '#/components/schemas/OpenAI.SummaryTextContent' + description: Reasoning summary content. + content: + type: array + items: + $ref: '#/components/schemas/OpenAI.ReasoningTextContent' + description: Reasoning text content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A description of the chain of thought used by a reasoning model while generating + a response. Be sure to include these items in your `input` to the Responses API + for subsequent turns of a conversation if you are manually + [managing context](/docs/guides/conversation-state). + title: Reasoning + OpenAI.ItemResourceToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + OpenAI.ItemResourceToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceType: anyOf: - type: string @@ -30455,6 +31525,11 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools + - reasoning + - compaction - image_generation_call - code_interpreter_call - local_shell_call @@ -30467,6 +31542,8 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call + - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -30530,6 +31607,77 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call + OpenAI.ItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + OpenAI.ItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemType: anyOf: - type: string @@ -30543,6 +31691,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -30634,7 +31785,6 @@ components: - keypress description: Specifies the event type. For a keypress action, this property is always set to `keypress`. x-stainless-const: true - default: keypress keys: type: array items: @@ -30662,11 +31812,13 @@ components: - list x-stainless-const: true first_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' last_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' x-ms-list-continuation-token: true has_more: type: boolean @@ -30719,23 +31871,10 @@ components: - local description: The environment type. Always `local`. x-stainless-const: true - default: local allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' description: Represents the use of a local environment to perform shell actions. title: Local Environment - OpenAI.LocalShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete - OpenAI.LocalShellCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.LocalShellExecAction: type: object required: @@ -30756,22 +31895,23 @@ components: type: string description: The command to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' working_directory: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' env: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -30785,7 +31925,6 @@ components: - local_shell description: The type of the local shell tool. Always `local_shell`. x-stainless-const: true - default: local_shell name: type: string description: Optional user-defined name for this tool or configuration. @@ -30794,7 +31933,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -30852,17 +31991,17 @@ components: type: string description: The name of the tool. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - nullable: true + - type: 'null' description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -30924,38 +32063,36 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' allowed_tools: anyOf: - type: array items: type: string - nullable: true - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + - type: 'null' require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string enum: - always - never - nullable: true + - type: 'null' default: always + defer_loading: + type: boolean + description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -31017,6 +32154,7 @@ components: refusal: '#/components/schemas/OpenAI.MessageContentRefusalContent' input_image: '#/components/schemas/OpenAI.MessageContentInputImageContent' input_file: '#/components/schemas/OpenAI.MessageContentInputFileContent' + summary_text: '#/components/schemas/OpenAI.SummaryTextContent' description: A content part that makes up an input or output item. OpenAI.MessageContentInputFileContent: type: object @@ -31031,18 +32169,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -31061,16 +32204,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -31180,6 +32325,15 @@ components: - input_image - computer_screenshot - input_file + OpenAI.MessagePhase: + type: string + enum: + - commentary + - final_answer + description: |- + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. OpenAI.MessageRole: type: string enum: @@ -31199,7 +32353,7 @@ components: - incomplete OpenAI.Metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -31210,13 +32364,9 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - allOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - type: string - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - type: 'null' description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. OpenAI.ModelIdsResponses: anyOf: @@ -31241,6 +32391,125 @@ components: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.ChatModel' + OpenAI.Moderation: + type: object + required: + - input + - output + properties: + input: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response input. + output: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response output. + description: Moderation results or errors for the response input and output. + title: Moderation + OpenAI.ModerationEntry: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ModerationEntryType' + discriminator: + propertyName: type + mapping: + moderation_result: '#/components/schemas/OpenAI.ModerationResultBody' + error: '#/components/schemas/OpenAI.ModerationErrorBody' + description: Moderation results or an error for a response moderation check. + OpenAI.ModerationEntryType: + anyOf: + - type: string + - type: string + enum: + - moderation_result + - error + OpenAI.ModerationErrorBody: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - error + description: The object type, which was always `error` for moderation failures. + x-stainless-const: true + code: + type: string + description: The error code. + message: + type: string + description: The error message. + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: An error produced while attempting moderation for the response input or output. + title: Moderation error + OpenAI.ModerationInputType: + type: string + enum: + - text + - image + OpenAI.ModerationParam: + type: object + required: + - model + properties: + model: + type: string + description: The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. + description: Configuration for running moderation on the input and output of this response. + OpenAI.ModerationResultBody: + type: object + required: + - type + - model + - flagged + - categories + - category_scores + - category_applied_input_types + properties: + type: + type: string + enum: + - moderation_result + description: The object type, which was always `moderation_result` for successful moderation results. + x-stainless-const: true + model: + type: string + description: The moderation model that produced this result. + flagged: + type: boolean + description: A boolean indicating whether the content was flagged by any category. + categories: + type: object + unevaluatedProperties: + type: boolean + description: A dictionary of moderation categories to booleans, True if the input is flagged under this category. + x-oaiTypeLabel: map + category_scores: + type: object + unevaluatedProperties: + $ref: '#/components/schemas/OpenAI.numeric' + description: A dictionary of moderation categories to scores. + x-oaiTypeLabel: map + category_applied_input_types: + type: object + unevaluatedProperties: + type: array + items: + $ref: '#/components/schemas/OpenAI.ModerationInputType' + description: Which modalities of input are reflected by the score for each category. + x-oaiTypeLabel: map + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: A moderation result produced for the response input or output. + title: Moderation result OpenAI.MoveParam: type: object required: @@ -31254,7 +32523,6 @@ components: - move description: Specifies the event type. For a move action, this property is always set to `move`. x-stainless-const: true - default: move x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -31263,10 +32531,50 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate to move to. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A mouse move action. title: Move + OpenAI.NamespaceToolParam: + type: object + required: + - type + - name + - description + - tools + properties: + type: + type: string + enum: + - namespace + description: The type of the tool. Always `namespace`. + x-stainless-const: true + name: + type: string + minLength: 1 + description: The namespace name used in tool calls (for example, `crm`). + description: + type: string + minLength: 1 + description: A description of the namespace shown to the model. + tools: + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionToolParam' + - $ref: '#/components/schemas/OpenAI.CustomToolParam' + minItems: 1 + description: The function/custom tools available inside this namespace. + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Groups function/custom tools under a shared namespace. + title: Namespace OpenAI.OutputContent: type: object required: @@ -31408,13 +32716,19 @@ components: output_message: '#/components/schemas/OpenAI.OutputItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.OutputItemFileSearchToolCall' function_call: '#/components/schemas/OpenAI.OutputItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput' web_search_call: '#/components/schemas/OpenAI.OutputItemWebSearchToolCall' computer_call: '#/components/schemas/OpenAI.OutputItemComputerToolCall' + computer_call_output: '#/components/schemas/OpenAI.OutputItemComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.OutputItemReasoningItem' + tool_search_call: '#/components/schemas/OpenAI.OutputItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.OutputItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.OutputItemAdditionalTools' compaction: '#/components/schemas/OpenAI.OutputItemCompactionBody' image_generation_call: '#/components/schemas/OpenAI.OutputItemImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.OutputItemLocalShellToolCall' + local_shell_call_output: '#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput' shell_call: '#/components/schemas/OpenAI.OutputItemFunctionShellCall' shell_call_output: '#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput' apply_patch_call: '#/components/schemas/OpenAI.OutputItemApplyPatchToolCall' @@ -31422,7 +32736,38 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' + mcp_approval_response: '#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource' + OpenAI.OutputItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -31487,8 +32832,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -31529,15 +32875,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -31575,7 +32923,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -31593,6 +32940,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -31613,13 +32962,99 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.OutputItemCustomToolCall: + OpenAI.OutputItemComputerToolCallOutput: + type: object + required: + - type + - id + - call_id + - output + properties: + type: + type: string + enum: + - computer_call_output + description: The type of the computer tool call output. Always `computer_call_output`. + x-stainless-const: true + default: computer_call_output + id: + type: string + description: The ID of the computer tool call output. + readOnly: true + call_id: + type: string + description: The ID of the computer tool call that produced the output. + acknowledged_safety_checks: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + description: |- + The safety checks reported by the API that have been acknowledged by the + developer. + output: + $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.OutputItemCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + title: ResponseCustomToolCallOutputItem + OpenAI.OutputItemCustomToolCallResource: type: object required: - type - call_id - name - input + - status properties: type: type: string @@ -31633,16 +33068,27 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. input: type: string description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' - description: A call to a custom tool created by the model. - title: Custom tool call + title: ResponseCustomToolCallItem OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -31677,10 +33123,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -31716,13 +33163,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -31755,7 +33201,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -31763,10 +33209,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -31777,6 +33222,7 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -31785,6 +33231,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -31794,6 +33241,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -31815,6 +33265,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.OutputItemFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.OutputItemImageGenToolCall: type: object required: @@ -31841,8 +33336,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -31881,6 +33377,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run a command on the local shell. title: Local shell call + OpenAI.OutputItemLocalShellToolCallOutput: + type: object + required: + - type + - id + - output + properties: + type: + type: string + enum: + - local_shell_call_output + description: The type of the local shell tool call output. Always `local_shell_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the local shell tool call generated by the model. + output: + type: string + description: A JSON string of the output of the local shell tool call. + status: + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a local shell tool call. + title: Local shell call output OpenAI.OutputItemMcpApprovalRequest: type: object required: @@ -31912,6 +33439,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A request for human approval of a tool invocation. title: MCP approval request + OpenAI.OutputItemMcpApprovalResponseResource: + type: object + required: + - type + - id + - approval_request_id + - approve + properties: + type: + type: string + enum: + - mcp_approval_response + description: The type of the item. Always `mcp_approval_response`. + x-stainless-const: true + id: + type: string + description: The unique ID of the approval response + approval_request_id: + type: string + description: The ID of the approval request being answered. + approve: + type: boolean + description: Whether the request was approved. + reason: + anyOf: + - type: string + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: A response to an MCP approval request. + title: MCP approval response OpenAI.OutputItemMcpListTools: type: object required: @@ -31938,8 +33496,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -31972,18 +33529,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -32017,6 +33576,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -32047,8 +33610,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -32076,6 +33640,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.OutputItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + OpenAI.OutputItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemType: anyOf: - type: string @@ -32084,13 +33729,19 @@ components: - output_message - file_search_call - function_call + - function_call_output - web_search_call - computer_call + - computer_call_output - reasoning + - tool_search_call + - tool_search_output + - additional_tools - compaction - image_generation_call - code_interpreter_call - local_shell_call + - local_shell_call_output - shell_call - shell_call_output - apply_patch_call @@ -32098,7 +33749,9 @@ components: - mcp_call - mcp_list_tools - mcp_approval_request + - mcp_approval_response - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -32241,16 +33894,21 @@ components: type: string description: The unique identifier of the prompt template to use. version: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' variables: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - nullable: true + - type: 'null' description: |- Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). + OpenAI.PromptCacheRetentionEnum: + type: string + enum: + - in_memory + - 24h OpenAI.RankerVersionType: type: string enum: @@ -32271,39 +33929,118 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.HybridSearchOptions' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + OpenAI.RealtimeMCPError: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.RealtimeMcpErrorType' + discriminator: + propertyName: type + mapping: + protocol_error: '#/components/schemas/OpenAI.RealtimeMCPProtocolError' + tool_execution_error: '#/components/schemas/OpenAI.RealtimeMCPToolExecutionError' + http_error: '#/components/schemas/OpenAI.RealtimeMCPHTTPError' + OpenAI.RealtimeMCPHTTPError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - http_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP HTTP error + OpenAI.RealtimeMCPProtocolError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - protocol_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP protocol error + OpenAI.RealtimeMCPToolExecutionError: + type: object + required: + - type + - message + properties: + type: + type: string + enum: + - tool_execution_error + x-stainless-const: true + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP tool execution error + OpenAI.RealtimeMcpErrorType: + anyOf: + - type: string + - type: string + enum: + - protocol_error + - tool_execution_error + - http_error OpenAI.Reasoning: type: object properties: effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' generate_summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh + anyOf: + - type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh + - type: 'null' description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -32314,7 +34051,6 @@ components: - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - nullable: true OpenAI.ReasoningTextContent: type: object required: @@ -32347,26 +34083,22 @@ components: - agent_reference properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -32377,44 +34109,41 @@ components: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -32426,11 +34155,12 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled id: type: string @@ -32458,19 +34188,20 @@ components: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - nullable: true + - type: 'null' incomplete_details: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - nullable: true + - type: 'null' output: type: array items: @@ -32489,21 +34220,29 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' output_text: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - nullable: true + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent: allOf: - $ref: '#/components/schemas/AgentId' @@ -32518,10 +34257,9 @@ components: or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox affinity in follow-up calls. agent_reference: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/AgentReference' - nullable: true + - type: 'null' description: The agent used for this response content_filters: type: array @@ -32548,8 +34286,10 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - format: base64 + contentEncoding: base64 description: A chunk of Base64 encoded response audio bytes. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial audio response. x-oaiMeta: name: response.audio.delta @@ -32577,6 +34317,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the audio response is complete. x-oaiMeta: name: response.audio.done @@ -32607,6 +34349,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial transcript of audio. x-oaiMeta: name: response.audio.transcript.delta @@ -32634,6 +34378,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the full audio transcript is completed. x-oaiMeta: name: response.audio.transcript.done @@ -32673,6 +34419,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial code snippet is streamed by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.delta @@ -32714,6 +34462,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code snippet is finalized by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.done @@ -32751,6 +34501,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter call is completed. x-oaiMeta: name: response.code_interpreter_call.completed @@ -32787,6 +34539,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a code interpreter call is in progress. x-oaiMeta: name: response.code_interpreter_call.in_progress @@ -32823,6 +34577,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter is actively interpreting the code snippet. x-oaiMeta: name: response.code_interpreter_call.interpreting @@ -32855,6 +34611,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the model response is complete. x-oaiMeta: name: response.completed @@ -32949,6 +34707,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new content part is added. x-oaiMeta: name: response.content_part.added @@ -33001,6 +34761,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputContent' description: The content part that is done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a content part is done. x-oaiMeta: name: response.content_part.done @@ -33039,6 +34801,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response is created. x-oaiMeta: name: response.created @@ -33110,6 +34874,8 @@ components: delta: type: string description: The incremental input data (delta) for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event representing a delta (partial update) to the input of a custom tool call. title: ResponseCustomToolCallInputDelta x-oaiMeta: @@ -33151,6 +34917,8 @@ components: input: type: string description: The complete input data for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event indicating that input for a custom tool call is complete. title: ResponseCustomToolCallInputDone x-oaiMeta: @@ -33213,18 +34981,22 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string description: The error message. param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' sequence_number: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an error occurs. x-oaiMeta: name: error @@ -33258,6 +35030,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Response' description: The response that failed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response fails. x-oaiMeta: name: response.failed @@ -33323,6 +35097,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is completed (results found). x-oaiMeta: name: response.file_search_call.completed @@ -33359,6 +35135,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is initiated. x-oaiMeta: name: response.file_search_call.in_progress @@ -33395,6 +35173,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search is currently searching. x-oaiMeta: name: response.file_search_call.searching @@ -33458,11 +35238,12 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.ResponseFormatJsonSchemaSchema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -33509,6 +35290,8 @@ components: delta: type: string description: The function-call arguments delta that is added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial function-call arguments delta. x-oaiMeta: name: response.function_call_arguments.delta @@ -33553,6 +35336,8 @@ components: arguments: type: string description: The function-call arguments. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when function-call arguments are finalized. x-oaiMeta: name: response.function_call_arguments.done @@ -33591,6 +35376,8 @@ components: item_id: type: string description: The unique identifier of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call has completed and the final image is available. title: ResponseImageGenCallCompletedEvent x-oaiMeta: @@ -33628,6 +35415,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is actively generating an image (intermediate state). title: ResponseImageGenCallGeneratingEvent x-oaiMeta: @@ -33665,6 +35454,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is in progress. title: ResponseImageGenCallInProgressEvent x-oaiMeta: @@ -33711,6 +35502,8 @@ components: partial_image_b64: type: string description: Base64-encoded partial image data, suitable for rendering as an image. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial image is available during image generation streaming. title: ResponseImageGenCallPartialImageEvent x-oaiMeta: @@ -33746,6 +35539,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the response is in progress. x-oaiMeta: name: response.in_progress @@ -33817,6 +35612,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response finishes as incomplete. x-oaiMeta: name: response.incomplete @@ -33874,7 +35671,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probability of the top 20 most likely tokens. + description: The log probabilities of up to 20 of the most likely tokens. description: |- A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) @@ -33915,6 +35712,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a delta (partial update) to the arguments of an MCP tool call. title: ResponseMCPCallArgumentsDeltaEvent x-oaiMeta: @@ -33957,6 +35756,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the arguments for an MCP tool call are finalized. title: ResponseMCPCallArgumentsDoneEvent x-oaiMeta: @@ -33995,6 +35796,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has completed successfully. title: ResponseMCPCallCompletedEvent x-oaiMeta: @@ -34032,6 +35835,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has failed. title: ResponseMCPCallFailedEvent x-oaiMeta: @@ -34069,6 +35874,8 @@ components: item_id: type: string description: The unique identifier of the MCP tool call item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call is in progress. title: ResponseMCPCallInProgressEvent x-oaiMeta: @@ -34106,6 +35913,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the list of available MCP tools has been successfully retrieved. title: ResponseMCPListToolsCompletedEvent x-oaiMeta: @@ -34143,6 +35952,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the attempt to list available MCP tools has failed. title: ResponseMCPListToolsFailedEvent x-oaiMeta: @@ -34180,6 +35991,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the system is in the process of retrieving the list of available MCP tools. title: ResponseMCPListToolsInProgressEvent x-oaiMeta: @@ -34218,6 +36031,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new output item is added. x-oaiMeta: name: response.output_item.added @@ -34261,6 +36076,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was marked done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an output item is marked done. x-oaiMeta: name: response.output_item.done @@ -34324,6 +36141,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Annotation' description: The annotation object being added. (See annotation schema for details.) + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an annotation is added to output text content. title: ResponseOutputTextAnnotationAddedEvent x-oaiMeta: @@ -34346,7 +36165,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -34380,6 +36199,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a response is queued and waiting to be processed. title: ResponseQueuedEvent x-oaiMeta: @@ -34431,6 +36252,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEventPart' description: The summary part that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new reasoning summary part is added. x-oaiMeta: name: response.reasoning_summary_part.added @@ -34495,6 +36318,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEventPart' description: The completed summary part. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary part is completed. x-oaiMeta: name: response.reasoning_summary_part.done @@ -34560,6 +36385,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning summary text. x-oaiMeta: name: response.reasoning_summary_text.delta @@ -34609,6 +36436,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary text is completed. x-oaiMeta: name: response.reasoning_summary_text.done @@ -34658,6 +36487,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning text. x-oaiMeta: name: response.reasoning_text.delta @@ -34705,6 +36536,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning text is completed. x-oaiMeta: name: response.reasoning_text.done @@ -34752,6 +36585,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial refusal text. x-oaiMeta: name: response.refusal.delta @@ -34799,6 +36634,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when refusal text is finalized. x-oaiMeta: name: response.refusal.done @@ -34812,6 +36649,127 @@ components: "refusal": "final refusal text", "sequence_number": 1 } + OpenAI.ResponseStreamEvent: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ResponseStreamEventType' + discriminator: + propertyName: type + mapping: + response.audio.transcript.delta: '#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent' + response.code_interpreter_call_code.delta: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent' + response.code_interpreter_call.in_progress: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent' + response.code_interpreter_call.interpreting: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent' + response.content_part.added: '#/components/schemas/OpenAI.ResponseContentPartAddedEvent' + response.created: '#/components/schemas/OpenAI.ResponseCreatedEvent' + error: '#/components/schemas/OpenAI.ResponseErrorEvent' + response.file_search_call.in_progress: '#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent' + response.file_search_call.searching: '#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent' + response.function_call_arguments.delta: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent' + response.in_progress: '#/components/schemas/OpenAI.ResponseInProgressEvent' + response.failed: '#/components/schemas/OpenAI.ResponseFailedEvent' + response.incomplete: '#/components/schemas/OpenAI.ResponseIncompleteEvent' + response.output_item.added: '#/components/schemas/OpenAI.ResponseOutputItemAddedEvent' + response.reasoning_summary_part.added: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent' + response.reasoning_summary_text.delta: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent' + response.reasoning_text.delta: '#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent' + response.refusal.delta: '#/components/schemas/OpenAI.ResponseRefusalDeltaEvent' + response.output_text.delta: '#/components/schemas/OpenAI.ResponseTextDeltaEvent' + response.web_search_call.in_progress: '#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent' + response.web_search_call.searching: '#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent' + response.image_generation_call.generating: '#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent' + response.image_generation_call.in_progress: '#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent' + response.image_generation_call.partial_image: '#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent' + response.mcp_call_arguments.delta: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent' + response.mcp_call.failed: '#/components/schemas/OpenAI.ResponseMCPCallFailedEvent' + response.mcp_call.in_progress: '#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent' + response.mcp_list_tools.failed: '#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent' + response.mcp_list_tools.in_progress: '#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent' + response.output_text.annotation.added: '#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent' + response.queued: '#/components/schemas/OpenAI.ResponseQueuedEvent' + response.custom_tool_call_input.delta: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent' + response.audio.done: '#/components/schemas/OpenAI.ResponseAudioDoneEvent' + response.audio.transcript.done: '#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent' + response.code_interpreter_call_code.done: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent' + response.code_interpreter_call.completed: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent' + response.completed: '#/components/schemas/OpenAI.ResponseCompletedEvent' + response.content_part.done: '#/components/schemas/OpenAI.ResponseContentPartDoneEvent' + response.file_search_call.completed: '#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent' + response.function_call_arguments.done: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent' + response.output_item.done: '#/components/schemas/OpenAI.ResponseOutputItemDoneEvent' + response.reasoning_summary_part.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent' + response.reasoning_summary_text.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent' + response.reasoning_text.done: '#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent' + response.refusal.done: '#/components/schemas/OpenAI.ResponseRefusalDoneEvent' + response.output_text.done: '#/components/schemas/OpenAI.ResponseTextDoneEvent' + response.web_search_call.completed: '#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent' + response.image_generation_call.completed: '#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent' + response.mcp_call_arguments.done: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent' + response.mcp_call.completed: '#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent' + response.mcp_list_tools.completed: '#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent' + response.custom_tool_call_input.done: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent' + response.audio.delta: '#/components/schemas/OpenAI.ResponseAudioDeltaEvent' + OpenAI.ResponseStreamEventType: + anyOf: + - type: string + - type: string + enum: + - response.audio.delta + - response.audio.done + - response.audio.transcript.delta + - response.audio.transcript.done + - response.code_interpreter_call_code.delta + - response.code_interpreter_call_code.done + - response.code_interpreter_call.completed + - response.code_interpreter_call.in_progress + - response.code_interpreter_call.interpreting + - response.completed + - response.content_part.added + - response.content_part.done + - response.created + - error + - response.file_search_call.completed + - response.file_search_call.in_progress + - response.file_search_call.searching + - response.function_call_arguments.delta + - response.function_call_arguments.done + - response.in_progress + - response.failed + - response.incomplete + - response.output_item.added + - response.output_item.done + - response.reasoning_summary_part.added + - response.reasoning_summary_part.done + - response.reasoning_summary_text.delta + - response.reasoning_summary_text.done + - response.reasoning_text.delta + - response.reasoning_text.done + - response.refusal.delta + - response.refusal.done + - response.output_text.delta + - response.output_text.done + - response.web_search_call.completed + - response.web_search_call.in_progress + - response.web_search_call.searching + - response.image_generation_call.completed + - response.image_generation_call.generating + - response.image_generation_call.in_progress + - response.image_generation_call.partial_image + - response.mcp_call_arguments.delta + - response.mcp_call_arguments.done + - response.mcp_call.completed + - response.mcp_call.failed + - response.mcp_call.in_progress + - response.mcp_list_tools.completed + - response.mcp_list_tools.failed + - response.mcp_list_tools.in_progress + - response.output_text.annotation.added + - response.queued + - response.custom_tool_call_input.delta + - response.custom_tool_call_input.done OpenAI.ResponseStreamOptions: type: object properties: @@ -34866,6 +36824,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is an additional text delta. x-oaiMeta: name: response.output_text.delta @@ -34919,6 +36879,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when text content is finalized. x-oaiMeta: name: response.output_text.done @@ -35015,6 +36977,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is completed. x-oaiMeta: name: response.web_search_call.completed @@ -35051,6 +37015,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is initiated. x-oaiMeta: name: response.web_search_call.in_progress @@ -35087,6 +37053,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is executing. x-oaiMeta: name: response.web_search_call.searching @@ -35109,7 +37077,6 @@ components: - screenshot description: Specifies the event type. For a screenshot action, this property is always set to `screenshot`. x-stainless-const: true - default: screenshot allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A screenshot action. @@ -35129,7 +37096,6 @@ components: - scroll description: Specifies the event type. For a scroll action, this property is always set to `scroll`. x-stainless-const: true - default: scroll x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -35146,10 +37112,21 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The vertical scroll distance. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A scroll action. title: Scroll + OpenAI.SearchContentType: + type: string + enum: + - text + - image OpenAI.SearchContextSize: type: string enum: @@ -35157,13 +37134,15 @@ components: - medium - high OpenAI.ServiceTier: - type: string - enum: - - auto - - default - - flex - - scale - - priority + anyOf: + - type: string + enum: + - auto + - default + - flex + - scale + - priority + - type: 'null' description: |- Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. @@ -35171,7 +37150,13 @@ components: - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - nullable: true + OpenAI.ServiceTierEnum: + type: string + enum: + - auto + - default + - flex + - priority OpenAI.SkillReferenceParam: type: object required: @@ -35184,7 +37169,6 @@ components: - skill_reference description: References a skill created with the /v1/skills endpoint. x-stainless-const: true - default: skill_reference skill_id: type: string minLength: 1 @@ -35206,7 +37190,6 @@ components: - apply_patch description: The tool to call. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the apply_patch tool when executing a tool call. @@ -35222,7 +37205,6 @@ components: - shell description: The tool to call. Always `shell`. x-stainless-const: true - default: shell allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the shell tool when a tool call is required. @@ -35239,7 +37221,6 @@ components: - summary_text description: The type of the object. Always `summary_text`. x-stainless-const: true - default: summary_text text: type: string description: A summary of the reasoning output from the model so far. @@ -35258,7 +37239,6 @@ components: enum: - text x-stainless-const: true - default: text text: type: string allOf: @@ -35356,8 +37336,9 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -35401,6 +37382,9 @@ components: custom: '#/components/schemas/OpenAI.CustomToolParam' web_search_preview: '#/components/schemas/OpenAI.WebSearchPreviewTool' apply_patch: '#/components/schemas/OpenAI.ApplyPatchToolParam' + computer: '#/components/schemas/OpenAI.ComputerTool' + namespace: '#/components/schemas/OpenAI.NamespaceToolParam' + tool_search: '#/components/schemas/OpenAI.ToolSearchToolParam' description: A tool that can be used to generate a response. OpenAI.ToolChoiceAllowed: type: object @@ -35429,7 +37413,7 @@ components: type: array items: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: @@ -35458,6 +37442,34 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputer: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputerUse: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer_use + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). OpenAI.ToolChoiceComputerUsePreview: type: object required: @@ -35554,8 +37566,9 @@ components: type: string description: The label of the MCP server to use. name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -35595,6 +37608,8 @@ components: web_search_preview_2025_03_11: '#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311' image_generation: '#/components/schemas/OpenAI.ToolChoiceImageGeneration' code_interpreter: '#/components/schemas/OpenAI.ToolChoiceCodeInterpreter' + computer: '#/components/schemas/OpenAI.ToolChoiceComputer' + computer_use: '#/components/schemas/OpenAI.ToolChoiceComputerUse' description: |- How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools @@ -35616,6 +37631,8 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter + - computer + - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -35644,6 +37661,38 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolSearchExecutionType: + type: string + enum: + - server + - client + OpenAI.ToolSearchToolParam: + type: object + required: + - type + properties: + type: + type: string + enum: + - tool_search + description: The type of the tool. Always `tool_search`. + x-stainless-const: true + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search is executed by the server or by the client. + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Hosted or BYOT tool search configuration for deferred tools. + title: Tool search tool OpenAI.ToolType: anyOf: - type: string @@ -35651,6 +37700,7 @@ components: enum: - function - file_search + - computer - computer_use_preview - web_search - mcp @@ -35659,6 +37709,8 @@ components: - local_shell - shell - custom + - namespace + - tool_search - web_search_preview - apply_patch - a2a_preview @@ -35725,7 +37777,6 @@ components: - type description: Specifies the event type. For a type action, this property is always set to `type`. x-stainless-const: true - default: type text: type: string description: The text to type. @@ -35739,10 +37790,9 @@ components: - metadata properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -35761,7 +37811,6 @@ components: - url_citation description: The type of the URL citation. Always `url_citation`. x-stainless-const: true - default: url_citation url: type: string format: uri @@ -35783,7 +37832,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -35796,16 +37845,17 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - type: string - enum: - - low - - medium - - high + anyOf: + - type: string + enum: + - low + - medium + - high + - type: 'null' description: |- Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. - nullable: true OpenAI.WaitParam: type: object required: @@ -35817,7 +37867,6 @@ components: - wait description: Specifies the event type. For a wait action, this property is always set to `wait`. x-stainless-const: true - default: wait allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A wait action. @@ -35856,9 +37905,10 @@ components: description: The action type. x-stainless-const: true url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -35866,7 +37916,6 @@ components: type: object required: - type - - query properties: type: type: string @@ -35876,7 +37925,7 @@ components: x-stainless-const: true query: type: string - description: '[DEPRECATED] The search query.' + description: The search query. deprecated: true queries: type: array @@ -35905,6 +37954,7 @@ components: x-stainless-const: true url: type: string + format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -35918,17 +37968,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -35942,16 +37996,18 @@ components: - web_search_preview description: The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. x-stainless-const: true - default: web_search_preview user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - nullable: true + - type: 'null' search_context_size: allOf: - $ref: '#/components/schemas/OpenAI.SearchContextSize' description: High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. + search_content_types: + type: array + items: + $ref: '#/components/schemas/OpenAI.SearchContentType' allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). @@ -35966,17 +38022,14 @@ components: enum: - web_search description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - default: web_search filters: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - nullable: true + - type: 'null' user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - nullable: true + - type: 'null' search_context_size: type: string enum: @@ -35993,7 +38046,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -36015,10 +38068,11 @@ components: type: object properties: allowed_domains: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' OpenAI.integer: type: integer format: int64 @@ -36082,7 +38136,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. spec: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -36106,7 +38160,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -36185,7 +38239,7 @@ components: description: The openapi function definition. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -36279,7 +38333,7 @@ components: description: Display name of the candidate (e.g., 'baseline', 'instruction-v2'). mutations: type: object - additionalProperties: {} + unevaluatedProperties: {} description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." avg_score: type: number @@ -36554,11 +38608,12 @@ components: max_candidates: type: integer format: int32 + minimum: 1 description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' default: 5 optimization_config: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. eval_model: type: string @@ -36606,12 +38661,14 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - example: https://my-collector.example.com/otlp + examples: + - https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - example: Http + examples: + - Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -36950,13 +39007,15 @@ components: type: string description: The model deployment to use for this agent. instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A system (or developer) message inserted into the model's context. temperature: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 2 description: |- @@ -36964,9 +39023,10 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 1 description: |- @@ -36977,10 +39037,9 @@ components: Defaults to `1`. default: 1 reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' tools: type: array items: @@ -37001,7 +39060,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -37208,12 +39267,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -37365,7 +39424,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -37410,7 +39469,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -37484,7 +39543,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -37766,17 +39825,17 @@ components: description: Task for the schedule. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the resource. readOnly: true @@ -37844,7 +39903,7 @@ components: readOnly: true properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Properties of the schedule run. readOnly: true @@ -37860,7 +39919,7 @@ components: description: Type of the task. configuration: type: object - additionalProperties: + unevaluatedProperties: type: string description: Configuration for the task. discriminator: @@ -37949,11 +40008,13 @@ components: allOf: - $ref: '#/components/schemas/SessionLogEventType' description: The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types. - example: log + examples: + - log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - example: '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + examples: + - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' description: |- A single Server-Sent Event frame emitted by the hosted agent session log stream. @@ -38070,7 +40131,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -38163,7 +40224,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -38245,7 +40306,7 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean @@ -38268,11 +40329,12 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured output. strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -38477,7 +40539,7 @@ components: description: List of taxonomy sub categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -38502,7 +40564,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -38549,10 +40611,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - example: - - ContainerStdoutStderr - - ContainerOtel - - Metrics + examples: + - - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -38636,11 +40698,11 @@ components: description: The version of the evaluator. Latest version if not specified. initialization_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The initialization parameters for the evaluation. Must support structured outputs. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: The model to use for the evaluation. Must support structured outputs. description: An Azure AI Evaluator grader used as testing criterion in evaluations. @@ -38668,7 +40730,7 @@ components: ToolCallOutputContent: anyOf: - type: object - additionalProperties: {} + unevaluatedProperties: {} - type: string - type: array items: {} @@ -38772,7 +40834,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -38829,10 +40891,11 @@ components: - tools properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -39127,7 +41190,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -39146,7 +41209,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -39155,7 +41218,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -39192,13 +41255,12 @@ components: name: type: string metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -39211,7 +41273,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Request body for updating a model version. Only description and tags can be modified. @@ -39406,7 +41468,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -39493,7 +41555,7 @@ components: description: The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'. modelParams: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Optional parameters passed to the model for evaluation. allOf: - $ref: '#/components/schemas/EvaluationTarget' diff --git a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp index 5742270a94fb..b6d65aaa3486 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp @@ -163,6 +163,7 @@ model OptimizationAgentDefinition { @doc("Tuning knobs and run-mode for an optimization job.") model OptimizationOptions { @doc("Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.") + @minValue(1) max_candidates?: int32 = 5; @doc("Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization.") From 15c9a739214daa7cfb56d068fbe2fbe9dd99bb57 Mon Sep 17 00:00:00 2001 From: jessli Date: Thu, 11 Jun 2026 18:23:30 -0700 Subject: [PATCH 4/5] address comments of OptimizationInlineDatasetInput.type --- .../data-plane/Foundry/src/agents-optimization/models.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp index b6d65aaa3486..414e30232c13 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp @@ -69,7 +69,7 @@ model OptimizationDatasetInput { /** Inline dataset — items supplied directly in the request body. */ model OptimizationInlineDatasetInput extends OptimizationDatasetInput { @doc("Dataset input type discriminator.") - type: "inline"; + type: OptimizationDatasetInputType.inline; @doc("Dataset items.") items: OptimizationDatasetItem[]; @@ -78,7 +78,7 @@ model OptimizationInlineDatasetInput extends OptimizationDatasetInput { /** Reference to a registered Foundry dataset. */ model OptimizationReferenceDatasetInput extends OptimizationDatasetInput { @doc("Dataset input type discriminator.") - type: "reference"; + type: OptimizationDatasetInputType.reference; @doc("Registered dataset name.") name: string; From 3179780e2ea753a96872c051d08ed3acc451c013 Mon Sep 17 00:00:00 2001 From: jessli Date: Fri, 12 Jun 2026 12:41:41 -0700 Subject: [PATCH 5/5] address coment of OptimizationJobListItem --- .../src/agents-optimization/models.tsp | 27 ++----------------- .../sdk-common/beta-ops-relocation-agents.tsp | 21 --------------- .../client.tsp | 13 --------- 3 files changed, 2 insertions(+), 59 deletions(-) diff --git a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp index 414e30232c13..2c848b3bc469 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/agents-optimization/models.tsp @@ -317,34 +317,11 @@ model OptimizationJob is JobLike { // --------------------------------------------------------------------------- @doc("Slim job representation returned by the LIST endpoint.") -model OptimizationJobListItem { - @doc("Server-assigned unique identifier.") - @visibility(Lifecycle.Read) - id: string; - - @doc("Current lifecycle status.") - @visibility(Lifecycle.Read) - status: JobStatus; - - @doc("The timestamp when the job was created, represented in Unix time.") - @visibility(Lifecycle.Read) - created_at: FoundryTimestamp; - - @doc("The timestamp when the job was last updated, represented in Unix time.") - @visibility(Lifecycle.Read) - updated_at: FoundryTimestamp; - +model OptimizationJobListItem + is OmitProperties { @doc("The agent targeted by this optimization job.") @visibility(Lifecycle.Read) agent?: OptimizationAgentIdentifier; - - @doc("Progress snapshot. May be present in terminal states reflecting last-known progress.") - @visibility(Lifecycle.Read) - progress?: OptimizationJobProgress; - - @doc("Error details — populated only on failure.") - @visibility(Lifecycle.Read) - error?: ApiError; } // --------------------------------------------------------------------------- diff --git a/specification/ai-foundry/data-plane/Foundry/src/sdk-common/beta-ops-relocation-agents.tsp b/specification/ai-foundry/data-plane/Foundry/src/sdk-common/beta-ops-relocation-agents.tsp index 4eac67ed8e68..f86601333fb8 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/sdk-common/beta-ops-relocation-agents.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/sdk-common/beta-ops-relocation-agents.tsp @@ -68,24 +68,3 @@ interface Agents {} @@clientLocation(Azure.AI.Projects.AgentOptimizationJobs.list, Agents); @@clientLocation(Azure.AI.Projects.AgentOptimizationJobs.cancel, Agents); @@clientLocation(Azure.AI.Projects.AgentOptimizationJobs.delete, Agents); -@@clientLocation( - Azure.AI.Projects.AgentOptimizationJobs.listCandidates, - Agents -); -@@clientLocation(Azure.AI.Projects.AgentOptimizationJobs.getCandidate, Agents); -@@clientLocation( - Azure.AI.Projects.AgentOptimizationJobs.getCandidateConfig, - Agents -); -@@clientLocation( - Azure.AI.Projects.AgentOptimizationJobs.getCandidateResults, - Agents -); -@@clientLocation( - Azure.AI.Projects.AgentOptimizationJobs.getCandidateFile, - Agents -); -@@clientLocation( - Azure.AI.Projects.AgentOptimizationJobs.promoteCandidate, - Agents -); diff --git a/specification/ai-foundry/data-plane/Foundry/src/sdk-python-js-azure-ai-projects/client.tsp b/specification/ai-foundry/data-plane/Foundry/src/sdk-python-js-azure-ai-projects/client.tsp index 584cd4412431..b550344bcf7a 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/sdk-python-js-azure-ai-projects/client.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/sdk-python-js-azure-ai-projects/client.tsp @@ -191,19 +191,6 @@ using Azure.AI.Projects; @@clientName(AgentOptimizationJobs.list, "listOptimizationJobs"); @@clientName(AgentOptimizationJobs.cancel, "cancelOptimizationJob"); @@clientName(AgentOptimizationJobs.delete, "deleteOptimizationJob"); -@@clientName( - AgentOptimizationJobs.listCandidates, - "listOptimizationCandidates" -); -@@clientName(AgentOptimizationJobs.getCandidate, "getOptimizationCandidate"); -@@clientName( - AgentOptimizationJobs.getCandidateConfig, - "getOptimizationCandidateConfig" -); -@@clientName( - AgentOptimizationJobs.getCandidateResults, - "getOptimizationCandidateResults" -); // DatasetItem model has a property `response_items?: OpenAI.OutputItem[]`. It is used // to define Agent optimization request. If emitted as-is, it pulls in a lot of