Cancel a response

client.Beta.Responses.Cancel(ctx, responseID, body) (*BetaResponse, error)

POST/responses/{response_id}/cancel

Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

ParametersExpand Collapse

responseID string

body BetaResponseCancelParams

Betas param.Field[[]string]Optional

Optional beta features to enable for this request.

const BetaResponseCancelParamsOpenAIBetaResponsesMultiAgentV1 BetaResponseCancelParamsOpenAIBeta = "responses_multi_agent=v1"

ReturnsExpand Collapse

type BetaResponse struct{…}

ID string

Unique identifier for this Response.

CreatedAt float64

Unix timestamp (in seconds) of when this Response was created.

formatunixtime

Error BetaResponseError

An error object returned when the model fails to generate a Response.

Code BetaResponseErrorCode

The error code for the response.

One of the following:

const BetaResponseErrorCodeServerError BetaResponseErrorCode = "server_error"

const BetaResponseErrorCodeRateLimitExceeded BetaResponseErrorCode = "rate_limit_exceeded"

const BetaResponseErrorCodeInvalidPrompt BetaResponseErrorCode = "invalid_prompt"

const BetaResponseErrorCodeDataResidencyMismatch BetaResponseErrorCode = "data_residency_mismatch"

const BetaResponseErrorCodeBioPolicy BetaResponseErrorCode = "bio_policy"

const BetaResponseErrorCodeVectorStoreTimeout BetaResponseErrorCode = "vector_store_timeout"

const BetaResponseErrorCodeInvalidImage BetaResponseErrorCode = "invalid_image"

const BetaResponseErrorCodeInvalidImageFormat BetaResponseErrorCode = "invalid_image_format"

const BetaResponseErrorCodeInvalidBase64Image BetaResponseErrorCode = "invalid_base64_image"

const BetaResponseErrorCodeInvalidImageURL BetaResponseErrorCode = "invalid_image_url"

const BetaResponseErrorCodeImageTooLarge BetaResponseErrorCode = "image_too_large"

const BetaResponseErrorCodeImageTooSmall BetaResponseErrorCode = "image_too_small"

const BetaResponseErrorCodeImageParseError BetaResponseErrorCode = "image_parse_error"

const BetaResponseErrorCodeImageContentPolicyViolation BetaResponseErrorCode = "image_content_policy_violation"

const BetaResponseErrorCodeInvalidImageMode BetaResponseErrorCode = "invalid_image_mode"

const BetaResponseErrorCodeImageFileTooLarge BetaResponseErrorCode = "image_file_too_large"

const BetaResponseErrorCodeUnsupportedImageMediaType BetaResponseErrorCode = "unsupported_image_media_type"

const BetaResponseErrorCodeEmptyImageFile BetaResponseErrorCode = "empty_image_file"

const BetaResponseErrorCodeFailedToDownloadImage BetaResponseErrorCode = "failed_to_download_image"

const BetaResponseErrorCodeImageFileNotFound BetaResponseErrorCode = "image_file_not_found"

Message string

A human-readable description of the error.

IncompleteDetails BetaResponseIncompleteDetails

Details about why the response is incomplete.

Reason stringOptional

The reason why the response is incomplete.

One of the following:

const BetaResponseIncompleteDetailsReasonMaxOutputTokens BetaResponseIncompleteDetailsReason = "max_output_tokens"

const BetaResponseIncompleteDetailsReasonContentFilter BetaResponseIncompleteDetailsReason = "content_filter"

Instructions BetaResponseInstructionsUnion

A system (or developer) message inserted into the model’s context.

When using along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

One of the following:

string

type BetaResponseInstructionsInputItemList []BetaResponseInputItemUnion

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

One of the following:

type BetaEasyInputMessage struct{…}

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Content BetaEasyInputMessageContentUnion

Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.

One of the following:

string

type BetaResponseInputMessageContentList []BetaResponseInputContentUnion

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

One of the following:

type BetaResponseInputText 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.

PromptCacheBreakpoint BetaResponseInputTextPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputImage struct{…}

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

Detail BetaResponseInputImageDetail

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

One of the following:

const BetaResponseInputImageDetailLow BetaResponseInputImageDetail = "low"

const BetaResponseInputImageDetailHigh BetaResponseInputImageDetail = "high"

const BetaResponseInputImageDetailAuto BetaResponseInputImageDetail = "auto"

const BetaResponseInputImageDetailOriginal BetaResponseInputImageDetail = "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.

formaturi

PromptCacheBreakpoint BetaResponseInputImagePromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputFile struct{…}

A file input to the model.

Type InputFile

The type of the input item. Always input_file.

Detail BetaResponseInputFileDetailOptional

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

One of the following:

const BetaResponseInputFileDetailAuto BetaResponseInputFileDetail = "auto"

const BetaResponseInputFileDetailLow BetaResponseInputFileDetail = "low"

const BetaResponseInputFileDetailHigh BetaResponseInputFileDetail = "high"

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.

formaturi

Filename stringOptional

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

PromptCacheBreakpoint BetaResponseInputFilePromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

Role BetaEasyInputMessageRole

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

One of the following:

const BetaEasyInputMessageRoleUser BetaEasyInputMessageRole = "user"

const BetaEasyInputMessageRoleAssistant BetaEasyInputMessageRole = "assistant"

const BetaEasyInputMessageRoleSystem BetaEasyInputMessageRole = "system"

const BetaEasyInputMessageRoleDeveloper BetaEasyInputMessageRole = "developer"

Phase BetaEasyInputMessagePhaseOptional

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.

One of the following:

const BetaEasyInputMessagePhaseCommentary BetaEasyInputMessagePhase = "commentary"

const BetaEasyInputMessagePhaseFinalAnswer BetaEasyInputMessagePhase = "final_answer"

Type BetaEasyInputMessageTypeOptional

The type of the message input. Always message.

type BetaResponseInputItemMessage struct{…}

Content BetaResponseInputMessageContentList

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

One of the following:

type BetaResponseInputText 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.

PromptCacheBreakpoint BetaResponseInputTextPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputImage struct{…}

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

Detail BetaResponseInputImageDetail

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

One of the following:

const BetaResponseInputImageDetailLow BetaResponseInputImageDetail = "low"

const BetaResponseInputImageDetailHigh BetaResponseInputImageDetail = "high"

const BetaResponseInputImageDetailAuto BetaResponseInputImageDetail = "auto"

const BetaResponseInputImageDetailOriginal BetaResponseInputImageDetail = "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.

formaturi

PromptCacheBreakpoint BetaResponseInputImagePromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputFile struct{…}

A file input to the model.

Type InputFile

The type of the input item. Always input_file.

Detail BetaResponseInputFileDetailOptional

One of the following:

const BetaResponseInputFileDetailAuto BetaResponseInputFileDetail = "auto"

const BetaResponseInputFileDetailLow BetaResponseInputFileDetail = "low"

const BetaResponseInputFileDetailHigh BetaResponseInputFileDetail = "high"

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.

formaturi

Filename stringOptional

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

PromptCacheBreakpoint BetaResponseInputFilePromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

Role string

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

One of the following:

const BetaResponseInputItemMessageRoleUser BetaResponseInputItemMessageRole = "user"

const BetaResponseInputItemMessageRoleSystem BetaResponseInputItemMessageRole = "system"

const BetaResponseInputItemMessageRoleDeveloper BetaResponseInputItemMessageRole = "developer"

Agent BetaResponseInputItemMessageAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

Status stringOptional

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

One of the following:

const BetaResponseInputItemMessageStatusInProgress BetaResponseInputItemMessageStatus = "in_progress"

const BetaResponseInputItemMessageStatusCompleted BetaResponseInputItemMessageStatus = "completed"

const BetaResponseInputItemMessageStatusIncomplete BetaResponseInputItemMessageStatus = "incomplete"

Type stringOptional

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

type BetaResponseOutputMessage struct{…}

An output message from the model.

ID string

The unique ID of the output message.

Content []BetaResponseOutputMessageContentUnion

The content of the output message.

One of the following:

type BetaResponseOutputText struct{…}

A text output from the model.

Annotations []BetaResponseOutputTextAnnotationUnion

The annotations of the text output.

One of the following:

type BetaResponseOutputTextAnnotationFileCitation 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 BetaResponseOutputTextAnnotationURLCitation 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.

formaturi

type BetaResponseOutputTextAnnotationContainerFileCitation 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 BetaResponseOutputTextAnnotationFilePath 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 []BetaResponseOutputTextLogprobOptional

Token string

Bytes []int64

Logprob float64

TopLogprobs []BetaResponseOutputTextLogprobTopLogprob

Token string

Bytes []int64

Logprob float64

type BetaResponseOutputRefusal 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 BetaResponseOutputMessageStatus

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

One of the following:

const BetaResponseOutputMessageStatusInProgress BetaResponseOutputMessageStatus = "in_progress"

const BetaResponseOutputMessageStatusCompleted BetaResponseOutputMessageStatus = "completed"

const BetaResponseOutputMessageStatusIncomplete BetaResponseOutputMessageStatus = "incomplete"

Type Message

The type of the output message. Always message.

Agent BetaResponseOutputMessageAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

Phase BetaResponseOutputMessagePhaseOptional

One of the following:

const BetaResponseOutputMessagePhaseCommentary BetaResponseOutputMessagePhase = "commentary"

const BetaResponseOutputMessagePhaseFinalAnswer BetaResponseOutputMessagePhase = "final_answer"

type BetaResponseFileSearchToolCall 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 BetaResponseFileSearchToolCallStatus

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

One of the following:

const BetaResponseFileSearchToolCallStatusInProgress BetaResponseFileSearchToolCallStatus = "in_progress"

const BetaResponseFileSearchToolCallStatusSearching BetaResponseFileSearchToolCallStatus = "searching"

const BetaResponseFileSearchToolCallStatusCompleted BetaResponseFileSearchToolCallStatus = "completed"

const BetaResponseFileSearchToolCallStatusIncomplete BetaResponseFileSearchToolCallStatus = "incomplete"

const BetaResponseFileSearchToolCallStatusFailed BetaResponseFileSearchToolCallStatus = "failed"

Type FileSearchCall

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

Agent BetaResponseFileSearchToolCallAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

Results []BetaResponseFileSearchToolCallResultOptional

The results of the file search tool call.

Attributes map[string, BetaResponseFileSearchToolCallResultAttributeUnion]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.

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 BetaResponseComputerToolCall 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 []BetaResponseComputerToolCallPendingSafetyCheck

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 BetaResponseComputerToolCallStatus

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

One of the following:

const BetaResponseComputerToolCallStatusInProgress BetaResponseComputerToolCallStatus = "in_progress"

const BetaResponseComputerToolCallStatusCompleted BetaResponseComputerToolCallStatus = "completed"

const BetaResponseComputerToolCallStatusIncomplete BetaResponseComputerToolCallStatus = "incomplete"

Type BetaResponseComputerToolCallType

The type of the computer call. Always computer_call.

Action BetaComputerActionUnionOptional

A click action.

One of the following:

type BetaComputerActionClick struct{…}

A click action.

Button string

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

One of the following:

const BetaComputerActionClickButtonLeft BetaComputerActionClickButton = "left"

const BetaComputerActionClickButtonRight BetaComputerActionClickButton = "right"

const BetaComputerActionClickButtonWheel BetaComputerActionClickButton = "wheel"

const BetaComputerActionClickButtonBack BetaComputerActionClickButton = "back"

const BetaComputerActionClickButtonForward BetaComputerActionClickButton = "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.

Keys []stringOptional

The keys being held while clicking.

type BetaComputerActionDoubleClick struct{…}

A double click action.

Keys []string

The keys being held while double-clicking.

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 BetaComputerActionDrag struct{…}

A drag action.

Path []BetaComputerActionDragPath

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.

Keys []stringOptional

The keys being held while dragging the mouse.

type BetaComputerActionKeypress 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 BetaComputerActionMove 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.

Keys []stringOptional

The keys being held while moving the mouse.

type BetaComputerActionScreenshot struct{…}

A screenshot action.

Type Screenshot

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

type BetaComputerActionScroll 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.

Keys []stringOptional

The keys being held while scrolling.

type BetaComputerActionType 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 BetaComputerActionWait struct{…}

A wait action.

Type Wait

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

Actions BetaComputerActionListOptional

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

One of the following:

type BetaComputerActionClick struct{…}

A click action.

Button string

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

One of the following:

const BetaComputerActionClickButtonLeft BetaComputerActionClickButton = "left"

const BetaComputerActionClickButtonRight BetaComputerActionClickButton = "right"

const BetaComputerActionClickButtonWheel BetaComputerActionClickButton = "wheel"

const BetaComputerActionClickButtonBack BetaComputerActionClickButton = "back"

const BetaComputerActionClickButtonForward BetaComputerActionClickButton = "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.

Keys []stringOptional

The keys being held while clicking.

type BetaComputerActionDoubleClick struct{…}

A double click action.

Keys []string

The keys being held while double-clicking.

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 BetaComputerActionDrag struct{…}

A drag action.

Path []BetaComputerActionDragPath

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.

Keys []stringOptional

The keys being held while dragging the mouse.

type BetaComputerActionKeypress 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 BetaComputerActionMove 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.

Keys []stringOptional

The keys being held while moving the mouse.

type BetaComputerActionScreenshot struct{…}

A screenshot action.

Type Screenshot

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

type BetaComputerActionScroll 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.

Keys []stringOptional

The keys being held while scrolling.

type BetaComputerActionType 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 BetaComputerActionWait struct{…}

A wait action.

Type Wait

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

Agent BetaResponseComputerToolCallAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

type BetaResponseInputItemComputerCallOutput struct{…}

The output of a computer tool call.

CallID string

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

maxLength64

minLength1

Output BetaResponseComputerToolCallOutputScreenshot

A computer screenshot image used with the computer use tool.

Type ComputerScreenshot

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

FileID stringOptional

The identifier of an uploaded file that contains the screenshot.

ImageURL stringOptional

The URL of the screenshot image.

formaturi

Type ComputerCallOutput

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

ID stringOptional

The ID of the computer tool call output.

AcknowledgedSafetyChecks []BetaResponseInputItemComputerCallOutputAcknowledgedSafetyCheckOptional

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.

Agent BetaResponseInputItemComputerCallOutputAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

Status stringOptional

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

One of the following:

const BetaResponseInputItemComputerCallOutputStatusInProgress BetaResponseInputItemComputerCallOutputStatus = "in_progress"

const BetaResponseInputItemComputerCallOutputStatusCompleted BetaResponseInputItemComputerCallOutputStatus = "completed"

const BetaResponseInputItemComputerCallOutputStatusIncomplete BetaResponseInputItemComputerCallOutputStatus = "incomplete"

type BetaResponseFunctionWebSearch 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 BetaResponseFunctionWebSearchActionUnion

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).

One of the following:

type BetaResponseFunctionWebSearchActionSearch struct{…}

Action type “search” - Performs a web search query.

Type Search

The action type.

Queries []stringOptional

The search queries.

DeprecatedQuery stringOptional

The search query.

Sources []BetaResponseFunctionWebSearchActionSearchSourceOptional

The sources used in the search.

Type URL

The type of source. Always url.

URL string

The URL of the source.

formaturi

type BetaResponseFunctionWebSearchActionOpenPage 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 BetaResponseFunctionWebSearchActionFindInPage 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 BetaResponseFunctionWebSearchStatus

The status of the web search tool call.

One of the following:

const BetaResponseFunctionWebSearchStatusInProgress BetaResponseFunctionWebSearchStatus = "in_progress"

const BetaResponseFunctionWebSearchStatusSearching BetaResponseFunctionWebSearchStatus = "searching"

const BetaResponseFunctionWebSearchStatusCompleted BetaResponseFunctionWebSearchStatus = "completed"

const BetaResponseFunctionWebSearchStatusFailed BetaResponseFunctionWebSearchStatus = "failed"

Type WebSearchCall

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

Agent BetaResponseFunctionWebSearchAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

type BetaResponseFunctionToolCall struct{…}

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

Arguments string

A JSON string of the arguments to pass to the function.

CallID string

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

Name string

The name of the function to run.

Type FunctionCall

The type of the function tool call. Always function_call.

ID stringOptional

The unique ID of the function tool call.

Agent BetaResponseFunctionToolCallAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

Caller BetaResponseFunctionToolCallCallerUnionOptional

The execution context that produced this tool call.

One of the following:

type BetaResponseFunctionToolCallCallerDirect struct{…}

Type Direct

type BetaResponseFunctionToolCallCallerProgram struct{…}

CallerID string

The call ID of the program item that produced this tool call.

Type Program

Namespace stringOptional

The namespace of the function to run.

Status BetaResponseFunctionToolCallStatusOptional

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

One of the following:

const BetaResponseFunctionToolCallStatusInProgress BetaResponseFunctionToolCallStatus = "in_progress"

const BetaResponseFunctionToolCallStatusCompleted BetaResponseFunctionToolCallStatus = "completed"

const BetaResponseFunctionToolCallStatusIncomplete BetaResponseFunctionToolCallStatus = "incomplete"

type BetaResponseInputItemFunctionCallOutput struct{…}

The output of a function tool call.

CallID string

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

maxLength64

minLength1

Output BetaResponseInputItemFunctionCallOutputOutputUnion

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

One of the following:

string

type BetaResponseFunctionCallOutputItemList []BetaResponseFunctionCallOutputItemUnion

An array of content outputs (text, image, file) for the function tool call.

One of the following:

type BetaResponseInputTextContent struct{…}

A text input to the model.

Text string

The text input to the model.

maxLength10485760

Type InputText

The type of the input item. Always input_text.

PromptCacheBreakpoint BetaResponseInputTextContentPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputImageContent struct{…}

An image input to the model. Learn about image inputs

Type InputImage

The type of the input item. Always input_image.

Detail BetaResponseInputImageContentDetailOptional

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

One of the following:

const BetaResponseInputImageContentDetailLow BetaResponseInputImageContentDetail = "low"

const BetaResponseInputImageContentDetailHigh BetaResponseInputImageContentDetail = "high"

const BetaResponseInputImageContentDetailAuto BetaResponseInputImageContentDetail = "auto"

const BetaResponseInputImageContentDetailOriginal BetaResponseInputImageContentDetail = "original"

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.

maxLength20971520

formaturi

PromptCacheBreakpoint BetaResponseInputImageContentPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputFileContent struct{…}

A file input to the model.

Type InputFile

The type of the input item. Always input_file.

Detail BetaResponseInputFileContentDetailOptional

One of the following:

const BetaResponseInputFileContentDetailAuto BetaResponseInputFileContentDetail = "auto"

const BetaResponseInputFileContentDetailLow BetaResponseInputFileContentDetail = "low"

const BetaResponseInputFileContentDetailHigh BetaResponseInputFileContentDetail = "high"

FileData stringOptional

The base64-encoded data of the file to be sent to the model.

maxLength73400320

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.

formaturi

Filename stringOptional

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

PromptCacheBreakpoint BetaResponseInputFileContentPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

Type FunctionCallOutput

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

ID stringOptional

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

Agent BetaResponseInputItemFunctionCallOutputAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

Caller BetaResponseInputItemFunctionCallOutputCallerUnionOptional

The execution context that produced this tool call.

One of the following:

type BetaResponseInputItemFunctionCallOutputCallerDirect struct{…}

Type Direct

The caller type. Always direct.

type BetaResponseInputItemFunctionCallOutputCallerProgram struct{…}

CallerID string

The call ID of the program item that produced this tool call.

maxLength64

minLength1

Type Program

The caller type. Always program.

Status stringOptional

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

One of the following:

const BetaResponseInputItemFunctionCallOutputStatusInProgress BetaResponseInputItemFunctionCallOutputStatus = "in_progress"

const BetaResponseInputItemFunctionCallOutputStatusCompleted BetaResponseInputItemFunctionCallOutputStatus = "completed"

const BetaResponseInputItemFunctionCallOutputStatusIncomplete BetaResponseInputItemFunctionCallOutputStatus = "incomplete"

type BetaResponseInputItemAgentMessage struct{…}

A message routed between agents.

Author string

The sending agent identity.

Content []BetaResponseInputItemAgentMessageContentUnion

Plaintext, image, or encrypted content sent between agents.

One of the following:

type BetaResponseInputTextContent struct{…}

A text input to the model.

Text string

The text input to the model.

maxLength10485760

Type InputText

The type of the input item. Always input_text.

PromptCacheBreakpoint BetaResponseInputTextContentPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputImageContent struct{…}

An image input to the model. Learn about image inputs

Type InputImage

The type of the input item. Always input_image.

Detail BetaResponseInputImageContentDetailOptional

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

One of the following:

const BetaResponseInputImageContentDetailLow BetaResponseInputImageContentDetail = "low"

const BetaResponseInputImageContentDetailHigh BetaResponseInputImageContentDetail = "high"

const BetaResponseInputImageContentDetailAuto BetaResponseInputImageContentDetail = "auto"

const BetaResponseInputImageContentDetailOriginal BetaResponseInputImageContentDetail = "original"

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.

maxLength20971520

formaturi

PromptCacheBreakpoint BetaResponseInputImageContentPromptCacheBreakpointOptional

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

Mode Explicit

The breakpoint mode. Always explicit.

type BetaResponseInputItemAgentMessageContentEncryptedContent struct{…}

Opaque encrypted content that Responses API decrypts inside trusted model execution.

EncryptedContent string

Opaque encrypted content.

maxLength10485760

Type EncryptedContent

The type of the input item. Always encrypted_content.

Recipient string

The destination agent identity.

Type AgentMessage

The item type. Always agent_message.

ID stringOptional

The unique ID of this agent message item.

Agent BetaResponseInputItemAgentMessageAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

type BetaResponseInputItemMultiAgentCall struct{…}

Action string

The multi-agent action that was executed.

One of the following:

const BetaResponseInputItemMultiAgentCallActionSpawnAgent BetaResponseInputItemMultiAgentCallAction = "spawn_agent"

const BetaResponseInputItemMultiAgentCallActionInterruptAgent BetaResponseInputItemMultiAgentCallAction = "interrupt_agent"

const BetaResponseInputItemMultiAgentCallActionListAgents BetaResponseInputItemMultiAgentCallAction = "list_agents"

const BetaResponseInputItemMultiAgentCallActionSendMessage BetaResponseInputItemMultiAgentCallAction = "send_message"

const BetaResponseInputItemMultiAgentCallActionFollowupTask BetaResponseInputItemMultiAgentCallAction = "followup_task"

const BetaResponseInputItemMultiAgentCallActionWaitAgent BetaResponseInputItemMultiAgentCallAction = "wait_agent"

Arguments string

The action arguments as a JSON string.

CallID string

The unique ID linking this call to its output.

maxLength64

minLength1

Type MultiAgentCall

The item type. Always multi_agent_call.

ID stringOptional

The unique ID of this multi-agent call.

Agent BetaResponseInputItemMultiAgentCallAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

type BetaResponseInputItemMultiAgentCallOutput struct{…}

Action string

The multi-agent action that produced this result.

One of the following:

const BetaResponseInputItemMultiAgentCallOutputActionSpawnAgent BetaResponseInputItemMultiAgentCallOutputAction = "spawn_agent"

const BetaResponseInputItemMultiAgentCallOutputActionInterruptAgent BetaResponseInputItemMultiAgentCallOutputAction = "interrupt_agent"

const BetaResponseInputItemMultiAgentCallOutputActionListAgents BetaResponseInputItemMultiAgentCallOutputAction = "list_agents"

const BetaResponseInputItemMultiAgentCallOutputActionSendMessage BetaResponseInputItemMultiAgentCallOutputAction = "send_message"

const BetaResponseInputItemMultiAgentCallOutputActionFollowupTask BetaResponseInputItemMultiAgentCallOutputAction = "followup_task"

const BetaResponseInputItemMultiAgentCallOutputActionWaitAgent BetaResponseInputItemMultiAgentCallOutputAction = "wait_agent"

CallID string

The unique ID of the multi-agent call.

maxLength64

minLength1

Output []BetaResponseInputItemMultiAgentCallOutputOutput

Text output returned by the multi-agent action.

Text string

The text content.

maxLength10485760

Type OutputText

The content type. Always output_text.

Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnionOptional

Citations associated with the text content.

One of the following:

type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}

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.

minimum0

Type FileCitation

The citation type. Always file_citation.

type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}

EndIndex int64

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

minimum0

StartIndex int64

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

minimum0

Title string

The title of the cited resource.

Type URLCitation

The citation type. Always url_citation.

URL string

The URL of the cited resource.

formaturi

type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}

ContainerID string

The ID of the container.

EndIndex int64

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

minimum0

FileID string

The ID of the container file.

Filename string

The filename of the container file cited.

StartIndex int64

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

minimum0

Type ContainerFileCitation

The citation type. Always container_file_citation.

Type MultiAgentCallOutput

The item type. Always multi_agent_call_output.

ID stringOptional

The unique ID of this multi-agent call output.

Agent BetaResponseInputItemMultiAgentCallOutputAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

type BetaResponseInputItemToolSearchCall struct{…}

Arguments any

The arguments supplied to the tool search call.

Type ToolSearchCall

The item type. Always tool_search_call.

ID stringOptional

The unique ID of this tool search call.

Agent BetaResponseInputItemToolSearchCallAgentOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

CallID stringOptional

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

maxLength64

minLength1

Execution stringOptional

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

One of the following:

const BetaResponseInputItemToolSearchCallExecutionServer BetaResponseInputItemToolSearchCallExecution = "server"

const BetaResponseInputItemToolSearchCallExecutionClient BetaResponseInputItemToolSearchCallExecution = "client"

Status stringOptional

The status of the tool search call.

One of the following:

const BetaResponseInputItemToolSearchCallStatusInProgress BetaResponseInputItemToolSearchCallStatus = "in_progress"

const BetaResponseInputItemToolSearchCallStatusCompleted BetaResponseInputItemToolSearchCallStatus = "completed"

const BetaResponseInputItemToolSearchCallStatusIncomplete BetaResponseInputItemToolSearchCallStatus = "incomplete"

type BetaResponseToolSearchOutputItemParamResp struct{…}

Tools []BetaToolUnion

The loaded tool definitions returned by the tool search output.

One of the following:

type BetaFunctionTool 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 strict parameter validation is enforced for this function tool.

Type Function

The type of the function tool. Always function.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaFunctionToolAllowedCallerDirect BetaFunctionToolAllowedCaller = "direct"

const BetaFunctionToolAllowedCallerProgrammatic BetaFunctionToolAllowedCaller = "programmatic"

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.

OutputSchema map[string, any]Optional

A JSON schema object describing the JSON value encoded in string outputs for this function.

type BetaFileSearchTool 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 BetaFileSearchToolFiltersUnionOptional

A filter to apply.

One of the following:

type BetaFileSearchToolFiltersComparisonFilter 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 string

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

One of the following:

const BetaFileSearchToolFiltersComparisonFilterTypeEq BetaFileSearchToolFiltersComparisonFilterType = "eq"

const BetaFileSearchToolFiltersComparisonFilterTypeNe BetaFileSearchToolFiltersComparisonFilterType = "ne"

const BetaFileSearchToolFiltersComparisonFilterTypeGt BetaFileSearchToolFiltersComparisonFilterType = "gt"

const BetaFileSearchToolFiltersComparisonFilterTypeGte BetaFileSearchToolFiltersComparisonFilterType = "gte"

const BetaFileSearchToolFiltersComparisonFilterTypeLt BetaFileSearchToolFiltersComparisonFilterType = "lt"

const BetaFileSearchToolFiltersComparisonFilterTypeLte BetaFileSearchToolFiltersComparisonFilterType = "lte"

const BetaFileSearchToolFiltersComparisonFilterTypeIn BetaFileSearchToolFiltersComparisonFilterType = "in"

const BetaFileSearchToolFiltersComparisonFilterTypeNin BetaFileSearchToolFiltersComparisonFilterType = "nin"

Value BetaFileSearchToolFiltersComparisonFilterValueUnion

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

One of the following:

string

float64

bool

type BetaFileSearchToolFiltersComparisonFilterValueArray []BetaFileSearchToolFiltersComparisonFilterValueArrayItemUnion

One of the following:

string

float64

type BetaFileSearchToolFiltersCompoundFilter struct{…}

Combine multiple filters using and or or.

Filters []BetaFileSearchToolFiltersCompoundFilterFilter

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

One of the following:

type BetaFileSearchToolFiltersCompoundFilterFilter 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 string

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

One of the following:

const BetaFileSearchToolFiltersCompoundFilterFilterTypeEq BetaFileSearchToolFiltersCompoundFilterFilterType = "eq"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeNe BetaFileSearchToolFiltersCompoundFilterFilterType = "ne"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeGt BetaFileSearchToolFiltersCompoundFilterFilterType = "gt"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeGte BetaFileSearchToolFiltersCompoundFilterFilterType = "gte"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeLt BetaFileSearchToolFiltersCompoundFilterFilterType = "lt"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeLte BetaFileSearchToolFiltersCompoundFilterFilterType = "lte"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeIn BetaFileSearchToolFiltersCompoundFilterFilterType = "in"

const BetaFileSearchToolFiltersCompoundFilterFilterTypeNin BetaFileSearchToolFiltersCompoundFilterFilterType = "nin"

Value BetaFileSearchToolFiltersCompoundFilterFilterValueUnion

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

One of the following:

string

float64

bool

type BetaFileSearchToolFiltersCompoundFilterFilterValueArray []BetaFileSearchToolFiltersCompoundFilterFilterValueArrayItemUnion

One of the following:

string

float64

Type string

Type of operation: and or or.

One of the following:

const BetaFileSearchToolFiltersCompoundFilterTypeAnd BetaFileSearchToolFiltersCompoundFilterType = "and"

const BetaFileSearchToolFiltersCompoundFilterTypeOr BetaFileSearchToolFiltersCompoundFilterType = "or"

MaxNumResults int64Optional

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

RankingOptions BetaFileSearchToolRankingOptionsOptional

Ranking options for search.

HybridSearch BetaFileSearchToolRankingOptionsHybridSearchOptional

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.

One of the following:

const BetaFileSearchToolRankingOptionsRankerAuto BetaFileSearchToolRankingOptionsRanker = "auto"

const BetaFileSearchToolRankingOptionsRankerDefault2024_11_15 BetaFileSearchToolRankingOptionsRanker = "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 BetaComputerTool 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 BetaComputerUsePreviewTool 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 BetaComputerUsePreviewToolEnvironment

The type of computer environment to control.

One of the following:

const BetaComputerUsePreviewToolEnvironmentWindows BetaComputerUsePreviewToolEnvironment = "windows"

const BetaComputerUsePreviewToolEnvironmentMac BetaComputerUsePreviewToolEnvironment = "mac"

const BetaComputerUsePreviewToolEnvironmentLinux BetaComputerUsePreviewToolEnvironment = "linux"

const BetaComputerUsePreviewToolEnvironmentUbuntu BetaComputerUsePreviewToolEnvironment = "ubuntu"

const BetaComputerUsePreviewToolEnvironmentBrowser BetaComputerUsePreviewToolEnvironment = "browser"

Type ComputerUsePreview

The type of the computer use tool. Always computer_use_preview.

type BetaWebSearchTool struct{…}

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

Type BetaWebSearchToolType

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

One of the following:

const BetaWebSearchToolTypeWebSearch BetaWebSearchToolType = "web_search"

const BetaWebSearchToolTypeWebSearch2025_08_26 BetaWebSearchToolType = "web_search_2025_08_26"

Filters BetaWebSearchToolFiltersOptional

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 BetaWebSearchToolSearchContextSizeOptional

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.

One of the following:

const BetaWebSearchToolSearchContextSizeLow BetaWebSearchToolSearchContextSize = "low"

const BetaWebSearchToolSearchContextSizeMedium BetaWebSearchToolSearchContextSize = "medium"

const BetaWebSearchToolSearchContextSizeHigh BetaWebSearchToolSearchContextSize = "high"

UserLocation BetaWebSearchToolUserLocationOptional

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 BetaToolMcp 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.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaToolMcpAllowedCallerDirect BetaToolMcpAllowedCaller = "direct"

const BetaToolMcpAllowedCallerProgrammatic BetaToolMcpAllowedCaller = "programmatic"

AllowedTools BetaToolMcpAllowedToolsUnionOptional

List of allowed tool names or a filter object.

One of the following:

type BetaToolMcpAllowedToolsMcpAllowedTools []string

A string array of allowed tool names

type BetaToolMcpAllowedToolsMcpToolFilter 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, connector_id, or tunnel_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

One of the following:

const BetaToolMcpConnectorIDConnectorDropbox BetaToolMcpConnectorID = "connector_dropbox"

const BetaToolMcpConnectorIDConnectorGmail BetaToolMcpConnectorID = "connector_gmail"

const BetaToolMcpConnectorIDConnectorGooglecalendar BetaToolMcpConnectorID = "connector_googlecalendar"

const BetaToolMcpConnectorIDConnectorGoogledrive BetaToolMcpConnectorID = "connector_googledrive"

const BetaToolMcpConnectorIDConnectorMicrosoftteams BetaToolMcpConnectorID = "connector_microsoftteams"

const BetaToolMcpConnectorIDConnectorOutlookcalendar BetaToolMcpConnectorID = "connector_outlookcalendar"

const BetaToolMcpConnectorIDConnectorOutlookemail BetaToolMcpConnectorID = "connector_outlookemail"

const BetaToolMcpConnectorIDConnectorSharepoint BetaToolMcpConnectorID = "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 BetaToolMcpRequireApprovalUnionOptional

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

One of the following:

type BetaToolMcpRequireApprovalMcpToolApprovalFilter 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 BetaToolMcpRequireApprovalMcpToolApprovalFilterAlwaysOptional

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 BetaToolMcpRequireApprovalMcpToolApprovalFilterNeverOptional

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 BetaToolMcpRequireApprovalMcpToolApprovalSetting 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.

One of the following:

const BetaToolMcpRequireApprovalMcpToolApprovalSettingAlways BetaToolMcpRequireApprovalMcpToolApprovalSetting = "always"

const BetaToolMcpRequireApprovalMcpToolApprovalSettingNever BetaToolMcpRequireApprovalMcpToolApprovalSetting = "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, connector_id, or tunnel_id must be provided.

formaturi

TunnelID stringOptional

The Secure MCP Tunnel ID to use instead of a direct server URL. One of server_url, connector_id, or tunnel_id must be provided.

type BetaToolCodeInterpreter struct{…}

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

Container BetaToolCodeInterpreterContainerUnion

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.

One of the following:

string

type BetaToolCodeInterpreterContainerCodeInterpreterToolAuto 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.

One of the following:

const BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit1g BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "1g"

const BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit4g BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "4g"

const BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit16g BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "16g"

const BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit64g BetaToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "64g"

NetworkPolicy BetaToolCodeInterpreterContainerCodeInterpreterToolAutoNetworkPolicyUnionOptional

Network access policy for the container.

One of the following:

type BetaContainerNetworkPolicyDisabled struct{…}

Type Disabled

Disable outbound network access. Always disabled.

type BetaContainerNetworkPolicyAllowlist 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 []BetaContainerNetworkPolicyDomainSecretOptional

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.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaToolCodeInterpreterAllowedCallerDirect BetaToolCodeInterpreterAllowedCaller = "direct"

const BetaToolCodeInterpreterAllowedCallerProgrammatic BetaToolCodeInterpreterAllowedCaller = "programmatic"

type BetaToolProgrammaticToolCalling struct{…}

Type ProgrammaticToolCalling

The type of the tool. Always programmatic_tool_calling.

type BetaToolImageGeneration 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.

One of the following:

const BetaToolImageGenerationActionGenerate BetaToolImageGenerationAction = "generate"

const BetaToolImageGenerationActionEdit BetaToolImageGenerationAction = "edit"

const BetaToolImageGenerationActionAuto BetaToolImageGenerationAction = "auto"

Background stringOptional

Allows to set transparency for the background of the generated image(s). This parameter is only supported for GPT image models that support transparent backgrounds. Must be one of transparent, opaque, or auto (default value). When auto is used, the model will automatically determine the best background for the image.

gpt-image-2 and gpt-image-2-2026-04-21 do not support transparent backgrounds. Requests with background set to transparent will return an error for these models; use opaque or auto instead.

If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

One of the following:

const BetaToolImageGenerationBackgroundTransparent BetaToolImageGenerationBackground = "transparent"

const BetaToolImageGenerationBackgroundOpaque BetaToolImageGenerationBackground = "opaque"

const BetaToolImageGenerationBackgroundAuto BetaToolImageGenerationBackground = "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.

One of the following:

const BetaToolImageGenerationInputFidelityHigh BetaToolImageGenerationInputFidelity = "high"

const BetaToolImageGenerationInputFidelityLow BetaToolImageGenerationInputFidelity = "low"

InputImageMask BetaToolImageGenerationInputImageMaskOptional

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.

One of the following:

string

One of the following:

const BetaToolImageGenerationModelGPTImage1 BetaToolImageGenerationModel = "gpt-image-1"

const BetaToolImageGenerationModelGPTImage1Mini BetaToolImageGenerationModel = "gpt-image-1-mini"

const BetaToolImageGenerationModelGPTImage2 BetaToolImageGenerationModel = "gpt-image-2"

const BetaToolImageGenerationModelGPTImage2_2026_04_21 BetaToolImageGenerationModel = "gpt-image-2-2026-04-21"

const BetaToolImageGenerationModelGPTImage1_5 BetaToolImageGenerationModel = "gpt-image-1.5"

const BetaToolImageGenerationModelChatgptImageLatest BetaToolImageGenerationModel = "chatgpt-image-latest"

Moderation stringOptional

Moderation level for the generated image. Default: auto.

One of the following:

const BetaToolImageGenerationModerationAuto BetaToolImageGenerationModeration = "auto"

const BetaToolImageGenerationModerationLow BetaToolImageGenerationModeration = "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.

One of the following:

const BetaToolImageGenerationOutputFormatPNG BetaToolImageGenerationOutputFormat = "png"

const BetaToolImageGenerationOutputFormatWebP BetaToolImageGenerationOutputFormat = "webp"

const BetaToolImageGenerationOutputFormatJPEG BetaToolImageGenerationOutputFormat = "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.

One of the following:

const BetaToolImageGenerationQualityLow BetaToolImageGenerationQuality = "low"

const BetaToolImageGenerationQualityMedium BetaToolImageGenerationQuality = "medium"

const BetaToolImageGenerationQualityHigh BetaToolImageGenerationQuality = "high"

const BetaToolImageGenerationQualityAuto BetaToolImageGenerationQuality = "auto"

Size stringOptional

The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

One of the following:

string

One of the following:

const BetaToolImageGenerationSize1024x1024 BetaToolImageGenerationSize = "1024x1024"

const BetaToolImageGenerationSize1024x1536 BetaToolImageGenerationSize = "1024x1536"

const BetaToolImageGenerationSize1536x1024 BetaToolImageGenerationSize = "1536x1024"

const BetaToolImageGenerationSizeAuto BetaToolImageGenerationSize = "auto"

type BetaToolLocalShell 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 BetaFunctionShellTool struct{…}

A tool that allows the model to execute shell commands.

Type Shell

The type of the shell tool. Always shell.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaFunctionShellToolAllowedCallerDirect BetaFunctionShellToolAllowedCaller = "direct"

const BetaFunctionShellToolAllowedCallerProgrammatic BetaFunctionShellToolAllowedCaller = "programmatic"

Environment BetaFunctionShellToolEnvironmentUnionOptional

One of the following:

type BetaContainerAuto 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 BetaContainerAutoMemoryLimitOptional

The memory limit for the container.

One of the following:

const BetaContainerAutoMemoryLimit1g BetaContainerAutoMemoryLimit = "1g"

const BetaContainerAutoMemoryLimit4g BetaContainerAutoMemoryLimit = "4g"

const BetaContainerAutoMemoryLimit16g BetaContainerAutoMemoryLimit = "16g"

const BetaContainerAutoMemoryLimit64g BetaContainerAutoMemoryLimit = "64g"

NetworkPolicy BetaContainerAutoNetworkPolicyUnionOptional

Network access policy for the container.

One of the following:

type BetaContainerNetworkPolicyDisabled struct{…}

Type Disabled

Disable outbound network access. Always disabled.

type BetaContainerNetworkPolicyAllowlist 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 []BetaContainerNetworkPolicyDomainSecretOptional

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 []BetaContainerAutoSkillUnionOptional

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

One of the following:

type BetaSkillReference 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 BetaInlineSkill struct{…}

Description string

The description of the skill.

Name string

The name of the skill.

Source BetaInlineSkillSource

Inline skill payload

Data string

Base64-encoded skill zip bundle.

maxLength70254592

minLength1

MediaType ApplicationZip

The media type of the inline skill payload. Must be application/zip.

Type Base64

The type of the inline skill source. Must be base64.

Type Inline

Defines an inline skill for this request.

type BetaLocalEnvironment struct{…}

Type Local

Use a local computer environment.

Skills []BetaLocalSkillOptional

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 BetaContainerReference struct{…}

ContainerID string

The ID of the referenced container.

Type ContainerReference

References a container created with the /v1/containers endpoint

type BetaCustomTool 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.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaCustomToolAllowedCallerDirect BetaCustomToolAllowedCaller = "direct"

const BetaCustomToolAllowedCallerProgrammatic BetaCustomToolAllowedCaller = "programmatic"

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 BetaCustomToolFormatUnionOptional

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

One of the following:

type BetaCustomToolFormatText struct{…}

Unconstrained free-form text.

Type Text

Unconstrained text format. Always text.

type BetaCustomToolFormatGrammar struct{…}

A grammar defined by the user.

Definition string

The grammar definition.

Syntax string

The syntax of the grammar definition. One of lark or regex.

One of the following:

const BetaCustomToolFormatGrammarSyntaxLark BetaCustomToolFormatGrammarSyntax = "lark"

const BetaCustomToolFormatGrammarSyntaxRegex BetaCustomToolFormatGrammarSyntax = "regex"

Type Grammar

Grammar format. Always grammar.

type BetaNamespaceTool 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 []BetaNamespaceToolToolUnion

The function/custom tools available inside this namespace.

One of the following:

type BetaNamespaceToolToolFunction struct{…}

Name string

maxLength128

minLength1

Type Function

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaNamespaceToolToolFunctionAllowedCallerDirect BetaNamespaceToolToolFunctionAllowedCaller = "direct"

const BetaNamespaceToolToolFunctionAllowedCallerProgrammatic BetaNamespaceToolToolFunctionAllowedCaller = "programmatic"

DeferLoading boolOptional

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

Description stringOptional

OutputSchema map[string, any]Optional

A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.

Parameters anyOptional

Strict boolOptional

Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

type BetaCustomTool 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.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaCustomToolAllowedCallerDirect BetaCustomToolAllowedCaller = "direct"

const BetaCustomToolAllowedCallerProgrammatic BetaCustomToolAllowedCaller = "programmatic"

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 BetaCustomToolFormatUnionOptional

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

One of the following:

type BetaCustomToolFormatText struct{…}

Unconstrained free-form text.

Type Text

Unconstrained text format. Always text.

type BetaCustomToolFormatGrammar struct{…}

A grammar defined by the user.

Definition string

The grammar definition.

Syntax string

The syntax of the grammar definition. One of lark or regex.

One of the following:

const BetaCustomToolFormatGrammarSyntaxLark BetaCustomToolFormatGrammarSyntax = "lark"

const BetaCustomToolFormatGrammarSyntaxRegex BetaCustomToolFormatGrammarSyntax = "regex"

Type Grammar

Grammar format. Always grammar.

Type Namespace

The type of the tool. Always namespace.

type BetaToolSearchTool 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 BetaToolSearchToolExecutionOptional

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

One of the following:

const BetaToolSearchToolExecutionServer BetaToolSearchToolExecution = "server"

const BetaToolSearchToolExecutionClient BetaToolSearchToolExecution = "client"

Parameters anyOptional

Parameter schema for a client-executed tool search tool.

type BetaWebSearchPreviewTool struct{…}

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

Type BetaWebSearchPreviewToolType

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

One of the following:

const BetaWebSearchPreviewToolTypeWebSearchPreview BetaWebSearchPreviewToolType = "web_search_preview"

const BetaWebSearchPreviewToolTypeWebSearchPreview2025_03_11 BetaWebSearchPreviewToolType = "web_search_preview_2025_03_11"

SearchContentTypes []stringOptional

One of the following:

const BetaWebSearchPreviewToolSearchContentTypeText BetaWebSearchPreviewToolSearchContentType = "text"

const BetaWebSearchPreviewToolSearchContentTypeImage BetaWebSearchPreviewToolSearchContentType = "image"

SearchContextSize BetaWebSearchPreviewToolSearchContextSizeOptional

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.

One of the following:

const BetaWebSearchPreviewToolSearchContextSizeLow BetaWebSearchPreviewToolSearchContextSize = "low"

const BetaWebSearchPreviewToolSearchContextSizeMedium BetaWebSearchPreviewToolSearchContextSize = "medium"

const BetaWebSearchPreviewToolSearchContextSizeHigh BetaWebSearchPreviewToolSearchContextSize = "high"

UserLocation BetaWebSearchPreviewToolUserLocationOptional

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 BetaApplyPatchTool struct{…}

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

Type ApplyPatch

The type of the tool. Always apply_patch.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaApplyPatchToolAllowedCallerDirect BetaApplyPatchToolAllowedCaller = "direct"

const BetaApplyPatchToolAllowedCallerProgrammatic BetaApplyPatchToolAllowedCaller = "programmatic"

Type ToolSearchOutput

The item type. Always tool_search_output.

ID stringOptional

The unique ID of this tool search output.

Agent BetaResponseToolSearchOutputItemParamAgentRespOptional

The agent that produced this item.

AgentName string

The canonical name of the agent that produced this item.

CallID stringOptional

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

maxLength64

minLength1

Execution BetaResponseToolSearchOutputItemParamExecutionOptional

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

One of the following:

const BetaResponseToolSearchOutputItemParamExecutionServer BetaResponseToolSearchOutputItemParamExecution = "server"

const BetaResponseToolSearchOutputItemParamExecutionClient BetaResponseToolSearchOutputItemParamExecution = "client"

Status BetaResponseToolSearchOutputItemParamStatusOptional

The status of the tool search output.

One of the following:

const BetaResponseToolSearchOutputItemParamStatusInProgress BetaResponseToolSearchOutputItemParamStatus = "in_progress"

const BetaResponseToolSearchOutputItemParamStatusCompleted BetaResponseToolSearchOutputItemParamStatus = "completed"

const BetaResponseToolSearchOutputItemParamStatusIncomplete BetaResponseToolSearchOutputItemParamStatus = "incomplete"

type BetaResponseInputItemAdditionalTools struct{…}

Role Developer

The role that provided the additional tools. Only developer is supported.

Tools []BetaToolUnion

A list of additional tools made available at this item.

One of the following:

type BetaFunctionTool 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 strict parameter validation is enforced for this function tool.

Type Function

The type of the function tool. Always function.

AllowedCallers []stringOptional

The tool invocation context(s).

One of the following:

const BetaFunctionToolAllowedCallerDirect BetaFunctionToolAllowedCaller = "direct"

const BetaFunctionToolAllowedCallerProgrammatic BetaFunctionToolAllowedCaller = "programmatic"

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.

OutputSchema map[string, any]Optional

A JSON schema object describing the JSON value encoded in string outputs for this function.

type BetaFileSearchTool 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 BetaFileSearchToolFiltersUnionOptional

A filter to apply.

One of the following:

type BetaFileSearchToolFiltersComparisonFilter 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 string

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