Skip to content

feat: add reasoning output types to OpenAI Responses API spec #5357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leseb merged 4 commits into from
Mar 31, 2026
Merged

feat: add reasoning output types to OpenAI Responses API spec #5357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
884dbd0
feat: add reasoning output types to OpenAI Responses API spec
robinnarsinghranabhat Mar 29, 2026
0cfd2fc
Merge branch 'main' into feat/reasoning-types-only
cdoern Mar 30, 2026
01519aa
fix: tighten status to Literal union and add Field descriptions per r…
robinnarsinghranabhat Mar 30, 2026
28c4b21
fix: handle ReasoningItem in input conversion and add exhaustive fall…
robinnarsinghranabhat Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 116 additions & 9 deletions client-sdks/stainless/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6863,6 +6863,7 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
oneOf:
Expand All @@ -6880,7 +6881,9 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
title: OpenAIResponseMessage | ... (7 variants)
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
title: OpenAIResponseMessage | ... (8 variants)
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
title: OpenAIResponseInputFunctionToolCallOutput
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
Expand Down Expand Up @@ -7032,6 +7035,8 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
discriminator:
propertyName: type
mapping:
Expand All @@ -7041,8 +7046,9 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseMessage-Output | ... (7 variants)
title: OpenAIResponseMessage-Output | ... (8 variants)
type: array
title: Output
parallel_tool_calls:
Expand Down Expand Up @@ -7208,6 +7214,8 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
discriminator:
propertyName: type
mapping:
Expand All @@ -7217,8 +7225,9 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseMessage-Output | ... (7 variants)
title: OpenAIResponseMessage-Output | ... (8 variants)
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
title: OpenAIResponseInputFunctionToolCallOutput
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
Expand Down Expand Up @@ -7247,6 +7256,7 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
oneOf:
Expand All @@ -7264,7 +7274,9 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
title: OpenAIResponseMessage | ... (7 variants)
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
title: OpenAIResponseMessage | ... (8 variants)
OpenAIResponsePrompt:
properties:
id:
Expand Down Expand Up @@ -7515,6 +7527,8 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
discriminator:
propertyName: type
mapping:
Expand All @@ -7524,8 +7538,9 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseMessage-Output | ... (7 variants)
title: OpenAIResponseMessage-Output | ... (8 variants)
type: array
title: Output
parallel_tool_calls:
Expand Down Expand Up @@ -8320,6 +8335,7 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
oneOf:
Expand All @@ -8337,7 +8353,9 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
title: OpenAIResponseMessage | ... (7 variants)
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
title: OpenAIResponseMessage | ... (8 variants)
output_index:
title: Output Index
type: integer
Expand Down Expand Up @@ -8370,6 +8388,7 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
oneOf:
Expand All @@ -8387,7 +8406,9 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
title: OpenAIResponseMessage | ... (7 variants)
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
title: OpenAIResponseMessage | ... (8 variants)
output_index:
title: Output Index
type: integer
Expand Down Expand Up @@ -8863,6 +8884,8 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
discriminator:
propertyName: type
mapping:
Expand All @@ -8872,8 +8895,9 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseMessage-Output | ... (7 variants)
title: OpenAIResponseMessage-Output | ... (8 variants)
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
title: OpenAIResponseInputFunctionToolCallOutput
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
Expand Down Expand Up @@ -11424,6 +11448,8 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
title: OpenAIResponseMCPApprovalRequest
- $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
title: OpenAIResponseOutputMessageReasoningItem
discriminator:
propertyName: type
mapping:
Expand All @@ -11433,8 +11459,9 @@ components:
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Input'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseMessage-Input | ... (7 variants)
title: OpenAIResponseMessage-Input | ... (8 variants)
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
title: OpenAIResponseInputFunctionToolCallOutput
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
Expand Down Expand Up @@ -12516,6 +12543,77 @@ components:
- text
title: OpenAIResponseOutputMessageFileSearchToolCallResults
description: Search results returned by the file search operation.
OpenAIResponseOutputMessageReasoningContent:
properties:
text:
type: string
title: Text
description: The reasoning text content from the model.
type:
type: string
title: Type
description: The type identifier, always 'reasoning_text'.
enum:
- reasoning_text
required:
- text
title: OpenAIResponseOutputMessageReasoningContent
description: Reasoning text from the model.
OpenAIResponseOutputMessageReasoningItem:
properties:
id:
type: string
title: Id
description: Unique identifier for the reasoning output item.
summary:
items:
$ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningSummary'
type: array
title: Summary
description: Summary of the reasoning output.
type:
type: string
title: Type
description: The type identifier, always 'reasoning'.
enum:
- reasoning
content:
anyOf:
- items:
$ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningContent'
type: array
- type: 'null'
description: The reasoning content from the model.
status:
anyOf:
- type: string
enum:
- in_progress
- completed
- incomplete
- type: 'null'
description: The status of the reasoning output.
required:
- id
- summary
title: OpenAIResponseOutputMessageReasoningItem
description: Reasoning output from the model, representing the model's thinking process.
OpenAIResponseOutputMessageReasoningSummary:
properties:
text:
type: string
title: Text
description: The summary text of the reasoning output.
type:
type: string
title: Type
description: The type identifier, always 'summary_text'.
enum:
- summary_text
required:
- text
title: OpenAIResponseOutputMessageReasoningSummary
description: A summary of reasoning output from the model.
OpenAIResponseReasoning:
properties:
effort:
Expand All @@ -12529,6 +12627,15 @@ components:
- high
- xhigh
- type: 'null'
summary:
anyOf:
- type: string
enum:
- auto
- concise
- detailed
- type: 'null'
description: Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
title: OpenAIResponseReasoning
description: |-
Configuration for reasoning effort in OpenAI responses.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-openai/conformance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1100,7 +1100,7 @@ Below is a detailed breakdown of conformance issues and missing properties for e
| `responses.200.content.application/json.properties.incomplete_details` | Union variants added: 1; Union variants removed: 1 | Yes |
| `responses.200.content.application/json.properties.metadata` | Union variants added: 2 | Yes |
| `responses.200.content.application/json.properties.object` | Default changed: response -> None | No |
| `responses.200.content.application/json.properties.output.items` | Union variants added: 7; Union variants removed: 4 | Yes |
| `responses.200.content.application/json.properties.output.items` | Union variants added: 8; Union variants removed: 4 | Yes |
| `responses.200.content.application/json.properties.parallel_tool_calls` | Type removed: ['boolean']; Nullable added (OpenAI non-nullable); Union variants added: 2; Default changed: None -> True | Yes |
| `responses.200.content.application/json.properties.presence_penalty` | Type removed: ['number']; Nullable added (OpenAI non-nullable); Union variants added: 2 | No |
| `responses.200.content.application/json.properties.reasoning` | Union variants added: 1; Union variants removed: 1 | Yes |
Expand Down
Loading
Loading