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

1# Input Tokens

2 

3## Get input token counts

4 

5`client.Responses.InputTokens.Count(ctx, body) (*InputTokenCountResponse, error)`

6 

7**post** `/responses/input_tokens`

8 

9Returns input token counts of the request.

10 

11Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.

12 

13### Parameters

14 

15- `body InputTokenCountParams`

16 

17 - `Conversation param.Field[InputTokenCountParamsConversationUnion]`

18 

19 The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request.

20 Input items and output items from this response are automatically added to this conversation after this response completes.

21 

22 - `string`

23 

24 - `type ResponseConversationParamResp struct{…}`

25 

26 The conversation that this response belongs to.

27 

28 - `ID string`

29 

30 The unique ID of the conversation.

31 

32 - `Input param.Field[InputTokenCountParamsInputUnion]`

33 

34 Text, image, or file inputs to the model, used to generate a response

35 

36 - `string`

37 

38 - `type InputTokenCountParamsInputArray []ResponseInputItemUnion`

39 

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

41 

42 - `type EasyInputMessage struct{…}`

43 

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

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

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

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

48 interactions.

49 

50 - `Content EasyInputMessageContentUnion`

51 

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

53 Can also contain previous assistant responses.

54 

55 - `string`

56 

57 - `type ResponseInputMessageContentList []ResponseInputContentUnion`

58 

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

60 types.

61 

62 - `type ResponseInputText struct{…}`

63 

64 A text input to the model.

65 

66 - `Text string`

67 

68 The text input to the model.

69 

70 - `Type InputText`

71 

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

73 

74 - `const InputTextInputText InputText = "input_text"`

75 

76 - `type ResponseInputImage struct{…}`

77 

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

79 

80 - `Detail ResponseInputImageDetail`

81 

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

83 

84 - `const ResponseInputImageDetailLow ResponseInputImageDetail = "low"`

85 

86 - `const ResponseInputImageDetailHigh ResponseInputImageDetail = "high"`

87 

88 - `const ResponseInputImageDetailAuto ResponseInputImageDetail = "auto"`

89 

90 - `const ResponseInputImageDetailOriginal ResponseInputImageDetail = "original"`

91 

92 - `Type InputImage`

93 

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

95 

96 - `const InputImageInputImage InputImage = "input_image"`

97 

98 - `FileID string`

99 

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

101 

102 - `ImageURL string`

103 

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

105 

106 - `type ResponseInputFile struct{…}`

107 

108 A file input to the model.

109 

110 - `Type InputFile`

111 

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

113 

114 - `const InputFileInputFile InputFile = "input_file"`

115 

116 - `Detail ResponseInputFileDetail`

117 

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

119 

120 - `const ResponseInputFileDetailLow ResponseInputFileDetail = "low"`

121 

122 - `const ResponseInputFileDetailHigh ResponseInputFileDetail = "high"`

123 

124 - `FileData string`

125 

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

127 

128 - `FileID string`

129 

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

131 

132 - `FileURL string`

133 

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

135 

136 - `Filename string`

137 

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

139 

140 - `Role EasyInputMessageRole`

141 

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

143 `developer`.

144 

145 - `const EasyInputMessageRoleUser EasyInputMessageRole = "user"`

146 

147 - `const EasyInputMessageRoleAssistant EasyInputMessageRole = "assistant"`

148 

149 - `const EasyInputMessageRoleSystem EasyInputMessageRole = "system"`

150 

151 - `const EasyInputMessageRoleDeveloper EasyInputMessageRole = "developer"`

152 

153 - `Phase EasyInputMessagePhase`

154 

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

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

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

158 

159 - `const EasyInputMessagePhaseCommentary EasyInputMessagePhase = "commentary"`

160 

161 - `const EasyInputMessagePhaseFinalAnswer EasyInputMessagePhase = "final_answer"`

162 

163 - `Type EasyInputMessageType`

164 

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

166 

167 - `const EasyInputMessageTypeMessage EasyInputMessageType = "message"`

168 

169 - `type ResponseInputItemMessage struct{…}`

170 

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

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

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

174 

175 - `Content ResponseInputMessageContentList`

176 

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

178 types.

179 

180 - `Role string`

181 

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

183 

184 - `const ResponseInputItemMessageRoleUser ResponseInputItemMessageRole = "user"`

185 

186 - `const ResponseInputItemMessageRoleSystem ResponseInputItemMessageRole = "system"`

187 

188 - `const ResponseInputItemMessageRoleDeveloper ResponseInputItemMessageRole = "developer"`

189 

190 - `Status string`

191 

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

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

194 

195 - `const ResponseInputItemMessageStatusInProgress ResponseInputItemMessageStatus = "in_progress"`

196 

197 - `const ResponseInputItemMessageStatusCompleted ResponseInputItemMessageStatus = "completed"`

198 

199 - `const ResponseInputItemMessageStatusIncomplete ResponseInputItemMessageStatus = "incomplete"`

200 

201 - `Type string`

202 

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

204 

205 - `const ResponseInputItemMessageTypeMessage ResponseInputItemMessageType = "message"`

206 

207 - `type ResponseOutputMessage struct{…}`

208 

209 An output message from the model.

210 

211 - `ID string`

212 

213 The unique ID of the output message.

214 

215 - `Content []ResponseOutputMessageContentUnion`

216 

217 The content of the output message.

218 

219 - `type ResponseOutputText struct{…}`

220 

221 A text output from the model.

222 

223 - `Annotations []ResponseOutputTextAnnotationUnion`

224 

225 The annotations of the text output.

226 

227 - `type ResponseOutputTextAnnotationFileCitation struct{…}`

228 

229 A citation to a file.

230 

231 - `FileID string`

232 

233 The ID of the file.

234 

235 - `Filename string`

236 

237 The filename of the file cited.

238 

239 - `Index int64`

240 

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

242 

243 - `Type FileCitation`

244 

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

246 

247 - `const FileCitationFileCitation FileCitation = "file_citation"`

248 

249 - `type ResponseOutputTextAnnotationURLCitation struct{…}`

250 

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

252 

253 - `EndIndex int64`

254 

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

256 

257 - `StartIndex int64`

258 

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

260 

261 - `Title string`

262 

263 The title of the web resource.

264 

265 - `Type URLCitation`

266 

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

268 

269 - `const URLCitationURLCitation URLCitation = "url_citation"`

270 

271 - `URL string`

272 

273 The URL of the web resource.

274 

275 - `type ResponseOutputTextAnnotationContainerFileCitation struct{…}`

276 

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

278 

279 - `ContainerID string`

280 

281 The ID of the container file.

282 

283 - `EndIndex int64`

284 

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

286 

287 - `FileID string`

288 

289 The ID of the file.

290 

291 - `Filename string`

292 

293 The filename of the container file cited.

294 

295 - `StartIndex int64`

296 

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

298 

299 - `Type ContainerFileCitation`

300 

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

302 

303 - `const ContainerFileCitationContainerFileCitation ContainerFileCitation = "container_file_citation"`

304 

305 - `type ResponseOutputTextAnnotationFilePath struct{…}`

306 

307 A path to a file.

308 

309 - `FileID string`

310 

311 The ID of the file.

312 

313 - `Index int64`

314 

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

316 

317 - `Type FilePath`

318 

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

320 

321 - `const FilePathFilePath FilePath = "file_path"`

322 

323 - `Text string`

324 

325 The text output from the model.

326 

327 - `Type OutputText`

328 

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

330 

331 - `const OutputTextOutputText OutputText = "output_text"`

332 

333 - `Logprobs []ResponseOutputTextLogprob`

334 

335 - `Token string`

336 

337 - `Bytes []int64`

338 

339 - `Logprob float64`

340 

341 - `TopLogprobs []ResponseOutputTextLogprobTopLogprob`

342 

343 - `Token string`

344 

345 - `Bytes []int64`

346 

347 - `Logprob float64`

348 

349 - `type ResponseOutputRefusal struct{…}`

350 

351 A refusal from the model.

352 

353 - `Refusal string`

354 

355 The refusal explanation from the model.

356 

357 - `Type Refusal`

358 

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

360 

361 - `const RefusalRefusal Refusal = "refusal"`

362 

363 - `Role Assistant`

364 

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

366 

367 - `const AssistantAssistant Assistant = "assistant"`

368 

369 - `Status ResponseOutputMessageStatus`

370 

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

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

373 

374 - `const ResponseOutputMessageStatusInProgress ResponseOutputMessageStatus = "in_progress"`

375 

376 - `const ResponseOutputMessageStatusCompleted ResponseOutputMessageStatus = "completed"`

377 

378 - `const ResponseOutputMessageStatusIncomplete ResponseOutputMessageStatus = "incomplete"`

379 

380 - `Type Message`

381 

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

383 

384 - `const MessageMessage Message = "message"`

385 

386 - `Phase ResponseOutputMessagePhase`

387 

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

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

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

391 

392 - `const ResponseOutputMessagePhaseCommentary ResponseOutputMessagePhase = "commentary"`

393 

394 - `const ResponseOutputMessagePhaseFinalAnswer ResponseOutputMessagePhase = "final_answer"`

395 

396 - `type ResponseFileSearchToolCall struct{…}`

397 

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

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

400 

401 - `ID string`

402 

403 The unique ID of the file search tool call.

404 

405 - `Queries []string`

406 

407 The queries used to search for files.

408 

409 - `Status ResponseFileSearchToolCallStatus`

410 

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

412 `searching`, `incomplete` or `failed`,

413 

414 - `const ResponseFileSearchToolCallStatusInProgress ResponseFileSearchToolCallStatus = "in_progress"`

415 

416 - `const ResponseFileSearchToolCallStatusSearching ResponseFileSearchToolCallStatus = "searching"`

417 

418 - `const ResponseFileSearchToolCallStatusCompleted ResponseFileSearchToolCallStatus = "completed"`

419 

420 - `const ResponseFileSearchToolCallStatusIncomplete ResponseFileSearchToolCallStatus = "incomplete"`

421 

422 - `const ResponseFileSearchToolCallStatusFailed ResponseFileSearchToolCallStatus = "failed"`

423 

424 - `Type FileSearchCall`

425 

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

427 

428 - `const FileSearchCallFileSearchCall FileSearchCall = "file_search_call"`

429 

430 - `Results []ResponseFileSearchToolCallResult`

431 

432 The results of the file search tool call.

433 

434 - `Attributes map[string, ResponseFileSearchToolCallResultAttributeUnion]`

435 

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

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

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

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

440 length of 512 characters, booleans, or numbers.

441 

442 - `string`

443 

444 - `float64`

445 

446 - `bool`

447 

448 - `FileID string`

449 

450 The unique ID of the file.

451 

452 - `Filename string`

453 

454 The name of the file.

455 

456 - `Score float64`

457 

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

459 

460 - `Text string`

461 

462 The text that was retrieved from the file.

463 

464 - `type ResponseComputerToolCall struct{…}`

465 

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

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

468 

469 - `ID string`

470 

471 The unique ID of the computer call.

472 

473 - `CallID string`

474 

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

476 

477 - `PendingSafetyChecks []ResponseComputerToolCallPendingSafetyCheck`

478 

479 The pending safety checks for the computer call.

480 

481 - `ID string`

482 

483 The ID of the pending safety check.

484 

485 - `Code string`

486 

487 The type of the pending safety check.

488 

489 - `Message string`

490 

491 Details about the pending safety check.

492 

493 - `Status ResponseComputerToolCallStatus`

494 

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

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

497 

498 - `const ResponseComputerToolCallStatusInProgress ResponseComputerToolCallStatus = "in_progress"`

499 

500 - `const ResponseComputerToolCallStatusCompleted ResponseComputerToolCallStatus = "completed"`

501 

502 - `const ResponseComputerToolCallStatusIncomplete ResponseComputerToolCallStatus = "incomplete"`

503 

504 - `Type ResponseComputerToolCallType`

505 

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

507 

508 - `const ResponseComputerToolCallTypeComputerCall ResponseComputerToolCallType = "computer_call"`

509 

510 - `Action ResponseComputerToolCallActionUnion`

511 

512 A click action.

513 

514 - `type ResponseComputerToolCallActionClick struct{…}`

515 

516 A click action.

517 

518 - `Button string`

519 

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

521 

522 - `const ResponseComputerToolCallActionClickButtonLeft ResponseComputerToolCallActionClickButton = "left"`

523 

524 - `const ResponseComputerToolCallActionClickButtonRight ResponseComputerToolCallActionClickButton = "right"`

525 

526 - `const ResponseComputerToolCallActionClickButtonWheel ResponseComputerToolCallActionClickButton = "wheel"`

527 

528 - `const ResponseComputerToolCallActionClickButtonBack ResponseComputerToolCallActionClickButton = "back"`

529 

530 - `const ResponseComputerToolCallActionClickButtonForward ResponseComputerToolCallActionClickButton = "forward"`

531 

532 - `Type Click`

533 

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

535 

536 - `const ClickClick Click = "click"`

537 

538 - `X int64`

539 

540 The x-coordinate where the click occurred.

541 

542 - `Y int64`

543 

544 The y-coordinate where the click occurred.

545 

546 - `Keys []string`

547 

548 The keys being held while clicking.

549 

550 - `type ResponseComputerToolCallActionDoubleClick struct{…}`

551 

552 A double click action.

553 

554 - `Keys []string`

555 

556 The keys being held while double-clicking.

557 

558 - `Type DoubleClick`

559 

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

561 

562 - `const DoubleClickDoubleClick DoubleClick = "double_click"`

563 

564 - `X int64`

565 

566 The x-coordinate where the double click occurred.

567 

568 - `Y int64`

569 

570 The y-coordinate where the double click occurred.

571 

572 - `type ResponseComputerToolCallActionDrag struct{…}`

573 

574 A drag action.

575 

576 - `Path []ResponseComputerToolCallActionDragPath`

577 

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

579 

580 ```

581 [

582 { x: 100, y: 200 },

583 { x: 200, y: 300 }

584 ]

585 ```

586 

587 - `X int64`

588 

589 The x-coordinate.

590 

591 - `Y int64`

592 

593 The y-coordinate.

594 

595 - `Type Drag`

596 

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

598 

599 - `const DragDrag Drag = "drag"`

600 

601 - `Keys []string`

602 

603 The keys being held while dragging the mouse.

604 

605 - `type ResponseComputerToolCallActionKeypress struct{…}`

606 

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

608 

609 - `Keys []string`

610 

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

612 

613 - `Type Keypress`

614 

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

616 

617 - `const KeypressKeypress Keypress = "keypress"`

618 

619 - `type ResponseComputerToolCallActionMove struct{…}`

620 

621 A mouse move action.

622 

623 - `Type Move`

624 

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

626 

627 - `const MoveMove Move = "move"`

628 

629 - `X int64`

630 

631 The x-coordinate to move to.

632 

633 - `Y int64`

634 

635 The y-coordinate to move to.

636 

637 - `Keys []string`

638 

639 The keys being held while moving the mouse.

640 

641 - `type ResponseComputerToolCallActionScreenshot struct{…}`

642 

643 A screenshot action.

644 

645 - `Type Screenshot`

646 

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

648 

649 - `const ScreenshotScreenshot Screenshot = "screenshot"`

650 

651 - `type ResponseComputerToolCallActionScroll struct{…}`

652 

653 A scroll action.

654 

655 - `ScrollX int64`

656 

657 The horizontal scroll distance.

658 

659 - `ScrollY int64`

660 

661 The vertical scroll distance.

662 

663 - `Type Scroll`

664 

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

666 

667 - `const ScrollScroll Scroll = "scroll"`

668 

669 - `X int64`

670 

671 The x-coordinate where the scroll occurred.

672 

673 - `Y int64`

674 

675 The y-coordinate where the scroll occurred.

676 

677 - `Keys []string`

678 

679 The keys being held while scrolling.

680 

681 - `type ResponseComputerToolCallActionType struct{…}`

682 

683 An action to type in text.

684 

685 - `Text string`

686 

687 The text to type.

688 

689 - `Type Type`

690 

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

692 

693 - `const TypeType Type = "type"`

694 

695 - `type ResponseComputerToolCallActionWait struct{…}`

696 

697 A wait action.

698 

699 - `Type Wait`

700 

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

702 

703 - `const WaitWait Wait = "wait"`

704 

705 - `Actions ComputerActionList`

706 

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

708 `type` discriminator and action-specific fields.

709 

710 - `type ComputerActionClick struct{…}`

711 

712 A click action.

713 

714 - `Button string`

715 

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

717 

718 - `const ComputerActionClickButtonLeft ComputerActionClickButton = "left"`

719 

720 - `const ComputerActionClickButtonRight ComputerActionClickButton = "right"`

721 

722 - `const ComputerActionClickButtonWheel ComputerActionClickButton = "wheel"`

723 

724 - `const ComputerActionClickButtonBack ComputerActionClickButton = "back"`

725 

726 - `const ComputerActionClickButtonForward ComputerActionClickButton = "forward"`

727 

728 - `Type Click`

729 

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

731 

732 - `const ClickClick Click = "click"`

733 

734 - `X int64`

735 

736 The x-coordinate where the click occurred.

737 

738 - `Y int64`

739 

740 The y-coordinate where the click occurred.

741 

742 - `Keys []string`

743 

744 The keys being held while clicking.

745 

746 - `type ComputerActionDoubleClick struct{…}`

747 

748 A double click action.

749 

750 - `Keys []string`

751 

752 The keys being held while double-clicking.

753 

754 - `Type DoubleClick`

755 

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

757 

758 - `const DoubleClickDoubleClick DoubleClick = "double_click"`

759 

760 - `X int64`

761 

762 The x-coordinate where the double click occurred.

763 

764 - `Y int64`

765 

766 The y-coordinate where the double click occurred.

767 

768 - `type ComputerActionDrag struct{…}`

769 

770 A drag action.

771 

772 - `Path []ComputerActionDragPath`

773 

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

775 

776 ```

777 [

778 { x: 100, y: 200 },

779 { x: 200, y: 300 }

780 ]

781 ```

782 

783 - `X int64`

784 

785 The x-coordinate.

786 

787 - `Y int64`

788 

789 The y-coordinate.

790 

791 - `Type Drag`

792 

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

794 

795 - `const DragDrag Drag = "drag"`

796 

797 - `Keys []string`

798 

799 The keys being held while dragging the mouse.

800 

801 - `type ComputerActionKeypress struct{…}`

802 

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

804 

805 - `Keys []string`

806 

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

808 

809 - `Type Keypress`

810 

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

812 

813 - `const KeypressKeypress Keypress = "keypress"`

814 

815 - `type ComputerActionMove struct{…}`

816 

817 A mouse move action.

818 

819 - `Type Move`

820 

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

822 

823 - `const MoveMove Move = "move"`

824 

825 - `X int64`

826 

827 The x-coordinate to move to.

828 

829 - `Y int64`

830 

831 The y-coordinate to move to.

832 

833 - `Keys []string`

834 

835 The keys being held while moving the mouse.

836 

837 - `type ComputerActionScreenshot struct{…}`

838 

839 A screenshot action.

840 

841 - `Type Screenshot`

842 

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

844 

845 - `const ScreenshotScreenshot Screenshot = "screenshot"`

846 

847 - `type ComputerActionScroll struct{…}`

848 

849 A scroll action.

850 

851 - `ScrollX int64`

852 

853 The horizontal scroll distance.

854 

855 - `ScrollY int64`

856 

857 The vertical scroll distance.

858 

859 - `Type Scroll`

860 

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

862 

863 - `const ScrollScroll Scroll = "scroll"`

864 

865 - `X int64`

866 

867 The x-coordinate where the scroll occurred.

868 

869 - `Y int64`

870 

871 The y-coordinate where the scroll occurred.

872 

873 - `Keys []string`

874 

875 The keys being held while scrolling.

876 

877 - `type ComputerActionType struct{…}`

878 

879 An action to type in text.

880 

881 - `Text string`

882 

883 The text to type.

884 

885 - `Type Type`

886 

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

888 

889 - `const TypeType Type = "type"`

890 

891 - `type ComputerActionWait struct{…}`

892 

893 A wait action.

894 

895 - `Type Wait`

896 

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

898 

899 - `const WaitWait Wait = "wait"`

900 

901 - `type ResponseInputItemComputerCallOutput struct{…}`

902 

903 The output of a computer tool call.

904 

905 - `CallID string`

906 

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

908 

909 - `Output ResponseComputerToolCallOutputScreenshot`

910 

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

912 

913 - `Type ComputerScreenshot`

914 

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

916 always set to `computer_screenshot`.

917 

918 - `const ComputerScreenshotComputerScreenshot ComputerScreenshot = "computer_screenshot"`

919 

920 - `FileID string`

921 

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

923 

924 - `ImageURL string`

925 

926 The URL of the screenshot image.

927 

928 - `Type ComputerCallOutput`

929 

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

931 

932 - `const ComputerCallOutputComputerCallOutput ComputerCallOutput = "computer_call_output"`

933 

934 - `ID string`

935 

936 The ID of the computer tool call output.

937 

938 - `AcknowledgedSafetyChecks []ResponseInputItemComputerCallOutputAcknowledgedSafetyCheck`

939 

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

941 

942 - `ID string`

943 

944 The ID of the pending safety check.

945 

946 - `Code string`

947 

948 The type of the pending safety check.

949 

950 - `Message string`

951 

952 Details about the pending safety check.

953 

954 - `Status string`

955 

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

957 

958 - `const ResponseInputItemComputerCallOutputStatusInProgress ResponseInputItemComputerCallOutputStatus = "in_progress"`

959 

960 - `const ResponseInputItemComputerCallOutputStatusCompleted ResponseInputItemComputerCallOutputStatus = "completed"`

961 

962 - `const ResponseInputItemComputerCallOutputStatusIncomplete ResponseInputItemComputerCallOutputStatus = "incomplete"`

963 

964 - `type ResponseFunctionWebSearch struct{…}`

965 

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

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

968 

969 - `ID string`

970 

971 The unique ID of the web search tool call.

972 

973 - `Action ResponseFunctionWebSearchActionUnion`

974 

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

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

977 

978 - `type ResponseFunctionWebSearchActionSearch struct{…}`

979 

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

981 

982 - `Query string`

983 

984 [DEPRECATED] The search query.

985 

986 - `Type Search`

987 

988 The action type.

989 

990 - `const SearchSearch Search = "search"`

991 

992 - `Queries []string`

993 

994 The search queries.

995 

996 - `Sources []ResponseFunctionWebSearchActionSearchSource`

997 

998 The sources used in the search.

999 

1000 - `Type URL`

1001 

1002 The type of source. Always `url`.

1003 

1004 - `const URLURL URL = "url"`

1005 

1006 - `URL string`

1007 

1008 The URL of the source.

1009 

1010 - `type ResponseFunctionWebSearchActionOpenPage struct{…}`

1011 

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

1013 

1014 - `Type OpenPage`

1015 

1016 The action type.

1017 

1018 - `const OpenPageOpenPage OpenPage = "open_page"`

1019 

1020 - `URL string`

1021 

1022 The URL opened by the model.

1023 

1024 - `type ResponseFunctionWebSearchActionFindInPage struct{…}`

1025 

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

1027 

1028 - `Pattern string`

1029 

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

1031 

1032 - `Type FindInPage`

1033 

1034 The action type.

1035 

1036 - `const FindInPageFindInPage FindInPage = "find_in_page"`

1037 

1038 - `URL string`

1039 

1040 The URL of the page searched for the pattern.

1041 

1042 - `Status ResponseFunctionWebSearchStatus`

1043 

1044 The status of the web search tool call.

1045 

1046 - `const ResponseFunctionWebSearchStatusInProgress ResponseFunctionWebSearchStatus = "in_progress"`

1047 

1048 - `const ResponseFunctionWebSearchStatusSearching ResponseFunctionWebSearchStatus = "searching"`

1049 

1050 - `const ResponseFunctionWebSearchStatusCompleted ResponseFunctionWebSearchStatus = "completed"`

1051 

1052 - `const ResponseFunctionWebSearchStatusFailed ResponseFunctionWebSearchStatus = "failed"`

1053 

1054 - `Type WebSearchCall`

1055 

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

1057 

1058 - `const WebSearchCallWebSearchCall WebSearchCall = "web_search_call"`

1059 

1060 - `type ResponseFunctionToolCall struct{…}`

1061 

1062 A tool call to run a function. See the

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

1064 

1065 - `Arguments string`

1066 

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

1068 

1069 - `CallID string`

1070 

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

1072 

1073 - `Name string`

1074 

1075 The name of the function to run.

1076 

1077 - `Type FunctionCall`

1078 

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

1080 

1081 - `const FunctionCallFunctionCall FunctionCall = "function_call"`

1082 

1083 - `ID string`

1084 

1085 The unique ID of the function tool call.

1086 

1087 - `Namespace string`

1088 

1089 The namespace of the function to run.

1090 

1091 - `Status ResponseFunctionToolCallStatus`

1092 

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

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

1095 

1096 - `const ResponseFunctionToolCallStatusInProgress ResponseFunctionToolCallStatus = "in_progress"`

1097 

1098 - `const ResponseFunctionToolCallStatusCompleted ResponseFunctionToolCallStatus = "completed"`

1099 

1100 - `const ResponseFunctionToolCallStatusIncomplete ResponseFunctionToolCallStatus = "incomplete"`

1101 

1102 - `type ResponseInputItemFunctionCallOutput struct{…}`

1103 

1104 The output of a function tool call.

1105 

1106 - `CallID string`

1107 

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

1109 

1110 - `Output ResponseInputItemFunctionCallOutputOutputUnion`

1111 

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

1113 

1114 - `string`

1115 

1116 - `type ResponseFunctionCallOutputItemList []ResponseFunctionCallOutputItemUnion`

1117 

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

1119 

1120 - `type ResponseInputTextContent struct{…}`

1121 

1122 A text input to the model.

1123 

1124 - `Text string`

1125 

1126 The text input to the model.

1127 

1128 - `Type InputText`

1129 

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

1131 

1132 - `const InputTextInputText InputText = "input_text"`

1133 

1134 - `type ResponseInputImageContent struct{…}`

1135 

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

1137 

1138 - `Type InputImage`

1139 

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

1141 

1142 - `const InputImageInputImage InputImage = "input_image"`

1143 

1144 - `Detail ResponseInputImageContentDetail`

1145 

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

1147 

1148 - `const ResponseInputImageContentDetailLow ResponseInputImageContentDetail = "low"`

1149 

1150 - `const ResponseInputImageContentDetailHigh ResponseInputImageContentDetail = "high"`

1151 

1152 - `const ResponseInputImageContentDetailAuto ResponseInputImageContentDetail = "auto"`

1153 

1154 - `const ResponseInputImageContentDetailOriginal ResponseInputImageContentDetail = "original"`

1155 

1156 - `FileID string`

1157 

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

1159 

1160 - `ImageURL string`

1161 

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

1163 

1164 - `type ResponseInputFileContent struct{…}`

1165 

1166 A file input to the model.

1167 

1168 - `Type InputFile`

1169 

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

1171 

1172 - `const InputFileInputFile InputFile = "input_file"`

1173 

1174 - `Detail ResponseInputFileContentDetail`

1175 

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

1177 

1178 - `const ResponseInputFileContentDetailLow ResponseInputFileContentDetail = "low"`

1179 

1180 - `const ResponseInputFileContentDetailHigh ResponseInputFileContentDetail = "high"`

1181 

1182 - `FileData string`

1183 

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

1185 

1186 - `FileID string`

1187 

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

1189 

1190 - `FileURL string`

1191 

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

1193 

1194 - `Filename string`

1195 

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

1197 

1198 - `Type FunctionCallOutput`

1199 

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

1201 

1202 - `const FunctionCallOutputFunctionCallOutput FunctionCallOutput = "function_call_output"`

1203 

1204 - `ID string`

1205 

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

1207 

1208 - `Status string`

1209 

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

1211 

1212 - `const ResponseInputItemFunctionCallOutputStatusInProgress ResponseInputItemFunctionCallOutputStatus = "in_progress"`

1213 

1214 - `const ResponseInputItemFunctionCallOutputStatusCompleted ResponseInputItemFunctionCallOutputStatus = "completed"`

1215 

1216 - `const ResponseInputItemFunctionCallOutputStatusIncomplete ResponseInputItemFunctionCallOutputStatus = "incomplete"`

1217 

1218 - `type ResponseInputItemToolSearchCall struct{…}`

1219 

1220 - `Arguments any`

1221 

1222 The arguments supplied to the tool search call.

1223 

1224 - `Type ToolSearchCall`

1225 

1226 The item type. Always `tool_search_call`.

1227 

1228 - `const ToolSearchCallToolSearchCall ToolSearchCall = "tool_search_call"`

1229 

1230 - `ID string`

1231 

1232 The unique ID of this tool search call.

1233 

1234 - `CallID string`

1235 

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

1237 

1238 - `Execution string`

1239 

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

1241 

1242 - `const ResponseInputItemToolSearchCallExecutionServer ResponseInputItemToolSearchCallExecution = "server"`

1243 

1244 - `const ResponseInputItemToolSearchCallExecutionClient ResponseInputItemToolSearchCallExecution = "client"`

1245 

1246 - `Status string`

1247 

1248 The status of the tool search call.

1249 

1250 - `const ResponseInputItemToolSearchCallStatusInProgress ResponseInputItemToolSearchCallStatus = "in_progress"`

1251 

1252 - `const ResponseInputItemToolSearchCallStatusCompleted ResponseInputItemToolSearchCallStatus = "completed"`

1253 

1254 - `const ResponseInputItemToolSearchCallStatusIncomplete ResponseInputItemToolSearchCallStatus = "incomplete"`

1255 

1256 - `type ResponseToolSearchOutputItemParamResp struct{…}`

1257 

1258 - `Tools []ToolUnion`

1259 

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

1261 

1262 - `type FunctionTool struct{…}`

1263 

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

1265 

1266 - `Name string`

1267 

1268 The name of the function to call.

1269 

1270 - `Parameters map[string, any]`

1271 

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

1273 

1274 - `Strict bool`

1275 

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

1277 

1278 - `Type Function`

1279 

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

1281 

1282 - `const FunctionFunction Function = "function"`

1283 

1284 - `DeferLoading bool`

1285 

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

1287 

1288 - `Description string`

1289 

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

1291 

1292 - `type FileSearchTool struct{…}`

1293 

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

1295 

1296 - `Type FileSearch`

1297 

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

1299 

1300 - `const FileSearchFileSearch FileSearch = "file_search"`

1301 

1302 - `VectorStoreIDs []string`

1303 

1304 The IDs of the vector stores to search.

1305 

1306 - `Filters FileSearchToolFiltersUnion`

1307 

1308 A filter to apply.

1309 

1310 - `type ComparisonFilter struct{…}`

1311 

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

1313 

1314 - `Key string`

1315 

1316 The key to compare against the value.

1317 

1318 - `Type ComparisonFilterType`

1319 

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

1321 

1322 - `eq`: equals

1323 - `ne`: not equal

1324 - `gt`: greater than

1325 - `gte`: greater than or equal

1326 - `lt`: less than

1327 - `lte`: less than or equal

1328 - `in`: in

1329 - `nin`: not in

1330 

1331 - `const ComparisonFilterTypeEq ComparisonFilterType = "eq"`

1332 

1333 - `const ComparisonFilterTypeNe ComparisonFilterType = "ne"`

1334 

1335 - `const ComparisonFilterTypeGt ComparisonFilterType = "gt"`

1336 

1337 - `const ComparisonFilterTypeGte ComparisonFilterType = "gte"`

1338 

1339 - `const ComparisonFilterTypeLt ComparisonFilterType = "lt"`

1340 

1341 - `const ComparisonFilterTypeLte ComparisonFilterType = "lte"`

1342 

1343 - `const ComparisonFilterTypeIn ComparisonFilterType = "in"`

1344 

1345 - `const ComparisonFilterTypeNin ComparisonFilterType = "nin"`

1346 

1347 - `Value ComparisonFilterValueUnion`

1348 

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

1350 

1351 - `string`

1352 

1353 - `float64`

1354 

1355 - `bool`

1356 

1357 - `type ComparisonFilterValueArray []ComparisonFilterValueArrayItemUnion`

1358 

1359 - `string`

1360 

1361 - `float64`

1362 

1363 - `type CompoundFilter struct{…}`

1364 

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

1366 

1367 - `Filters []ComparisonFilter`

1368 

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

1370 

1371 - `type ComparisonFilter struct{…}`

1372 

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

1374 

1375 - `Type CompoundFilterType`

1376 

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

1378 

1379 - `const CompoundFilterTypeAnd CompoundFilterType = "and"`

1380 

1381 - `const CompoundFilterTypeOr CompoundFilterType = "or"`

1382 

1383 - `MaxNumResults int64`

1384 

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

1386 

1387 - `RankingOptions FileSearchToolRankingOptions`

1388 

1389 Ranking options for search.

1390 

1391 - `HybridSearch FileSearchToolRankingOptionsHybridSearch`

1392 

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

1394 

1395 - `EmbeddingWeight float64`

1396 

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

1398 

1399 - `TextWeight float64`

1400 

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

1402 

1403 - `Ranker string`

1404 

1405 The ranker to use for the file search.

1406 

1407 - `const FileSearchToolRankingOptionsRankerAuto FileSearchToolRankingOptionsRanker = "auto"`

1408 

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

1410 

1411 - `ScoreThreshold float64`

1412 

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

1414 

1415 - `type ComputerTool struct{…}`

1416 

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

1418 

1419 - `Type Computer`

1420 

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

1422 

1423 - `const ComputerComputer Computer = "computer"`

1424 

1425 - `type ComputerUsePreviewTool struct{…}`

1426 

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

1428 

1429 - `DisplayHeight int64`

1430 

1431 The height of the computer display.

1432 

1433 - `DisplayWidth int64`

1434 

1435 The width of the computer display.

1436 

1437 - `Environment ComputerUsePreviewToolEnvironment`

1438 

1439 The type of computer environment to control.

1440 

1441 - `const ComputerUsePreviewToolEnvironmentWindows ComputerUsePreviewToolEnvironment = "windows"`

1442 

1443 - `const ComputerUsePreviewToolEnvironmentMac ComputerUsePreviewToolEnvironment = "mac"`

1444 

1445 - `const ComputerUsePreviewToolEnvironmentLinux ComputerUsePreviewToolEnvironment = "linux"`

1446 

1447 - `const ComputerUsePreviewToolEnvironmentUbuntu ComputerUsePreviewToolEnvironment = "ubuntu"`

1448 

1449 - `const ComputerUsePreviewToolEnvironmentBrowser ComputerUsePreviewToolEnvironment = "browser"`

1450 

1451 - `Type ComputerUsePreview`

1452 

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

1454 

1455 - `const ComputerUsePreviewComputerUsePreview ComputerUsePreview = "computer_use_preview"`

1456 

1457 - `type WebSearchTool struct{…}`

1458 

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

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

1461 

1462 - `Type WebSearchToolType`

1463 

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

1465 

1466 - `const WebSearchToolTypeWebSearch WebSearchToolType = "web_search"`

1467 

1468 - `const WebSearchToolTypeWebSearch2025_08_26 WebSearchToolType = "web_search_2025_08_26"`

1469 

1470 - `Filters WebSearchToolFilters`

1471 

1472 Filters for the search.

1473 

1474 - `AllowedDomains []string`

1475 

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

1477 Subdomains of the provided domains are allowed as well.

1478 

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

1480 

1481 - `SearchContextSize WebSearchToolSearchContextSize`

1482 

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

1484 

1485 - `const WebSearchToolSearchContextSizeLow WebSearchToolSearchContextSize = "low"`

1486 

1487 - `const WebSearchToolSearchContextSizeMedium WebSearchToolSearchContextSize = "medium"`

1488 

1489 - `const WebSearchToolSearchContextSizeHigh WebSearchToolSearchContextSize = "high"`

1490 

1491 - `UserLocation WebSearchToolUserLocation`

1492 

1493 The approximate location of the user.

1494 

1495 - `City string`

1496 

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

1498 

1499 - `Country string`

1500 

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

1502 

1503 - `Region string`

1504 

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

1506 

1507 - `Timezone string`

1508 

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

1510 

1511 - `Type string`

1512 

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

1514 

1515 - `const WebSearchToolUserLocationTypeApproximate WebSearchToolUserLocationType = "approximate"`

1516 

1517 - `type ToolMcp struct{…}`

1518 

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

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

1521 

1522 - `ServerLabel string`

1523 

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

1525 

1526 - `Type Mcp`

1527 

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

1529 

1530 - `const McpMcp Mcp = "mcp"`

1531 

1532 - `AllowedTools ToolMcpAllowedToolsUnion`

1533 

1534 List of allowed tool names or a filter object.

1535 

1536 - `type ToolMcpAllowedToolsMcpAllowedTools []string`

1537 

1538 A string array of allowed tool names

1539 

1540 - `type ToolMcpAllowedToolsMcpToolFilter struct{…}`

1541 

1542 A filter object to specify which tools are allowed.

1543 

1544 - `ReadOnly bool`

1545 

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

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

1548 it will match this filter.

1549 

1550 - `ToolNames []string`

1551 

1552 List of allowed tool names.

1553 

1554 - `Authorization string`

1555 

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

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

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

1559 

1560 - `ConnectorID string`

1561 

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

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

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

1565 

1566 Currently supported `connector_id` values are:

1567 

1568 - Dropbox: `connector_dropbox`

1569 - Gmail: `connector_gmail`

1570 - Google Calendar: `connector_googlecalendar`

1571 - Google Drive: `connector_googledrive`

1572 - Microsoft Teams: `connector_microsoftteams`

1573 - Outlook Calendar: `connector_outlookcalendar`

1574 - Outlook Email: `connector_outlookemail`

1575 - SharePoint: `connector_sharepoint`

1576 

1577 - `const ToolMcpConnectorIDConnectorDropbox ToolMcpConnectorID = "connector_dropbox"`

1578 

1579 - `const ToolMcpConnectorIDConnectorGmail ToolMcpConnectorID = "connector_gmail"`

1580 

1581 - `const ToolMcpConnectorIDConnectorGooglecalendar ToolMcpConnectorID = "connector_googlecalendar"`

1582 

1583 - `const ToolMcpConnectorIDConnectorGoogledrive ToolMcpConnectorID = "connector_googledrive"`

1584 

1585 - `const ToolMcpConnectorIDConnectorMicrosoftteams ToolMcpConnectorID = "connector_microsoftteams"`

1586 

1587 - `const ToolMcpConnectorIDConnectorOutlookcalendar ToolMcpConnectorID = "connector_outlookcalendar"`

1588 

1589 - `const ToolMcpConnectorIDConnectorOutlookemail ToolMcpConnectorID = "connector_outlookemail"`

1590 

1591 - `const ToolMcpConnectorIDConnectorSharepoint ToolMcpConnectorID = "connector_sharepoint"`

1592 

1593 - `DeferLoading bool`

1594 

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

1596 

1597 - `Headers map[string, string]`

1598 

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

1600 or other purposes.

1601 

1602 - `RequireApproval ToolMcpRequireApprovalUnion`

1603 

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

1605 

1606 - `type ToolMcpRequireApprovalMcpToolApprovalFilter struct{…}`

1607 

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

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

1610 that require approval.

1611 

1612 - `Always ToolMcpRequireApprovalMcpToolApprovalFilterAlways`

1613 

1614 A filter object to specify which tools are allowed.

1615 

1616 - `ReadOnly bool`

1617 

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

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

1620 it will match this filter.

1621 

1622 - `ToolNames []string`

1623 

1624 List of allowed tool names.

1625 

1626 - `Never ToolMcpRequireApprovalMcpToolApprovalFilterNever`

1627 

1628 A filter object to specify which tools are allowed.

1629 

1630 - `ReadOnly bool`

1631 

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

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

1634 it will match this filter.

1635 

1636 - `ToolNames []string`

1637 

1638 List of allowed tool names.

1639 

1640 - `type ToolMcpRequireApprovalMcpToolApprovalSetting string`

1641 

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

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

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

1645 

1646 - `const ToolMcpRequireApprovalMcpToolApprovalSettingAlways ToolMcpRequireApprovalMcpToolApprovalSetting = "always"`

1647 

1648 - `const ToolMcpRequireApprovalMcpToolApprovalSettingNever ToolMcpRequireApprovalMcpToolApprovalSetting = "never"`

1649 

1650 - `ServerDescription string`

1651 

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

1653 

1654 - `ServerURL string`

1655 

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

1657 provided.

1658 

1659 - `type ToolCodeInterpreter struct{…}`

1660 

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

1662 

1663 - `Container ToolCodeInterpreterContainerUnion`

1664 

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

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

1667 optional `memory_limit` setting.

1668 

1669 - `string`

1670 

1671 - `type ToolCodeInterpreterContainerCodeInterpreterContainerAuto struct{…}`

1672 

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

1674 

1675 - `Type Auto`

1676 

1677 Always `auto`.

1678 

1679 - `const AutoAuto Auto = "auto"`

1680 

1681 - `FileIDs []string`

1682 

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

1684 

1685 - `MemoryLimit string`

1686 

1687 The memory limit for the code interpreter container.

1688 

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

1690 

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

1692 

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

1694 

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

1696 

1697 - `NetworkPolicy ToolCodeInterpreterContainerCodeInterpreterToolAutoNetworkPolicyUnion`

1698 

1699 Network access policy for the container.

1700 

1701 - `type ContainerNetworkPolicyDisabled struct{…}`

1702 

1703 - `Type Disabled`

1704 

1705 Disable outbound network access. Always `disabled`.

1706 

1707 - `const DisabledDisabled Disabled = "disabled"`

1708 

1709 - `type ContainerNetworkPolicyAllowlist struct{…}`

1710 

1711 - `AllowedDomains []string`

1712 

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

1714 

1715 - `Type Allowlist`

1716 

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

1718 

1719 - `const AllowlistAllowlist Allowlist = "allowlist"`

1720 

1721 - `DomainSecrets []ContainerNetworkPolicyDomainSecret`

1722 

1723 Optional domain-scoped secrets for allowlisted domains.

1724 

1725 - `Domain string`

1726 

1727 The domain associated with the secret.

1728 

1729 - `Name string`

1730 

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

1732 

1733 - `Value string`

1734 

1735 The secret value to inject for the domain.

1736 

1737 - `Type CodeInterpreter`

1738 

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

1740 

1741 - `const CodeInterpreterCodeInterpreter CodeInterpreter = "code_interpreter"`

1742 

1743 - `type ToolImageGeneration struct{…}`

1744 

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

1746 

1747 - `Type ImageGeneration`

1748 

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

1750 

1751 - `const ImageGenerationImageGeneration ImageGeneration = "image_generation"`

1752 

1753 - `Action string`

1754 

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

1756 

1757 - `const ToolImageGenerationActionGenerate ToolImageGenerationAction = "generate"`

1758 

1759 - `const ToolImageGenerationActionEdit ToolImageGenerationAction = "edit"`

1760 

1761 - `const ToolImageGenerationActionAuto ToolImageGenerationAction = "auto"`

1762 

1763 - `Background string`

1764 

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

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

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

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

1769 automatically determine the best background for the image.

1770 

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

1772 transparent backgrounds. Requests with `background` set to

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

1774 `auto` instead.

1775 

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

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

1778 

1779 - `const ToolImageGenerationBackgroundTransparent ToolImageGenerationBackground = "transparent"`

1780 

1781 - `const ToolImageGenerationBackgroundOpaque ToolImageGenerationBackground = "opaque"`

1782 

1783 - `const ToolImageGenerationBackgroundAuto ToolImageGenerationBackground = "auto"`

1784 

1785 - `InputFidelity string`

1786 

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

1788 

1789 - `const ToolImageGenerationInputFidelityHigh ToolImageGenerationInputFidelity = "high"`

1790 

1791 - `const ToolImageGenerationInputFidelityLow ToolImageGenerationInputFidelity = "low"`

1792 

1793 - `InputImageMask ToolImageGenerationInputImageMask`

1794 

1795 Optional mask for inpainting. Contains `image_url`

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

1797 

1798 - `FileID string`

1799 

1800 File ID for the mask image.

1801 

1802 - `ImageURL string`

1803 

1804 Base64-encoded mask image.

1805 

1806 - `Model string`

1807 

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

1809 

1810 - `string`

1811 

1812 - `string`

1813 

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

1815 

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

1817 

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

1819 

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

1821 

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

1823 

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

1825 

1826 - `Moderation string`

1827 

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

1829 

1830 - `const ToolImageGenerationModerationAuto ToolImageGenerationModeration = "auto"`

1831 

1832 - `const ToolImageGenerationModerationLow ToolImageGenerationModeration = "low"`

1833 

1834 - `OutputCompression int64`

1835 

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

1837 

1838 - `OutputFormat string`

1839 

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

1841 `jpeg`. Default: `png`.

1842 

1843 - `const ToolImageGenerationOutputFormatPNG ToolImageGenerationOutputFormat = "png"`

1844 

1845 - `const ToolImageGenerationOutputFormatWebP ToolImageGenerationOutputFormat = "webp"`

1846 

1847 - `const ToolImageGenerationOutputFormatJPEG ToolImageGenerationOutputFormat = "jpeg"`

1848 

1849 - `PartialImages int64`

1850 

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

1852 

1853 - `Quality string`

1854 

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

1856 or `auto`. Default: `auto`.

1857 

1858 - `const ToolImageGenerationQualityLow ToolImageGenerationQuality = "low"`

1859 

1860 - `const ToolImageGenerationQualityMedium ToolImageGenerationQuality = "medium"`

1861 

1862 - `const ToolImageGenerationQualityHigh ToolImageGenerationQuality = "high"`

1863 

1864 - `const ToolImageGenerationQualityAuto ToolImageGenerationQuality = "auto"`

1865 

1866 - `Size string`

1867 

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

1869 

1870 - `string`

1871 

1872 - `string`

1873 

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

1875 

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

1877 

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

1879 

1880 - `const ToolImageGenerationSizeAuto ToolImageGenerationSize = "auto"`

1881 

1882 - `type ToolLocalShell struct{…}`

1883 

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

1885 

1886 - `Type LocalShell`

1887 

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

1889 

1890 - `const LocalShellLocalShell LocalShell = "local_shell"`

1891 

1892 - `type FunctionShellTool struct{…}`

1893 

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

1895 

1896 - `Type Shell`

1897 

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

1899 

1900 - `const ShellShell Shell = "shell"`

1901 

1902 - `Environment FunctionShellToolEnvironmentUnion`

1903 

1904 - `type ContainerAuto struct{…}`

1905 

1906 - `Type ContainerAuto`

1907 

1908 Automatically creates a container for this request

1909 

1910 - `const ContainerAutoContainerAuto ContainerAuto = "container_auto"`

1911 

1912 - `FileIDs []string`

1913 

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

1915 

1916 - `MemoryLimit ContainerAutoMemoryLimit`

1917 

1918 The memory limit for the container.

1919 

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

1921 

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

1923 

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

1925 

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

1927 

1928 - `NetworkPolicy ContainerAutoNetworkPolicyUnion`

1929 

1930 Network access policy for the container.

1931 

1932 - `type ContainerNetworkPolicyDisabled struct{…}`

1933 

1934 - `type ContainerNetworkPolicyAllowlist struct{…}`

1935 

1936 - `Skills []ContainerAutoSkillUnion`

1937 

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

1939 

1940 - `type SkillReference struct{…}`

1941 

1942 - `SkillID string`

1943 

1944 The ID of the referenced skill.

1945 

1946 - `Type SkillReference`

1947 

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

1949 

1950 - `const SkillReferenceSkillReference SkillReference = "skill_reference"`

1951 

1952 - `Version string`

1953 

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

1955 

1956 - `type InlineSkill struct{…}`

1957 

1958 - `Description string`

1959 

1960 The description of the skill.

1961 

1962 - `Name string`

1963 

1964 The name of the skill.

1965 

1966 - `Source InlineSkillSource`

1967 

1968 Inline skill payload

1969 

1970 - `Data string`

1971 

1972 Base64-encoded skill zip bundle.

1973 

1974 - `MediaType ApplicationZip`

1975 

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

1977 

1978 - `const ApplicationZipApplicationZip ApplicationZip = "application/zip"`

1979 

1980 - `Type Base64`

1981 

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

1983 

1984 - `const Base64Base64 Base64 = "base64"`

1985 

1986 - `Type Inline`

1987 

1988 Defines an inline skill for this request.

1989 

1990 - `const InlineInline Inline = "inline"`

1991 

1992 - `type LocalEnvironment struct{…}`

1993 

1994 - `Type Local`

1995 

1996 Use a local computer environment.