The identity and technical contract details declared by the specification.
ReasoningEffort
stringnull
o-series models only Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are l…
FunctionToolCallOutput
object
The output of a function tool call.
5 properties
3 required
ResponseFailedEvent
object
An event that is emitted when a response fails.
2 properties
2 required
ResponseFunctionCallArgumentsDeltaEvent
object
Emitted when there is a partial function-call arguments delta.
4 properties
4 required
TextResponseFormatConfiguration
An object specifying the format that the model must output. Configuring { "type": "jsonschema" } enables Structured Outputs, which ensures the model will match…
ResponseOutputItemAddedEvent
object
Emitted when a new output item is added.
3 properties
3 required
ResponseTextDeltaEvent
object
Emitted when there is an additional text delta.
5 properties
5 required
WebSearchContextSize
string
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.
FilePath
object
A path to a file.
3 properties
3 required
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
ResponseCodeInterpreterCallInProgressEvent
object
Emitted when a code interpreter call is in progress.
3 properties
4 required
ResponseIncompleteEvent
object
An event that is emitted when a response finishes as incomplete.
2 properties
2 required
ResponseCodeInterpreterCallCodeDeltaEvent
object
Emitted when a partial code snippet is added by the code interpreter.
3 properties
4 required
Error
object
4 properties
4 required
DoubleClick
object
A double click action.
3 properties
3 required
ResponseFileSearchCallSearchingEvent
object
Emitted when a file search is currently searching.
3 properties
3 required
ReasoningItem
object
A description of the chain of thought used by a reasoning model while generating a response.
4 properties
3 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
Refusal
object
A refusal from the model.
2 properties
2 required
InputFile
object
A file input to the model.
4 properties
1 required
ResponseErrorCode
string
The error code for the response.
ResponseOutputItemDoneEvent
object
Emitted when an output item is marked done.
3 properties
3 required
ResponseAudioDoneEvent
object
Emitted when the audio response is complete.
1 property
2 required
CodeInterpreterTextOutput
object
The output of a code interpreter tool call that is text.
2 properties
2 required
InputImage
object
An image input to the model. Learn about [image inputs](/docs/guides/vision).
4 properties
2 required
ResponseError
objectnull
An error object returned when the model fails to generate a Response.
2 properties
2 required
Move
object
A mouse move action.
3 properties
3 required
OutputText
object
A text output from the model.
3 properties
3 required
Type
object
An action to type in text.
2 properties
2 required
InputText
object
A text input to the model.
2 properties
2 required
WebSearchLocation
object
Approximate location parameters for the search.
4 properties
Includable
string
Specify additional output data to include in the model response. Currently supported values are: - filesearchcall.results: Include the search results of the fi…
ResponseCodeInterpreterCallCompletedEvent
object
Emitted when the code interpreter call is completed.
3 properties
4 required
ResponseWebSearchCallInProgressEvent
object
Emitted when a web search call is initiated.
3 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
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
ResponseCompletedEvent
object
Emitted when the model response is complete.
2 properties
2 required
CodeInterpreterFileOutput
object
The output of a code interpreter tool call that is a file.
2 properties
2 required
TextResponseFormatJsonSchema
object
JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
5 properties
2 required
ResponseAudioTranscriptDeltaEvent
object
Emitted when there is a partial transcript of audio.
2 properties
3 required
Item
object
Content item used to generate a response.
VectorStoreFileAttributes
objectnull
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…
WebSearchToolCall
object
The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information.
3 properties
3 required
CodeInterpreterToolOutput
UrlCitation
object
A citation for a web resource used to generate a model response.
5 properties
5 required
ComputerScreenshotImage
object
A computer screenshot image used with the computer use tool.
3 properties
1 required
CreateModelResponseProperties
FunctionTool
object
Defines a function in your own code the model can choose to call. Learn more about [function calling](/docs/guides/function-calling).
5 properties
4 required
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…
ResponseContentPartDoneEvent
object
Emitted when a content part is done.
5 properties
5 required
ComputerTool
object
A tool that controls a virtual computer. Learn more about the [computer tool](/docs/guides/tools-computer-use).
4 properties
4 required
Wait
object
A wait action.
1 property
1 required
ItemResource
Content item used to generate a response.
ComputerToolCallOutputResource
ResponseRefusalDeltaEvent
object
Emitted when there is a partial refusal text.
5 properties
5 required
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/).
ModelResponseProperties
object
4 properties
ResponseWebSearchCallSearchingEvent
object
Emitted when a web search call is executing.
3 properties
3 required
ResponseFunctionCallArgumentsDoneEvent
object
Emitted when function-call arguments are finalized.
4 properties
4 required
ItemReference
object
An internal identifier for an item to reference.
2 properties
2 required
Metadata
objectnull
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…
FunctionToolCall
object
A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information.
6 properties
4 required
ComputerToolCallOutput
object
The output of a computer tool call.
6 properties
3 required
FileSearchTool
object
A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](/docs/guides/tools-file-search).
5 properties
2 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…
3 properties
2 required
ResponseCodeInterpreterCallCodeDoneEvent
object
Emitted when code snippet output is finalized by the code interpreter.
3 properties
4 required
Drag
object
A drag action.
2 properties
2 required
ResponseInProgressEvent
object
Emitted when the response is in progress.
2 properties
2 required
Screenshot
object
A screenshot action.
1 property
1 required
Coordinate
object
An x/y coordinate pair, e.g. { x: 100, y: 200 }.
2 properties
2 required
ComputerToolCall
object
A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information.
6 properties
6 required
FileCitation
object
A citation to a file.
3 properties
3 required
ResponseAudioTranscriptDoneEvent
object
Emitted when the full audio transcript is completed.
1 property
2 required
OutputMessage
object
An output message from the model.
5 properties
5 required
Scroll
object
A scroll action.
5 properties
5 required
ResponseFormatText
object
Default response format. Used to generate text responses.
1 property
1 required
ResponseItemList
object
A list of Response items.
5 properties
5 required
ResponseRefusalDoneEvent
object
Emitted when refusal text is finalized.
5 properties
5 required
Click
object
A click action.
4 properties
4 required
FunctionToolCallOutputResource
ResponseContentPartAddedEvent
object
Emitted when a new content part is added.
5 properties
5 required
InputMessageContentList
array
A list of one or many input items to the model, containing different content types.
Reasoning
object
o-series models only Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
2 properties
ResponseCodeInterpreterCallInterpretingEvent
object
Emitted when the code interpreter is actively interpreting the code snippet.
3 properties
4 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
CompoundFilter
object
Combine multiple filters using and or or.
2 properties
2 required
WebSearchTool
object
This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](/docs/guides/tools-web-search).
3 properties
1 required
ResponseFileSearchCallCompletedEvent
object
Emitted when a file search call is completed (results found).
3 properties
3 required
ResponseErrorEvent
object
Emitted when an error occurs.
4 properties
4 required
ComparisonFilter
object
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
3 properties
3 required
KeyPress
object
A collection of keypresses the model would like to perform.
2 properties
2 required
ResponseTextDoneEvent
object
Emitted when text content is finalized.
5 properties
5 required
CodeInterpreterToolCall
object
A tool call to run code.
5 properties
5 required
ComputerToolCallSafetyCheck
object
A pending safety check for the computer call.
3 properties
3 required
ToolChoiceFunction
object
Use this option to force the model to call a specific function.
2 properties
2 required
ResponseWebSearchCallCompletedEvent
object
Emitted when a web search call is completed.
3 properties
3 required
ResponseTextAnnotationDeltaEvent
object
Emitted when a text annotation is added.
6 properties
6 required
ResponseAudioDeltaEvent
object
Emitted when there is a partial audio response.
2 properties
2 required
ResponseFileSearchCallInProgressEvent
object
Emitted when a file search call is initiated.
3 properties
3 required
ResponseProperties
object
9 properties
ResponseCreatedEvent
object
An event that is emitted when a response is created.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Portkey publishes across the network.
