go/resources/responses/methods/cancel/index.md 2026-05-18 22:01 UTC to 2026-05-19 06:34 UTC

1## Cancel a response

2 

3`client.Responses.Cancel(ctx, responseID) (*Response, error)`

4 

5**post** `/responses/{response_id}/cancel`

6 

7Cancels a model response with the given ID. Only responses created with

8the `background` parameter set to `true` can be cancelled.

9[Learn more](https://platform.openai.com/docs/guides/background).

10 

11### Parameters

12 

13- `responseID string`

14 

15### Returns

16 

17- `type Response struct{…}`

18 

19 - `ID string`

20 

21 Unique identifier for this Response.

22 

23 - `CreatedAt float64`

24 

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

26 

27 - `Error ResponseError`

28 

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

30 

31 - `Code ResponseErrorCode`

32 

33 The error code for the response.

34 

35 - `const ResponseErrorCodeServerError ResponseErrorCode = "server_error"`

36 

37 - `const ResponseErrorCodeRateLimitExceeded ResponseErrorCode = "rate_limit_exceeded"`

38 

39 - `const ResponseErrorCodeInvalidPrompt ResponseErrorCode = "invalid_prompt"`

40 

41 - `const ResponseErrorCodeVectorStoreTimeout ResponseErrorCode = "vector_store_timeout"`

42 

43 - `const ResponseErrorCodeInvalidImage ResponseErrorCode = "invalid_image"`

44 

45 - `const ResponseErrorCodeInvalidImageFormat ResponseErrorCode = "invalid_image_format"`

46 

47 - `const ResponseErrorCodeInvalidBase64Image ResponseErrorCode = "invalid_base64_image"`

48 

49 - `const ResponseErrorCodeInvalidImageURL ResponseErrorCode = "invalid_image_url"`

50 

51 - `const ResponseErrorCodeImageTooLarge ResponseErrorCode = "image_too_large"`

52 

53 - `const ResponseErrorCodeImageTooSmall ResponseErrorCode = "image_too_small"`

54 

55 - `const ResponseErrorCodeImageParseError ResponseErrorCode = "image_parse_error"`

56 

57 - `const ResponseErrorCodeImageContentPolicyViolation ResponseErrorCode = "image_content_policy_violation"`

58 

59 - `const ResponseErrorCodeInvalidImageMode ResponseErrorCode = "invalid_image_mode"`

60 

61 - `const ResponseErrorCodeImageFileTooLarge ResponseErrorCode = "image_file_too_large"`

62 

63 - `const ResponseErrorCodeUnsupportedImageMediaType ResponseErrorCode = "unsupported_image_media_type"`

64 

65 - `const ResponseErrorCodeEmptyImageFile ResponseErrorCode = "empty_image_file"`

66 

67 - `const ResponseErrorCodeFailedToDownloadImage ResponseErrorCode = "failed_to_download_image"`

68 

69 - `const ResponseErrorCodeImageFileNotFound ResponseErrorCode = "image_file_not_found"`

70 

71 - `Message string`

72 

73 A human-readable description of the error.

74 

75 - `IncompleteDetails ResponseIncompleteDetails`

76 

77 Details about why the response is incomplete.

78 

79 - `Reason string`

80 

81 The reason why the response is incomplete.

82 

83 - `const ResponseIncompleteDetailsReasonMaxOutputTokens ResponseIncompleteDetailsReason = "max_output_tokens"`

84 

85 - `const ResponseIncompleteDetailsReasonContentFilter ResponseIncompleteDetailsReason = "content_filter"`

86 

87 - `Instructions ResponseInstructionsUnion`

88 

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

90 

91 When using along with `previous_response_id`, the instructions from a previous

92 response will not be carried over to the next response. This makes it simple

93 to swap out system (or developer) messages in new responses.

94 

95 - `string`

96 

97 - `type ResponseInstructionsInputItemList []ResponseInputItemUnion`

98 

99 A list of one or many input items to the model, containing

100 different content types.

101 

102 - `type EasyInputMessage struct{…}`

103 

104 A message input to the model with a role indicating instruction following

105 hierarchy. Instructions given with the `developer` or `system` role take

106 precedence over instructions given with the `user` role. Messages with the

107 `assistant` role are presumed to have been generated by the model in previous

108 interactions.

109 

110 - `Content EasyInputMessageContentUnion`

111 

112 Text, image, or audio input to the model, used to generate a response.

113 Can also contain previous assistant responses.

114 

115 - `string`

116 

117 - `type ResponseInputMessageContentList []ResponseInputContentUnion`

118 

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

120 types.

121 

122 - `type ResponseInputText struct{…}`

123 

124 A text input to the model.

125 

126 - `Text string`

127 

128 The text input to the model.

129 

130 - `Type InputText`

131 

132 The type of the input item. Always `input_text`.

133 

134 - `const InputTextInputText InputText = "input_text"`

135 

136 - `type ResponseInputImage struct{…}`

137 

138 An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).

139 

140 - `Detail ResponseInputImageDetail`

141 

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

143 

144 - `const ResponseInputImageDetailLow ResponseInputImageDetail = "low"`

145 

146 - `const ResponseInputImageDetailHigh ResponseInputImageDetail = "high"`

147 

148 - `const ResponseInputImageDetailAuto ResponseInputImageDetail = "auto"`

149 

150 - `const ResponseInputImageDetailOriginal ResponseInputImageDetail = "original"`

151 

152 - `Type InputImage`

153 

154 The type of the input item. Always `input_image`.

155 

156 - `const InputImageInputImage InputImage = "input_image"`

157 

158 - `FileID string`

159 

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

161 

162 - `ImageURL string`

163 

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

165 

166 - `type ResponseInputFile struct{…}`

167 

168 A file input to the model.

169 

170 - `Type InputFile`

171 

172 The type of the input item. Always `input_file`.

173 

174 - `const InputFileInputFile InputFile = "input_file"`

175 

176 - `Detail ResponseInputFileDetail`

177 

178 The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`.

179 

180 - `const ResponseInputFileDetailLow ResponseInputFileDetail = "low"`

181 

182 - `const ResponseInputFileDetailHigh ResponseInputFileDetail = "high"`

183 

184 - `FileData string`

185 

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

187 

188 - `FileID string`

189 

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

191 

192 - `FileURL string`

193 

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

195 

196 - `Filename string`

197 

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

199 

200 - `Role EasyInputMessageRole`

201 

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

203 `developer`.

204 

205 - `const EasyInputMessageRoleUser EasyInputMessageRole = "user"`

206 

207 - `const EasyInputMessageRoleAssistant EasyInputMessageRole = "assistant"`

208 

209 - `const EasyInputMessageRoleSystem EasyInputMessageRole = "system"`

210 

211 - `const EasyInputMessageRoleDeveloper EasyInputMessageRole = "developer"`

212 

213 - `Phase EasyInputMessagePhase`

214 

215 Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).

216 For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend

217 phase on all assistant messages — dropping it can degrade performance. Not used for user messages.

218 

219 - `const EasyInputMessagePhaseCommentary EasyInputMessagePhase = "commentary"`

220 

221 - `const EasyInputMessagePhaseFinalAnswer EasyInputMessagePhase = "final_answer"`

222 

223 - `Type EasyInputMessageType`

224 

225 The type of the message input. Always `message`.

226 

227 - `const EasyInputMessageTypeMessage EasyInputMessageType = "message"`

228 

229 - `type ResponseInputItemMessage struct{…}`

230 

231 A message input to the model with a role indicating instruction following

232 hierarchy. Instructions given with the `developer` or `system` role take

233 precedence over instructions given with the `user` role.

234 

235 - `Content ResponseInputMessageContentList`

236 

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

238 types.

239 

240 - `Role string`

241 

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

243 

244 - `const ResponseInputItemMessageRoleUser ResponseInputItemMessageRole = "user"`

245 

246 - `const ResponseInputItemMessageRoleSystem ResponseInputItemMessageRole = "system"`

247 

248 - `const ResponseInputItemMessageRoleDeveloper ResponseInputItemMessageRole = "developer"`

249 

250 - `Status string`

251 

252 The status of item. One of `in_progress`, `completed`, or

253 `incomplete`. Populated when items are returned via API.

254 

255 - `const ResponseInputItemMessageStatusInProgress ResponseInputItemMessageStatus = "in_progress"`

256 

257 - `const ResponseInputItemMessageStatusCompleted ResponseInputItemMessageStatus = "completed"`

258 

259 - `const ResponseInputItemMessageStatusIncomplete ResponseInputItemMessageStatus = "incomplete"`

260 

261 - `Type string`

262 

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

264 

265 - `const ResponseInputItemMessageTypeMessage ResponseInputItemMessageType = "message"`

266 

267 - `type ResponseOutputMessage struct{…}`

268 

269 An output message from the model.

270 

271 - `ID string`

272 

273 The unique ID of the output message.

274 

275 - `Content []ResponseOutputMessageContentUnion`

276 

277 The content of the output message.

278 

279 - `type ResponseOutputText struct{…}`

280 

281 A text output from the model.

282 

283 - `Annotations []ResponseOutputTextAnnotationUnion`

284 

285 The annotations of the text output.

286 

287 - `type ResponseOutputTextAnnotationFileCitation struct{…}`

288 

289 A citation to a file.

290 

291 - `FileID string`

292 

293 The ID of the file.

294 

295 - `Filename string`

296 

297 The filename of the file cited.

298 

299 - `Index int64`

300 

301 The index of the file in the list of files.

302 

303 - `Type FileCitation`

304 

305 The type of the file citation. Always `file_citation`.

306 

307 - `const FileCitationFileCitation FileCitation = "file_citation"`

308 

309 - `type ResponseOutputTextAnnotationURLCitation struct{…}`

310 

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

312 

313 - `EndIndex int64`

314 

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

316 

317 - `StartIndex int64`

318 

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

320 

321 - `Title string`

322 

323 The title of the web resource.

324 

325 - `Type URLCitation`

326 

327 The type of the URL citation. Always `url_citation`.

328 

329 - `const URLCitationURLCitation URLCitation = "url_citation"`

330 

331 - `URL string`

332 

333 The URL of the web resource.

334 

335 - `type ResponseOutputTextAnnotationContainerFileCitation struct{…}`

336 

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

338 

339 - `ContainerID string`

340 

341 The ID of the container file.

342 

343 - `EndIndex int64`

344 

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

346 

347 - `FileID string`

348 

349 The ID of the file.

350 

351 - `Filename string`

352 

353 The filename of the container file cited.

354 

355 - `StartIndex int64`

356 

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

358 

359 - `Type ContainerFileCitation`

360 

361 The type of the container file citation. Always `container_file_citation`.

362 

363 - `const ContainerFileCitationContainerFileCitation ContainerFileCitation = "container_file_citation"`

364 

365 - `type ResponseOutputTextAnnotationFilePath struct{…}`

366 

367 A path to a file.

368 

369 - `FileID string`

370 

371 The ID of the file.

372 

373 - `Index int64`

374 

375 The index of the file in the list of files.

376 

377 - `Type FilePath`

378 

379 The type of the file path. Always `file_path`.

380 

381 - `const FilePathFilePath FilePath = "file_path"`

382 

383 - `Text string`

384 

385 The text output from the model.

386 

387 - `Type OutputText`

388 

389 The type of the output text. Always `output_text`.

390 

391 - `const OutputTextOutputText OutputText = "output_text"`

392 

393 - `Logprobs []ResponseOutputTextLogprob`

394 

395 - `Token string`

396 

397 - `Bytes []int64`

398 

399 - `Logprob float64`

400 

401 - `TopLogprobs []ResponseOutputTextLogprobTopLogprob`

402 

403 - `Token string`

404 

405 - `Bytes []int64`

406 

407 - `Logprob float64`

408 

409 - `type ResponseOutputRefusal struct{…}`

410 

411 A refusal from the model.

412 

413 - `Refusal string`

414 

415 The refusal explanation from the model.

416 

417 - `Type Refusal`

418 

419 The type of the refusal. Always `refusal`.

420 

421 - `const RefusalRefusal Refusal = "refusal"`

422 

423 - `Role Assistant`

424 

425 The role of the output message. Always `assistant`.

426 

427 - `const AssistantAssistant Assistant = "assistant"`

428 

429 - `Status ResponseOutputMessageStatus`

430 

431 The status of the message input. One of `in_progress`, `completed`, or

432 `incomplete`. Populated when input items are returned via API.

433 

434 - `const ResponseOutputMessageStatusInProgress ResponseOutputMessageStatus = "in_progress"`

435 

436 - `const ResponseOutputMessageStatusCompleted ResponseOutputMessageStatus = "completed"`

437 

438 - `const ResponseOutputMessageStatusIncomplete ResponseOutputMessageStatus = "incomplete"`

439 

440 - `Type Message`

441 

442 The type of the output message. Always `message`.

443 

444 - `const MessageMessage Message = "message"`

445 

446 - `Phase ResponseOutputMessagePhase`

447 

448 Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).

449 For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend

450 phase on all assistant messages — dropping it can degrade performance. Not used for user messages.

451 

452 - `const ResponseOutputMessagePhaseCommentary ResponseOutputMessagePhase = "commentary"`

453 

454 - `const ResponseOutputMessagePhaseFinalAnswer ResponseOutputMessagePhase = "final_answer"`

455 

456 - `type ResponseFileSearchToolCall struct{…}`

457 

458 The results of a file search tool call. See the

459 [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information.

460 

461 - `ID string`

462 

463 The unique ID of the file search tool call.

464 

465 - `Queries []string`

466 

467 The queries used to search for files.

468 

469 - `Status ResponseFileSearchToolCallStatus`

470 

471 The status of the file search tool call. One of `in_progress`,

472 `searching`, `incomplete` or `failed`,

473 

474 - `const ResponseFileSearchToolCallStatusInProgress ResponseFileSearchToolCallStatus = "in_progress"`

475 

476 - `const ResponseFileSearchToolCallStatusSearching ResponseFileSearchToolCallStatus = "searching"`

477 

478 - `const ResponseFileSearchToolCallStatusCompleted ResponseFileSearchToolCallStatus = "completed"`

479 

480 - `const ResponseFileSearchToolCallStatusIncomplete ResponseFileSearchToolCallStatus = "incomplete"`

481 

482 - `const ResponseFileSearchToolCallStatusFailed ResponseFileSearchToolCallStatus = "failed"`

483 

484 - `Type FileSearchCall`

485 

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

487 

488 - `const FileSearchCallFileSearchCall FileSearchCall = "file_search_call"`

489 

490 - `Results []ResponseFileSearchToolCallResult`

491 

492 The results of the file search tool call.

493 

494 - `Attributes map[string, ResponseFileSearchToolCallResultAttributeUnion]`

495 

496 Set of 16 key-value pairs that can be attached to an object. This can be

497 useful for storing additional information about the object in a structured

498 format, and querying for objects via API or the dashboard. Keys are strings

499 with a maximum length of 64 characters. Values are strings with a maximum

500 length of 512 characters, booleans, or numbers.

501 

502 - `string`

503 

504 - `float64`

505 

506 - `bool`

507 

508 - `FileID string`

509 

510 The unique ID of the file.

511 

512 - `Filename string`

513 

514 The name of the file.

515 

516 - `Score float64`

517 

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

519 

520 - `Text string`

521 

522 The text that was retrieved from the file.

523 

524 - `type ResponseComputerToolCall struct{…}`

525 

526 A tool call to a computer use tool. See the

527 [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information.

528 

529 - `ID string`

530 

531 The unique ID of the computer call.

532 

533 - `CallID string`

534 

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

536 

537 - `PendingSafetyChecks []ResponseComputerToolCallPendingSafetyCheck`

538 

539 The pending safety checks for the computer call.

540 

541 - `ID string`

542 

543 The ID of the pending safety check.

544 

545 - `Code string`

546 

547 The type of the pending safety check.

548 

549 - `Message string`

550 

551 Details about the pending safety check.

552 

553 - `Status ResponseComputerToolCallStatus`

554 

555 The status of the item. One of `in_progress`, `completed`, or

556 `incomplete`. Populated when items are returned via API.

557 

558 - `const ResponseComputerToolCallStatusInProgress ResponseComputerToolCallStatus = "in_progress"`

559 

560 - `const ResponseComputerToolCallStatusCompleted ResponseComputerToolCallStatus = "completed"`

561 

562 - `const ResponseComputerToolCallStatusIncomplete ResponseComputerToolCallStatus = "incomplete"`

563 

564 - `Type ResponseComputerToolCallType`

565 

566 The type of the computer call. Always `computer_call`.

567 

568 - `const ResponseComputerToolCallTypeComputerCall ResponseComputerToolCallType = "computer_call"`

569 

570 - `Action ResponseComputerToolCallActionUnion`

571 

572 A click action.

573 

574 - `type ResponseComputerToolCallActionClick struct{…}`

575 

576 A click action.

577 

578 - `Button string`

579 

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

581 

582 - `const ResponseComputerToolCallActionClickButtonLeft ResponseComputerToolCallActionClickButton = "left"`

583 

584 - `const ResponseComputerToolCallActionClickButtonRight ResponseComputerToolCallActionClickButton = "right"`

585 

586 - `const ResponseComputerToolCallActionClickButtonWheel ResponseComputerToolCallActionClickButton = "wheel"`

587 

588 - `const ResponseComputerToolCallActionClickButtonBack ResponseComputerToolCallActionClickButton = "back"`

589 

590 - `const ResponseComputerToolCallActionClickButtonForward ResponseComputerToolCallActionClickButton = "forward"`

591 

592 - `Type Click`

593 

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

595 

596 - `const ClickClick Click = "click"`

597 

598 - `X int64`

599 

600 The x-coordinate where the click occurred.

601 

602 - `Y int64`

603 

604 The y-coordinate where the click occurred.

605 

606 - `Keys []string`

607 

608 The keys being held while clicking.

609 

610 - `type ResponseComputerToolCallActionDoubleClick struct{…}`

611 

612 A double click action.

613 

614 - `Keys []string`

615 

616 The keys being held while double-clicking.

617 

618 - `Type DoubleClick`

619 

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

621 

622 - `const DoubleClickDoubleClick DoubleClick = "double_click"`

623 

624 - `X int64`

625 

626 The x-coordinate where the double click occurred.

627 

628 - `Y int64`

629 

630 The y-coordinate where the double click occurred.

631 

632 - `type ResponseComputerToolCallActionDrag struct{…}`

633 

634 A drag action.

635 

636 - `Path []ResponseComputerToolCallActionDragPath`

637 

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

639 

640 ```

641 [

642 { x: 100, y: 200 },

643 { x: 200, y: 300 }

644 ]

645 ```

646 

647 - `X int64`

648 

649 The x-coordinate.

650 

651 - `Y int64`

652 

653 The y-coordinate.

654 

655 - `Type Drag`

656 

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

658 

659 - `const DragDrag Drag = "drag"`

660 

661 - `Keys []string`

662 

663 The keys being held while dragging the mouse.

664 

665 - `type ResponseComputerToolCallActionKeypress struct{…}`

666 

667 A collection of keypresses the model would like to perform.

668 

669 - `Keys []string`

670 

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

672 

673 - `Type Keypress`

674 

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

676 

677 - `const KeypressKeypress Keypress = "keypress"`

678 

679 - `type ResponseComputerToolCallActionMove struct{…}`

680 

681 A mouse move action.

682 

683 - `Type Move`

684 

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

686 

687 - `const MoveMove Move = "move"`

688 

689 - `X int64`

690 

691 The x-coordinate to move to.

692 

693 - `Y int64`

694 

695 The y-coordinate to move to.

696 

697 - `Keys []string`

698 

699 The keys being held while moving the mouse.

700 

701 - `type ResponseComputerToolCallActionScreenshot struct{…}`

702 

703 A screenshot action.

704 

705 - `Type Screenshot`

706 

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

708 

709 - `const ScreenshotScreenshot Screenshot = "screenshot"`

710 

711 - `type ResponseComputerToolCallActionScroll struct{…}`

712 

713 A scroll action.

714 

715 - `ScrollX int64`

716 

717 The horizontal scroll distance.

718 

719 - `ScrollY int64`

720 

721 The vertical scroll distance.

722 

723 - `Type Scroll`

724 

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

726 

727 - `const ScrollScroll Scroll = "scroll"`

728 

729 - `X int64`

730 

731 The x-coordinate where the scroll occurred.

732 

733 - `Y int64`

734 

735 The y-coordinate where the scroll occurred.

736 

737 - `Keys []string`

738 

739 The keys being held while scrolling.

740 

741 - `type ResponseComputerToolCallActionType struct{…}`

742 

743 An action to type in text.

744 

745 - `Text string`

746 

747 The text to type.

748 

749 - `Type Type`

750 

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

752 

753 - `const TypeType Type = "type"`

754 

755 - `type ResponseComputerToolCallActionWait struct{…}`

756 

757 A wait action.

758 

759 - `Type Wait`

760 

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

762 

763 - `const WaitWait Wait = "wait"`

764 

765 - `Actions ComputerActionList`

766 

767 Flattened batched actions for `computer_use`. Each action includes an

768 `type` discriminator and action-specific fields.

769 

770 - `type ComputerActionClick struct{…}`

771 

772 A click action.

773 

774 - `Button string`

775 

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

777 

778 - `const ComputerActionClickButtonLeft ComputerActionClickButton = "left"`

779 

780 - `const ComputerActionClickButtonRight ComputerActionClickButton = "right"`

781 

782 - `const ComputerActionClickButtonWheel ComputerActionClickButton = "wheel"`

783 

784 - `const ComputerActionClickButtonBack ComputerActionClickButton = "back"`

785 

786 - `const ComputerActionClickButtonForward ComputerActionClickButton = "forward"`

787 

788 - `Type Click`

789 

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

791 

792 - `const ClickClick Click = "click"`

793 

794 - `X int64`

795 

796 The x-coordinate where the click occurred.

797 

798 - `Y int64`

799 

800 The y-coordinate where the click occurred.

801 

802 - `Keys []string`

803 

804 The keys being held while clicking.

805 

806 - `type ComputerActionDoubleClick struct{…}`

807 

808 A double click action.

809 

810 - `Keys []string`

811 

812 The keys being held while double-clicking.

813 

814 - `Type DoubleClick`

815 

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

817 

818 - `const DoubleClickDoubleClick DoubleClick = "double_click"`

819 

820 - `X int64`

821 

822 The x-coordinate where the double click occurred.

823 

824 - `Y int64`

825 

826 The y-coordinate where the double click occurred.

827 

828 - `type ComputerActionDrag struct{…}`

829 

830 A drag action.

831 

832 - `Path []ComputerActionDragPath`

833 

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

835 

836 ```

837 [

838 { x: 100, y: 200 },

839 { x: 200, y: 300 }

840 ]

841 ```

842 

843 - `X int64`

844 

845 The x-coordinate.

846 

847 - `Y int64`

848 

849 The y-coordinate.

850 

851 - `Type Drag`

852 

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

854 

855 - `const DragDrag Drag = "drag"`

856 

857 - `Keys []string`

858 

859 The keys being held while dragging the mouse.

860 

861 - `type ComputerActionKeypress struct{…}`

862 

863 A collection of keypresses the model would like to perform.

864 

865 - `Keys []string`

866 

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

868 

869 - `Type Keypress`

870 

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

872 

873 - `const KeypressKeypress Keypress = "keypress"`

874 

875 - `type ComputerActionMove struct{…}`

876 

877 A mouse move action.

878 

879 - `Type Move`

880 

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

882 

883 - `const MoveMove Move = "move"`

884 

885 - `X int64`

886 

887 The x-coordinate to move to.

888 

889 - `Y int64`

890 

891 The y-coordinate to move to.

892 

893 - `Keys []string`

894 

895 The keys being held while moving the mouse.

896 

897 - `type ComputerActionScreenshot struct{…}`

898 

899 A screenshot action.

900 

901 - `Type Screenshot`

902 

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

904 

905 - `const ScreenshotScreenshot Screenshot = "screenshot"`

906 

907 - `type ComputerActionScroll struct{…}`

908 

909 A scroll action.

910 

911 - `ScrollX int64`

912 

913 The horizontal scroll distance.

914 

915 - `ScrollY int64`

916 

917 The vertical scroll distance.

918 

919 - `Type Scroll`

920 

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

922 

923 - `const ScrollScroll Scroll = "scroll"`

924 

925 - `X int64`

926 

927 The x-coordinate where the scroll occurred.

928 

929 - `Y int64`

930 

931 The y-coordinate where the scroll occurred.

932 

933 - `Keys []string`

934 

935 The keys being held while scrolling.

936 

937 - `type ComputerActionType struct{…}`

938 

939 An action to type in text.

940 

941 - `Text string`

942 

943 The text to type.

944 

945 - `Type Type`

946 

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

948 

949 - `const TypeType Type = "type"`

950 

951 - `type ComputerActionWait struct{…}`

952 

953 A wait action.

954 

955 - `Type Wait`

956 

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

958 

959 - `const WaitWait Wait = "wait"`

960 

961 - `type ResponseInputItemComputerCallOutput struct{…}`

962 

963 The output of a computer tool call.

964 

965 - `CallID string`

966 

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

968 

969 - `Output ResponseComputerToolCallOutputScreenshot`

970 

971 A computer screenshot image used with the computer use tool.

972 

973 - `Type ComputerScreenshot`

974 

975 Specifies the event type. For a computer screenshot, this property is

976 always set to `computer_screenshot`.

977 

978 - `const ComputerScreenshotComputerScreenshot ComputerScreenshot = "computer_screenshot"`

979 

980 - `FileID string`

981 

982 The identifier of an uploaded file that contains the screenshot.

983 

984 - `ImageURL string`

985 

986 The URL of the screenshot image.

987 

988 - `Type ComputerCallOutput`

989 

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

991 

992 - `const ComputerCallOutputComputerCallOutput ComputerCallOutput = "computer_call_output"`

993 

994 - `ID string`

995 

996 The ID of the computer tool call output.

997 

998 - `AcknowledgedSafetyChecks []ResponseInputItemComputerCallOutputAcknowledgedSafetyCheck`

999 

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

1001 

1002 - `ID string`

1003 

1004 The ID of the pending safety check.

1005 

1006 - `Code string`

1007 

1008 The type of the pending safety check.

1009 

1010 - `Message string`

1011 

1012 Details about the pending safety check.

1013 

1014 - `Status string`

1015 

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

1017 

1018 - `const ResponseInputItemComputerCallOutputStatusInProgress ResponseInputItemComputerCallOutputStatus = "in_progress"`

1019 

1020 - `const ResponseInputItemComputerCallOutputStatusCompleted ResponseInputItemComputerCallOutputStatus = "completed"`

1021 

1022 - `const ResponseInputItemComputerCallOutputStatusIncomplete ResponseInputItemComputerCallOutputStatus = "incomplete"`

1023 

1024 - `type ResponseFunctionWebSearch struct{…}`

1025 

1026 The results of a web search tool call. See the

1027 [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information.

1028 

1029 - `ID string`

1030 

1031 The unique ID of the web search tool call.

1032 

1033 - `Action ResponseFunctionWebSearchActionUnion`

1034 

1035 An object describing the specific action taken in this web search call.

1036 Includes details on how the model used the web (search, open_page, find_in_page).

1037 

1038 - `type ResponseFunctionWebSearchActionSearch struct{…}`

1039 

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

1041 

1042 - `Query string`

1043 

1044 [DEPRECATED] The search query.

1045 

1046 - `Type Search`

1047 

1048 The action type.

1049 

1050 - `const SearchSearch Search = "search"`

1051 

1052 - `Queries []string`

1053 

1054 The search queries.

1055 

1056 - `Sources []ResponseFunctionWebSearchActionSearchSource`

1057 

1058 The sources used in the search.

1059 

1060 - `Type URL`

1061 

1062 The type of source. Always `url`.

1063 

1064 - `const URLURL URL = "url"`

1065 

1066 - `URL string`

1067 

1068 The URL of the source.

1069 

1070 - `type ResponseFunctionWebSearchActionOpenPage struct{…}`

1071 

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

1073 

1074 - `Type OpenPage`

1075 

1076 The action type.

1077 

1078 - `const OpenPageOpenPage OpenPage = "open_page"`

1079 

1080 - `URL string`

1081 

1082 The URL opened by the model.

1083 

1084 - `type ResponseFunctionWebSearchActionFindInPage struct{…}`

1085 

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

1087 

1088 - `Pattern string`

1089 

1090 The pattern or text to search for within the page.

1091 

1092 - `Type FindInPage`

1093 

1094 The action type.

1095 

1096 - `const FindInPageFindInPage FindInPage = "find_in_page"`

1097 

1098 - `URL string`

1099 

1100 The URL of the page searched for the pattern.

1101 

1102 - `Status ResponseFunctionWebSearchStatus`

1103 

1104 The status of the web search tool call.

1105 

1106 - `const ResponseFunctionWebSearchStatusInProgress ResponseFunctionWebSearchStatus = "in_progress"`

1107 

1108 - `const ResponseFunctionWebSearchStatusSearching ResponseFunctionWebSearchStatus = "searching"`

1109 

1110 - `const ResponseFunctionWebSearchStatusCompleted ResponseFunctionWebSearchStatus = "completed"`

1111 

1112 - `const ResponseFunctionWebSearchStatusFailed ResponseFunctionWebSearchStatus = "failed"`

1113 

1114 - `Type WebSearchCall`

1115 

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

1117 

1118 - `const WebSearchCallWebSearchCall WebSearchCall = "web_search_call"`

1119 

1120 - `type ResponseFunctionToolCall struct{…}`

1121 

1122 A tool call to run a function. See the

1123 [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.

1124 

1125 - `Arguments string`

1126 

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

1128 

1129 - `CallID string`

1130 

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

1132 

1133 - `Name string`

1134 

1135 The name of the function to run.

1136 

1137 - `Type FunctionCall`

1138 

1139 The type of the function tool call. Always `function_call`.

1140 

1141 - `const FunctionCallFunctionCall FunctionCall = "function_call"`

1142 

1143 - `ID string`

1144 

1145 The unique ID of the function tool call.

1146 

1147 - `Namespace string`

1148 

1149 The namespace of the function to run.

1150 

1151 - `Status ResponseFunctionToolCallStatus`

1152 

1153 The status of the item. One of `in_progress`, `completed`, or

1154 `incomplete`. Populated when items are returned via API.

1155 

1156 - `const ResponseFunctionToolCallStatusInProgress ResponseFunctionToolCallStatus = "in_progress"`

1157 

1158 - `const ResponseFunctionToolCallStatusCompleted ResponseFunctionToolCallStatus = "completed"`

1159 

1160 - `const ResponseFunctionToolCallStatusIncomplete ResponseFunctionToolCallStatus = "incomplete"`

1161 

1162 - `type ResponseInputItemFunctionCallOutput struct{…}`

1163 

1164 The output of a function tool call.

1165 

1166 - `CallID string`

1167 

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

1169 

1170 - `Output ResponseInputItemFunctionCallOutputOutputUnion`

1171 

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

1173 

1174 - `string`

1175 

1176 - `type ResponseFunctionCallOutputItemList []ResponseFunctionCallOutputItemUnion`

1177 

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

1179 

1180 - `type ResponseInputTextContent struct{…}`

1181 

1182 A text input to the model.

1183 

1184 - `Text string`

1185 

1186 The text input to the model.

1187 

1188 - `Type InputText`

1189 

1190 The type of the input item. Always `input_text`.

1191 

1192 - `const InputTextInputText InputText = "input_text"`

1193 

1194 - `type ResponseInputImageContent struct{…}`

1195 

1196 An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision)

1197 

1198 - `Type InputImage`

1199 

1200 The type of the input item. Always `input_image`.

1201 

1202 - `const InputImageInputImage InputImage = "input_image"`

1203 

1204 - `Detail ResponseInputImageContentDetail`

1205 

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

1207 

1208 - `const ResponseInputImageContentDetailLow ResponseInputImageContentDetail = "low"`

1209 

1210 - `const ResponseInputImageContentDetailHigh ResponseInputImageContentDetail = "high"`

1211 

1212 - `const ResponseInputImageContentDetailAuto ResponseInputImageContentDetail = "auto"`

1213 

1214 - `const ResponseInputImageContentDetailOriginal ResponseInputImageContentDetail = "original"`

1215 

1216 - `FileID string`

1217 

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

1219 

1220 - `ImageURL string`

1221 

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

1223 

1224 - `type ResponseInputFileContent struct{…}`

1225 

1226 A file input to the model.

1227 

1228 - `Type InputFile`

1229 

1230 The type of the input item. Always `input_file`.

1231 

1232 - `const InputFileInputFile InputFile = "input_file"`

1233 

1234 - `Detail ResponseInputFileContentDetail`

1235 

1236 The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`.

1237 

1238 - `const ResponseInputFileContentDetailLow ResponseInputFileContentDetail = "low"`

1239 

1240 - `const ResponseInputFileContentDetailHigh ResponseInputFileContentDetail = "high"`

1241 

1242 - `FileData string`

1243 

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

1245 

1246 - `FileID string`

1247 

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

1249 

1250 - `FileURL string`

1251 

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

1253 

1254 - `Filename string`

1255 

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

1257 

1258 - `Type FunctionCallOutput`

1259 

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

1261 

1262 - `const FunctionCallOutputFunctionCallOutput FunctionCallOutput = "function_call_output"`

1263 

1264 - `ID string`

1265 

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

1267 

1268 - `Status string`

1269 

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

1271 

1272 - `const ResponseInputItemFunctionCallOutputStatusInProgress ResponseInputItemFunctionCallOutputStatus = "in_progress"`

1273 

1274 - `const ResponseInputItemFunctionCallOutputStatusCompleted ResponseInputItemFunctionCallOutputStatus = "completed"`

1275 

1276 - `const ResponseInputItemFunctionCallOutputStatusIncomplete ResponseInputItemFunctionCallOutputStatus = "incomplete"`

1277 

1278 - `type ResponseInputItemToolSearchCall struct{…}`

1279 

1280 - `Arguments any`

1281 

1282 The arguments supplied to the tool search call.

1283 

1284 - `Type ToolSearchCall`

1285 

1286 The item type. Always `tool_search_call`.

1287 

1288 - `const ToolSearchCallToolSearchCall ToolSearchCall = "tool_search_call"`

1289 

1290 - `ID string`

1291 

1292 The unique ID of this tool search call.

1293 

1294 - `CallID string`

1295 

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

1297 

1298 - `Execution string`

1299 

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

1301 

1302 - `const ResponseInputItemToolSearchCallExecutionServer ResponseInputItemToolSearchCallExecution = "server"`

1303 

1304 - `const ResponseInputItemToolSearchCallExecutionClient ResponseInputItemToolSearchCallExecution = "client"`

1305 

1306 - `Status string`

1307 

1308 The status of the tool search call.

1309 

1310 - `const ResponseInputItemToolSearchCallStatusInProgress ResponseInputItemToolSearchCallStatus = "in_progress"`

1311 

1312 - `const ResponseInputItemToolSearchCallStatusCompleted ResponseInputItemToolSearchCallStatus = "completed"`

1313 

1314 - `const ResponseInputItemToolSearchCallStatusIncomplete ResponseInputItemToolSearchCallStatus = "incomplete"`

1315 

1316 - `type ResponseToolSearchOutputItemParamResp struct{…}`

1317 

1318 - `Tools []ToolUnion`

1319 

1320 The loaded tool definitions returned by the tool search output.

1321 

1322 - `type FunctionTool struct{…}`

1323 

1324 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

1325 

1326 - `Name string`

1327 

1328 The name of the function to call.

1329 

1330 - `Parameters map[string, any]`

1331 

1332 A JSON schema object describing the parameters of the function.

1333 

1334 - `Strict bool`

1335 

1336 Whether to enforce strict parameter validation. Default `true`.

1337 

1338 - `Type Function`

1339 

1340 The type of the function tool. Always `function`.

1341 

1342 - `const FunctionFunction Function = "function"`

1343 

1344 - `DeferLoading bool`

1345 

1346 Whether this function is deferred and loaded via tool search.

1347 

1348 - `Description string`

1349 

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

1351 

1352 - `type FileSearchTool struct{…}`

1353 

1354 A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).

1355 

1356 - `Type FileSearch`

1357 

1358 The type of the file search tool. Always `file_search`.

1359 

1360 - `const FileSearchFileSearch FileSearch = "file_search"`

1361 

1362 - `VectorStoreIDs []string`

1363 

1364 The IDs of the vector stores to search.

1365 

1366 - `Filters FileSearchToolFiltersUnion`

1367 

1368 A filter to apply.

1369 

1370 - `type ComparisonFilter struct{…}`

1371 

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

1373 

1374 - `Key string`

1375 

1376 The key to compare against the value.

1377 

1378 - `Type ComparisonFilterType`

1379 

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

1381 

1382 - `eq`: equals

1383 - `ne`: not equal

1384 - `gt`: greater than

1385 - `gte`: greater than or equal

1386 - `lt`: less than

1387 - `lte`: less than or equal

1388 - `in`: in

1389 - `nin`: not in

1390 

1391 - `const ComparisonFilterTypeEq ComparisonFilterType = "eq"`

1392 

1393 - `const ComparisonFilterTypeNe ComparisonFilterType = "ne"`

1394 

1395 - `const ComparisonFilterTypeGt ComparisonFilterType = "gt"`

1396 

1397 - `const ComparisonFilterTypeGte ComparisonFilterType = "gte"`

1398 

1399 - `const ComparisonFilterTypeLt ComparisonFilterType = "lt"`

1400 

1401 - `const ComparisonFilterTypeLte ComparisonFilterType = "lte"`

1402 

1403 - `const ComparisonFilterTypeIn ComparisonFilterType = "in"`

1404 

1405 - `const ComparisonFilterTypeNin ComparisonFilterType = "nin"`

1406 

1407 - `Value ComparisonFilterValueUnion`

1408 

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

1410 

1411 - `string`

1412 

1413 - `float64`

1414 

1415 - `bool`

1416 

1417 - `type ComparisonFilterValueArray []ComparisonFilterValueArrayItemUnion`

1418 

1419 - `string`

1420 

1421 - `float64`

1422 

1423 - `type CompoundFilter struct{…}`

1424 

1425 Combine multiple filters using `and` or `or`.

1426 

1427 - `Filters []ComparisonFilter`

1428 

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

1430 

1431 - `type ComparisonFilter struct{…}`

1432 

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

1434 

1435 - `Type CompoundFilterType`

1436 

1437 Type of operation: `and` or `or`.

1438 

1439 - `const CompoundFilterTypeAnd CompoundFilterType = "and"`

1440 

1441 - `const CompoundFilterTypeOr CompoundFilterType = "or"`

1442 

1443 - `MaxNumResults int64`

1444 

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

1446 

1447 - `RankingOptions FileSearchToolRankingOptions`

1448 

1449 Ranking options for search.

1450 

1451 - `HybridSearch FileSearchToolRankingOptionsHybridSearch`

1452 

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

1454 

1455 - `EmbeddingWeight float64`

1456 

1457 The weight of the embedding in the reciprocal ranking fusion.

1458 

1459 - `TextWeight float64`

1460 

1461 The weight of the text in the reciprocal ranking fusion.

1462 

1463 - `Ranker string`

1464 

1465 The ranker to use for the file search.

1466 

1467 - `const FileSearchToolRankingOptionsRankerAuto FileSearchToolRankingOptionsRanker = "auto"`

1468 

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

1470 

1471 - `ScoreThreshold float64`

1472 

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

1474 

1475 - `type ComputerTool struct{…}`

1476 

1477 A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).

1478 

1479 - `Type Computer`

1480 

1481 The type of the computer tool. Always `computer`.

1482 

1483 - `const ComputerComputer Computer = "computer"`

1484 

1485 - `type ComputerUsePreviewTool struct{…}`

1486 

1487 A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).

1488 

1489 - `DisplayHeight int64`

1490 

1491 The height of the computer display.

1492 

1493 - `DisplayWidth int64`

1494 

1495 The width of the computer display.

1496 

1497 - `Environment ComputerUsePreviewToolEnvironment`

1498 

1499 The type of computer environment to control.

1500 

1501 - `const ComputerUsePreviewToolEnvironmentWindows ComputerUsePreviewToolEnvironment = "windows"`

1502 

1503 - `const ComputerUsePreviewToolEnvironmentMac ComputerUsePreviewToolEnvironment = "mac"`

1504 

1505 - `const ComputerUsePreviewToolEnvironmentLinux ComputerUsePreviewToolEnvironment = "linux"`

1506 

1507 - `const ComputerUsePreviewToolEnvironmentUbuntu ComputerUsePreviewToolEnvironment = "ubuntu"`

1508 

1509 - `const ComputerUsePreviewToolEnvironmentBrowser ComputerUsePreviewToolEnvironment = "browser"`

1510 

1511 - `Type ComputerUsePreview`

1512 

1513 The type of the computer use tool. Always `computer_use_preview`.

1514 

1515 - `const ComputerUsePreviewComputerUsePreview ComputerUsePreview = "computer_use_preview"`

1516 

1517 - `type WebSearchTool struct{…}`

1518 

1519 Search the Internet for sources related to the prompt. Learn more about the

1520 [web search tool](https://platform.openai.com/docs/guides/tools-web-search).

1521 

1522 - `Type WebSearchToolType`

1523 

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

1525 

1526 - `const WebSearchToolTypeWebSearch WebSearchToolType = "web_search"`

1527 

1528 - `const WebSearchToolTypeWebSearch2025_08_26 WebSearchToolType = "web_search_2025_08_26"`

1529 

1530 - `Filters WebSearchToolFilters`

1531 

1532 Filters for the search.

1533 

1534 - `AllowedDomains []string`

1535 

1536 Allowed domains for the search. If not provided, all domains are allowed.

1537 Subdomains of the provided domains are allowed as well.

1538 

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

1540 

1541 - `SearchContextSize WebSearchToolSearchContextSize`

1542 

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

1544 

1545 - `const WebSearchToolSearchContextSizeLow WebSearchToolSearchContextSize = "low"`

1546 

1547 - `const WebSearchToolSearchContextSizeMedium WebSearchToolSearchContextSize = "medium"`

1548 

1549 - `const WebSearchToolSearchContextSizeHigh WebSearchToolSearchContextSize = "high"`

1550 

1551 - `UserLocation WebSearchToolUserLocation`

1552 

1553 The approximate location of the user.

1554 

1555 - `City string`

1556 

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

1558 

1559 - `Country string`

1560 

1561 The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.

1562 

1563 - `Region string`

1564 

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

1566 

1567 - `Timezone string`

1568 

1569 The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.

1570 

1571 - `Type string`

1572 

1573 The type of location approximation. Always `approximate`.

1574 

1575 - `const WebSearchToolUserLocationTypeApproximate WebSearchToolUserLocationType = "approximate"`

1576 

1577 - `type ToolMcp struct{…}`

1578 

1579 Give the model access to additional tools via remote Model Context Protocol

1580 (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).

1581 

1582 - `ServerLabel string`

1583 

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

1585 

1586 - `Type Mcp`

1587 

1588 The type of the MCP tool. Always `mcp`.

1589 

1590 - `const McpMcp Mcp = "mcp"`

1591 

1592 - `AllowedTools ToolMcpAllowedToolsUnion`

1593 

1594 List of allowed tool names or a filter object.

1595 

1596 - `type ToolMcpAllowedToolsMcpAllowedTools []string`

1597 

1598 A string array of allowed tool names

1599 

1600 - `type ToolMcpAllowedToolsMcpToolFilter struct{…}`

1601 

1602 A filter object to specify which tools are allowed.

1603 

1604 - `ReadOnly bool`

1605 

1606 Indicates whether or not a tool modifies data or is read-only. If an

1607 MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),

1608 it will match this filter.

1609 

1610 - `ToolNames []string`

1611 

1612 List of allowed tool names.

1613 

1614 - `Authorization string`

1615 

1616 An OAuth access token that can be used with a remote MCP server, either

1617 with a custom MCP server URL or a service connector. Your application

1618 must handle the OAuth authorization flow and provide the token here.

1619 

1620 - `ConnectorID string`

1621 

1622 Identifier for service connectors, like those available in ChatGPT. One of

1623 `server_url` or `connector_id` must be provided. Learn more about service

1624 connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).

1625 

1626 Currently supported `connector_id` values are:

1627 

1628 - Dropbox: `connector_dropbox`

1629 - Gmail: `connector_gmail`

1630 - Google Calendar: `connector_googlecalendar`

1631 - Google Drive: `connector_googledrive`

1632 - Microsoft Teams: `connector_microsoftteams`

1633 - Outlook Calendar: `connector_outlookcalendar`

1634 - Outlook Email: `connector_outlookemail`

1635 - SharePoint: `connector_sharepoint`

1636 

1637 - `const ToolMcpConnectorIDConnectorDropbox ToolMcpConnectorID = "connector_dropbox"`

1638 

1639 - `const ToolMcpConnectorIDConnectorGmail ToolMcpConnectorID = "connector_gmail"`

1640 

1641 - `const ToolMcpConnectorIDConnectorGooglecalendar ToolMcpConnectorID = "connector_googlecalendar"`

1642 

1643 - `const ToolMcpConnectorIDConnectorGoogledrive ToolMcpConnectorID = "connector_googledrive"`

1644 

1645 - `const ToolMcpConnectorIDConnectorMicrosoftteams ToolMcpConnectorID = "connector_microsoftteams"`

1646 

1647 - `const ToolMcpConnectorIDConnectorOutlookcalendar ToolMcpConnectorID = "connector_outlookcalendar"`

1648 

1649 - `const ToolMcpConnectorIDConnectorOutlookemail ToolMcpConnectorID = "connector_outlookemail"`

1650 

1651 - `const ToolMcpConnectorIDConnectorSharepoint ToolMcpConnectorID = "connector_sharepoint"`

1652 

1653 - `DeferLoading bool`

1654 

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

1656 

1657 - `Headers map[string, string]`

1658 

1659 Optional HTTP headers to send to the MCP server. Use for authentication

1660 or other purposes.

1661 

1662 - `RequireApproval ToolMcpRequireApprovalUnion`

1663 

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

1665 

1666 - `type ToolMcpRequireApprovalMcpToolApprovalFilter struct{…}`

1667 

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

1669 `always`, `never`, or a filter object associated with tools

1670 that require approval.

1671 

1672 - `Always ToolMcpRequireApprovalMcpToolApprovalFilterAlways`

1673 

1674 A filter object to specify which tools are allowed.

1675 

1676 - `ReadOnly bool`

1677 

1678 Indicates whether or not a tool modifies data or is read-only. If an

1679 MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),

1680 it will match this filter.

1681 

1682 - `ToolNames []string`

1683 

1684 List of allowed tool names.

1685 

1686 - `Never ToolMcpRequireApprovalMcpToolApprovalFilterNever`

1687 

1688 A filter object to specify which tools are allowed.

1689 

1690 - `ReadOnly bool`

1691 

1692 Indicates whether or not a tool modifies data or is read-only. If an

1693 MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),

1694 it will match this filter.

1695 

1696 - `ToolNames []string`

1697 

1698 List of allowed tool names.

1699 

1700 - `type ToolMcpRequireApprovalMcpToolApprovalSetting string`

1701 

1702 Specify a single approval policy for all tools. One of `always` or

1703 `never`. When set to `always`, all tools will require approval. When

1704 set to `never`, all tools will not require approval.

1705 

1706 - `const ToolMcpRequireApprovalMcpToolApprovalSettingAlways ToolMcpRequireApprovalMcpToolApprovalSetting = "always"`

1707 

1708 - `const ToolMcpRequireApprovalMcpToolApprovalSettingNever ToolMcpRequireApprovalMcpToolApprovalSetting = "never"`

1709 

1710 - `ServerDescription string`

1711 

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

1713 

1714 - `ServerURL string`

1715 

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

1717 provided.

1718 

1719 - `type ToolCodeInterpreter struct{…}`

1720 

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

1722 

1723 - `Container ToolCodeInterpreterContainerUnion`

1724 

1725 The code interpreter container. Can be a container ID or an object that

1726 specifies uploaded file IDs to make available to your code, along with an

1727 optional `memory_limit` setting.

1728 

1729 - `string`

1730 

1731 - `type ToolCodeInterpreterContainerCodeInterpreterContainerAuto struct{…}`

1732 

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

1734 

1735 - `Type Auto`

1736 

1737 Always `auto`.

1738 

1739 - `const AutoAuto Auto = "auto"`

1740 

1741 - `FileIDs []string`

1742 

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

1744 

1745 - `MemoryLimit string`

1746 

1747 The memory limit for the code interpreter container.

1748 

1749 - `const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit1g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "1g"`

1750 

1751 - `const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit4g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "4g"`

1752 

1753 - `const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit16g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "16g"`

1754 

1755 - `const ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit64g ToolCodeInterpreterContainerCodeInterpreterToolAutoMemoryLimit = "64g"`

1756 

1757 - `NetworkPolicy ToolCodeInterpreterContainerCodeInterpreterToolAutoNetworkPolicyUnion`

1758 

1759 Network access policy for the container.

1760 

1761 - `type ContainerNetworkPolicyDisabled struct{…}`

1762 

1763 - `Type Disabled`

1764 

1765 Disable outbound network access. Always `disabled`.

1766 

1767 - `const DisabledDisabled Disabled = "disabled"`

1768 

1769 - `type ContainerNetworkPolicyAllowlist struct{…}`

1770 

1771 - `AllowedDomains []string`

1772 

1773 A list of allowed domains when type is `allowlist`.

1774 

1775 - `Type Allowlist`

1776 

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

1778 

1779 - `const AllowlistAllowlist Allowlist = "allowlist"`

1780 

1781 - `DomainSecrets []ContainerNetworkPolicyDomainSecret`

1782 

1783 Optional domain-scoped secrets for allowlisted domains.

1784 

1785 - `Domain string`

1786 

1787 The domain associated with the secret.

1788 

1789 - `Name string`

1790 

1791 The name of the secret to inject for the domain.

1792 

1793 - `Value string`

1794 

1795 The secret value to inject for the domain.

1796 

1797 - `Type CodeInterpreter`

1798 

1799 The type of the code interpreter tool. Always `code_interpreter`.

1800 

1801 - `const CodeInterpreterCodeInterpreter CodeInterpreter = "code_interpreter"`

1802 

1803 - `type ToolImageGeneration struct{…}`

1804 

1805 A tool that generates images using the GPT image models.

1806 

1807 - `Type ImageGeneration`

1808 

1809 The type of the image generation tool. Always `image_generation`.

1810 

1811 - `const ImageGenerationImageGeneration ImageGeneration = "image_generation"`

1812 

1813 - `Action string`

1814 

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

1816 

1817 - `const ToolImageGenerationActionGenerate ToolImageGenerationAction = "generate"`

1818 

1819 - `const ToolImageGenerationActionEdit ToolImageGenerationAction = "edit"`

1820 

1821 - `const ToolImageGenerationActionAuto ToolImageGenerationAction = "auto"`

1822 

1823 - `Background string`

1824 

1825 Allows to set transparency for the background of the generated image(s).

1826 This parameter is only supported for GPT image models that support

1827 transparent backgrounds. Must be one of `transparent`, `opaque`, or

1828 `auto` (default value). When `auto` is used, the model will

1829 automatically determine the best background for the image.

1830 

1831 `gpt-image-2` and `gpt-image-2-2026-04-21` do not support

1832 transparent backgrounds. Requests with `background` set to

1833 `transparent` will return an error for these models; use `opaque` or

1834 `auto` instead.

1835 

1836 If `transparent`, the output format needs to support transparency,

1837 so it should be set to either `png` (default value) or `webp`.

1838 

1839 - `const ToolImageGenerationBackgroundTransparent ToolImageGenerationBackground = "transparent"`

1840 

1841 - `const ToolImageGenerationBackgroundOpaque ToolImageGenerationBackground = "opaque"`

1842 

1843 - `const ToolImageGenerationBackgroundAuto ToolImageGenerationBackground = "auto"`

1844 

1845 - `InputFidelity string`

1846 

1847 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`.

1848 

1849 - `const ToolImageGenerationInputFidelityHigh ToolImageGenerationInputFidelity = "high"`

1850 

1851 - `const ToolImageGenerationInputFidelityLow ToolImageGenerationInputFidelity = "low"`

1852 

1853 - `InputImageMask ToolImageGenerationInputImageMask`

1854 

1855 Optional mask for inpainting. Contains `image_url`

1856 (string, optional) and `file_id` (string, optional).

1857 

1858 - `FileID string`

1859 

1860 File ID for the mask image.

1861 

1862 - `ImageURL string`

1863 

1864 Base64-encoded mask image.

1865 

1866 - `Model string`

1867 

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

1869 

1870 - `string`

1871 

1872 - `string`

1873 

1874 - `const ToolImageGenerationModelGPTImage1 ToolImageGenerationModel = "gpt-image-1"`

1875 

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

1877 

1878 - `const ToolImageGenerationModelGPTImage2 ToolImageGenerationModel = "gpt-image-2"`

1879 

1880 - `const ToolImageGenerationModelGPTImage2_2026_04_21 ToolImageGenerationModel = "gpt-image-2-2026-04-21"`

1881 

1882 - `const ToolImageGenerationModelGPTImage1_5 ToolImageGenerationModel = "gpt-image-1.5"`

1883 

1884 - `const ToolImageGenerationModelChatgptImageLatest ToolImageGenerationModel = "chatgpt-image-latest"`

1885 

1886 - `Moderation string`

1887 

1888 Moderation level for the generated image. Default: `auto`.

1889 

1890 - `const ToolImageGenerationModerationAuto ToolImageGenerationModeration = "auto"`

1891 

1892 - `const ToolImageGenerationModerationLow ToolImageGenerationModeration = "low"`

1893 

1894 - `OutputCompression int64`

1895 

1896 Compression level for the output image. Default: 100.

1897 

1898 - `OutputFormat string`

1899 

1900 The output format of the generated image. One of `png`, `webp`, or

1901 `jpeg`. Default: `png`.

1902 

1903 - `const ToolImageGenerationOutputFormatPNG ToolImageGenerationOutputFormat = "png"`

1904 

1905 - `const ToolImageGenerationOutputFormatWebP ToolImageGenerationOutputFormat = "webp"`

1906 

1907 - `const ToolImageGenerationOutputFormatJPEG ToolImageGenerationOutputFormat = "jpeg"`

1908 

1909 - `PartialImages int64`

1910 

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

1912 

1913 - `Quality string`

1914 

1915 The quality of the generated image. One of `low`, `medium`, `high`,

1916 or `auto`. Default: `auto`.

1917 

1918 - `const ToolImageGenerationQualityLow ToolImageGenerationQuality = "low"`

1919 

1920 - `const ToolImageGenerationQualityMedium ToolImageGenerationQuality = "medium"`

1921 

1922 - `const ToolImageGenerationQualityHigh ToolImageGenerationQuality = "high"`

1923 

1924 - `const ToolImageGenerationQualityAuto ToolImageGenerationQuality = "auto"`

1925 

1926 - `Size string`

1927 

1928 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`.

1929 

1930 - `string`

1931 

1932 - `string`

1933 

1934 - `const ToolImageGenerationSize1024x1024 ToolImageGenerationSize = "1024x1024"`

1935 

1936 - `const ToolImageGenerationSize1024x1536 ToolImageGenerationSize = "1024x1536"`

1937 

1938 - `const ToolImageGenerationSize1536x1024 ToolImageGenerationSize = "1536x1024"`

1939 

1940 - `const ToolImageGenerationSizeAuto ToolImageGenerationSize = "auto"`

1941 

1942 - `type ToolLocalShell struct{…}`

1943 

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

1945 

1946 - `Type LocalShell`

1947 

1948 The type of the local shell tool. Always `local_shell`.

1949 

1950 - `const LocalShellLocalShell LocalShell = "local_shell"`

1951 

1952 - `type FunctionShellTool struct{…}`

1953 

1954 A tool that allows the model to execute shell commands.

1955 

1956 - `Type Shell`

1957 

1958 The type of the shell tool. Always `shell`.

1959 

1960 - `const ShellShell Shell = "shell"`

1961 

1962 - `Environment FunctionShellToolEnvironmentUnion`

1963 

1964 - `type ContainerAuto struct{…}`

1965 

1966 - `Type ContainerAuto`

1967 

1968 Automatically creates a container for this request

1969 

1970 - `const ContainerAutoContainerAuto ContainerAuto = "container_auto"`

1971 

1972 - `FileIDs []string`

1973 

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

1975 

1976 - `MemoryLimit ContainerAutoMemoryLimit`

1977 

1978 The memory limit for the container.

1979 

1980 - `const ContainerAutoMemoryLimit1g ContainerAutoMemoryLimit = "1g"`

1981 

1982 - `const ContainerAutoMemoryLimit4g ContainerAutoMemoryLimit = "4g"`

1983 

1984 - `const ContainerAutoMemoryLimit16g ContainerAutoMemoryLimit = "16g"`

1985 

1986 - `const ContainerAutoMemoryLimit64g ContainerAutoMemoryLimit = "64g"`

1987 

1988 - `NetworkPolicy ContainerAutoNetworkPolicyUnion`

1989 

1990 Network access policy for the container.

1991 

1992 - `type ContainerNetworkPolicyDisabled struct{…}`

1993 

1994 - `type ContainerNetworkPolicyAllowlist struct{…}`

1995 

1996 - `Skills []ContainerAutoSkillUnion`