OpenAI Responses API
The Responses API from OpenAI — 6 operation(s) for responses.
OpenAI Responses API is one of 51 APIs that OpenAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Responses. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes 7 operations across 6 paths, and defines 288 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against a single base URL, https://api.openai.com/v1.
7 operations
6 paths
288 schemas
1 DELETE2 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
OpenAI Responses API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Responses 7
POST
/responses
Creates a model response. Provide [text](/docs/guides/text) or [image](/docs/guides/images) inputs to generate [text](/docs/guides/text) or [JSON](/docs/guides/structured-outputs) outputs. Have the m…
GET
/responses/{response_id}
Retrieves a model response with the given ID.
DELETE
/responses/{response_id}
Deletes a model response with the given ID.
POST
/responses/{response_id}/cancel
Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. [Learn more](/docs/guides/background).
GET
/responses/{response_id}/input_items
Returns a list of input items for a given response.
POST
/responses/input_tokens
Returns input token counts of the request. Returns an object with object set to response.inputtokens and an inputtokens count.
POST
/responses/compact
Compact a conversation. Returns a compacted response object. Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-statemanaging-the-con…
Schemas 288
The contract defines 288 schemas that model the data the API accepts and returns. The most detailed are ImageGenTool (12 properties), TokenCountsBody (11 properties), MCPTool (10 properties), ResponseProperties (10 properties). Each schema is shown below with its type and property counts.
Annotation
An annotation that applies to a span of output text.
ApplyPatchUpdateFileOperation
object
Instruction describing how to update a file via the applypatch tool.
3 properties
3 required
ResponseCompletedEvent
object
Emitted when the model response is complete.
3 properties
3 required
Response
ResponseReasoningSummaryPartAddedEvent
object
Emitted when a new reasoning summary part is added.
6 properties
6 required
FileCitationBody
object
A citation to a file.
4 properties
4 required
FunctionShellCallOutputContentParam
object
Captured stdout and stderr for a portion of a shell tool call output.
3 properties
3 required
ResponseStreamEvent
ResponseAudioDoneEvent
object
Emitted when the audio response is complete.
2 properties
3 required
FileSearchToolCall
object
The results of a file search tool call. See the [file search guide](/docs/guides/tools-file-search) for more information.
5 properties
4 required
WebSearchTool
object
Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search).
4 properties
1 required
WebSearchActionSearch
object
Action type "search" - Performs a web search query.
4 properties
2 required
InlineSkillParam
object
4 properties
4 required
ResponseOutputItemAddedEvent
object
Emitted when a new output item is added.
4 properties
4 required
FunctionShellCallOutput
object
The output of a shell tool call that was emitted.
7 properties
6 required
ImageGenActionEnum
string
FunctionShellCall
object
A tool call that executes one or more shell commands in a managed environment.
7 properties
6 required
ConversationParam-2
object
The conversation that this response belongs to.
1 property
1 required
ServiceTier
CustomToolCall
object
A call to a custom tool created by the model.
6 properties
4 required
FileInputDetail
string
CodeInterpreterOutputLogs
object
The logs output from the code interpreter.
2 properties
2 required
ToolChoiceFunction
object
Use this option to force the model to call a specific function.
2 properties
2 required
ReasoningTextContent
object
Reasoning text from the model.
2 properties
2 required
ResponseReasoningSummaryPartDoneEvent
object
Emitted when a reasoning summary part is completed.
6 properties
6 required
Item
object
Content item used to generate a response.
SearchContentType
string
ToolSearchOutputItemParam
object
6 properties
2 required
OutputMessage
object
An output message from the model.
6 properties
5 required
ComputerCallSafetyCheckParam
object
A pending safety check for the computer call.
3 properties
1 required
ModelIdsResponses
TypeParam
object
An action to type in text.
2 properties
2 required
FunctionCallItemStatus
string
KeyPressAction
object
A collection of keypresses the model would like to perform.
2 properties
2 required
InputParam
Text, image, or file inputs to the model, used to generate a response. Learn more: - [Text inputs and outputs](/docs/guides/text) - [Image inputs](/docs/guides…
ToolSearchToolParam
object
Hosted or BYOT tool search configuration for deferred tools.
4 properties
1 required
ToolChoiceAllowed
object
Constrains the tools available to the model to a pre-defined set.
3 properties
3 required
ResponseCodeInterpreterCallInProgressEvent
object
Emitted when a code interpreter call is in progress.
4 properties
4 required
ComputerAction
ResponseWebSearchCallInProgressEvent
object
Emitted when a web search call is initiated.
4 properties
4 required
ReasoningItem
object
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…
6 properties
3 required
FunctionCallOutputStatusEnum
string
CodeInterpreterOutputImage
object
The image output from the code interpreter.
2 properties
2 required
ResponseFileSearchCallInProgressEvent
object
Emitted when a file search call is initiated.
4 properties
4 required
GrammarSyntax1
string
ImageGenToolCall
object
An image generation request made by the model.
4 properties
4 required
Filters
ComputerToolCall
object
A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information.
7 properties
5 required
WebSearchActionFind
object
Action type "findinpage": Searches for a pattern within a loaded page.
3 properties
3 required
WebSearchActionOpenPage
object
Action type "openpage" - Opens a specific URL from search results.
2 properties
1 required
ToolSearchOutput
object
7 properties
6 required
MessageRole
string
ContainerNetworkPolicyDisabledParam
object
1 property
1 required
ComputerActionList
array
Flattened batched actions for computeruse. Each action includes an type discriminator and action-specific fields.
ContainerAutoParam
object
5 properties
1 required
RankerVersionType
string
FunctionShellCallItemStatus
string
Status values reported for shell tool calls.
ToolChoiceOptions
string
Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick…
OutputMessageContent
MessagePhase
string
Labels an assistant message as intermediate commentary (commentary) or the final answer (finalanswer). For models like gpt-5.3-codex and beyond, when sending f…
ResponseMCPListToolsInProgressEvent
object
Emitted when the system is in the process of retrieving the list of available MCP tools.
4 properties
4 required
CoordParam
object
An x/y coordinate pair, e.g. { x: 100, y: 200 }.
2 properties
2 required
ResponseFormatJsonObject
object
JSON object response format. An older method of generating JSON responses. Using jsonschema is recommended for models that support it. Note that the model will…
1 property
1 required
OutputContent
CustomToolCallOutput
object
The output of a custom tool call from your code, being sent back to the model.
4 properties
3 required
ApplyPatchCreateFileOperation
object
Instruction describing how to create a file via the applypatch tool.
3 properties
3 required
MCPListToolsTool
object
A tool available on an MCP server.
4 properties
2 required
FunctionToolCallOutput
object
The output of a function tool call.
5 properties
3 required
ComputerScreenshotImage
object
A computer screenshot image used with the computer use tool.
3 properties
1 required
EmptyModelParam
object
InputMessageContentList
array
A list of one or many input items to the model, containing different content types.
Prompt
ResponseTextParam
object
Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - [Text inputs and outputs](/docs/guides/text)…
2 properties
ComputerUsePreviewTool
object
A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
4 properties
4 required
DoubleClickAction
object
A double click action.
4 properties
4 required
InlineSkillSourceParam
object
Inline skill payload
3 properties
3 required
CustomToolCallOutputResource
ApplyPatchToolParam
object
Allows the assistant to create, delete, or update files using unified diffs.
1 property
1 required
ContainerFileCitationBody
object
A citation for a container file used to generate a model response.
6 properties
6 required
FileDetailEnum
string
ComparisonFilter
object
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
3 properties
3 required
ToolSearchCall
object
7 properties
6 required
ResponseImageGenCallInProgressEvent
object
Emitted when an image generation tool call is in progress.
4 properties
4 required
LocalSkillParam
object
3 properties
3 required
ResponseCustomToolCallInputDeltaEvent
object
Event representing a delta (partial update) to the input of a custom tool call.
5 properties
5 required
ModelIdsShared
LogProb
object
The log probability of a token.
4 properties
4 required
ContainerReferenceResource
object
Represents a container created with /v1/containers.
2 properties
2 required
ComputerCallOutputItemParam
object
The output of a computer tool call.
6 properties
3 required
InputMessage
object
A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over…
4 properties
2 required
ApplyPatchCallOutputStatusParam
string
Outcome values reported for applypatch tool call outputs.
ApplyPatchToolCallOutputItemParam
object
The streamed output emitted by an apply patch tool call.
5 properties
3 required
InputMessageResource
ComputerEnvironment
string
FunctionShellCallItemParam
object
A tool representing a request to execute one or more shell commands.
6 properties
3 required
ResponseReasoningTextDeltaEvent
object
Emitted when a delta is added to a reasoning text.
6 properties
6 required
ResponseMCPCallArgumentsDeltaEvent
object
Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
5 properties
5 required
ResponseTextDeltaEvent
object
Emitted when there is an additional text delta.
7 properties
7 required
ContainerNetworkPolicyAllowlistParam
object
3 properties
2 required
FunctionShellActionParam
object
Commands and limits describing how to run the shell tool call.
3 properties
1 required
FunctionToolCall
object
A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information.
7 properties
4 required
ClickButtonType
string
ResponseProperties
object
10 properties
CompactionBody
object
A compaction item generated by the [v1/responses/compact API](/docs/api-reference/responses/compact).
4 properties
3 required
MCPToolFilter
object
A filter object to specify which tools are allowed.
2 properties
ComputerToolCallOutput
object
The output of a computer tool call.
6 properties
3 required
OutputItem
ResponseReasoningTextDoneEvent
object
Emitted when a reasoning text is completed.
6 properties
6 required
NamespaceToolParam
object
Groups function/custom tools under a shared namespace.
4 properties
4 required
FunctionShellAction
object
Execute a shell command.
3 properties
3 required
ResponseFormatText
object
Default response format. Used to generate text responses.
1 property
1 required
EasyInputMessage
object
A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over…
4 properties
2 required
ResponseTextDoneEvent
object
Emitted when text content is finalized.
7 properties
7 required
ToolChoiceCustom
object
Use this option to force the model to call a specific custom tool.
2 properties
2 required
FunctionShellCallOutputExitOutcome
object
Indicates that the shell commands finished and returned an exit code.
2 properties
2 required
MoveParam
object
A mouse move action.
4 properties
3 required
ResponseFileSearchCallCompletedEvent
object
Emitted when a file search call is completed (results found).
4 properties
4 required
FunctionShellCallOutputItemParam
object
The streamed output items emitted by a shell tool call.
6 properties
3 required
ContextManagementParam
object
2 properties
1 required
ResponseImageGenCallCompletedEvent
object
Emitted when an image generation tool call has completed and the final image is available.
4 properties
4 required
ResponseInProgressEvent
object
Emitted when the response is in progress.
3 properties
3 required
FunctionShellCallStatus
string
CodeInterpreterToolCall
object
A tool call to run code.
6 properties
6 required
FunctionAndCustomToolCallOutput
TokenCountsResource
object
2 properties
2 required
ResponseImageGenCallGeneratingEvent
object
Emitted when an image generation tool call is actively generating an image (intermediate state).
4 properties
4 required
Tool
A tool that can be used to generate a response.
LocalShellToolParam
object
A tool that allows the model to execute shell commands in a local environment.
1 property
1 required
ToolChoiceMCP
object
Use this option to force the model to call a specific tool on a remote MCP server.
3 properties
2 required
CreateResponse
InputImageContentParamAutoParam
object
An image input to the model. Learn about [image inputs](/docs/guides/vision)
4 properties
1 required
ResponseReasoningSummaryTextDeltaEvent
object
Emitted when a delta is added to a reasoning summary text.
6 properties
6 required
RefusalContent
object
A refusal from the model.
2 properties
2 required
ApplyPatchCallStatus
string
ItemField
An item representing a message, tool call, tool output, reasoning, or other response element.
SummaryTextContent
object
A summary text from the model.
2 properties
2 required
ScrollParam
object
A scroll action.
6 properties
5 required
CustomTextFormatParam
object
Unconstrained free-form text.
1 property
1 required
ResponseCreatedEvent
object
An event that is emitted when a response is created.
3 properties
3 required
MCPTool
object
Give the model access to additional tools via remote Model Context Protocol (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).
10 properties
2 required
ApplyPatchOperationParam
One of the createfile, deletefile, or updatefile operations supplied to the applypatch tool.
ResponseCodeInterpreterCallInterpretingEvent
object
Emitted when the code interpreter is actively interpreting the code snippet.
4 properties
4 required
InputImageContent
object
An image input to the model. Learn about [image inputs](/docs/guides/vision).
4 properties
2 required
Conversation-2
object
The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.
1 property
1 required
LocalEnvironmentParam
object
2 properties
1 required
ConversationParam
The conversation that this response belongs to. Items from this conversation are prepended to inputitems for this response request. Input items and output item…
SearchContextSize
string
ResponseWebSearchCallSearchingEvent
object
Emitted when a web search call is executing.
4 properties
4 required
ApproximateLocation
object
5 properties
1 required
ItemResource
Content item used to generate a response.
ResponseAudioTranscriptDoneEvent
object
Emitted when the full audio transcript is completed.
2 properties
3 required
ItemReferenceParam
object
An internal identifier for an item to reference.
2 properties
1 required
ResponseFileSearchCallSearchingEvent
object
Emitted when a file search is currently searching.
4 properties
4 required
CompactionSummaryItemParam
object
A compaction item generated by the [v1/responses/compact API](/docs/api-reference/responses/compact).
3 properties
2 required
ResponseAudioDeltaEvent
object
Emitted when there is a partial audio response.
3 properties
3 required
WebSearchToolCall
object
The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information.
4 properties
4 required
LocalEnvironmentResource
object
Represents the use of a local environment to perform shell actions.
1 property
1 required
TruncationEnum
string
CompactResponseMethodPublicBody
object
7 properties
1 required
InputTextContent
object
A text input to the model.
2 properties
2 required
UrlCitationBody
object
A citation for a web resource used to generate a model response.
5 properties
5 required
MCPApprovalResponseResource
object
A response to an MCP approval request.
5 properties
5 required
ApplyPatchDeleteFileOperation
object
Instruction describing how to delete a file via the applypatch tool.
2 properties
2 required
InputItem
ResponseQueuedEvent
object
Emitted when a response is queued and waiting to be processed.
3 properties
3 required
MCPListTools
object
A list of tools available on an MCP server.
5 properties
4 required
RankingOptions
object
3 properties
Error
object
4 properties
4 required
ResponseImageGenCallPartialImageEvent
object
Emitted when a partial image is available during image generation streaming.
6 properties
6 required
LocalShellToolCallOutput
object
The output of a local shell tool call.
4 properties
4 required
FileSearchTool
object
A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-searc…
5 properties
2 required
FunctionShellCallOutputExitOutcomeParam
object
Indicates that the shell commands finished and returned an exit code.
2 properties
2 required
FunctionCallOutputItemParam
object
The output of a function tool call.
5 properties
3 required
Reasoning
object
gpt-5 and o-series models only Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
3 properties
ResponseFailedEvent
object
An event that is emitted when a response fails.
3 properties
3 required
ApplyPatchCreateFileOperationParam
object
Instruction for creating a new file via the applypatch tool.
3 properties
3 required
ResponseMCPCallArgumentsDoneEvent
object
Emitted when the arguments for an MCP tool call are finalized.
5 properties
5 required
ContainerMemoryLimit
string
FunctionShellToolParam
object
A tool that allows the model to execute shell commands.
2 properties
1 required
ResponseCodeInterpreterCallCodeDeltaEvent
object
Emitted when a partial code snippet is streamed by the code interpreter.
5 properties
5 required
ResponseIncompleteEvent
object
An event that is emitted when a response finishes as incomplete.
3 properties
3 required
ResponseContentPartDoneEvent
object
Emitted when a content part is done.
6 properties
6 required
ToolSearchCallItemParam
object
6 properties
2 required
SkillReferenceParam
object
3 properties
2 required
TokenCountsBody
object
11 properties
ResponseFunctionCallArgumentsDoneEvent
object
Emitted when function-call arguments are finalized.
6 properties
6 required
InputContent
FunctionShellCallOutputStatusEnum
string
ResponseItemList
object
A list of Response items.
5 properties
5 required
WebSearchPreviewTool
object
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-…
4 properties
1 required
ApplyPatchToolCallItemParam
object
A tool call representing a request to create, delete, or update files using diff patches.
5 properties
4 required
ResponseUsage
object
Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.
5 properties
5 required
DragParam
object
A drag action.
3 properties
2 required
CompoundFilter
object
Combine multiple filters using and or or.
2 properties
2 required
ResponseErrorCode
string
The error code for the response.
CodeInterpreterTool
object
A tool that runs Python code to help generate a response to a prompt.
2 properties
2 required
ComputerTool
object
A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
1 property
1 required
ToolsArray
array
An array of tools the model may call while generating a response. You can specify which tool to use by setting the toolchoice parameter. We support the followi…
ResponseWebSearchCallCompletedEvent
object
Emitted when a web search call is completed.
4 properties
4 required
PromptCacheRetentionEnum
string
ToolChoiceTypes
object
Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](/docs/guides/tools).
1 property
1 required
MessageStatus
string
ApplyPatchUpdateFileOperationParam
object
Instruction for updating an existing file via the applypatch tool.
3 properties
3 required
ResponseCodeInterpreterCallCodeDoneEvent
object
Emitted when the code snippet is finalized by the code interpreter.
5 properties
5 required
AutoCodeInterpreterToolParam
object
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
4 properties
1 required
CustomToolParam
object
A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-callingcustom-tools)
5 properties
2 required
MCPApprovalRequest
object
A request for human approval of a tool invocation.
5 properties
5 required
FunctionToolCallResource
FunctionTool
object
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).
6 properties
4 required
ContainerNetworkPolicyDomainSecretParam
object
3 properties
3 required
FunctionShellCallOutputTimeoutOutcome
object
Indicates that the shell call exceeded its configured time limit.
1 property
1 required
InputFileContent
object
A file input to the model.
6 properties
1 required
ModelIdsCompaction
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 pr…
Verbosity
HybridSearchOptions
object
2 properties
2 required
CompactResource
object
5 properties
5 required
ResponseMCPCallCompletedEvent
object
Emitted when an MCP tool call has completed successfully.
4 properties
4 required
ServiceTierEnum
string
SpecificFunctionShellParam
object
Forces the model to call the shell tool when a tool call is required.
1 property
1 required
ResponseStreamOptions
ResponsePromptVariables
LocalShellExecAction
object
Execute a shell command on the server.
6 properties
3 required
FunctionCallStatus
string
LocalShellToolCall
object
A tool call to run a command on the local shell.
5 properties
5 required
ResponseOutputTextAnnotationAddedEvent
object
Emitted when an annotation is added to output text content.
7 properties
7 required
DetailEnum
string
FunctionShellCallOutputTimeoutOutcomeParam
object
Indicates that the shell call exceeded its configured time limit.
1 property
1 required
FunctionShellCallOutputOutcomeParam
The exit or timeout outcome associated with this shell call.
ResponseCodeInterpreterCallCompletedEvent
object
Emitted when the code interpreter call is completed.
4 properties
4 required
ClickParam
object
A click action.
5 properties
4 required
ResponseRefusalDeltaEvent
object
Emitted when there is a partial refusal text.
6 properties
6 required
InputTextContentParam
object
A text input to the model.
2 properties
2 required
OutputTextContent
object
A text output from the model.
4 properties
4 required
ApplyPatchCallOutputStatus
string
ResponseFunctionCallArgumentsDeltaEvent
object
Emitted when there is a partial function-call arguments delta.
5 properties
5 required
MCPApprovalResponse
object
A response to an MCP approval request.
5 properties
4 required
ResponseOutputItemDoneEvent
object
Emitted when an output item is marked done.
4 properties
4 required
ReasoningEffort
ApplyPatchToolCallOutput
object
The output emitted by an apply patch tool call.
6 properties
4 required
FunctionToolCallOutputResource
FunctionShellCallOutputContent
object
The content of a shell tool call output that was emitted.
4 properties
3 required
TextResponseFormatJsonSchema
object
JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
5 properties
3 required
InputFileContentParam
object
A file input to the model.
6 properties
1 required
ResponseCustomToolCallInputDoneEvent
object
Event indicating that input for a custom tool call is complete.
5 properties
5 required
TopLogProb
object
The top log probability of a token.
3 properties
3 required
ModelResponseProperties
object
9 properties
ToolSearchExecutionType
string
VectorStoreFileAttributes
MCPToolCallStatus
string
Message
object
A message to or from the model.
6 properties
5 required
MCPToolCall
object
An invocation of a tool on an MCP server.
9 properties
5 required
ToolChoiceParam
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 the model can ca…
ComputerToolCallOutputResource
ComputerCallOutputStatus
string
ResponseMCPListToolsFailedEvent
object
Emitted when the attempt to list available MCP tools has failed.
4 properties
4 required
FilePath
object
A path to a file.
3 properties
3 required
FunctionToolParam
object
6 properties
2 required
ResponseAudioTranscriptDeltaEvent
object
Emitted when there is a partial transcript of audio.
3 properties
4 required
Metadata
WaitParam
object
A wait action.
1 property
1 required
ResponseErrorEvent
object
Emitted when an error occurs.
5 properties
5 required
InputFidelity
string
Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for…
ComputerScreenshotContent
object
A screenshot of a computer.
4 properties
4 required
ResponseReasoningSummaryTextDoneEvent
object
Emitted when a reasoning summary text is completed.
6 properties
6 required
ApplyPatchToolCall
object
A tool call that applies file diffs by creating, deleting, or updating files.
6 properties
5 required
TextResponseFormatConfiguration
An object specifying the format that the model must output. Configuring { "type": "jsonschema" } enables Structured Outputs, which ensures the model will match…
ImageDetail
string
WebSearchApproximateLocation
ResponseMCPListToolsCompletedEvent
object
Emitted when the list of available MCP tools has been successfully retrieved.
4 properties
4 required
IncludeEnum
string
Specify additional output data to include in the model response. Currently supported values are: - websearchcall.results: Include the search results of the web…
ResponseFormatJsonSchemaSchema
object
The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/).
ScreenshotParam
object
A screenshot action.
1 property
1 required
ApplyPatchDeleteFileOperationParam
object
Instruction for deleting an existing file via the applypatch tool.
2 properties
2 required
ResponseMCPCallInProgressEvent
object
Emitted when an MCP tool call is in progress.
4 properties
4 required
SpecificApplyPatchParam
object
Forces the model to call the applypatch tool when executing a tool call.
1 property
1 required
ResponseContentPartAddedEvent
object
Emitted when a new content part is added.
6 properties
6 required
ResponseLogProb
object
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) log…
3 properties
2 required
ResponseMCPCallFailedEvent
object
Emitted when an MCP tool call has failed.
4 properties
4 required
ContainerReferenceParam
object
2 properties
2 required
MessagePhase-2
string
ResponseError
TextContent
object
A text content.
2 properties
2 required
CustomToolCallResource
ResponseRefusalDoneEvent
object
Emitted when refusal text is finalized.
6 properties
6 required
ApplyPatchCallStatusParam
string
Status values reported for applypatch tool calls.
CustomGrammarFormatParam
object
A grammar defined by the user.
3 properties
3 required
CreateModelResponseProperties
ImageGenTool
object
A tool that generates images using the GPT image models.
12 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenAI 12
Other APIs OpenAI publishes across the network.
OpenAI Moderations API
OpenAI Batch API
OpenAI Vector Stores API
OpenAI Uploads API
OpenAI Realtime API
OpenAI Evals API
OpenAI Videos API
OpenAI Conversations API
OpenAI Containers API
OpenAI ChatKit API
OpenAI Skills API
OpenAI Agents SDK
#Responses
Where this information came from
This is an independent, third-party profile of OpenAI Responses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.