nexos.ai Responses API
Create and manage model responses.
nexos.ai Responses API is one of 16 APIs that nexos.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Responses. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 7 operations across 6 paths, and defines 242 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://api.nexos.ai.
7 operations
6 paths
242 schemas
1 DELETE2 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
nexos.ai Responses API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
An API key is passed in the header as X-Api-Key (apiKeyHeader).
By default, every request must be authenticated.
apiKeyHeader— Authenticate by sending your nexos API key in the X-Api-Key header (e.g. X-Api-Key: nexos-... for a user key or X-Api-Key: nexos-team-... for a team key). This…
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
Create and manage model responses.
POST
/v1/responses
Create a model response
GET
/v1/responses/{response_id}
Get a model response
DELETE
/v1/responses/{response_id}
Delete a model response
GET
/v1/responses/{response_id}/input_items
List input items
POST
/v1/responses/{response_id}/cancel
Cancel a response
POST
/v1/responses/compact
Compact a response
POST
/v1/responses/input_tokens
Get input token counts
Schemas 242
The contract defines 242 schemas that model the data the API accepts and returns. The most detailed are ImageGenTool (11 properties), TokenCountsBody (11 properties), ResponseProperties (11 properties), MCPToolCall (9 properties). Each schema is shown below with its type and property counts.
FunctionAndCustomToolCallOutput
ModelIdsCompaction
string
Model ID used to generate the response, like gpt-5 or o3.
ApproximateLocation
object
5 properties
1 required
ReasoningEffort
string
Controls how much reasoning effort the model uses. Lower settings are faster and use fewer tokens; higher settings provide more detailed reasoning.
LocalShellToolCall
object
A tool call to run a command on the local shell.
5 properties
5 required
OutputTextContent
object
A text output from the model.
4 properties
3 required
ApplyPatchToolCall
object
A tool call that applies file diffs by creating, deleting, or updating files.
6 properties
5 required
Type
object
An action to type in text.
2 properties
2 required
FunctionShellCallOutputContent
object
The content of a shell call output.
4 properties
3 required
ResponseProperties
object
11 properties
1 required
ResponseCustomToolCallInputDeltaEvent
object
Event representing a delta (partial update) to the input of a custom tool call.
5 properties
5 required
LocalShellExecAction
object
Execute a shell command on the server.
6 properties
3 required
ContainerFileCitationBody
object
A citation for a container file used to generate a model response.
6 properties
6 required
WebSearchActionFind
object
Action type "find": Searches for a pattern within a loaded page.
3 properties
3 required
CodeInterpreterToolCall
object
A tool call to run code.
6 properties
6 required
CustomToolCallOutput
object
The output of a custom tool call from your code, being sent back to the model.
4 properties
3 required
ContainerMemoryLimit
string
ResponseMCPListToolsFailedEvent
object
Emitted when the attempt to list available MCP tools has failed.
4 properties
4 required
Summary
object
A summary text from the model.
2 properties
2 required
ResponseMCPCallArgumentsDeltaEvent
object
Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
5 properties
5 required
FunctionShellCallOutputItemParam
object
The streamed output items emitted by a function shell tool call.
5 properties
3 required
ComputerToolCallOutput
object
The output of a computer tool call.
6 properties
3 required
MCPListTools
object
A list of tools available on an MCP server.
5 properties
4 required
FunctionShellCallOutputContentParam
object
Captured stdout and stderr for a portion of a function shell tool call output.
3 properties
3 required
ReasoningTextContent
object
Reasoning text from the model.
2 properties
2 required
ItemReferenceParam
object
An internal identifier for an item to reference.
2 properties
1 required
ComputerUsePreviewTool
object
A tool that controls a virtual computer. Learn more in the computer tool guide.
4 properties
4 required
FunctionToolCall
object
A tool call to run a function. Used when the model requests your code to execute a function.
6 properties
4 required
CompactResource
object
5 properties
5 required
ReasoningItem
object
A description of the chain of thought used by a reasoning model while generating a response. Include these items in your input for subsequent turns if you are…
6 properties
3 required
CompactResponseMethodPublicBody
object
4 properties
OutputContent
ResponseFileSearchCallCompletedEvent
object
Emitted when a file search call is completed (results found).
4 properties
4 required
ServiceTier
string
Specifies the processing tier for the request. The response includes the actual tier used, which may differ from the requested value.
ComparisonFilterValueItems
SearchContextSize
string
MCPApprovalResponseResource
object
A response to an MCP approval request.
5 properties
5 required
ApplyPatchCallStatusParam
string
Status values reported for applypatch tool calls.
ApplyPatchToolCallOutput
object
The output emitted by an apply patch tool call.
6 properties
4 required
FilePath
object
A path to a file.
3 properties
3 required
ToolChoiceFunction
object
Use this option to force the model to call a specific function.
2 properties
2 required
WebSearchPreviewTool
object
Searches the web for relevant results to use in a response. Learn more in the web search tool guide.
3 properties
1 required
ResponseImageGenCallInProgressEvent
object
Emitted when an image generation tool call is in progress.
4 properties
4 required
ClickButtonType
string
ComputerAction
WebSearchToolCall
object
The results of a web search tool call. See the web search guide for more information.
4 properties
4 required
Drag
object
A drag action.
2 properties
2 required
CodeInterpreterTool
object
A tool that runs Python code to help generate a response to a prompt.
2 properties
2 required
FileCitationBody
object
A citation to a file.
4 properties
4 required
FunctionCallOutputItemParam
object
The output of a function tool call.
5 properties
3 required
FunctionShellActionParam
object
Commands and limits describing how to run the function shell tool call.
3 properties
1 required
RefusalContent
object
A refusal from the model.
2 properties
2 required
ConversationParam-2
object
The conversation that this response belongs to.
1 property
1 required
ResponseReasoningSummaryTextDoneEvent
object
Emitted when a reasoning summary text is completed.
6 properties
6 required
FunctionShellCallOutputTimeoutOutcome
object
Indicates that the function shell call exceeded its configured time limit.
1 property
1 required
ResponseImageGenCallCompletedEvent
object
Emitted when an image generation tool call has completed and the final image is available.
4 properties
4 required
ResponseError
object
An error object returned when the model fails to generate a Response.
2 properties
2 required
ResponseAudioDeltaEvent
object
Emitted when there is a partial audio response.
3 properties
3 required
ApplyPatchDeleteFileOperation
object
Instruction describing how to delete a file via the applypatch tool.
2 properties
2 required
ToolChoiceMCP
object
Use this option to force the model to call a specific tool on a remote MCP server.
3 properties
2 required
ItemResource
object
Content item used to generate a response.
1 property
1 required
ResponseTextParam
object
Configuration options for a text response. Supports plain text or structured JSON.
2 properties
ResponseCodeInterpreterCallCodeDoneEvent
object
Emitted when the code snippet is finalized by the code interpreter.
5 properties
5 required
InputMessageResource
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…
TruncationEnum
string
Prompt
object
Reference to a prompt template and its variables.
3 properties
1 required
MCPApprovalRequest
object
A request for human approval of a tool invocation.
5 properties
5 required
FunctionShellCallOutputTimeoutOutcomeParam
object
Indicates that the function shell call exceeded its configured time limit.
1 property
1 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…
ImageDetail
string
responses_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
Item
object
Content item used to generate a response.
1 property
1 required
FileSearchTool
object
Searches uploaded files for relevant content. See the file search guide.
5 properties
2 required
MCPToolFilter
object
A filter object to specify which tools are allowed.
2 properties
InputFileContentParam
object
A file input to the model.
5 properties
1 required
ApplyPatchUpdateFileOperation
object
Instruction describing how to update a file via the applypatch tool.
3 properties
3 required
ResponseMCPListToolsInProgressEvent
object
Emitted when the system is in the process of retrieving the list of available MCP tools.
4 properties
4 required
Error
object
4 properties
4 required
ResponseFailedEvent
object
An event that is emitted when a response fails.
3 properties
3 required
ModelResponseProperties
object
9 properties
FileSearchToolCall
object
The results of a file search tool call. See the file search guide for more information.
5 properties
ImageGenToolCall
object
An image generation request made by the model.
4 properties
4 required
ResponseReasoningSummaryTextDeltaEvent
object
Emitted when a delta is added to a reasoning summary text.
6 properties
6 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
WebSearchTool
object
Search the internet for sources related to the prompt. Learn more in the web search tool guide.
4 properties
1 required
CodeInterpreterOutputImage
object
The image output from the code interpreter.
2 properties
2 required
responses_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
InputContent
InputMessageContentList
array
A list of one or many input items to the model, containing different content types.
FunctionShellCallOutputOutcomeParam
The exit or timeout outcome associated with this chunk.
ResponseRefusalDoneEvent
object
Emitted when refusal text is finalized.
6 properties
6 required
FunctionToolCallResource
TokenCountsResource
object
2 properties
2 required
ResponseStreamOptions
object
Options for streaming responses. Only set this when you set stream: true.
1 property
ResponseInProgressEvent
object
Emitted when the response is in progress.
3 properties
3 required
ResponseOutputItemAddedEvent
object
Emitted when a new output item is added.
4 properties
4 required
HybridSearchOptions
object
2 properties
2 required
ResponseTextDeltaEvent
object
Emitted when there is an additional text delta.
7 properties
7 required
ResponseTextDoneEvent
object
Emitted when text content is finalized.
7 properties
7 required
ToolChoiceAllowed
object
Constrains the tools available to the model to a pre-defined set.
3 properties
3 required
Move
object
A mouse move action.
3 properties
3 required
ComputerEnvironment
string
ComputerCallSafetyCheckParam
object
A pending safety check for the computer call.
3 properties
1 required
MCPApprovalResponse
object
A response to an MCP approval request.
5 properties
4 required
ApplyPatchCreateFileOperation
object
Instruction describing how to create a file via the applypatch tool.
3 properties
3 required
MCPToolCallStatus
string
CreateResponseRequest
DetailEnum
string
responses_Annotation
ToolChoiceTypes
object
Indicates that the model should use a built-in tool to generate a response. Use this to select a specific hosted capability.
1 property
1 required
ApplyPatchToolCallOutputItemParam
object
The streamed output emitted by an apply patch tool call.
5 properties
3 required
responses_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/).
FunctionTool
object
Defines a function in your code that the model can call.
5 properties
4 required
ResponseCodeInterpreterCallInProgressEvent
object
Emitted when a code interpreter call is in progress.
4 properties
4 required
DragPoint
object
An x/y coordinate pair, e.g. { x: 100, y: 200 }.
2 properties
2 required
ComputerScreenshotImage
object
A computer screenshot image used with the computer use tool.
3 properties
1 required
TopLogProb
object
The top log probability of a token.
3 properties
3 required
VectorStoreFileAttributes
object
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…
RankingOptions
object
3 properties
CustomGrammarFormatParam
object
A grammar defined by the user.
3 properties
3 required
ApplyPatchCallOutputStatus
string
FunctionToolCallOutput
object
The output of a function tool call.
5 properties
3 required
ResponseOutputTextAnnotationAddedEvent
object
Emitted when an annotation is added to output text content.
7 properties
7 required
MCPListToolsTool
object
A tool available on an MCP server.
4 properties
2 required
OutputItem
object
1 property
1 required
FunctionShellCallOutputExitOutcome
object
Indicates that the shell commands finished and returned an exit code.
2 properties
2 required
responses_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
responses_ResponseFormatText
object
Default response format. Used to generate text responses.
1 property
1 required
RankerVersionType
string
ApplyPatchToolParam
object
Allows the assistant to create, delete, or update files using unified diffs.
1 property
1 required
OutputMessage
object
An output message from the model.
5 properties
5 required
ToolsArray
array
An array of tools the model may call while generating a response. Categories include built-in tools, MCP tools, and custom function calls.
InputParam
Text, image, or file inputs used to generate a response. Use this to provide content the model should consider.
CodeInterpreterOutputLogs
object
The logs output from the code interpreter.
2 properties
2 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…
Response
Conversation-2
object
The conversation that this response belongs to. Input items and output items from this response are automatically added to this conversation.
1 property
1 required
SpecificApplyPatchParam
object
Forces the model to call the applypatch tool when executing a tool call.
1 property
1 required
ResponseCompletedEvent
object
Emitted when the model response is complete.
3 properties
3 required
FunctionShellAction
object
Execute a shell command.
3 properties
3 required
MCPTool
object
Give the model access to tools via remote Model Context Protocol (MCP) servers. Learn more in the MCP guide.
9 properties
2 required
ResponseWebSearchCallCompletedEvent
object
Emitted when a web search call is completed.
4 properties
4 required
InputImageContent
object
An image input to the model. See the vision guide for details.
4 properties
2 required
ResponseMCPCallInProgressEvent
object
Emitted when an MCP tool call is in progress.
4 properties
4 required
CustomToolCall
object
A call to a custom tool created by the model.
5 properties
4 required
FunctionShellToolParam
object
A tool that allows the model to execute shell commands.
1 property
1 required
CustomToolParam
object
A custom tool that processes input using a specified format.
4 properties
2 required
CustomTextFormatParam
object
Unconstrained free-form text.
1 property
1 required
ToolChoiceCustom
object
Use this option to force the model to call a specific custom tool.
2 properties
2 required
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.action.sources: Include the sources of the web…
CompactionSummaryItemParam
object
A compaction item generated by the v1/responses/compact API.
3 properties
2 required
UrlCitationBody
object
A citation for a web resource used to generate a model response.
5 properties
5 required
ApplyPatchOperationParam
One of the createfile, deletefile, or updatefile operations supplied to the applypatch tool.
ResponseErrorCode
string
The error code for the response.
TokenCountsBody
object
11 properties
FunctionShellCallOutput
object
The output of a shell tool call.
6 properties
5 required
LocalShellCallStatus
string
ApplyPatchCallStatus
string
ResponseAudioTranscriptDoneEvent
object
Emitted when the full audio transcript is completed.
2 properties
3 required
Filters
ResponseReasoningTextDoneEvent
object
Emitted when a reasoning text is completed.
6 properties
6 required
InputTextContent
object
A text input to the model.
2 properties
2 required
ResponseFileSearchCallInProgressEvent
object
Emitted when a file search call is initiated.
4 properties
4 required
ResponseCodeInterpreterCallInterpretingEvent
object
Emitted when the code interpreter is actively interpreting the code snippet.
4 properties
4 required
FunctionCallItemStatus
string
ApplyPatchDeleteFileOperationParam
object
Instruction for deleting an existing file via the applypatch tool.
2 properties
2 required
ResponseErrorEvent
object
Emitted when an error occurs.
5 properties
5 required
ComputerToolCallOutputResource
ResponseCustomToolCallInputDoneEvent
object
Event indicating that input for a custom tool call is complete.
5 properties
5 required
ResponseMCPCallCompletedEvent
object
Emitted when an MCP tool call has completed successfully.
4 properties
4 required
ResponseRefusalDeltaEvent
object
Emitted when there is a partial refusal text.
6 properties
6 required
Reasoning
object
Configuration options for reasoning models. Applicable to gpt-5 and o-series models only.
4 properties
TextResponseFormatConfiguration
Specifies the required output format. Use type: jsonschema to enforce a schema; type: text is the default.
WebSearchActionOpenPage
object
Action type "openpage" - Opens a specific URL from search results.
2 properties
2 required
responses_Metadata
object
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…
ResponseQueuedEvent
object
Emitted when a response is queued and waiting to be processed.
3 properties
3 required
WebSearchApproximateLocation
object
The approximate location of the user.
5 properties
WebSearchActionSearch
object
Action type "search" - Performs a web search query.
3 properties
2 required
ResponsePromptVariables
object
Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images…
CodeInterpreterContainerAuto
object
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
3 properties
1 required
ResponseItemList
object
A list of Response items.
5 properties
5 required
ResponseUsage
object
Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.
6 properties
5 required
ApplyPatchToolCallItemParam
object
A tool call representing a request to create, delete, or update files using diff patches.
5 properties
4 required
InputImageContentParamAutoParam
object
An image input to the model.
4 properties
1 required
Screenshot
object
A screenshot action.
1 property
1 required
ResponseReasoningSummaryPartAddedEvent
object
Emitted when a new reasoning summary part is added.
6 properties
6 required
GrammarSyntax1
string
ComputerCallOutputItemParam
object
The output of a computer tool call.
6 properties
3 required
ResponseReasoningTextDeltaEvent
object
Emitted when a delta is added to a reasoning text.
6 properties
6 required
ApplyPatchCreateFileOperationParam
object
Instruction for creating a new file via the applypatch tool.
3 properties
3 required
InputItem
object
1 property
1 required
ApplyPatchCallOutputStatusParam
string
Outcome values reported for applypatch tool call outputs.
LocalShellToolCallOutput
object
The output of a local shell tool call.
4 properties
4 required
ResponseImageGenCallPartialImageEvent
object
Emitted when a partial image is available during image generation streaming.
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
ResponseCreatedEvent
object
An event that is emitted when a response is created.
3 properties
3 required
ResponseCodeInterpreterCallCodeDeltaEvent
object
Emitted when a partial code snippet is streamed by the code interpreter.
5 properties
5 required
ResponseWebSearchCallSearchingEvent
object
Emitted when a web search call is executing.
4 properties
4 required
CreateModelResponseProperties
ResponseAudioDoneEvent
object
Emitted when the audio response is complete.
2 properties
3 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
ClickParam
object
A click action.
4 properties
4 required
ResponseFunctionCallArgumentsDoneEvent
object
Emitted when function-call arguments are finalized.
6 properties
6 required
Verbosity
string
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…
ResponseCodeInterpreterCallCompletedEvent
object
Emitted when the code interpreter call is completed.
4 properties
4 required
ResponseReasoningSummaryPartDoneEvent
object
Emitted when a reasoning summary part is completed.
6 properties
6 required
ResponseImageGenCallGeneratingEvent
object
Emitted when an image generation tool call is actively generating an image (intermediate state).
4 properties
4 required
ApplyPatchUpdateFileOperationParam
object
Instruction for updating an existing file via the applypatch tool.
3 properties
3 required
DoubleClickAction
object
A double click action.
3 properties
3 required
Wait
object
A wait action.
1 property
1 required
SpecificFunctionShellParam
object
Forces the model to call the function shell tool when a tool call is required.
1 property
1 required
ResponseMCPCallArgumentsDoneEvent
object
Emitted when the arguments for an MCP tool call are finalized.
5 properties
5 required
ResponseFunctionCallArgumentsDeltaEvent
object
Emitted when there is a partial function-call arguments delta.
5 properties
5 required
FunctionShellCallItemStatus
string
Status values reported for function shell tool calls.
TextResponseFormatJsonSchema
object
JSON Schema response format used to generate structured JSON responses. Learn more in the Structured Outputs guide.
5 properties
3 required
ComputerToolCall
object
A tool call to a computer use tool. See the computer use guide for more information.
6 properties
6 required
KeyPressAction
object
A collection of keypresses the model would like to perform.
2 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
OutputMessageContent
MCPToolCall
object
An invocation of a tool on an MCP server.
9 properties
5 required
ResponseOutputItemDoneEvent
object
Emitted when an output item is marked done.
4 properties
4 required
ResponseWebSearchCallInProgressEvent
object
Emitted when a web search call is initiated.
4 properties
4 required
FunctionToolCallOutputResource
InputTextContentParam
object
A text input to the model.
2 properties
2 required
Scroll
object
A scroll action.
5 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…
InputFileContent
object
A file input to the model.
5 properties
1 required
CompoundFilter
object
Combine multiple filters using and or or.
2 properties
2 required
FunctionShellCallItemParam
object
A tool representing a request to execute one or more shell commands.
5 properties
3 required
FunctionShellCallOutputExitOutcomeParam
object
Indicates that the shell commands finished and returned an exit code.
2 properties
2 required
FunctionShellCall
object
A tool call that executes one or more shell commands in a managed environment.
6 properties
5 required
ResponseFileSearchCallSearchingEvent
object
Emitted when a file search is currently searching.
4 properties
4 required
ResponseMCPCallFailedEvent
object
Emitted when an MCP tool call has failed.
4 properties
4 required
ResponseStreamEvent
ImageGenTool
object
A tool that generates images using a model like gpt-image-1.
11 properties
1 required
LogProb
object
The log probability of a token.
4 properties
4 required
ResponseAudioTranscriptDeltaEvent
object
Emitted when there is a partial transcript of audio.
3 properties
4 required
ResponseContentPartAddedEvent
object
Emitted when a new content part is added.
6 properties
6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from nexos.ai 12
Other APIs nexos.ai publishes across the network.
nexos.ai Agent Management API
nexos.ai Assistant Management API
nexos.ai Audio API
nexos.ai Batches API
nexos.ai Budget Limit Management API
nexos.ai Chat API
nexos.ai Company Management API
nexos.ai Embeddings API
nexos.ai Files API
nexos.ai Images API
nexos.ai Messages API
nexos.ai Models API
#Responses