API Reference

Responses

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Input Items

List input items

client.Responses.InputItems.List(ctx, responseID, query) (*CursorPage[ResponseItemUnion], error)

GET/responses/{response_id}/input_items

ModelsExpand Collapse

type ResponseItemList struct{…}

A list of Response items.

Data []ResponseItemUnion

A list of items used to generate this response.

Accepts one of the following:

type ResponseInputMessageItem struct{…}

ID string

The unique ID of the message input.

Content ResponseInputMessageContentList

A list of one or many input items to the model, containing different content types.

Role ResponseInputMessageItemRole

The role of the message input. One of user, system, or developer.

Accepts one of the following:

const ResponseInputMessageItemRoleUser ResponseInputMessageItemRole = "user"

const ResponseInputMessageItemRoleSystem ResponseInputMessageItemRole = "system"

const ResponseInputMessageItemRoleDeveloper ResponseInputMessageItemRole = "developer"

Status ResponseInputMessageItemStatusoptional

The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Accepts one of the following:

const ResponseInputMessageItemStatusInProgress ResponseInputMessageItemStatus = "in_progress"

const ResponseInputMessageItemStatusCompleted ResponseInputMessageItemStatus = "completed"

const ResponseInputMessageItemStatusIncomplete ResponseInputMessageItemStatus = "incomplete"

Type ResponseInputMessageItemTypeoptional

The type of the message input. Always set to message.

type ResponseOutputMessage struct{…}

An output message from the model.

ID string

The unique ID of the output message.

Content []ResponseOutputMessageContentUnion

The content of the output message.

Accepts one of the following:

type ResponseOutputText struct{…}

A text output from the model.

Annotations []ResponseOutputTextAnnotationUnion

The annotations of the text output.

Accepts one of the following:

type ResponseOutputTextAnnotationFileCitation struct{…}

A citation to a file.

FileID string

The ID of the file.

Filename string

The filename of the file cited.

Index int64

The index of the file in the list of files.

Type FileCitation

The type of the file citation. Always file_citation.

type ResponseOutputTextAnnotationURLCitation struct{…}

A citation for a web resource used to generate a model response.

EndIndex int64

The index of the last character of the URL citation in the message.

StartIndex int64

The index of the first character of the URL citation in the message.

Title string

The title of the web resource.

Type URLCitation

The type of the URL citation. Always url_citation.

URL string

The URL of the web resource.

type ResponseOutputTextAnnotationContainerFileCitation struct{…}

A citation for a container file used to generate a model response.

ContainerID string

The ID of the container file.

EndIndex int64

The index of the last character of the container file citation in the message.

FileID string

The ID of the file.

Filename string

The filename of the container file cited.

StartIndex int64

The index of the first character of the container file citation in the message.

Type ContainerFileCitation

The type of the container file citation. Always container_file_citation.

type ResponseOutputTextAnnotationFilePath struct{…}

A path to a file.

FileID string

The ID of the file.

Index int64

The index of the file in the list of files.

Type FilePath

The type of the file path. Always file_path.

Text string

The text output from the model.

Type OutputText

The type of the output text. Always output_text.

Logprobs []ResponseOutputTextLogproboptional

Token string

Bytes []int64

Logprob float64

TopLogprobs []ResponseOutputTextLogprobTopLogprob

Token string

Bytes []int64

Logprob float64

type ResponseOutputRefusal struct{…}

A refusal from the model.

Refusal string

The refusal explanation from the model.

Type Refusal

The type of the refusal. Always refusal.

Role Assistant

The role of the output message. Always assistant.

Status ResponseOutputMessageStatus

The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.

Accepts one of the following:

const ResponseOutputMessageStatusInProgress ResponseOutputMessageStatus = "in_progress"

const ResponseOutputMessageStatusCompleted ResponseOutputMessageStatus = "completed"

const ResponseOutputMessageStatusIncomplete ResponseOutputMessageStatus = "incomplete"

Type Message

The type of the output message. Always message.

Phase ResponseOutputMessagePhaseoptional

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.

Accepts one of the following:

const ResponseOutputMessagePhaseCommentary ResponseOutputMessagePhase = "commentary"

const ResponseOutputMessagePhaseFinalAnswer ResponseOutputMessagePhase = "final_answer"

type ResponseFileSearchToolCall struct{…}

The results of a file search tool call. See the file search guide for more information.

ID string

The unique ID of the file search tool call.

Queries []string

The queries used to search for files.

Status ResponseFileSearchToolCallStatus

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

Accepts one of the following:

const ResponseFileSearchToolCallStatusInProgress ResponseFileSearchToolCallStatus = "in_progress"

const ResponseFileSearchToolCallStatusSearching ResponseFileSearchToolCallStatus = "searching"

const ResponseFileSearchToolCallStatusCompleted ResponseFileSearchToolCallStatus = "completed"

const ResponseFileSearchToolCallStatusIncomplete ResponseFileSearchToolCallStatus = "incomplete"

const ResponseFileSearchToolCallStatusFailed ResponseFileSearchToolCallStatus = "failed"

Type FileSearchCall

The type of the file search tool call. Always file_search_call.

Results []ResponseFileSearchToolCallResultoptional

The results of the file search tool call.

Attributes map[string, ResponseFileSearchToolCallResultAttributeUnion]optional

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, booleans, or numbers.

Accepts one of the following:

string

float64

bool

FileID stringoptional

The unique ID of the file.

Filename stringoptional

The name of the file.

Score float64optional

The relevance score of the file - a value between 0 and 1.

formatfloat

Text stringoptional

The text that was retrieved from the file.

type ResponseComputerToolCall struct{…}

A tool call to a computer use tool. See the computer use guide for more information.

ID string

The unique ID of the computer call.

CallID string

An identifier used when responding to the tool call with output.

PendingSafetyChecks []ResponseComputerToolCallPendingSafetyCheck

The pending safety checks for the computer call.

ID string

The ID of the pending safety check.

Code stringoptional

The type of the pending safety check.

Message stringoptional

Details about the pending safety check.

Status ResponseComputerToolCallStatus

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Accepts one of the following:

const ResponseComputerToolCallStatusInProgress ResponseComputerToolCallStatus = "in_progress"

const ResponseComputerToolCallStatusCompleted ResponseComputerToolCallStatus = "completed"

const ResponseComputerToolCallStatusIncomplete ResponseComputerToolCallStatus = "incomplete"

Type ResponseComputerToolCallType

The type of the computer call. Always computer_call.

Action ResponseComputerToolCallActionUnionoptional

A click action.

Accepts one of the following:

type ResponseComputerToolCallActionClick struct{…}

A click action.

Button string

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

Accepts one of the following:

const ResponseComputerToolCallActionClickButtonLeft ResponseComputerToolCallActionClickButton = "left"

const ResponseComputerToolCallActionClickButtonRight ResponseComputerToolCallActionClickButton = "right"

const ResponseComputerToolCallActionClickButtonWheel ResponseComputerToolCallActionClickButton = "wheel"

const ResponseComputerToolCallActionClickButtonBack ResponseComputerToolCallActionClickButton = "back"

const ResponseComputerToolCallActionClickButtonForward ResponseComputerToolCallActionClickButton = "forward"

Type Click

Specifies the event type. For a click action, this property is always click.

X int64

The x-coordinate where the click occurred.

Y int64

The y-coordinate where the click occurred.

type ResponseComputerToolCallActionDoubleClick struct{…}

A double click action.

Type DoubleClick

Specifies the event type. For a double click action, this property is always set to double_click.

X int64

The x-coordinate where the double click occurred.

Y int64

The y-coordinate where the double click occurred.

type ResponseComputerToolCallActionDrag struct{…}

A drag action.

Path []ResponseComputerToolCallActionDragPath

An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg

[
  { x: 100, y: 200 },
  { x: 200, y: 300 }
]

X int64

The x-coordinate.

Y int64

The y-coordinate.

Type Drag

Specifies the event type. For a drag action, this property is always set to drag.

type ResponseComputerToolCallActionKeypress struct{…}

A collection of keypresses the model would like to perform.

Keys []string

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

Type Keypress

Specifies the event type. For a keypress action, this property is always set to keypress.

type ResponseComputerToolCallActionMove struct{…}

A mouse move action.

Type Move

Specifies the event type. For a move action, this property is always set to move.

X int64

The x-coordinate to move to.

Y int64

The y-coordinate to move to.

type ResponseComputerToolCallActionScreenshot struct{…}

A screenshot action.

Type Screenshot

Specifies the event type. For a screenshot action, this property is always set to screenshot.

type ResponseComputerToolCallActionScroll struct{…}

A scroll action.

ScrollX int64

The horizontal scroll distance.

ScrollY int64

The vertical scroll distance.

Type Scroll

Specifies the event type. For a scroll action, this property is always set to scroll.

X int64

The x-coordinate where the scroll occurred.

Y int64

The y-coordinate where the scroll occurred.

type ResponseComputerToolCallActionType struct{…}

An action to type in text.

Text string

The text to type.

Type Type

Specifies the event type. For a type action, this property is always set to type.

type ResponseComputerToolCallActionWait struct{…}

A wait action.

Type Wait

Specifies the event type. For a wait action, this property is always set to wait.

Actions ComputerActionListoptional

Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.

type ResponseComputerToolCallOutputItem struct{…}

ID string

The unique ID of the computer call tool output.

CallID string

The ID of the computer tool call that produced the output.

Output ResponseComputerToolCallOutputScreenshot

A computer screenshot image used with the computer use tool.

Type ComputerCallOutput

The type of the computer tool call output. Always computer_call_output.

AcknowledgedSafetyChecks []ResponseComputerToolCallOutputItemAcknowledgedSafetyCheckoptional

The safety checks reported by the API that have been acknowledged by the developer.

ID string

The ID of the pending safety check.

Code stringoptional

The type of the pending safety check.

Message stringoptional

Details about the pending safety check.

Status ResponseComputerToolCallOutputItemStatusoptional

The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.

Accepts one of the following:

const ResponseComputerToolCallOutputItemStatusInProgress ResponseComputerToolCallOutputItemStatus = "in_progress"

const ResponseComputerToolCallOutputItemStatusCompleted ResponseComputerToolCallOutputItemStatus = "completed"

const ResponseComputerToolCallOutputItemStatusIncomplete ResponseComputerToolCallOutputItemStatus = "incomplete"

type ResponseFunctionWebSearch struct{…}

The results of a web search tool call. See the web search guide for more information.

ID string

The unique ID of the web search tool call.

Action ResponseFunctionWebSearchActionUnion

An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).

Accepts one of the following:

type ResponseFunctionWebSearchActionSearch struct{…}

Action type "search" - Performs a web search query.

Query string

[DEPRECATED] The search query.

Type Search

The action type.

Queries []stringoptional

The search queries.

Sources []ResponseFunctionWebSearchActionSearchSourceoptional

The sources used in the search.

Type URL

The type of source. Always url.

URL string

The URL of the source.

type ResponseFunctionWebSearchActionOpenPage struct{…}

Action type "open_page" - Opens a specific URL from search results.

Type OpenPage

The action type.

URL stringoptional

The URL opened by the model.

formaturi

type ResponseFunctionWebSearchActionFindInPage struct{…}

Action type "find_in_page": Searches for a pattern within a loaded page.

Pattern string

The pattern or text to search for within the page.

Type FindInPage

The action type.

URL string

The URL of the page searched for the pattern.

formaturi

Status ResponseFunctionWebSearchStatus

The status of the web search tool call.

Accepts one of the following:

const ResponseFunctionWebSearchStatusInProgress ResponseFunctionWebSearchStatus = "in_progress"

const ResponseFunctionWebSearchStatusSearching ResponseFunctionWebSearchStatus = "searching"

const ResponseFunctionWebSearchStatusCompleted ResponseFunctionWebSearchStatus = "completed"

const ResponseFunctionWebSearchStatusFailed ResponseFunctionWebSearchStatus = "failed"

Type WebSearchCall

The type of the web search tool call. Always web_search_call.

type ResponseFunctionToolCallItem struct{…}

A tool call to run a function. See the function calling guide for more information.

ID string

The unique ID of the function tool call.

type ResponseFunctionToolCallOutputItem struct{…}

ID string

The unique ID of the function call tool output.

CallID string

The unique ID of the function tool call generated by the model.

Output ResponseFunctionToolCallOutputItemOutputUnion

The output from the function call generated by your code. Can be a string or an list of output content.

Accepts one of the following:

string

type ResponseFunctionToolCallOutputItemOutputOutputContentList []ResponseFunctionToolCallOutputItemOutputOutputContentListItemUnion

Text, image, or file output of the function call.

Accepts one of the following:

type ResponseInputText struct{…}

A text input to the model.

Text string

The text input to the model.

Type InputText

The type of the input item. Always input_text.

type ResponseInputImage struct{…}

An image input to the model. Learn about image inputs.

Detail ResponseInputImageDetail

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

Accepts one of the following:

const ResponseInputImageDetailLow ResponseInputImageDetail = "low"

const ResponseInputImageDetailHigh ResponseInputImageDetail = "high"

const ResponseInputImageDetailAuto ResponseInputImageDetail = "auto"

const ResponseInputImageDetailOriginal ResponseInputImageDetail = "original"

Type InputImage

The type of the input item. Always input_image.

FileID stringoptional

The ID of the file to be sent to the model.

ImageURL stringoptional

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

type ResponseInputFile struct{…}

A file input to the model.

Type InputFile

The type of the input item. Always input_file.

FileData stringoptional

The content of the file to be sent to the model.

FileID stringoptional

The ID of the file to be sent to the model.

FileURL stringoptional

The URL of the file to be sent to the model.

Filename stringoptional

The name of the file to be sent to the model.

Type FunctionCallOutput

The type of the function tool call output. Always function_call_output.

Status ResponseFunctionToolCallOutputItemStatusoptional

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Accepts one of the following:

const ResponseFunctionToolCallOutputItemStatusInProgress ResponseFunctionToolCallOutputItemStatus = "in_progress"

const ResponseFunctionToolCallOutputItemStatusCompleted ResponseFunctionToolCallOutputItemStatus = "completed"

const ResponseFunctionToolCallOutputItemStatusIncomplete ResponseFunctionToolCallOutputItemStatus = "incomplete"

type ResponseToolSearchCall struct{…}

ID string

The unique ID of the tool search call item.

Arguments any

Arguments used for the tool search call.

CallID string

The unique ID of the tool search call generated by the model.

Execution ResponseToolSearchCallExecution

Whether tool search was executed by the server or by the client.

Accepts one of the following:

const ResponseToolSearchCallExecutionServer ResponseToolSearchCallExecution = "server"

const ResponseToolSearchCallExecutionClient ResponseToolSearchCallExecution = "client"

Status ResponseToolSearchCallStatus

The status of the tool search call item that was recorded.

Accepts one of the following:

const ResponseToolSearchCallStatusInProgress ResponseToolSearchCallStatus = "in_progress"

const ResponseToolSearchCallStatusCompleted ResponseToolSearchCallStatus = "completed"

const ResponseToolSearchCallStatusIncomplete ResponseToolSearchCallStatus = "incomplete"

Type ToolSearchCall

The type of the item. Always tool_search_call.

CreatedBy stringoptional

The identifier of the actor that created the item.

type ResponseToolSearchOutputItem struct{…}

ID string

The unique ID of the tool search output item.

CallID string

The unique ID of the tool search call generated by the model.

Execution ResponseToolSearchOutputItemExecution

Whether tool search was executed by the server or by the client.

Accepts one of the following:

const ResponseToolSearchOutputItemExecutionServer ResponseToolSearchOutputItemExecution = "server"

const ResponseToolSearchOutputItemExecutionClient ResponseToolSearchOutputItemExecution = "client"

Status ResponseToolSearchOutputItemStatus

The status of the tool search output item that was recorded.

Accepts one of the following:

const ResponseToolSearchOutputItemStatusInProgress ResponseToolSearchOutputItemStatus = "in_progress"

const ResponseToolSearchOutputItemStatusCompleted ResponseToolSearchOutputItemStatus = "completed"

const ResponseToolSearchOutputItemStatusIncomplete ResponseToolSearchOutputItemStatus = "incomplete"

Tools []ToolUnion

The loaded tool definitions returned by tool search.

Accepts one of the following:

type FunctionTool struct{…}

Defines a function in your own code the model can choose to call. Learn more about function calling.

Name string

The name of the function to call.

Parameters map[string, any]

A JSON schema object describing the parameters of the function.

Strict bool

Whether to enforce strict parameter validation. Default true.

Type Function

The type of the function tool. Always function.

DeferLoading booloptional

Whether this function is deferred and loaded via tool search.

Description stringoptional

A description of the function. Used by the model to determine whether or not to call the function.

type FileSearchTool struct{…}

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

Type FileSearch

The type of the file search tool. Always file_search.

VectorStoreIDs []string

The IDs of the vector stores to search.

Filters FileSearchToolFiltersUnionoptional

A filter to apply.

Accepts one of the following:

type ComparisonFilter struct{…}

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

Key string

The key to compare against the value.

Type ComparisonFilterType

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

• eq: equals
• ne: not equal
• gt: greater than
• gte: greater than or equal
• lt: less than
• lte: less than or equal
• in: in
• nin: not in

Accepts one of the following:

const ComparisonFilterTypeEq ComparisonFilterType = "eq"

const ComparisonFilterTypeNe ComparisonFilterType = "ne"

const ComparisonFilterTypeGt ComparisonFilterType = "gt"

const ComparisonFilterTypeGte ComparisonFilterType = "gte"

const ComparisonFilterTypeLt ComparisonFilterType = "lt"

const ComparisonFilterTypeLte ComparisonFilterType = "lte"

Value ComparisonFilterValueUnion

The value to compare against the attribute key; supports string, number, or boolean types.

Accepts one of the following:

string

float64

bool

type ComparisonFilterValueArray []ComparisonFilterValueArrayItemUnion

Accepts one of the following:

string

float64

type CompoundFilter struct{…}

Combine multiple filters using and or or.

Filters []ComparisonFilter

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

Accepts one of the following:

type ComparisonFilter struct{…}

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

Key string

The key to compare against the value.

Type ComparisonFilterType

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

• eq: equals
• ne: not equal
• gt: greater than
• gte: greater than or equal
• lt: less than
• lte: less than or equal
• in: in
• nin: not in

Accepts one of the following:

const ComparisonFilterTypeEq ComparisonFilterType = "eq"

const ComparisonFilterTypeNe ComparisonFilterType = "ne"

const ComparisonFilterTypeGt ComparisonFilterType = "gt"

const ComparisonFilterTypeGte ComparisonFilterType = "gte"

const ComparisonFilterTypeLt ComparisonFilterType = "lt"

const ComparisonFilterTypeLte ComparisonFilterType = "lte"

Value ComparisonFilterValueUnion

The value to compare against the attribute key; supports string, number, or boolean types.

Accepts one of the following:

string

float64

bool

type ComparisonFilterValueArray []ComparisonFilterValueArrayItemUnion

Accepts one of the following:

string

float64

Type CompoundFilterType

Type of operation: and or or.

Accepts one of the following:

const CompoundFilterTypeAnd CompoundFilterType = "and"

const CompoundFilterTypeOr CompoundFilterType = "or"

MaxNumResults int64optional

The maximum number of results to return. This number should be between 1 and 50 inclusive.

RankingOptions FileSearchToolRankingOptionsoptional

Ranking options for search.

HybridSearch FileSearchToolRankingOptionsHybridSearchoptional

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

EmbeddingWeight float64

The weight of the embedding in the reciprocal ranking fusion.

TextWeight float64

The weight of the text in the reciprocal ranking fusion.

Ranker stringoptional

The ranker to use for the file search.

Accepts one of the following:

const FileSearchToolRankingOptionsRankerAuto FileSearchToolRankingOptionsRanker = "auto"

const FileSearchToolRankingOptionsRankerDefault2024_11_15 FileSearchToolRankingOptionsRanker = "default-2024-11-15"

ScoreThreshold float64optional

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

type ComputerTool struct{…}

A tool that controls a virtual computer. Learn more about the computer tool.

Type Computer

The type of the computer tool. Always computer.

type ComputerUsePreviewTool struct{…}

A tool that controls a virtual computer. Learn more about the computer tool.

DisplayHeight int64

The height of the computer display.

DisplayWidth int64

The width of the computer display.

Environment ComputerUsePreviewToolEnvironment

The type of computer environment to control.

Accepts one of the following:

const ComputerUsePreviewToolEnvironmentWindows ComputerUsePreviewToolEnvironment = "windows"

const ComputerUsePreviewToolEnvironmentMac ComputerUsePreviewToolEnvironment = "mac"

const ComputerUsePreviewToolEnvironmentLinux ComputerUsePreviewToolEnvironment = "linux"

const ComputerUsePreviewToolEnvironmentUbuntu ComputerUsePreviewToolEnvironment = "ubuntu"

const ComputerUsePreviewToolEnvironmentBrowser ComputerUsePreviewToolEnvironment = "browser"

Type ComputerUsePreview

The type of the computer use tool. Always computer_use_preview.

type WebSearchTool struct{…}

Search the Internet for sources related to the prompt. Learn more about the web search tool.

Type WebSearchToolType

The type of the web search tool. One of web_search or web_search_2025_08_26.

Accepts one of the following:

const WebSearchToolTypeWebSearch WebSearchToolType = "web_search"

const WebSearchToolTypeWebSearch2025_08_26 WebSearchToolType = "web_search_2025_08_26"

Filters WebSearchToolFiltersoptional

Filters for the search.

AllowedDomains []stringoptional

Allowed domains for the search. If not provided, all domains are allowed. Subdomains of the provided domains are allowed as well.

Example: ["pubmed.ncbi.nlm.nih.gov"]

SearchContextSize WebSearchToolSearchContextSizeoptional

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.

Accepts one of the following:

const WebSearchToolSearchContextSizeLow WebSearchToolSearchContextSize = "low"

const WebSearchToolSearchContextSizeMedium WebSearchToolSearchContextSize = "medium"

const WebSearchToolSearchContextSizeHigh WebSearchToolSearchContextSize = "high"

UserLocation WebSearchToolUserLocationoptional

The approximate location of the user.

City stringoptional

Free text input for the city of the user, e.g. San Francisco.

Country stringoptional

The two-letter ISO country code of the user, e.g. US.

Region stringoptional

Free text input for the region of the user, e.g. California.

Timezone stringoptional

The IANA timezone of the user, e.g. America/Los_Angeles.

Type stringoptional

The type of location approximation. Always approximate.

type ToolMcp struct{…}

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

ServerLabel string

A label for this MCP server, used to identify it in tool calls.

Type Mcp

The type of the MCP tool. Always mcp.

AllowedTools ToolMcpAllowedToolsUnionoptional

List of allowed tool names or a filter object.

Accepts one of the following:

type ToolMcpAllowedToolsMcpAllowedTools []string

A string array of allowed tool names

type ToolMcpAllowedToolsMcpToolFilter struct{…}

A filter object to specify which tools are allowed.

ReadOnly booloptional

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

ToolNames []stringoptional

List of allowed tool names.

Authorization stringoptional

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

ConnectorID stringoptional

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

Currently supported connector_id values are:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Calendar: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams: connector_microsoftteams
• Outlook Calendar: connector_outlookcalendar
• Outlook Email: connector_outlookemail
• SharePoint: connector_sharepoint

Accepts one of the following:

const ToolMcpConnectorIDConnectorDropbox ToolMcpConnectorID = "connector_dropbox"

const ToolMcpConnectorIDConnectorGmail ToolMcpConnectorID = "connector_gmail"

const ToolMcpConnectorIDConnectorGooglecalendar ToolMcpConnectorID = "connector_googlecalendar"

const ToolMcpConnectorIDConnectorGoogledrive ToolMcpConnectorID = "connector_googledrive"

const ToolMcpConnectorIDConnectorMicrosoftteams ToolMcpConnectorID = "connector_microsoftteams"

const ToolMcpConnectorIDConnectorOutlookcalendar ToolMcpConnectorID = "connector_outlookcalendar"

const ToolMcpConnectorIDConnectorOutlookemail ToolMcpConnectorID = "connector_outlookemail"

const ToolMcpConnectorIDConnectorSharepoint ToolMcpConnectorID = "connector_sharepoint"

DeferLoading booloptional

Whether this MCP tool is deferred and discovered via tool search.

Headers map[string, string]optional

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

RequireApproval ToolMcpRequireApprovalUnionoptional

Specify which of the MCP server's tools require approval.

Accepts one of the following:

type ToolMcpRequireApprovalMcpToolApprovalFilter struct{…}

Specify which of the MCP server's tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Always ToolMcpRequireApprovalMcpToolApprovalFilterAlwaysoptional

A filter object to specify which tools are allowed.

ReadOnly booloptional

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

ToolNames []stringoptional

List of allowed tool names.

Never ToolMcpRequireApprovalMcpToolApprovalFilterNeveroptional

A filter object to specify which tools are allowed.

ReadOnly booloptional

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

ToolNames []stringoptional

List of allowed tool names.

type ToolMcpRequireApprovalMcpToolApprovalSetting string

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

Accepts one of the following:

const ToolMcpRequireApprovalMcpToolApprovalSettingAlways ToolMcpRequireApprovalMcpToolApprovalSetting = "always"

const ToolMcpRequireApprovalMcpToolApprovalSettingNever ToolMcpRequireApprovalMcpToolApprovalSetting = "never"

ServerDescription stringoptional

Optional description of the MCP server, used to provide more context.

ServerURL stringoptional

The URL for the MCP server. One of server_url or connector_id must be provided.

type ToolCodeInterpreter struct{…}

A tool that runs Python code to help generate a response to a prompt.

Container ToolCodeInterpreterContainerUnion

The code interpreter container. Can be a container ID or an object that specifies uploaded file IDs to make available to your code, along with an optional memory_limit setting.

Accepts one of the following:

string

type ToolCodeInterpreterContainerCodeInterpreterContainerAuto struct{…}

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

Type Auto

Always auto.

FileIDs []stringoptional

An optional list of uploaded files to make available to your code.

MemoryLimit stringoptional

The memory limit for the code interpreter container.

Accepts one of the following:

const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit1g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "1g"

const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit4g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "4g"

const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit16g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "16g"

const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit64g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "64g"

NetworkPolicy ToolCodeInterpreterContainerCodeInterpreterToolAutoNetworkPolicyUnionoptional

Network access policy for the container.

Accepts one of the following:

type ContainerNetworkPolicyDisabled struct{…}

Type Disabled

Disable outbound network access. Always disabled.

type ContainerNetworkPolicyAllowlist struct{…}

AllowedDomains []string

A list of allowed domains when type is allowlist.

Type Allowlist

Allow outbound network access only to specified domains. Always allowlist.

DomainSecrets []ContainerNetworkPolicyDomainSecretoptional

Optional domain-scoped secrets for allowlisted domains.

Domain string

The domain associated with the secret.

minLength1

Name string

The name of the secret to inject for the domain.

minLength1

Value string

The secret value to inject for the domain.

maxLength10485760

minLength1

Type CodeInterpreter

The type of the code interpreter tool. Always code_interpreter.

type ToolImageGeneration struct{…}

A tool that generates images using the GPT image models.

Type ImageGeneration

The type of the image generation tool. Always image_generation.

Action stringoptional

Whether to generate a new image or edit an existing image. Default: auto.

Accepts one of the following:

const ToolImageGenerationActionGenerate ToolImageGenerationAction = "generate"

const ToolImageGenerationActionEdit ToolImageGenerationAction = "edit"

const ToolImageGenerationActionAuto ToolImageGenerationAction = "auto"

Background stringoptional

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

Accepts one of the following:

const ToolImageGenerationBackgroundTransparent ToolImageGenerationBackground = "transparent"

const ToolImageGenerationBackgroundOpaque ToolImageGenerationBackground = "opaque"

const ToolImageGenerationBackgroundAuto ToolImageGenerationBackground = "auto"

InputFidelity stringoptional

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 gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

Accepts one of the following:

const ToolImageGenerationInputFidelityHigh ToolImageGenerationInputFidelity = "high"

const ToolImageGenerationInputFidelityLow ToolImageGenerationInputFidelity = "low"

InputImageMask ToolImageGenerationInputImageMaskoptional

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

FileID stringoptional

File ID for the mask image.

ImageURL stringoptional

Base64-encoded mask image.

Model stringoptional

The image generation model to use. Default: gpt-image-1.

Accepts one of the following:

string

string

Accepts one of the following:

const ToolImageGenerationModelGPTImage1 ToolImageGenerationModel = "gpt-image-1"

const ToolImageGenerationModelGPTImage1Mini ToolImageGenerationModel = "gpt-image-1-mini"

const ToolImageGenerationModelGPTImage1_5 ToolImageGenerationModel = "gpt-image-1.5"

Moderation stringoptional

Moderation level for the generated image. Default: auto.

Accepts one of the following:

const ToolImageGenerationModerationAuto ToolImageGenerationModeration = "auto"

const ToolImageGenerationModerationLow ToolImageGenerationModeration = "low"

OutputCompression int64optional

Compression level for the output image. Default: 100.

minimum0

maximum100

OutputFormat stringoptional

The output format of the generated image. One of png, webp, or jpeg. Default: png.

Accepts one of the following:

const ToolImageGenerationOutputFormatPNG ToolImageGenerationOutputFormat = "png"

const ToolImageGenerationOutputFormatWebP ToolImageGenerationOutputFormat = "webp"

const ToolImageGenerationOutputFormatJPEG ToolImageGenerationOutputFormat = "jpeg"

PartialImages int64optional

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Quality stringoptional

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

Accepts one of the following:

const ToolImageGenerationQualityLow ToolImageGenerationQuality = "low"

const ToolImageGenerationQualityMedium ToolImageGenerationQuality = "medium"

const ToolImageGenerationQualityHigh ToolImageGenerationQuality = "high"

const ToolImageGenerationQualityAuto ToolImageGenerationQuality = "auto"

Size stringoptional

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

Accepts one of the following:

const ToolImageGenerationSize1024x1024 ToolImageGenerationSize = "1024x1024"

const ToolImageGenerationSize1024x1536 ToolImageGenerationSize = "1024x1536"

const ToolImageGenerationSize1536x1024 ToolImageGenerationSize = "1536x1024"

const ToolImageGenerationSizeAuto ToolImageGenerationSize = "auto"

type ToolLocalShell struct{…}

A tool that allows the model to execute shell commands in a local environment.

Type LocalShell

The type of the local shell tool. Always local_shell.

type FunctionShellTool struct{…}

A tool that allows the model to execute shell commands.

Type Shell

The type of the shell tool. Always shell.

Environment FunctionShellToolEnvironmentUnionoptional

Accepts one of the following:

type ContainerAuto struct{…}

Type ContainerAuto

Automatically creates a container for this request

FileIDs []stringoptional

An optional list of uploaded files to make available to your code.

MemoryLimit ContainerAutoMemoryLimitoptional

The memory limit for the container.

Accepts one of the following:

const ContainerAutoMemoryLimit1g ContainerAutoMemoryLimit = "1g"

const ContainerAutoMemoryLimit4g ContainerAutoMemoryLimit = "4g"

const ContainerAutoMemoryLimit16g ContainerAutoMemoryLimit = "16g"

const ContainerAutoMemoryLimit64g ContainerAutoMemoryLimit = "64g"

NetworkPolicy ContainerAutoNetworkPolicyUnionoptional

Network access policy for the container.

Accepts one of the following:

type ContainerNetworkPolicyDisabled struct{…}

Type Disabled

Disable outbound network access. Always disabled.

type ContainerNetworkPolicyAllowlist struct{…}

AllowedDomains []string

A list of allowed domains when type is allowlist.

Type Allowlist

Allow outbound network access only to specified domains. Always allowlist.

DomainSecrets []ContainerNetworkPolicyDomainSecretoptional

Optional domain-scoped secrets for allowlisted domains.

Domain string

The domain associated with the secret.

minLength1

Name string

The name of the secret to inject for the domain.

minLength1

Value string

The secret value to inject for the domain.

maxLength10485760

minLength1

Skills []ContainerAutoSkillUnionoptional

An optional list of skills referenced by id or inline data.

Accepts one of the following:

type SkillReference struct{…}

SkillID string

The ID of the referenced skill.

maxLength64

minLength1

Type SkillReference

References a skill created with the /v1/skills endpoint.

Version stringoptional

Optional skill version. Use a positive integer or 'latest'. Omit for default.

type InlineSkill struct{…}

Description string

The description of the skill.

Name string

The name of the skill.

Source InlineSkillSource

Inline skill payload

Type Inline

Defines an inline skill for this request.

type LocalEnvironment struct{…}

Type Local

Use a local computer environment.

Skills []LocalSkilloptional

An optional list of skills.

Description string

The description of the skill.

Name string

The name of the skill.

Path string

The path to the directory containing the skill.

type ContainerReference struct{…}

ContainerID string

The ID of the referenced container.

Type ContainerReference

References a container created with the /v1/containers endpoint

type CustomTool struct{…}

A custom tool that processes input using a specified format. Learn more about custom tools

Name string

The name of the custom tool, used to identify it in tool calls.

Type Custom

The type of the custom tool. Always custom.

DeferLoading booloptional

Whether this tool should be deferred and discovered via tool search.

Description stringoptional

Optional description of the custom tool, used to provide more context.

Format CustomToolInputFormatUnionoptional

The input format for the custom tool. Default is unconstrained text.

type NamespaceTool struct{…}

Groups function/custom tools under a shared namespace.

Description string

A description of the namespace shown to the model.

minLength1

Name string

The namespace name used in tool calls (for example, crm).

minLength1

Tools []NamespaceToolToolUnion

The function/custom tools available inside this namespace.

Accepts one of the following:

type NamespaceToolToolFunction struct{…}

Name string

maxLength128

minLength1

Type Function

Description stringoptional

Parameters anyoptional

Strict booloptional

type CustomTool struct{…}

A custom tool that processes input using a specified format. Learn more about custom tools

Name string

The name of the custom tool, used to identify it in tool calls.

Type Custom

The type of the custom tool. Always custom.

DeferLoading booloptional

Whether this tool should be deferred and discovered via tool search.

Description stringoptional

Optional description of the custom tool, used to provide more context.

Format CustomToolInputFormatUnionoptional

The input format for the custom tool. Default is unconstrained text.

Type Namespace

The type of the tool. Always namespace.

type ToolSearchTool struct{…}

Hosted or BYOT tool search configuration for deferred tools.

Type ToolSearch

The type of the tool. Always tool_search.

Description stringoptional

Description shown to the model for a client-executed tool search tool.

Execution ToolSearchToolExecutionoptional

Whether tool search is executed by the server or by the client.

Accepts one of the following:

const ToolSearchToolExecutionServer ToolSearchToolExecution = "server"

const ToolSearchToolExecutionClient ToolSearchToolExecution = "client"

Parameters anyoptional

Parameter schema for a client-executed tool search tool.

type WebSearchPreviewTool struct{…}

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

Type WebSearchPreviewToolType

The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.

Accepts one of the following:

const WebSearchPreviewToolTypeWebSearchPreview WebSearchPreviewToolType = "web_search_preview"

const WebSearchPreviewToolTypeWebSearchPreview2025_03_11 WebSearchPreviewToolType = "web_search_preview_2025_03_11"

SearchContentTypes []stringoptional

Accepts one of the following:

const WebSearchPreviewToolSearchContentTypeText WebSearchPreviewToolSearchContentType = "text"

const WebSearchPreviewToolSearchContentTypeImage WebSearchPreviewToolSearchContentType = "image"

SearchContextSize WebSearchPreviewToolSearchContextSizeoptional

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.

Accepts one of the following:

const WebSearchPreviewToolSearchContextSizeLow WebSearchPreviewToolSearchContextSize = "low"

const WebSearchPreviewToolSearchContextSizeMedium WebSearchPreviewToolSearchContextSize = "medium"

const WebSearchPreviewToolSearchContextSizeHigh WebSearchPreviewToolSearchContextSize = "high"

UserLocation WebSearchPreviewToolUserLocationoptional

The user's location.

Type Approximate

The type of location approximation. Always approximate.

City stringoptional

Free text input for the city of the user, e.g. San Francisco.

Country stringoptional

The two-letter ISO country code of the user, e.g. US.

Region stringoptional

Free text input for the region of the user, e.g. California.

Timezone stringoptional

The IANA timezone of the user, e.g. America/Los_Angeles.

type ApplyPatchTool struct{…}

Allows the assistant to create, delete, or update files using unified diffs.

Type ApplyPatch

The type of the tool. Always apply_patch.

Type ToolSearchOutput

The type of the item. Always tool_search_output.

CreatedBy stringoptional

The identifier of the actor that created the item.

type ResponseItemImageGenerationCall struct{…}

An image generation request made by the model.

ID string

The unique ID of the image generation call.

Result string

The generated image encoded in base64.

Status string

The status of the image generation call.

Accepts one of the following:

const ResponseItemImageGenerationCallStatusInProgress ResponseItemImageGenerationCallStatus = "in_progress"

const ResponseItemImageGenerationCallStatusCompleted ResponseItemImageGenerationCallStatus = "completed"

const ResponseItemImageGenerationCallStatusGenerating ResponseItemImageGenerationCallStatus = "generating"

const ResponseItemImageGenerationCallStatusFailed ResponseItemImageGenerationCallStatus = "failed"

Type ImageGenerationCall

The type of the image generation call. Always image_generation_call.

type ResponseCodeInterpreterToolCall struct{…}

A tool call to run code.

ID string

The unique ID of the code interpreter tool call.

Code string

The code to run, or null if not available.

ContainerID string

The ID of the container used to run the code.

Outputs []ResponseCodeInterpreterToolCallOutputUnion

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

Accepts one of the following:

type ResponseCodeInterpreterToolCallOutputLogs struct{…}

The logs output from the code interpreter.

Logs string

The logs output from the code interpreter.

Type Logs

The type of the output. Always logs.

type ResponseCodeInterpreterToolCallOutputImage struct{…}

The image output from the code interpreter.

Type Image

The type of the output. Always image.

URL string

The URL of the image output from the code interpreter.

Status ResponseCodeInterpreterToolCallStatus

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

Accepts one of the following:

const ResponseCodeInterpreterToolCallStatusInProgress ResponseCodeInterpreterToolCallStatus = "in_progress"

const ResponseCodeInterpreterToolCallStatusCompleted ResponseCodeInterpreterToolCallStatus = "completed"

const ResponseCodeInterpreterToolCallStatusIncomplete ResponseCodeInterpreterToolCallStatus = "incomplete"

const ResponseCodeInterpreterToolCallStatusInterpreting ResponseCodeInterpreterToolCallStatus = "interpreting"

const ResponseCodeInterpreterToolCallStatusFailed ResponseCodeInterpreterToolCallStatus = "failed"

Type CodeInterpreterCall

The type of the code interpreter tool call. Always code_interpreter_call.

type ResponseItemLocalShellCall struct{…}

A tool call to run a command on the local shell.

ID string

The unique ID of the local shell call.

Action ResponseItemLocalShellCallAction

Execute a shell command on the server.

Command []string

The command to run.

Env map[string, string]

Environment variables to set for the command.

Type Exec

The type of the local shell action. Always exec.

TimeoutMs int64optional

Optional timeout in milliseconds for the command.

User stringoptional

Optional user to run the command as.

WorkingDirectory stringoptional

Optional working directory to run the command in.

CallID string

The unique ID of the local shell tool call generated by the model.

Status string

The status of the local shell call.

Accepts one of the following:

const ResponseItemLocalShellCallStatusInProgress ResponseItemLocalShellCallStatus = "in_progress"

const ResponseItemLocalShellCallStatusCompleted ResponseItemLocalShellCallStatus = "completed"

const ResponseItemLocalShellCallStatusIncomplete ResponseItemLocalShellCallStatus = "incomplete"

Type LocalShellCall

The type of the local shell call. Always local_shell_call.

type ResponseItemLocalShellCallOutput struct{…}

The output of a local shell tool call.

ID string

The unique ID of the local shell tool call generated by the model.

Output string

A JSON string of the output of the local shell tool call.

Type LocalShellCallOutput

The type of the local shell tool call output. Always local_shell_call_output.

Status stringoptional

The status of the item. One of in_progress, completed, or incomplete.

Accepts one of the following:

const ResponseItemLocalShellCallOutputStatusInProgress ResponseItemLocalShellCallOutputStatus = "in_progress"

const ResponseItemLocalShellCallOutputStatusCompleted ResponseItemLocalShellCallOutputStatus = "completed"

const ResponseItemLocalShellCallOutputStatusIncomplete ResponseItemLocalShellCallOutputStatus = "incomplete"

type ResponseFunctionShellToolCall struct{…}

A tool call that executes one or more shell commands in a managed environment.

ID string

The unique ID of the shell tool call. Populated when this item is returned via API.

Action ResponseFunctionShellToolCallAction

The shell commands and limits that describe how to run the tool call.

Commands []string

MaxOutputLength int64

Optional maximum number of characters to return from each command.

TimeoutMs int64

Optional timeout in milliseconds for the commands.

CallID string

The unique ID of the shell tool call generated by the model.

Environment ResponseFunctionShellToolCallEnvironmentUnion

Represents the use of a local environment to perform shell actions.

Accepts one of the following:

type ResponseLocalEnvironment struct{…}

Represents the use of a local environment to perform shell actions.

Type Local

The environment type. Always local.

type ResponseContainerReference struct{…}

Represents a container created with /v1/containers.

ContainerID string

Type ContainerReference

The environment type. Always container_reference.

Status ResponseFunctionShellToolCallStatus

The status of the shell call. One of in_progress, completed, or incomplete.

Accepts one of the following:

const ResponseFunctionShellToolCallStatusInProgress ResponseFunctionShellToolCallStatus = "in_progress"

const ResponseFunctionShellToolCallStatusCompleted ResponseFunctionShellToolCallStatus = "completed"

const ResponseFunctionShellToolCallStatusIncomplete ResponseFunctionShellToolCallStatus = "incomplete"

Type ShellCall

The type of the item. Always shell_call.

CreatedBy stringoptional

The ID of the entity that created this tool call.

type ResponseFunctionShellToolCallOutput struct{…}

The output of a shell tool call that was emitted.

ID string

The unique ID of the shell call output. Populated when this item is returned via API.

CallID string

The unique ID of the shell tool call generated by the model.

MaxOutputLength int64

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

Output []ResponseFunctionShellToolCallOutputOutput

An array of shell call output contents

Outcome ResponseFunctionShellToolCallOutputOutputOutcomeUnion

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

Accepts one of the following:

type ResponseFunctionShellToolCallOutputOutputOutcomeTimeout struct{…}

Indicates that the shell call exceeded its configured time limit.

Type Timeout

The outcome type. Always timeout.

type ResponseFunctionShellToolCallOutputOutputOutcomeExit struct{…}

Indicates that the shell commands finished and returned an exit code.

ExitCode int64

Exit code from the shell process.

Type Exit

The outcome type. Always exit.

Stderr string

The standard error output that was captured.

Stdout string

The standard output that was captured.

CreatedBy stringoptional

The identifier of the actor that created the item.

Status ResponseFunctionShellToolCallOutputStatus

The status of the shell call output. One of in_progress, completed, or incomplete.

Accepts one of the following:

const ResponseFunctionShellToolCallOutputStatusInProgress ResponseFunctionShellToolCallOutputStatus = "in_progress"

const ResponseFunctionShellToolCallOutputStatusCompleted ResponseFunctionShellToolCallOutputStatus = "completed"

const ResponseFunctionShellToolCallOutputStatusIncomplete ResponseFunctionShellToolCallOutputStatus = "incomplete"

Type ShellCallOutput

The type of the shell call output. Always shell_call_output.

CreatedBy stringoptional

The identifier of the actor that created the item.

type ResponseApplyPatchToolCall struct{…}

A tool call that applies file diffs by creating, deleting, or updating files.

ID string

The unique ID of the apply patch tool call. Populated when this item is returned via API.

CallID string

The unique ID of the apply patch tool call generated by the model.

Operation ResponseApplyPatchToolCallOperationUnion

One of the create_file, delete_file, or update_file operations applied via apply_patch.

Accepts one of the following:

type ResponseApplyPatchToolCallOperationCreateFile struct{…}

Instruction describing how to create a file via the apply_patch tool.

Diff string

Diff to apply.

Path string

Path of the file to create.

Type CreateFile

Create a new file with the provided diff.

type ResponseApplyPatchToolCallOperationDeleteFile struct{…}

Instruction describing how to delete a file via the apply_patch tool.

Path string

Path of the file to delete.

Type DeleteFile

Delete the specified file.

type ResponseApplyPatchToolCallOperationUpdateFile struct{…}

Instruction describing how to update a file via the apply_patch tool.

Diff string

Diff to apply.

Path string

Path of the file to update.

Type UpdateFile

Update an existing file with the provided diff.

Status ResponseApplyPatchToolCallStatus

The status of the apply patch tool call. One of in_progress or completed.

Accepts one of the following:

const ResponseApplyPatchToolCallStatusInProgress ResponseApplyPatchToolCallStatus = "in_progress"

const ResponseApplyPatchToolCallStatusCompleted ResponseApplyPatchToolCallStatus = "completed"

Type ApplyPatchCall

The type of the item. Always apply_patch_call.

CreatedBy stringoptional

The ID of the entity that created this tool call.

type ResponseApplyPatchToolCallOutput struct{…}

The output emitted by an apply patch tool call.

ID string

The unique ID of the apply patch tool call output. Populated when this item is returned via API.

CallID string

The unique ID of the apply patch tool call generated by the model.

Status ResponseApplyPatchToolCallOutputStatus

The status of the apply patch tool call output. One of completed or failed.

Accepts one of the following:

const ResponseApplyPatchToolCallOutputStatusCompleted ResponseApplyPatchToolCallOutputStatus = "completed"

const ResponseApplyPatchToolCallOutputStatusFailed ResponseApplyPatchToolCallOutputStatus = "failed"

Type ApplyPatchCallOutput

The type of the item. Always apply_patch_call_output.

CreatedBy stringoptional

The ID of the entity that created this tool call output.

Output stringoptional

Optional textual output returned by the apply patch tool.

type ResponseItemMcpListTools struct{…}

A list of tools available on an MCP server.

ID string

The unique ID of the list.

ServerLabel string

The label of the MCP server.

Tools []ResponseItemMcpListToolsTool

The tools available on the server.

InputSchema any

The JSON schema describing the tool's input.

Name string

The name of the tool.

Annotations anyoptional

Additional annotations about the tool.

Description stringoptional

The description of the tool.

Type McpListTools

The type of the item. Always mcp_list_tools.

Error stringoptional

Error message if the server could not list tools.

type ResponseItemMcpApprovalRequest struct{…}

A request for human approval of a tool invocation.

ID string

The unique ID of the approval request.

Arguments string

A JSON string of arguments for the tool.

Name string

The name of the tool to run.

ServerLabel string

The label of the MCP server making the request.

Type McpApprovalRequest

The type of the item. Always mcp_approval_request.

type ResponseItemMcpApprovalResponse struct{…}

A response to an MCP approval request.

ID string

The unique ID of the approval response

ApprovalRequestID string

The ID of the approval request being answered.

Approve bool

Whether the request was approved.

Type McpApprovalResponse

The type of the item. Always mcp_approval_response.

Reason stringoptional

Optional reason for the decision.

type ResponseItemMcpCall struct{…}

An invocation of a tool on an MCP server.

ID string

The unique ID of the tool call.

Arguments string

A JSON string of the arguments passed to the tool.

Name string

The name of the tool that was run.

ServerLabel string

The label of the MCP server running the tool.

Type McpCall

The type of the item. Always mcp_call.

ApprovalRequestID stringoptional

Unique identifier for the MCP tool call approval request. Include this value in a subsequent mcp_approval_response input to approve or reject the corresponding tool call.

Error stringoptional

The error from the tool call, if any.

Output stringoptional

The output from the tool call.

Status stringoptional

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

Accepts one of the following:

const ResponseItemMcpCallStatusInProgress ResponseItemMcpCallStatus = "in_progress"

const ResponseItemMcpCallStatusCompleted ResponseItemMcpCallStatus = "completed"

const ResponseItemMcpCallStatusIncomplete ResponseItemMcpCallStatus = "incomplete"

const ResponseItemMcpCallStatusCalling ResponseItemMcpCallStatus = "calling"

const ResponseItemMcpCallStatusFailed ResponseItemMcpCallStatus = "failed"

FirstID string

The ID of the first item in the list.

HasMore bool

Whether there are more items available.

LastID string

The ID of the last item in the list.

Object List

The type of object returned, must be list.