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

1## Get a model response

2 

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

4 

5**get** `/responses/{response_id}`

6 

7Retrieves a model response with the given ID.

8 

9### Parameters

10 

11- `responseID string`

12 

13- `query ResponseGetParams`

14 

15 - `Include param.Field[[]ResponseIncludable]`

16 

17 Additional fields to include in the response. See the `include`

18 parameter for Response creation above for more information.

19 

20 - `const ResponseIncludableFileSearchCallResults ResponseIncludable = "file_search_call.results"`

21 

22 - `const ResponseIncludableWebSearchCallResults ResponseIncludable = "web_search_call.results"`

23 

24 - `const ResponseIncludableWebSearchCallActionSources ResponseIncludable = "web_search_call.action.sources"`

25 

26 - `const ResponseIncludableMessageInputImageImageURL ResponseIncludable = "message.input_image.image_url"`

27 

28 - `const ResponseIncludableComputerCallOutputOutputImageURL ResponseIncludable = "computer_call_output.output.image_url"`

29 

30 - `const ResponseIncludableCodeInterpreterCallOutputs ResponseIncludable = "code_interpreter_call.outputs"`

31 

32 - `const ResponseIncludableReasoningEncryptedContent ResponseIncludable = "reasoning.encrypted_content"`

33 

34 - `const ResponseIncludableMessageOutputTextLogprobs ResponseIncludable = "message.output_text.logprobs"`

35 

36 - `IncludeObfuscation param.Field[bool]`

37 

38 When true, stream obfuscation will be enabled. Stream obfuscation adds

39 random characters to an `obfuscation` field on streaming delta events

40 to normalize payload sizes as a mitigation to certain side-channel

41 attacks. These obfuscation fields are included by default, but add a

42 small amount of overhead to the data stream. You can set

43 `include_obfuscation` to false to optimize for bandwidth if you trust

44 the network links between your application and the OpenAI API.

45 

46 - `StartingAfter param.Field[int64]`

47 

48 The sequence number of the event after which to start streaming.

49 

50 - ``

51 

52### Returns

53 

54- `type Response struct{…}`

55 

56 - `ID string`

57 

58 Unique identifier for this Response.

59 

60 - `CreatedAt float64`

61 

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

63 

64 - `Error ResponseError`

65 

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

67 

68 - `Code ResponseErrorCode`

69 

70 The error code for the response.

71 

72 - `const ResponseErrorCodeServerError ResponseErrorCode = "server_error"`

73 

74 - `const ResponseErrorCodeRateLimitExceeded ResponseErrorCode = "rate_limit_exceeded"`

75 

76 - `const ResponseErrorCodeInvalidPrompt ResponseErrorCode = "invalid_prompt"`

77 

78 - `const ResponseErrorCodeVectorStoreTimeout ResponseErrorCode = "vector_store_timeout"`

79 

80 - `const ResponseErrorCodeInvalidImage ResponseErrorCode = "invalid_image"`

81 

82 - `const ResponseErrorCodeInvalidImageFormat ResponseErrorCode = "invalid_image_format"`

83 

84 - `const ResponseErrorCodeInvalidBase64Image ResponseErrorCode = "invalid_base64_image"`

85 

86 - `const ResponseErrorCodeInvalidImageURL ResponseErrorCode = "invalid_image_url"`

87 

88 - `const ResponseErrorCodeImageTooLarge ResponseErrorCode = "image_too_large"`

89 

90 - `const ResponseErrorCodeImageTooSmall ResponseErrorCode = "image_too_small"`

91 

92 - `const ResponseErrorCodeImageParseError ResponseErrorCode = "image_parse_error"`

93 

94 - `const ResponseErrorCodeImageContentPolicyViolation ResponseErrorCode = "image_content_policy_violation"`

95 

96 - `const ResponseErrorCodeInvalidImageMode ResponseErrorCode = "invalid_image_mode"`

97 

98 - `const ResponseErrorCodeImageFileTooLarge ResponseErrorCode = "image_file_too_large"`

99 

100 - `const ResponseErrorCodeUnsupportedImageMediaType ResponseErrorCode = "unsupported_image_media_type"`

101 

102 - `const ResponseErrorCodeEmptyImageFile ResponseErrorCode = "empty_image_file"`

103 

104 - `const ResponseErrorCodeFailedToDownloadImage ResponseErrorCode = "failed_to_download_image"`

105 

106 - `const ResponseErrorCodeImageFileNotFound ResponseErrorCode = "image_file_not_found"`

107 

108 - `Message string`

109 

110 A human-readable description of the error.

111 

112 - `IncompleteDetails ResponseIncompleteDetails`

113 

114 Details about why the response is incomplete.

115 

116 - `Reason string`

117 

118 The reason why the response is incomplete.

119 

120 - `const ResponseIncompleteDetailsReasonMaxOutputTokens ResponseIncompleteDetailsReason = "max_output_tokens"`

121 

122 - `const ResponseIncompleteDetailsReasonContentFilter ResponseIncompleteDetailsReason = "content_filter"`

123 

124 - `Instructions ResponseInstructionsUnion`

125 

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

127 

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

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

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

131 

132 - `string`

133 

134 - `type ResponseInstructionsInputItemList []ResponseInputItemUnion`

135 

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

137 different content types.

138 

139 - `type EasyInputMessage struct{…}`

140 

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

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

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

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

145 interactions.

146 

147 - `Content EasyInputMessageContentUnion`

148 

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

150 Can also contain previous assistant responses.

151 

152 - `string`

153 

154 - `type ResponseInputMessageContentList []ResponseInputContentUnion`

155 

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

157 types.

158 

159 - `type ResponseInputText struct{…}`

160 

161 A text input to the model.

162 

163 - `Text string`

164 

165 The text input to the model.

166 

167 - `Type InputText`

168 

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

170 

171 - `const InputTextInputText InputText = "input_text"`

172 

173 - `type ResponseInputImage struct{…}`

174 

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

176 

177 - `Detail ResponseInputImageDetail`

178 

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

180 

181 - `const ResponseInputImageDetailLow ResponseInputImageDetail = "low"`

182 

183 - `const ResponseInputImageDetailHigh ResponseInputImageDetail = "high"`

184 

185 - `const ResponseInputImageDetailAuto ResponseInputImageDetail = "auto"`

186 

187 - `const ResponseInputImageDetailOriginal ResponseInputImageDetail = "original"`

188 

189 - `Type InputImage`

190 

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

192 

193 - `const InputImageInputImage InputImage = "input_image"`

194 

195 - `FileID string`

196 

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

198 

199 - `ImageURL string`

200 

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

202 

203 - `type ResponseInputFile struct{…}`

204 

205 A file input to the model.

206 

207 - `Type InputFile`

208 

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

210 

211 - `const InputFileInputFile InputFile = "input_file"`

212 

213 - `Detail ResponseInputFileDetail`

214 

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

216 

217 - `const ResponseInputFileDetailLow ResponseInputFileDetail = "low"`

218 

219 - `const ResponseInputFileDetailHigh ResponseInputFileDetail = "high"`

220 

221 - `FileData string`

222 

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

224 

225 - `FileID string`

226 

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

228 

229 - `FileURL string`

230 

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

232 

233 - `Filename string`

234 

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

236 

237 - `Role EasyInputMessageRole`

238 

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

240 `developer`.

241 

242 - `const EasyInputMessageRoleUser EasyInputMessageRole = "user"`

243 

244 - `const EasyInputMessageRoleAssistant EasyInputMessageRole = "assistant"`

245 

246 - `const EasyInputMessageRoleSystem EasyInputMessageRole = "system"`

247 

248 - `const EasyInputMessageRoleDeveloper EasyInputMessageRole = "developer"`

249 

250 - `Phase EasyInputMessagePhase`

251 

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

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

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

255 

256 - `const EasyInputMessagePhaseCommentary EasyInputMessagePhase = "commentary"`

257 

258 - `const EasyInputMessagePhaseFinalAnswer EasyInputMessagePhase = "final_answer"`

259 

260 - `Type EasyInputMessageType`

261 

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

263 

264 - `const EasyInputMessageTypeMessage EasyInputMessageType = "message"`

265 

266 - `type ResponseInputItemMessage struct{…}`

267 

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

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

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

271 

272 - `Content ResponseInputMessageContentList`

273 

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

275 types.

276 

277 - `Role string`

278 

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

280 

281 - `const ResponseInputItemMessageRoleUser ResponseInputItemMessageRole = "user"`

282 

283 - `const ResponseInputItemMessageRoleSystem ResponseInputItemMessageRole = "system"`

284 

285 - `const ResponseInputItemMessageRoleDeveloper ResponseInputItemMessageRole = "developer"`

286 

287 - `Status string`

288 

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

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

291 

292 - `const ResponseInputItemMessageStatusInProgress ResponseInputItemMessageStatus = "in_progress"`

293 

294 - `const ResponseInputItemMessageStatusCompleted ResponseInputItemMessageStatus = "completed"`

295 

296 - `const ResponseInputItemMessageStatusIncomplete ResponseInputItemMessageStatus = "incomplete"`

297 

298 - `Type string`

299 

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

301 

302 - `const ResponseInputItemMessageTypeMessage ResponseInputItemMessageType = "message"`

303 

304 - `type ResponseOutputMessage struct{…}`

305 

306 An output message from the model.

307 

308 - `ID string`

309 

310 The unique ID of the output message.

311 

312 - `Content []ResponseOutputMessageContentUnion`

313 

314 The content of the output message.

315 

316 - `type ResponseOutputText struct{…}`

317 

318 A text output from the model.

319 

320 - `Annotations []ResponseOutputTextAnnotationUnion`

321 

322 The annotations of the text output.

323 

324 - `type ResponseOutputTextAnnotationFileCitation struct{…}`

325 

326 A citation to a file.

327 

328 - `FileID string`

329 

330 The ID of the file.

331 

332 - `Filename string`

333 

334 The filename of the file cited.

335 

336 - `Index int64`

337 

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

339 

340 - `Type FileCitation`

341 

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

343 

344 - `const FileCitationFileCitation FileCitation = "file_citation"`

345 

346 - `type ResponseOutputTextAnnotationURLCitation struct{…}`

347 

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

349 

350 - `EndIndex int64`

351 

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

353 

354 - `StartIndex int64`

355 

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

357 

358 - `Title string`

359 

360 The title of the web resource.

361 

362 - `Type URLCitation`

363 

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

365 

366 - `const URLCitationURLCitation URLCitation = "url_citation"`

367 

368 - `URL string`

369 

370 The URL of the web resource.

371 

372 - `type ResponseOutputTextAnnotationContainerFileCitation struct{…}`

373 

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

375 

376 - `ContainerID string`

377 

378 The ID of the container file.

379 

380 - `EndIndex int64`

381 

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

383 

384 - `FileID string`

385 

386 The ID of the file.

387 

388 - `Filename string`

389 

390 The filename of the container file cited.

391 

392 - `StartIndex int64`

393 

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

395 

396 - `Type ContainerFileCitation`

397 

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

399 

400 - `const ContainerFileCitationContainerFileCitation ContainerFileCitation = "container_file_citation"`

401 

402 - `type ResponseOutputTextAnnotationFilePath struct{…}`

403 

404 A path to a file.

405 

406 - `FileID string`

407 

408 The ID of the file.

409 

410 - `Index int64`

411 

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

413 

414 - `Type FilePath`

415 

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

417 

418 - `const FilePathFilePath FilePath = "file_path"`

419 

420 - `Text string`

421 

422 The text output from the model.

423 

424 - `Type OutputText`

425 

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

427 

428 - `const OutputTextOutputText OutputText = "output_text"`

429 

430 - `Logprobs []ResponseOutputTextLogprob`

431 

432 - `Token string`

433 

434 - `Bytes []int64`

435 

436 - `Logprob float64`

437 

438 - `TopLogprobs []ResponseOutputTextLogprobTopLogprob`

439 

440 - `Token string`

441 

442 - `Bytes []int64`

443 

444 - `Logprob float64`

445 

446 - `type ResponseOutputRefusal struct{…}`

447 

448 A refusal from the model.

449 

450 - `Refusal string`

451 

452 The refusal explanation from the model.

453 

454 - `Type Refusal`

455 

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

457 

458 - `const RefusalRefusal Refusal = "refusal"`

459 

460 - `Role Assistant`

461 

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

463 

464 - `const AssistantAssistant Assistant = "assistant"`

465 

466 - `Status ResponseOutputMessageStatus`

467 

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

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

470 

471 - `const ResponseOutputMessageStatusInProgress ResponseOutputMessageStatus = "in_progress"`

472 

473 - `const ResponseOutputMessageStatusCompleted ResponseOutputMessageStatus = "completed"`

474 

475 - `const ResponseOutputMessageStatusIncomplete ResponseOutputMessageStatus = "incomplete"`

476 

477 - `Type Message`

478 

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

480 

481 - `const MessageMessage Message = "message"`

482 

483 - `Phase ResponseOutputMessagePhase`

484 

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

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

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

488 

489 - `const ResponseOutputMessagePhaseCommentary ResponseOutputMessagePhase = "commentary"`

490 

491 - `const ResponseOutputMessagePhaseFinalAnswer ResponseOutputMessagePhase = "final_answer"`

492 

493 - `type ResponseFileSearchToolCall struct{…}`

494 

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

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

497 

498 - `ID string`

499 

500 The unique ID of the file search tool call.

501 

502 - `Queries []string`

503 

504 The queries used to search for files.

505 

506 - `Status ResponseFileSearchToolCallStatus`

507 

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

509 `searching`, `incomplete` or `failed`,

510 

511 - `const ResponseFileSearchToolCallStatusInProgress ResponseFileSearchToolCallStatus = "in_progress"`

512 

513 - `const ResponseFileSearchToolCallStatusSearching ResponseFileSearchToolCallStatus = "searching"`

514 

515 - `const ResponseFileSearchToolCallStatusCompleted ResponseFileSearchToolCallStatus = "completed"`

516 

517 - `const ResponseFileSearchToolCallStatusIncomplete ResponseFileSearchToolCallStatus = "incomplete"`

518 

519 - `const ResponseFileSearchToolCallStatusFailed ResponseFileSearchToolCallStatus = "failed"`

520 

521 - `Type FileSearchCall`

522 

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

524 

525 - `const FileSearchCallFileSearchCall FileSearchCall = "file_search_call"`

526 

527 - `Results []ResponseFileSearchToolCallResult`

528 

529 The results of the file search tool call.

530 

531 - `Attributes map[string, ResponseFileSearchToolCallResultAttributeUnion]`

532 

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

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

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

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

537 length of 512 characters, booleans, or numbers.

538 

539 - `string`

540 

541 - `float64`

542 

543 - `bool`

544 

545 - `FileID string`

546 

547 The unique ID of the file.

548 

549 - `Filename string`

550 

551 The name of the file.

552 

553 - `Score float64`

554 

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

556 

557 - `Text string`

558 

559 The text that was retrieved from the file.

560 

561 - `type ResponseComputerToolCall struct{…}`

562 

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

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

565 

566 - `ID string`

567 

568 The unique ID of the computer call.

569 

570 - `CallID string`

571 

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

573 

574 - `PendingSafetyChecks []ResponseComputerToolCallPendingSafetyCheck`

575 

576 The pending safety checks for the computer call.

577 

578 - `ID string`

579 

580 The ID of the pending safety check.

581 

582 - `Code string`

583 

584 The type of the pending safety check.

585 

586 - `Message string`

587 

588 Details about the pending safety check.

589 

590 - `Status ResponseComputerToolCallStatus`

591 

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

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

594 

595 - `const ResponseComputerToolCallStatusInProgress ResponseComputerToolCallStatus = "in_progress"`

596 

597 - `const ResponseComputerToolCallStatusCompleted ResponseComputerToolCallStatus = "completed"`

598 

599 - `const ResponseComputerToolCallStatusIncomplete ResponseComputerToolCallStatus = "incomplete"`

600 

601 - `Type ResponseComputerToolCallType`

602 

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

604 

605 - `const ResponseComputerToolCallTypeComputerCall ResponseComputerToolCallType = "computer_call"`

606 

607 - `Action ResponseComputerToolCallActionUnion`

608 

609 A click action.

610 

611 - `type ResponseComputerToolCallActionClick struct{…}`

612 

613 A click action.

614 

615 - `Button string`

616 

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

618 

619 - `const ResponseComputerToolCallActionClickButtonLeft ResponseComputerToolCallActionClickButton = "left"`

620 

621 - `const ResponseComputerToolCallActionClickButtonRight ResponseComputerToolCallActionClickButton = "right"`

622 

623 - `const ResponseComputerToolCallActionClickButtonWheel ResponseComputerToolCallActionClickButton = "wheel"`

624 

625 - `const ResponseComputerToolCallActionClickButtonBack ResponseComputerToolCallActionClickButton = "back"`

626 

627 - `const ResponseComputerToolCallActionClickButtonForward ResponseComputerToolCallActionClickButton = "forward"`

628 

629 - `Type Click`

630 

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

632 

633 - `const ClickClick Click = "click"`

634 

635 - `X int64`

636 

637 The x-coordinate where the click occurred.

638 

639 - `Y int64`

640 

641 The y-coordinate where the click occurred.

642 

643 - `Keys []string`

644 

645 The keys being held while clicking.

646 

647 - `type ResponseComputerToolCallActionDoubleClick struct{…}`

648 

649 A double click action.

650 

651 - `Keys []string`

652 

653 The keys being held while double-clicking.

654 

655 - `Type DoubleClick`

656 

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

658 

659 - `const DoubleClickDoubleClick DoubleClick = "double_click"`

660 

661 - `X int64`

662 

663 The x-coordinate where the double click occurred.

664 

665 - `Y int64`

666 

667 The y-coordinate where the double click occurred.

668 

669 - `type ResponseComputerToolCallActionDrag struct{…}`

670 

671 A drag action.

672 

673 - `Path []ResponseComputerToolCallActionDragPath`

674 

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

676 

677 ```

678 [

679 { x: 100, y: 200 },

680 { x: 200, y: 300 }

681 ]

682 ```

683 

684 - `X int64`

685 

686 The x-coordinate.

687 

688 - `Y int64`

689 

690 The y-coordinate.

691 

692 - `Type Drag`

693 

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

695 

696 - `const DragDrag Drag = "drag"`

697 

698 - `Keys []string`

699 

700 The keys being held while dragging the mouse.

701 

702 - `type ResponseComputerToolCallActionKeypress struct{…}`

703 

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

705 

706 - `Keys []string`

707 

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

709 

710 - `Type Keypress`

711 

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

713 

714 - `const KeypressKeypress Keypress = "keypress"`

715 

716 - `type ResponseComputerToolCallActionMove struct{…}`

717 

718 A mouse move action.

719 

720 - `Type Move`

721 

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

723 

724 - `const MoveMove Move = "move"`

725 

726 - `X int64`

727 

728 The x-coordinate to move to.

729 

730 - `Y int64`

731 

732 The y-coordinate to move to.

733 

734 - `Keys []string`

735 

736 The keys being held while moving the mouse.

737 

738 - `type ResponseComputerToolCallActionScreenshot struct{…}`

739 

740 A screenshot action.

741 

742 - `Type Screenshot`

743 

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

745 

746 - `const ScreenshotScreenshot Screenshot = "screenshot"`

747 

748 - `type ResponseComputerToolCallActionScroll struct{…}`

749 

750 A scroll action.

751 

752 - `ScrollX int64`

753 

754 The horizontal scroll distance.

755 

756 - `ScrollY int64`

757 

758 The vertical scroll distance.

759 

760 - `Type Scroll`

761 

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

763 

764 - `const ScrollScroll Scroll = "scroll"`

765 

766 - `X int64`

767 

768 The x-coordinate where the scroll occurred.

769 

770 - `Y int64`

771 

772 The y-coordinate where the scroll occurred.

773 

774 - `Keys []string`

775 

776 The keys being held while scrolling.

777 

778 - `type ResponseComputerToolCallActionType struct{…}`

779 

780 An action to type in text.

781 

782 - `Text string`

783 

784 The text to type.

785 

786 - `Type Type`

787 

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

789 

790 - `const TypeType Type = "type"`

791 

792 - `type ResponseComputerToolCallActionWait struct{…}`

793 

794 A wait action.

795 

796 - `Type Wait`

797 

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

799 

800 - `const WaitWait Wait = "wait"`

801 

802 - `Actions ComputerActionList`

803 

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

805 `type` discriminator and action-specific fields.

806 

807 - `type ComputerActionClick struct{…}`

808 

809 A click action.

810 

811 - `Button string`

812 

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

814 

815 - `const ComputerActionClickButtonLeft ComputerActionClickButton = "left"`

816 

817 - `const ComputerActionClickButtonRight ComputerActionClickButton = "right"`

818 

819 - `const ComputerActionClickButtonWheel ComputerActionClickButton = "wheel"`

820 

821 - `const ComputerActionClickButtonBack ComputerActionClickButton = "back"`

822 

823 - `const ComputerActionClickButtonForward ComputerActionClickButton = "forward"`

824 

825 - `Type Click`

826 

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

828 

829 - `const ClickClick Click = "click"`

830 

831 - `X int64`

832 

833 The x-coordinate where the click occurred.

834 

835 - `Y int64`

836 

837 The y-coordinate where the click occurred.

838 

839 - `Keys []string`

840 

841 The keys being held while clicking.

842 

843 - `type ComputerActionDoubleClick struct{…}`

844 

845 A double click action.

846 

847 - `Keys []string`

848 

849 The keys being held while double-clicking.

850 

851 - `Type DoubleClick`

852 

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

854 

855 - `const DoubleClickDoubleClick DoubleClick = "double_click"`

856 

857 - `X int64`

858 

859 The x-coordinate where the double click occurred.

860 

861 - `Y int64`

862 

863 The y-coordinate where the double click occurred.

864 

865 - `type ComputerActionDrag struct{…}`

866 

867 A drag action.

868 

869 - `Path []ComputerActionDragPath`

870 

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

872 

873 ```

874 [

875 { x: 100, y: 200 },

876 { x: 200, y: 300 }

877 ]

878 ```

879 

880 - `X int64`

881 

882 The x-coordinate.

883 

884 - `Y int64`

885 

886 The y-coordinate.

887 

888 - `Type Drag`

889 

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

891 

892 - `const DragDrag Drag = "drag"`

893 

894 - `Keys []string`

895 

896 The keys being held while dragging the mouse.

897 

898 - `type ComputerActionKeypress struct{…}`

899 

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

901 

902 - `Keys []string`

903 

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

905 

906 - `Type Keypress`

907 

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

909 

910 - `const KeypressKeypress Keypress = "keypress"`

911 

912 - `type ComputerActionMove struct{…}`

913 

914 A mouse move action.

915 

916 - `Type Move`

917 

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

919 

920 - `const MoveMove Move = "move"`

921 

922 - `X int64`

923 

924 The x-coordinate to move to.

925 

926 - `Y int64`

927 

928 The y-coordinate to move to.

929 

930 - `Keys []string`

931 

932 The keys being held while moving the mouse.

933 

934 - `type ComputerActionScreenshot struct{…}`

935 

936 A screenshot action.

937 

938 - `Type Screenshot`

939 

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

941 

942 - `const ScreenshotScreenshot Screenshot = "screenshot"`

943 

944 - `type ComputerActionScroll struct{…}`

945 

946 A scroll action.

947 

948 - `ScrollX int64`

949 

950 The horizontal scroll distance.

951 

952 - `ScrollY int64`

953 

954 The vertical scroll distance.

955 

956 - `Type Scroll`

957 

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

959 

960 - `const ScrollScroll Scroll = "scroll"`

961 

962 - `X int64`

963 

964 The x-coordinate where the scroll occurred.

965 

966 - `Y int64`

967 

968 The y-coordinate where the scroll occurred.

969 

970 - `Keys []string`

971 

972 The keys being held while scrolling.

973 

974 - `type ComputerActionType struct{…}`

975 

976 An action to type in text.

977 

978 - `Text string`

979 

980 The text to type.

981 

982 - `Type Type`

983 

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

985 

986 - `const TypeType Type = "type"`

987 

988 - `type ComputerActionWait struct{…}`

989 

990 A wait action.

991 

992 - `Type Wait`

993 

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

995 

996 - `const WaitWait Wait = "wait"`

997 

998 - `type ResponseInputItemComputerCallOutput struct{…}`

999 

1000 The output of a computer tool call.

1001 

1002 - `CallID string`

1003 

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

1005 

1006 - `Output ResponseComputerToolCallOutputScreenshot`

1007 

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

1009 

1010 - `Type ComputerScreenshot`

1011 

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

1013 always set to `computer_screenshot`.

1014 

1015 - `const ComputerScreenshotComputerScreenshot ComputerScreenshot = "computer_screenshot"`

1016 

1017 - `FileID string`

1018 

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

1020 

1021 - `ImageURL string`

1022 

1023 The URL of the screenshot image.

1024 

1025 - `Type ComputerCallOutput`

1026 

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

1028 

1029 - `const ComputerCallOutputComputerCallOutput ComputerCallOutput = "computer_call_output"`

1030 

1031 - `ID string`

1032 

1033 The ID of the computer tool call output.

1034 

1035 - `AcknowledgedSafetyChecks []ResponseInputItemComputerCallOutputAcknowledgedSafetyCheck`

1036 

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

1038 

1039 - `ID string`

1040 

1041 The ID of the pending safety check.

1042 

1043 - `Code string`

1044 

1045 The type of the pending safety check.

1046 

1047 - `Message string`

1048 

1049 Details about the pending safety check.

1050 

1051 - `Status string`

1052 

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

1054 

1055 - `const ResponseInputItemComputerCallOutputStatusInProgress ResponseInputItemComputerCallOutputStatus = "in_progress"`

1056 

1057 - `const ResponseInputItemComputerCallOutputStatusCompleted ResponseInputItemComputerCallOutputStatus = "completed"`

1058 

1059 - `const ResponseInputItemComputerCallOutputStatusIncomplete ResponseInputItemComputerCallOutputStatus = "incomplete"`

1060 

1061 - `type ResponseFunctionWebSearch struct{…}`

1062 

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

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

1065 

1066 - `ID string`

1067 

1068 The unique ID of the web search tool call.

1069 

1070 - `Action ResponseFunctionWebSearchActionUnion`

1071 

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

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

1074 

1075 - `type ResponseFunctionWebSearchActionSearch struct{…}`

1076 

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

1078 

1079 - `Query string`

1080 

1081 [DEPRECATED] The search query.

1082 

1083 - `Type Search`

1084 

1085 The action type.

1086 

1087 - `const SearchSearch Search = "search"`

1088 

1089 - `Queries []string`

1090 

1091 The search queries.

1092 

1093 - `Sources []ResponseFunctionWebSearchActionSearchSource`

1094 

1095 The sources used in the search.

1096 

1097 - `Type URL`

1098 

1099 The type of source. Always `url`.

1100 

1101 - `const URLURL URL = "url"`

1102 

1103 - `URL string`

1104 

1105 The URL of the source.

1106 

1107 - `type ResponseFunctionWebSearchActionOpenPage struct{…}`

1108 

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

1110 

1111 - `Type OpenPage`

1112 

1113 The action type.

1114 

1115 - `const OpenPageOpenPage OpenPage = "open_page"`

1116 

1117 - `URL string`

1118 

1119 The URL opened by the model.

1120 

1121 - `type ResponseFunctionWebSearchActionFindInPage struct{…}`

1122 

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

1124 

1125 - `Pattern string`

1126 

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

1128 

1129 - `Type FindInPage`

1130 

1131 The action type.

1132 

1133 - `const FindInPageFindInPage FindInPage = "find_in_page"`

1134 

1135 - `URL string`

1136 

1137 The URL of the page searched for the pattern.

1138 

1139 - `Status ResponseFunctionWebSearchStatus`

1140 

1141 The status of the web search tool call.

1142 

1143 - `const ResponseFunctionWebSearchStatusInProgress ResponseFunctionWebSearchStatus = "in_progress"`

1144 

1145 - `const ResponseFunctionWebSearchStatusSearching ResponseFunctionWebSearchStatus = "searching"`

1146 

1147 - `const ResponseFunctionWebSearchStatusCompleted ResponseFunctionWebSearchStatus = "completed"`

1148 

1149 - `const ResponseFunctionWebSearchStatusFailed ResponseFunctionWebSearchStatus = "failed"`

1150 

1151 - `Type WebSearchCall`

1152 

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

1154 

1155 - `const WebSearchCallWebSearchCall WebSearchCall = "web_search_call"`

1156 

1157 - `type ResponseFunctionToolCall struct{…}`

1158 

1159 A tool call to run a function. See the

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

1161 

1162 - `Arguments string`

1163 

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

1165 

1166 - `CallID string`

1167 

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

1169 

1170 - `Name string`

1171 

1172 The name of the function to run.

1173 

1174 - `Type FunctionCall`

1175 

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

1177 

1178 - `const FunctionCallFunctionCall FunctionCall = "function_call"`

1179 

1180 - `ID string`

1181 

1182 The unique ID of the function tool call.

1183 

1184 - `Namespace string`

1185 

1186 The namespace of the function to run.

1187 

1188 - `Status ResponseFunctionToolCallStatus`

1189 

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

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

1192 

1193 - `const ResponseFunctionToolCallStatusInProgress ResponseFunctionToolCallStatus = "in_progress"`

1194 

1195 - `const ResponseFunctionToolCallStatusCompleted ResponseFunctionToolCallStatus = "completed"`

1196 

1197 - `const ResponseFunctionToolCallStatusIncomplete ResponseFunctionToolCallStatus = "incomplete"`

1198 

1199 - `type ResponseInputItemFunctionCallOutput struct{…}`

1200 

1201 The output of a function tool call.

1202 

1203 - `CallID string`

1204 

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

1206 

1207 - `Output ResponseInputItemFunctionCallOutputOutputUnion`

1208 

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

1210 

1211 - `string`

1212 

1213 - `type ResponseFunctionCallOutputItemList []ResponseFunctionCallOutputItemUnion`

1214 

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

1216 

1217 - `type ResponseInputTextContent struct{…}`

1218 

1219 A text input to the model.

1220 

1221 - `Text string`

1222 

1223 The text input to the model.

1224 

1225 - `Type InputText`

1226 

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

1228 

1229 - `const InputTextInputText InputText = "input_text"`

1230 

1231 - `type ResponseInputImageContent struct{…}`

1232 

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

1234 

1235 - `Type InputImage`

1236 

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

1238 

1239 - `const InputImageInputImage InputImage = "input_image"`

1240 

1241 - `Detail ResponseInputImageContentDetail`

1242 

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

1244 

1245 - `const ResponseInputImageContentDetailLow ResponseInputImageContentDetail = "low"`

1246 

1247 - `const ResponseInputImageContentDetailHigh ResponseInputImageContentDetail = "high"`

1248 

1249 - `const ResponseInputImageContentDetailAuto ResponseInputImageContentDetail = "auto"`

1250 

1251 - `const ResponseInputImageContentDetailOriginal ResponseInputImageContentDetail = "original"`

1252 

1253 - `FileID string`

1254 

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

1256 

1257 - `ImageURL string`

1258 

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

1260 

1261 - `type ResponseInputFileContent struct{…}`

1262 

1263 A file input to the model.

1264 

1265 - `Type InputFile`

1266 

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

1268 

1269 - `const InputFileInputFile InputFile = "input_file"`

1270 

1271 - `Detail ResponseInputFileContentDetail`

1272 

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

1274 

1275 - `const ResponseInputFileContentDetailLow ResponseInputFileContentDetail = "low"`

1276 

1277 - `const ResponseInputFileContentDetailHigh ResponseInputFileContentDetail = "high"`

1278 

1279 - `FileData string`

1280 

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

1282 

1283 - `FileID string`

1284 

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

1286 

1287 - `FileURL string`

1288 

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

1290 

1291 - `Filename string`

1292 

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

1294 

1295 - `Type FunctionCallOutput`

1296 

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

1298 

1299 - `const FunctionCallOutputFunctionCallOutput FunctionCallOutput = "function_call_output"`

1300 

1301 - `ID string`

1302 

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

1304 

1305 - `Status string`

1306 

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

1308 

1309 - `const ResponseInputItemFunctionCallOutputStatusInProgress ResponseInputItemFunctionCallOutputStatus = "in_progress"`

1310 

1311 - `const ResponseInputItemFunctionCallOutputStatusCompleted ResponseInputItemFunctionCallOutputStatus = "completed"`

1312 

1313 - `const ResponseInputItemFunctionCallOutputStatusIncomplete ResponseInputItemFunctionCallOutputStatus = "incomplete"`

1314 

1315 - `type ResponseInputItemToolSearchCall struct{…}`

1316 

1317 - `Arguments any`

1318 

1319 The arguments supplied to the tool search call.

1320 

1321 - `Type ToolSearchCall`

1322 

1323 The item type. Always `tool_search_call`.

1324 

1325 - `const ToolSearchCallToolSearchCall ToolSearchCall = "tool_search_call"`

1326 

1327 - `ID string`

1328 

1329 The unique ID of this tool search call.

1330 

1331 - `CallID string`

1332 

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

1334 

1335 - `Execution string`

1336 

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

1338 

1339 - `const ResponseInputItemToolSearchCallExecutionServer ResponseInputItemToolSearchCallExecution = "server"`

1340 

1341 - `const ResponseInputItemToolSearchCallExecutionClient ResponseInputItemToolSearchCallExecution = "client"`

1342 

1343 - `Status string`

1344 

1345 The status of the tool search call.

1346 

1347 - `const ResponseInputItemToolSearchCallStatusInProgress ResponseInputItemToolSearchCallStatus = "in_progress"`

1348 

1349 - `const ResponseInputItemToolSearchCallStatusCompleted ResponseInputItemToolSearchCallStatus = "completed"`

1350 

1351 - `const ResponseInputItemToolSearchCallStatusIncomplete ResponseInputItemToolSearchCallStatus = "incomplete"`

1352 

1353 - `type ResponseToolSearchOutputItemParamResp struct{…}`

1354 

1355 - `Tools []ToolUnion`

1356 

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

1358 

1359 - `type FunctionTool struct{…}`

1360 

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

1362 

1363 - `Name string`

1364 

1365 The name of the function to call.

1366 

1367 - `Parameters map[string, any]`

1368 

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

1370 

1371 - `Strict bool`

1372 

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

1374 

1375 - `Type Function`

1376 

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

1378 

1379 - `const FunctionFunction Function = "function"`

1380 

1381 - `DeferLoading bool`

1382 

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

1384 

1385 - `Description string`

1386 

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

1388 

1389 - `type FileSearchTool struct{…}`

1390 

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

1392 

1393 - `Type FileSearch`

1394 

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

1396 

1397 - `const FileSearchFileSearch FileSearch = "file_search"`

1398 

1399 - `VectorStoreIDs []string`

1400 

1401 The IDs of the vector stores to search.

1402 

1403 - `Filters FileSearchToolFiltersUnion`

1404 

1405 A filter to apply.

1406 

1407 - `type ComparisonFilter struct{…}`

1408 

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

1410 

1411 - `Key string`

1412 

1413 The key to compare against the value.

1414 

1415 - `Type ComparisonFilterType`

1416 

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

1418 

1419 - `eq`: equals

1420 - `ne`: not equal

1421 - `gt`: greater than

1422 - `gte`: greater than or equal

1423 - `lt`: less than

1424 - `lte`: less than or equal

1425 - `in`: in

1426 - `nin`: not in

1427 

1428 - `const ComparisonFilterTypeEq ComparisonFilterType = "eq"`

1429 

1430 - `const ComparisonFilterTypeNe ComparisonFilterType = "ne"`

1431 

1432 - `const ComparisonFilterTypeGt ComparisonFilterType = "gt"`

1433 

1434 - `const ComparisonFilterTypeGte ComparisonFilterType = "gte"`

1435 

1436 - `const ComparisonFilterTypeLt ComparisonFilterType = "lt"`

1437 

1438 - `const ComparisonFilterTypeLte ComparisonFilterType = "lte"`

1439 

1440 - `const ComparisonFilterTypeIn ComparisonFilterType = "in"`

1441 

1442 - `const ComparisonFilterTypeNin ComparisonFilterType = "nin"`

1443 

1444 - `Value ComparisonFilterValueUnion`

1445 

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

1447 

1448 - `string`

1449 

1450 - `float64`

1451 

1452 - `bool`

1453 

1454 - `type ComparisonFilterValueArray []ComparisonFilterValueArrayItemUnion`

1455 

1456 - `string`

1457 

1458 - `float64`

1459 

1460 - `type CompoundFilter struct{…}`

1461 

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

1463 

1464 - `Filters []ComparisonFilter`

1465 

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

1467 

1468 - `type ComparisonFilter struct{…}`

1469 

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

1471 

1472 - `Type CompoundFilterType`

1473 

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

1475 

1476 - `const CompoundFilterTypeAnd CompoundFilterType = "and"`

1477 

1478 - `const CompoundFilterTypeOr CompoundFilterType = "or"`

1479 

1480 - `MaxNumResults int64`

1481 

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

1483 

1484 - `RankingOptions FileSearchToolRankingOptions`

1485 

1486 Ranking options for search.

1487 

1488 - `HybridSearch FileSearchToolRankingOptionsHybridSearch`

1489 

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

1491 

1492 - `EmbeddingWeight float64`

1493 

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

1495 

1496 - `TextWeight float64`

1497 

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

1499 

1500 - `Ranker string`

1501 

1502 The ranker to use for the file search.

1503 

1504 - `const FileSearchToolRankingOptionsRankerAuto FileSearchToolRankingOptionsRanker = "auto"`

1505 

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

1507 

1508 - `ScoreThreshold float64`

1509 

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

1511 

1512 - `type ComputerTool struct{…}`

1513 

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

1515 

1516 - `Type Computer`

1517 

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

1519 

1520 - `const ComputerComputer Computer = "computer"`

1521 

1522 - `type ComputerUsePreviewTool struct{…}`

1523 

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

1525 

1526 - `DisplayHeight int64`

1527 

1528 The height of the computer display.

1529 

1530 - `DisplayWidth int64`

1531 

1532 The width of the computer display.

1533 

1534 - `Environment ComputerUsePreviewToolEnvironment`

1535 

1536 The type of computer environment to control.

1537 

1538 - `const ComputerUsePreviewToolEnvironmentWindows ComputerUsePreviewToolEnvironment = "windows"`

1539 

1540 - `const ComputerUsePreviewToolEnvironmentMac ComputerUsePreviewToolEnvironment = "mac"`

1541 

1542 - `const ComputerUsePreviewToolEnvironmentLinux ComputerUsePreviewToolEnvironment = "linux"`

1543 

1544 - `const ComputerUsePreviewToolEnvironmentUbuntu ComputerUsePreviewToolEnvironment = "ubuntu"`

1545 

1546 - `const ComputerUsePreviewToolEnvironmentBrowser ComputerUsePreviewToolEnvironment = "browser"`

1547 

1548 - `Type ComputerUsePreview`

1549 

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

1551 

1552 - `const ComputerUsePreviewComputerUsePreview ComputerUsePreview = "computer_use_preview"`

1553 

1554 - `type WebSearchTool struct{…}`

1555 

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

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

1558 

1559 - `Type WebSearchToolType`

1560 

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

1562 

1563 - `const WebSearchToolTypeWebSearch WebSearchToolType = "web_search"`

1564 

1565 - `const WebSearchToolTypeWebSearch2025_08_26 WebSearchToolType = "web_search_2025_08_26"`

1566 

1567 - `Filters WebSearchToolFilters`

1568 

1569 Filters for the search.

1570 

1571 - `AllowedDomains []string`

1572 

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

1574 Subdomains of the provided domains are allowed as well.

1575 

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

1577 

1578 - `SearchContextSize WebSearchToolSearchContextSize`

1579 

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

1581 

1582 - `const WebSearchToolSearchContextSizeLow WebSearchToolSearchContextSize = "low"`

1583 

1584 - `const WebSearchToolSearchContextSizeMedium WebSearchToolSearchContextSize = "medium"`

1585 

1586 - `const WebSearchToolSearchContextSizeHigh WebSearchToolSearchContextSize = "high"`

1587 

1588 - `UserLocation WebSearchToolUserLocation`

1589 

1590 The approximate location of the user.

1591 

1592 - `City string`

1593 

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

1595 

1596 - `Country string`

1597 

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

1599 

1600 - `Region string`

1601 

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

1603 

1604 - `Timezone string`

1605 

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

1607 

1608 - `Type string`

1609 

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

1611 

1612 - `const WebSearchToolUserLocationTypeApproximate WebSearchToolUserLocationType = "approximate"`

1613 

1614 - `type ToolMcp struct{…}`

1615 

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

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

1618 

1619 - `ServerLabel string`

1620 

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

1622 

1623 - `Type Mcp`

1624 

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

1626 

1627 - `const McpMcp Mcp = "mcp"`

1628 

1629 - `AllowedTools ToolMcpAllowedToolsUnion`

1630 

1631 List of allowed tool names or a filter object.

1632 

1633 - `type ToolMcpAllowedToolsMcpAllowedTools []string`

1634 

1635 A string array of allowed tool names

1636 

1637 - `type ToolMcpAllowedToolsMcpToolFilter struct{…}`

1638 

1639 A filter object to specify which tools are allowed.

1640 

1641 - `ReadOnly bool`

1642 

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

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

1645 it will match this filter.

1646 

1647 - `ToolNames []string`

1648 

1649 List of allowed tool names.

1650 

1651 - `Authorization string`

1652 

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

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

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

1656 

1657 - `ConnectorID string`

1658 

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

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

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

1662 

1663 Currently supported `connector_id` values are:

1664 

1665 - Dropbox: `connector_dropbox`

1666 - Gmail: `connector_gmail`

1667 - Google Calendar: `connector_googlecalendar`

1668 - Google Drive: `connector_googledrive`

1669 - Microsoft Teams: `connector_microsoftteams`

1670 - Outlook Calendar: `connector_outlookcalendar`

1671 - Outlook Email: `connector_outlookemail`

1672 - SharePoint: `connector_sharepoint`

1673 

1674 - `const ToolMcpConnectorIDConnectorDropbox ToolMcpConnectorID = "connector_dropbox"`

1675 

1676 - `const ToolMcpConnectorIDConnectorGmail ToolMcpConnectorID = "connector_gmail"`

1677 

1678 - `const ToolMcpConnectorIDConnectorGooglecalendar ToolMcpConnectorID = "connector_googlecalendar"`

1679 

1680 - `const ToolMcpConnectorIDConnectorGoogledrive ToolMcpConnectorID = "connector_googledrive"`

1681 

1682 - `const ToolMcpConnectorIDConnectorMicrosoftteams ToolMcpConnectorID = "connector_microsoftteams"`

1683 

1684 - `const ToolMcpConnectorIDConnectorOutlookcalendar ToolMcpConnectorID = "connector_outlookcalendar"`

1685 

1686 - `const ToolMcpConnectorIDConnectorOutlookemail ToolMcpConnectorID = "connector_outlookemail"`

1687 

1688 - `const ToolMcpConnectorIDConnectorSharepoint ToolMcpConnectorID = "connector_sharepoint"`

1689 

1690 - `DeferLoading bool`

1691 

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

1693 

1694 - `Headers map[string, string]`

1695 

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

1697 or other purposes.

1698 

1699 - `RequireApproval ToolMcpRequireApprovalUnion`

1700 

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

1702 

1703 - `type ToolMcpRequireApprovalMcpToolApprovalFilter struct{…}`

1704 

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

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

1707 that require approval.

1708 

1709 - `Always ToolMcpRequireApprovalMcpToolApprovalFilterAlways`

1710 

1711 A filter object to specify which tools are allowed.

1712 

1713 - `ReadOnly bool`

1714 

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

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

1717 it will match this filter.

1718 

1719 - `ToolNames []string`

1720 

1721 List of allowed tool names.

1722 

1723 - `Never ToolMcpRequireApprovalMcpToolApprovalFilterNever`

1724 

1725 A filter object to specify which tools are allowed.

1726 

1727 - `ReadOnly bool`

1728 

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

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

1731 it will match this filter.

1732 

1733 - `ToolNames []string`

1734 

1735 List of allowed tool names.

1736 

1737 - `type ToolMcpRequireApprovalMcpToolApprovalSetting string`

1738 

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

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

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

1742 

1743 - `const ToolMcpRequireApprovalMcpToolApprovalSettingAlways ToolMcpRequireApprovalMcpToolApprovalSetting = "always"`

1744 

1745 - `const ToolMcpRequireApprovalMcpToolApprovalSettingNever ToolMcpRequireApprovalMcpToolApprovalSetting = "never"`

1746 

1747 - `ServerDescription string`

1748 

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

1750 

1751 - `ServerURL string`

1752 

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

1754 provided.

1755 

1756 - `type ToolCodeInterpreter struct{…}`

1757 

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

1759 

1760 - `Container ToolCodeInterpreterContainerUnion`

1761 

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

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

1764 optional `memory_limit` setting.

1765 

1766 - `string`

1767 

1768 - `type ToolCodeInterpreterContainerCodeInterpreterContainerAuto struct{…}`

1769 

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

1771 

1772 - `Type Auto`

1773 

1774 Always `auto`.

1775 

1776 - `const AutoAuto Auto = "auto"`

1777 

1778 - `FileIDs []string`

1779 

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

1781 

1782 - `MemoryLimit string`

1783 

1784 The memory limit for the code interpreter container.

1785 

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

1787 

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

1789 

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

1791 

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

1793 

1794 - `NetworkPolicy ToolCodeInterpreterContainerCodeInterpreterToolAutoNetworkPolicyUnion`

1795 

1796 Network access policy for the container.

1797 

1798 - `type ContainerNetworkPolicyDisabled struct{…}`

1799 

1800 - `Type Disabled`

1801 

1802 Disable outbound network access. Always `disabled`.

1803 

1804 - `const DisabledDisabled Disabled = "disabled"`

1805 

1806 - `type ContainerNetworkPolicyAllowlist struct{…}`

1807 

1808 - `AllowedDomains []string`

1809 

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

1811 

1812 - `Type Allowlist`

1813 

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

1815 

1816 - `const AllowlistAllowlist Allowlist = "allowlist"`

1817 

1818 - `DomainSecrets []ContainerNetworkPolicyDomainSecret`

1819 

1820 Optional domain-scoped secrets for allowlisted domains.

1821 

1822 - `Domain string`

1823 

1824 The domain associated with the secret.

1825 

1826 - `Name string`

1827 

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

1829 

1830 - `Value string`

1831 

1832 The secret value to inject for the domain.

1833 

1834 - `Type CodeInterpreter`

1835 

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

1837 

1838 - `const CodeInterpreterCodeInterpreter CodeInterpreter = "code_interpreter"`

1839 

1840 - `type ToolImageGeneration struct{…}`

1841 

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

1843 

1844 - `Type ImageGeneration`

1845 

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

1847 

1848 - `const ImageGenerationImageGeneration ImageGeneration = "image_generation"`

1849 

1850 - `Action string`

1851 

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

1853 

1854 - `const ToolImageGenerationActionGenerate ToolImageGenerationAction = "generate"`

1855 

1856 - `const ToolImageGenerationActionEdit ToolImageGenerationAction = "edit"`

1857 

1858 - `const ToolImageGenerationActionAuto ToolImageGenerationAction = "auto"`

1859 

1860 - `Background string`

1861 

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

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

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

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

1866 automatically determine the best background for the image.

1867 

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

1869 transparent backgrounds. Requests with `background` set to

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

1871 `auto` instead.

1872 

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

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

1875 

1876 - `const ToolImageGenerationBackgroundTransparent ToolImageGenerationBackground = "transparent"`

1877 

1878 - `const ToolImageGenerationBackgroundOpaque ToolImageGenerationBackground = "opaque"`

1879 

1880 - `const ToolImageGenerationBackgroundAuto ToolImageGenerationBackground = "auto"`

1881 

1882 - `InputFidelity string`

1883 

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

1885 

1886 - `const ToolImageGenerationInputFidelityHigh ToolImageGenerationInputFidelity = "high"`

1887 

1888 - `const ToolImageGenerationInputFidelityLow ToolImageGenerationInputFidelity = "low"`

1889 

1890 - `InputImageMask ToolImageGenerationInputImageMask`

1891 

1892 Optional mask for inpainting. Contains `image_url`

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

1894 

1895 - `FileID string`

1896 

1897 File ID for the mask image.

1898 

1899 - `ImageURL string`

1900 

1901 Base64-encoded mask image.

1902 

1903 - `Model string`

1904 

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

1906 

1907 - `string`

1908 

1909 - `string`

1910 

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

1912 

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

1914 

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

1916 

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

1918 

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

1920 

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

1922 

1923 - `Moderation string`

1924 

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

1926 

1927 - `const ToolImageGenerationModerationAuto ToolImageGenerationModeration = "auto"`

1928 

1929 - `const ToolImageGenerationModerationLow ToolImageGenerationModeration = "low"`

1930 

1931 - `OutputCompression int64`

1932 

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

1934 

1935 - `OutputFormat string`

1936 

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

1938 `jpeg`. Default: `png`.

1939 

1940 - `const ToolImageGenerationOutputFormatPNG ToolImageGenerationOutputFormat = "png"`

1941 

1942 - `const ToolImageGenerationOutputFormatWebP ToolImageGenerationOutputFormat = "webp"`

1943 

1944 - `const ToolImageGenerationOutputFormatJPEG ToolImageGenerationOutputFormat = "jpeg"`

1945 

1946 - `PartialImages int64`

1947 

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

1949 

1950 - `Quality string`

1951 

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

1953 or `auto`. Default: `auto`.

1954 

1955 - `const ToolImageGenerationQualityLow ToolImageGenerationQuality = "low"`

1956 

1957 - `const ToolImageGenerationQualityMedium ToolImageGenerationQuality = "medium"`

1958 

1959 - `const ToolImageGenerationQualityHigh ToolImageGenerationQuality = "high"`

1960 

1961 - `const ToolImageGenerationQualityAuto ToolImageGenerationQuality = "auto"`

1962 

1963 - `Size string`

1964 

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

1966 

1967 - `string`

1968 

1969 - `string`

1970 

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

1972 

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

1974 

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

1976 

1977 - `const ToolImageGenerationSizeAuto ToolImageGenerationSize = "auto"`

1978 

1979 - `type ToolLocalShell struct{…}`

1980 

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

1982 

1983 - `Type LocalShell`

1984 

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

1986 

1987 - `const LocalShellLocalShell LocalShell = "local_shell"`

1988 

1989 - `type FunctionShellTool struct{…}`

1990 

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

1992 

1993 - `Type Shell`

1994 

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

1996