java/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`InputTokenCountResponse responses().inputTokens().count(InputTokenCountParamsparams = InputTokenCountParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

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- `InputTokenCountParams params`

16 

17 - `Optional<Conversation> conversation`

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 - `class ResponseConversationParam:`

25 

26 The conversation that this response belongs to.

27 

28 - `String id`

29 

30 The unique ID of the conversation.

31 

32 - `Optional<Input> input`

33 

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

35 

36 - `String`

37 

38 - `List<ResponseInputItem>`

39 

40 - `class EasyInputMessage:`

41 

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

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

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

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

46 interactions.

47 

48 - `Content content`

49 

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

51 Can also contain previous assistant responses.

52 

53 - `String`

54 

55 - `List<ResponseInputContent>`

56 

57 - `class ResponseInputText:`

58 

59 A text input to the model.

60 

61 - `String text`

62 

63 The text input to the model.

64 

65 - `JsonValue; type "input_text"constant`

66 

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

68 

69 - `INPUT_TEXT("input_text")`

70 

71 - `class ResponseInputImage:`

72 

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

74 

75 - `Detail detail`

76 

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

78 

79 - `LOW("low")`

80 

81 - `HIGH("high")`

82 

83 - `AUTO("auto")`

84 

85 - `ORIGINAL("original")`

86 

87 - `JsonValue; type "input_image"constant`

88 

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

90 

91 - `INPUT_IMAGE("input_image")`

92 

93 - `Optional<String> fileId`

94 

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

96 

97 - `Optional<String> imageUrl`

98 

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

100 

101 - `class ResponseInputFile:`

102 

103 A file input to the model.

104 

105 - `JsonValue; type "input_file"constant`

106 

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

108 

109 - `INPUT_FILE("input_file")`

110 

111 - `Optional<Detail> detail`

112 

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

114 

115 - `LOW("low")`

116 

117 - `HIGH("high")`

118 

119 - `Optional<String> fileData`

120 

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

122 

123 - `Optional<String> fileId`

124 

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

126 

127 - `Optional<String> fileUrl`

128 

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

130 

131 - `Optional<String> filename`

132 

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

134 

135 - `Role role`

136 

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

138 `developer`.

139 

140 - `USER("user")`

141 

142 - `ASSISTANT("assistant")`

143 

144 - `SYSTEM("system")`

145 

146 - `DEVELOPER("developer")`

147 

148 - `Optional<Phase> phase`

149 

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

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

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

153 

154 - `COMMENTARY("commentary")`

155 

156 - `FINAL_ANSWER("final_answer")`

157 

158 - `Optional<Type> type`

159 

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

161 

162 - `MESSAGE("message")`

163 

164 - `Message`

165 

166 - `List<ResponseInputContent> content`

167 

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

169 types.

170 

171 - `class ResponseInputText:`

172 

173 A text input to the model.

174 

175 - `class ResponseInputImage:`

176 

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

178 

179 - `class ResponseInputFile:`

180 

181 A file input to the model.

182 

183 - `Role role`

184 

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

186 

187 - `USER("user")`

188 

189 - `SYSTEM("system")`

190 

191 - `DEVELOPER("developer")`

192 

193 - `Optional<Status> status`

194 

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

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

197 

198 - `IN_PROGRESS("in_progress")`

199 

200 - `COMPLETED("completed")`

201 

202 - `INCOMPLETE("incomplete")`

203 

204 - `Optional<Type> type`

205 

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

207 

208 - `MESSAGE("message")`

209 

210 - `class ResponseOutputMessage:`

211 

212 An output message from the model.

213 

214 - `String id`

215 

216 The unique ID of the output message.

217 

218 - `List<Content> content`

219 

220 The content of the output message.

221 

222 - `class ResponseOutputText:`

223 

224 A text output from the model.

225 

226 - `List<Annotation> annotations`

227 

228 The annotations of the text output.

229 

230 - `class FileCitation:`

231 

232 A citation to a file.

233 

234 - `String fileId`

235 

236 The ID of the file.

237 

238 - `String filename`

239 

240 The filename of the file cited.

241 

242 - `long index`

243 

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

245 

246 - `JsonValue; type "file_citation"constant`

247 

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

249 

250 - `FILE_CITATION("file_citation")`

251 

252 - `class UrlCitation:`

253 

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

255 

256 - `long endIndex`

257 

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

259 

260 - `long startIndex`

261 

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

263 

264 - `String title`

265 

266 The title of the web resource.

267 

268 - `JsonValue; type "url_citation"constant`

269 

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

271 

272 - `URL_CITATION("url_citation")`

273 

274 - `String url`

275 

276 The URL of the web resource.

277 

278 - `class ContainerFileCitation:`

279 

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

281 

282 - `String containerId`

283 

284 The ID of the container file.

285 

286 - `long endIndex`

287 

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

289 

290 - `String fileId`

291 

292 The ID of the file.

293 

294 - `String filename`

295 

296 The filename of the container file cited.

297 

298 - `long startIndex`

299 

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

301 

302 - `JsonValue; type "container_file_citation"constant`

303 

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

305 

306 - `CONTAINER_FILE_CITATION("container_file_citation")`

307 

308 - `class FilePath:`

309 

310 A path to a file.

311 

312 - `String fileId`

313 

314 The ID of the file.

315 

316 - `long index`

317 

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

319 

320 - `JsonValue; type "file_path"constant`

321 

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

323 

324 - `FILE_PATH("file_path")`

325 

326 - `String text`

327 

328 The text output from the model.

329 

330 - `JsonValue; type "output_text"constant`

331 

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

333 

334 - `OUTPUT_TEXT("output_text")`

335 

336 - `Optional<List<Logprob>> logprobs`

337 

338 - `String token`

339 

340 - `List<long> bytes`

341 

342 - `double logprob`

343 

344 - `List<TopLogprob> topLogprobs`

345 

346 - `String token`

347 

348 - `List<long> bytes`

349 

350 - `double logprob`

351 

352 - `class ResponseOutputRefusal:`

353 

354 A refusal from the model.

355 

356 - `String refusal`

357 

358 The refusal explanation from the model.

359 

360 - `JsonValue; type "refusal"constant`

361 

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

363 

364 - `REFUSAL("refusal")`

365 

366 - `JsonValue; role "assistant"constant`

367 

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

369 

370 - `ASSISTANT("assistant")`

371 

372 - `Status status`

373 

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

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

376 

377 - `IN_PROGRESS("in_progress")`

378 

379 - `COMPLETED("completed")`

380 

381 - `INCOMPLETE("incomplete")`

382 

383 - `JsonValue; type "message"constant`

384 

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

386 

387 - `MESSAGE("message")`

388 

389 - `Optional<Phase> phase`

390 

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

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

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

394 

395 - `COMMENTARY("commentary")`

396 

397 - `FINAL_ANSWER("final_answer")`

398 

399 - `class ResponseFileSearchToolCall:`

400 

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

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

403 

404 - `String id`

405 

406 The unique ID of the file search tool call.

407 

408 - `List<String> queries`

409 

410 The queries used to search for files.

411 

412 - `Status status`

413 

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

415 `searching`, `incomplete` or `failed`,

416 

417 - `IN_PROGRESS("in_progress")`

418 

419 - `SEARCHING("searching")`

420 

421 - `COMPLETED("completed")`

422 

423 - `INCOMPLETE("incomplete")`

424 

425 - `FAILED("failed")`

426 

427 - `JsonValue; type "file_search_call"constant`

428 

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

430 

431 - `FILE_SEARCH_CALL("file_search_call")`

432 

433 - `Optional<List<Result>> results`

434 

435 The results of the file search tool call.

436 

437 - `Optional<Attributes> attributes`

438 

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

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

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

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

443 length of 512 characters, booleans, or numbers.

444 

445 - `String`

446 

447 - `double`

448 

449 - `boolean`

450 

451 - `Optional<String> fileId`

452 

453 The unique ID of the file.

454 

455 - `Optional<String> filename`

456 

457 The name of the file.

458 

459 - `Optional<Double> score`

460 

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

462 

463 - `Optional<String> text`

464 

465 The text that was retrieved from the file.

466 

467 - `class ResponseComputerToolCall:`

468 

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

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

471 

472 - `String id`

473 

474 The unique ID of the computer call.

475 

476 - `String callId`

477 

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

479 

480 - `List<PendingSafetyCheck> pendingSafetyChecks`

481 

482 The pending safety checks for the computer call.

483 

484 - `String id`

485 

486 The ID of the pending safety check.

487 

488 - `Optional<String> code`

489 

490 The type of the pending safety check.

491 

492 - `Optional<String> message`

493 

494 Details about the pending safety check.

495 

496 - `Status status`

497 

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

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

500 

501 - `IN_PROGRESS("in_progress")`

502 

503 - `COMPLETED("completed")`

504 

505 - `INCOMPLETE("incomplete")`

506 

507 - `Type type`

508 

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

510 

511 - `COMPUTER_CALL("computer_call")`

512 

513 - `Optional<Action> action`

514 

515 A click action.

516 

517 - `class Click:`

518 

519 A click action.

520 

521 - `Button button`

522 

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

524 

525 - `LEFT("left")`

526 

527 - `RIGHT("right")`

528 

529 - `WHEEL("wheel")`

530 

531 - `BACK("back")`

532 

533 - `FORWARD("forward")`

534 

535 - `JsonValue; type "click"constant`

536 

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

538 

539 - `CLICK("click")`

540 

541 - `long x`

542 

543 The x-coordinate where the click occurred.

544 

545 - `long y`

546 

547 The y-coordinate where the click occurred.

548 

549 - `Optional<List<String>> keys`

550 

551 The keys being held while clicking.

552 

553 - `class DoubleClick:`

554 

555 A double click action.

556 

557 - `Optional<List<String>> keys`

558 

559 The keys being held while double-clicking.

560 

561 - `JsonValue; type "double_click"constant`

562 

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

564 

565 - `DOUBLE_CLICK("double_click")`

566 

567 - `long x`

568 

569 The x-coordinate where the double click occurred.

570 

571 - `long y`

572 

573 The y-coordinate where the double click occurred.

574 

575 - `class Drag:`

576 

577 A drag action.

578 

579 - `List<Path> path`

580 

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

582 

583 ```

584 [

585 { x: 100, y: 200 },

586 { x: 200, y: 300 }

587 ]

588 ```

589 

590 - `long x`

591 

592 The x-coordinate.

593 

594 - `long y`

595 

596 The y-coordinate.

597 

598 - `JsonValue; type "drag"constant`

599 

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

601 

602 - `DRAG("drag")`

603 

604 - `Optional<List<String>> keys`

605 

606 The keys being held while dragging the mouse.

607 

608 - `class Keypress:`

609 

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

611 

612 - `List<String> keys`

613 

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

615 

616 - `JsonValue; type "keypress"constant`

617 

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

619 

620 - `KEYPRESS("keypress")`

621 

622 - `class Move:`

623 

624 A mouse move action.

625 

626 - `JsonValue; type "move"constant`

627 

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

629 

630 - `MOVE("move")`

631 

632 - `long x`

633 

634 The x-coordinate to move to.

635 

636 - `long y`

637 

638 The y-coordinate to move to.

639 

640 - `Optional<List<String>> keys`

641 

642 The keys being held while moving the mouse.

643 

644 - `JsonValue;`

645 

646 - `JsonValue; type "screenshot"constant`

647 

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

649 

650 - `SCREENSHOT("screenshot")`

651 

652 - `class Scroll:`

653 

654 A scroll action.

655 

656 - `long scrollX`

657 

658 The horizontal scroll distance.

659 

660 - `long scrollY`

661 

662 The vertical scroll distance.

663 

664 - `JsonValue; type "scroll"constant`

665 

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

667 

668 - `SCROLL("scroll")`

669 

670 - `long x`

671 

672 The x-coordinate where the scroll occurred.

673 

674 - `long y`

675 

676 The y-coordinate where the scroll occurred.

677 

678 - `Optional<List<String>> keys`

679 

680 The keys being held while scrolling.

681 

682 - `class Type:`

683 

684 An action to type in text.

685 

686 - `String text`

687 

688 The text to type.

689 

690 - `JsonValue; type "type"constant`

691 

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

693 

694 - `TYPE("type")`

695 

696 - `JsonValue;`

697 

698 - `JsonValue; type "wait"constant`

699 

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

701 

702 - `WAIT("wait")`

703 

704 - `Optional<List<ComputerAction>> actions`

705 

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

707 `type` discriminator and action-specific fields.

708 

709 - `Click`

710 

711 - `Button button`

712 

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

714 

715 - `LEFT("left")`

716 

717 - `RIGHT("right")`

718 

719 - `WHEEL("wheel")`

720 

721 - `BACK("back")`

722 

723 - `FORWARD("forward")`

724 

725 - `JsonValue; type "click"constant`

726 

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

728 

729 - `CLICK("click")`

730 

731 - `long x`

732 

733 The x-coordinate where the click occurred.

734 

735 - `long y`

736 

737 The y-coordinate where the click occurred.

738 

739 - `Optional<List<String>> keys`

740 

741 The keys being held while clicking.

742 

743 - `DoubleClick`

744 

745 - `Optional<List<String>> keys`

746 

747 The keys being held while double-clicking.

748 

749 - `JsonValue; type "double_click"constant`

750 

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

752 

753 - `DOUBLE_CLICK("double_click")`

754 

755 - `long x`

756 

757 The x-coordinate where the double click occurred.

758 

759 - `long y`

760 

761 The y-coordinate where the double click occurred.

762 

763 - `Drag`

764 

765 - `List<Path> path`

766 

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

768 

769 ```

770 [

771 { x: 100, y: 200 },

772 { x: 200, y: 300 }

773 ]

774 ```

775 

776 - `long x`

777 

778 The x-coordinate.

779 

780 - `long y`

781 

782 The y-coordinate.

783 

784 - `JsonValue; type "drag"constant`

785 

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

787 

788 - `DRAG("drag")`

789 

790 - `Optional<List<String>> keys`

791 

792 The keys being held while dragging the mouse.

793 

794 - `Keypress`

795 

796 - `List<String> keys`

797 

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

799 

800 - `JsonValue; type "keypress"constant`

801 

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

803 

804 - `KEYPRESS("keypress")`

805 

806 - `Move`

807 

808 - `JsonValue; type "move"constant`

809 

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

811 

812 - `MOVE("move")`

813 

814 - `long x`

815 

816 The x-coordinate to move to.

817 

818 - `long y`

819 

820 The y-coordinate to move to.

821 

822 - `Optional<List<String>> keys`

823 

824 The keys being held while moving the mouse.

825 

826 - `JsonValue;`

827 

828 - `JsonValue; type "screenshot"constant`

829 

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

831 

832 - `SCREENSHOT("screenshot")`

833 

834 - `Scroll`

835 

836 - `long scrollX`

837 

838 The horizontal scroll distance.

839 

840 - `long scrollY`

841 

842 The vertical scroll distance.

843 

844 - `JsonValue; type "scroll"constant`

845 

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

847 

848 - `SCROLL("scroll")`

849 

850 - `long x`

851 

852 The x-coordinate where the scroll occurred.

853 

854 - `long y`

855 

856 The y-coordinate where the scroll occurred.

857 

858 - `Optional<List<String>> keys`

859 

860 The keys being held while scrolling.

861 

862 - `Type`

863 

864 - `String text`

865 

866 The text to type.

867 

868 - `JsonValue; type "type"constant`

869 

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

871 

872 - `TYPE("type")`

873 

874 - `JsonValue;`

875 

876 - `JsonValue; type "wait"constant`

877 

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

879 

880 - `WAIT("wait")`

881 

882 - `ComputerCallOutput`

883 

884 - `String callId`

885 

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

887 

888 - `ResponseComputerToolCallOutputScreenshot output`

889 

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

891 

892 - `JsonValue; type "computer_screenshot"constant`

893 

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

895 always set to `computer_screenshot`.

896 

897 - `COMPUTER_SCREENSHOT("computer_screenshot")`

898 

899 - `Optional<String> fileId`

900 

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

902 

903 - `Optional<String> imageUrl`

904 

905 The URL of the screenshot image.

906 

907 - `JsonValue; type "computer_call_output"constant`

908 

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

910 

911 - `COMPUTER_CALL_OUTPUT("computer_call_output")`

912 

913 - `Optional<String> id`

914 

915 The ID of the computer tool call output.

916 

917 - `Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks`

918 

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

920 

921 - `String id`

922 

923 The ID of the pending safety check.

924 

925 - `Optional<String> code`

926 

927 The type of the pending safety check.

928 

929 - `Optional<String> message`

930 

931 Details about the pending safety check.

932 

933 - `Optional<Status> status`

934 

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

936 

937 - `IN_PROGRESS("in_progress")`

938 

939 - `COMPLETED("completed")`

940 

941 - `INCOMPLETE("incomplete")`

942 

943 - `class ResponseFunctionWebSearch:`

944 

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

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

947 

948 - `String id`

949 

950 The unique ID of the web search tool call.

951 

952 - `Action action`

953 

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

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

956 

957 - `class Search:`

958 

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

960 

961 - `String query`

962 

963 [DEPRECATED] The search query.

964 

965 - `JsonValue; type "search"constant`

966 

967 The action type.

968 

969 - `SEARCH("search")`

970 

971 - `Optional<List<String>> queries`

972 

973 The search queries.

974 

975 - `Optional<List<Source>> sources`

976 

977 The sources used in the search.

978 

979 - `JsonValue; type "url"constant`

980 

981 The type of source. Always `url`.

982 

983 - `URL("url")`

984 

985 - `String url`

986 

987 The URL of the source.

988 

989 - `class OpenPage:`

990 

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

992 

993 - `JsonValue; type "open_page"constant`

994 

995 The action type.

996 

997 - `OPEN_PAGE("open_page")`

998 

999 - `Optional<String> url`

1000 

1001 The URL opened by the model.

1002 

1003 - `class FindInPage:`

1004 

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

1006 

1007 - `String pattern`

1008 

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

1010 

1011 - `JsonValue; type "find_in_page"constant`

1012 

1013 The action type.

1014 

1015 - `FIND_IN_PAGE("find_in_page")`

1016 

1017 - `String url`

1018 

1019 The URL of the page searched for the pattern.

1020 

1021 - `Status status`

1022 

1023 The status of the web search tool call.

1024 

1025 - `IN_PROGRESS("in_progress")`

1026 

1027 - `SEARCHING("searching")`

1028 

1029 - `COMPLETED("completed")`

1030 

1031 - `FAILED("failed")`

1032 

1033 - `JsonValue; type "web_search_call"constant`

1034 

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

1036 

1037 - `WEB_SEARCH_CALL("web_search_call")`

1038 

1039 - `class ResponseFunctionToolCall:`

1040 

1041 A tool call to run a function. See the

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

1043 

1044 - `String arguments`

1045 

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

1047 

1048 - `String callId`

1049 

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

1051 

1052 - `String name`

1053 

1054 The name of the function to run.

1055 

1056 - `JsonValue; type "function_call"constant`

1057 

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

1059 

1060 - `FUNCTION_CALL("function_call")`

1061 

1062 - `Optional<String> id`

1063 

1064 The unique ID of the function tool call.

1065 

1066 - `Optional<String> namespace`

1067 

1068 The namespace of the function to run.

1069 

1070 - `Optional<Status> status`

1071 

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

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

1074 

1075 - `IN_PROGRESS("in_progress")`

1076 

1077 - `COMPLETED("completed")`

1078 

1079 - `INCOMPLETE("incomplete")`

1080 

1081 - `FunctionCallOutput`

1082 

1083 - `String callId`

1084 

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

1086 

1087 - `Output output`

1088 

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

1090 

1091 - `String`

1092 

1093 - `List<ResponseFunctionCallOutputItem>`

1094 

1095 - `class ResponseInputTextContent:`

1096 

1097 A text input to the model.

1098 

1099 - `String text`

1100 

1101 The text input to the model.

1102 

1103 - `JsonValue; type "input_text"constant`

1104 

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

1106 

1107 - `INPUT_TEXT("input_text")`

1108 

1109 - `class ResponseInputImageContent:`

1110 

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

1112 

1113 - `JsonValue; type "input_image"constant`

1114 

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

1116 

1117 - `INPUT_IMAGE("input_image")`

1118 

1119 - `Optional<Detail> detail`

1120 

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

1122 

1123 - `LOW("low")`

1124 

1125 - `HIGH("high")`

1126 

1127 - `AUTO("auto")`

1128 

1129 - `ORIGINAL("original")`

1130 

1131 - `Optional<String> fileId`

1132 

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

1134 

1135 - `Optional<String> imageUrl`

1136 

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

1138 

1139 - `class ResponseInputFileContent:`

1140 

1141 A file input to the model.

1142 

1143 - `JsonValue; type "input_file"constant`

1144 

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

1146 

1147 - `INPUT_FILE("input_file")`

1148 

1149 - `Optional<Detail> detail`

1150 

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

1152 

1153 - `LOW("low")`

1154 

1155 - `HIGH("high")`

1156 

1157 - `Optional<String> fileData`

1158 

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

1160 

1161 - `Optional<String> fileId`

1162 

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

1164 

1165 - `Optional<String> fileUrl`

1166 

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

1168 

1169 - `Optional<String> filename`

1170 

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

1172 

1173 - `JsonValue; type "function_call_output"constant`

1174 

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

1176 

1177 - `FUNCTION_CALL_OUTPUT("function_call_output")`

1178 

1179 - `Optional<String> id`

1180 

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

1182 

1183 - `Optional<Status> status`

1184 

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

1186 

1187 - `IN_PROGRESS("in_progress")`

1188 

1189 - `COMPLETED("completed")`

1190 

1191 - `INCOMPLETE("incomplete")`

1192 

1193 - `ToolSearchCall`

1194 

1195 - `JsonValue arguments`

1196 

1197 The arguments supplied to the tool search call.

1198 

1199 - `JsonValue; type "tool_search_call"constant`

1200 

1201 The item type. Always `tool_search_call`.

1202 

1203 - `TOOL_SEARCH_CALL("tool_search_call")`

1204 

1205 - `Optional<String> id`

1206 

1207 The unique ID of this tool search call.

1208 

1209 - `Optional<String> callId`

1210 

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

1212 

1213 - `Optional<Execution> execution`

1214 

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

1216 

1217 - `SERVER("server")`

1218 

1219 - `CLIENT("client")`

1220 

1221 - `Optional<Status> status`

1222 

1223 The status of the tool search call.

1224 

1225 - `IN_PROGRESS("in_progress")`

1226 

1227 - `COMPLETED("completed")`

1228 

1229 - `INCOMPLETE("incomplete")`

1230 

1231 - `class ResponseToolSearchOutputItemParam:`

1232 

1233 - `List<Tool> tools`

1234 

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

1236 

1237 - `class FunctionTool:`

1238 

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

1240 

1241 - `String name`

1242 

1243 The name of the function to call.

1244 

1245 - `Optional<Parameters> parameters`

1246 

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

1248 

1249 - `Optional<Boolean> strict`

1250 

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

1252 

1253 - `JsonValue; type "function"constant`

1254 

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

1256 

1257 - `FUNCTION("function")`

1258 

1259 - `Optional<Boolean> deferLoading`

1260 

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

1262 

1263 - `Optional<String> description`

1264 

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

1266 

1267 - `class FileSearchTool:`

1268 

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

1270 

1271 - `JsonValue; type "file_search"constant`

1272 

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

1274 

1275 - `FILE_SEARCH("file_search")`

1276 

1277 - `List<String> vectorStoreIds`

1278 

1279 The IDs of the vector stores to search.

1280 

1281 - `Optional<Filters> filters`

1282 

1283 A filter to apply.

1284 

1285 - `class ComparisonFilter:`

1286 

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

1288 

1289 - `String key`

1290 

1291 The key to compare against the value.

1292 

1293 - `Type type`

1294 

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

1296 

1297 - `eq`: equals

1298 - `ne`: not equal

1299 - `gt`: greater than

1300 - `gte`: greater than or equal

1301 - `lt`: less than

1302 - `lte`: less than or equal

1303 - `in`: in

1304 - `nin`: not in

1305 

1306 - `EQ("eq")`

1307 

1308 - `NE("ne")`

1309 

1310 - `GT("gt")`

1311 

1312 - `GTE("gte")`

1313 

1314 - `LT("lt")`

1315 

1316 - `LTE("lte")`

1317 

1318 - `IN("in")`

1319 

1320 - `NIN("nin")`

1321 

1322 - `Value value`

1323 

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

1325 

1326 - `String`

1327 

1328 - `double`

1329 

1330 - `boolean`

1331 

1332 - `List<ComparisonFilterValueItem>`

1333 

1334 - `String`

1335 

1336 - `double`

1337 

1338 - `class CompoundFilter:`

1339 

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

1341 

1342 - `List<Filter> filters`

1343 

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

1345 

1346 - `class ComparisonFilter:`

1347 

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

1349 

1350 - `JsonValue`

1351 

1352 - `Type type`

1353 

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

1355 

1356 - `AND("and")`

1357 

1358 - `OR("or")`

1359 

1360 - `Optional<Long> maxNumResults`

1361 

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

1363 

1364 - `Optional<RankingOptions> rankingOptions`

1365 

1366 Ranking options for search.

1367 

1368 - `Optional<HybridSearch> hybridSearch`

1369 

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

1371 

1372 - `double embeddingWeight`

1373 

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

1375 

1376 - `double textWeight`

1377 

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

1379 

1380 - `Optional<Ranker> ranker`

1381 

1382 The ranker to use for the file search.

1383 

1384 - `AUTO("auto")`

1385 

1386 - `DEFAULT_2024_11_15("default-2024-11-15")`

1387 

1388 - `Optional<Double> scoreThreshold`

1389 

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

1391 

1392 - `class ComputerTool:`

1393 

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

1395 

1396 - `JsonValue; type "computer"constant`

1397 

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

1399 

1400 - `COMPUTER("computer")`

1401 

1402 - `class ComputerUsePreviewTool:`

1403 

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

1405 

1406 - `long displayHeight`

1407 

1408 The height of the computer display.

1409 

1410 - `long displayWidth`

1411 

1412 The width of the computer display.

1413 

1414 - `Environment environment`

1415 

1416 The type of computer environment to control.

1417 

1418 - `WINDOWS("windows")`

1419 

1420 - `MAC("mac")`

1421 

1422 - `LINUX("linux")`

1423 

1424 - `UBUNTU("ubuntu")`

1425 

1426 - `BROWSER("browser")`

1427 

1428 - `JsonValue; type "computer_use_preview"constant`

1429 

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

1431 

1432 - `COMPUTER_USE_PREVIEW("computer_use_preview")`

1433 

1434 - `class WebSearchTool:`

1435 

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

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

1438 

1439 - `Type type`

1440 

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

1442 

1443 - `WEB_SEARCH("web_search")`

1444 

1445 - `WEB_SEARCH_2025_08_26("web_search_2025_08_26")`

1446 

1447 - `Optional<Filters> filters`

1448 

1449 Filters for the search.

1450 

1451 - `Optional<List<String>> allowedDomains`

1452 

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

1454 Subdomains of the provided domains are allowed as well.

1455 

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

1457 

1458 - `Optional<SearchContextSize> searchContextSize`

1459 

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

1461 

1462 - `LOW("low")`

1463 

1464 - `MEDIUM("medium")`

1465 

1466 - `HIGH("high")`

1467 

1468 - `Optional<UserLocation> userLocation`

1469 

1470 The approximate location of the user.

1471 

1472 - `Optional<String> city`

1473 

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

1475 

1476 - `Optional<String> country`

1477 

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

1479 

1480 - `Optional<String> region`

1481 

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

1483 

1484 - `Optional<String> timezone`

1485 

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

1487 

1488 - `Optional<Type> type`

1489 

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

1491 

1492 - `APPROXIMATE("approximate")`

1493 

1494 - `Mcp`

1495 

1496 - `String serverLabel`

1497 

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

1499 

1500 - `JsonValue; type "mcp"constant`

1501 

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

1503 

1504 - `MCP("mcp")`

1505 

1506 - `Optional<AllowedTools> allowedTools`

1507 

1508 List of allowed tool names or a filter object.

1509 

1510 - `List<String>`

1511 

1512 - `class McpToolFilter:`

1513 

1514 A filter object to specify which tools are allowed.

1515 

1516 - `Optional<Boolean> readOnly`

1517 

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

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

1520 it will match this filter.

1521 

1522 - `Optional<List<String>> toolNames`

1523 

1524 List of allowed tool names.

1525 

1526 - `Optional<String> authorization`

1527 

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

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

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

1531 

1532 - `Optional<ConnectorId> connectorId`

1533 

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

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

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

1537 

1538 Currently supported `connector_id` values are:

1539 

1540 - Dropbox: `connector_dropbox`

1541 - Gmail: `connector_gmail`

1542 - Google Calendar: `connector_googlecalendar`

1543 - Google Drive: `connector_googledrive`

1544 - Microsoft Teams: `connector_microsoftteams`

1545 - Outlook Calendar: `connector_outlookcalendar`

1546 - Outlook Email: `connector_outlookemail`

1547 - SharePoint: `connector_sharepoint`

1548 

1549 - `CONNECTOR_DROPBOX("connector_dropbox")`

1550 

1551 - `CONNECTOR_GMAIL("connector_gmail")`

1552 

1553 - `CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")`

1554 

1555 - `CONNECTOR_GOOGLEDRIVE("connector_googledrive")`

1556 

1557 - `CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")`

1558 

1559 - `CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")`

1560 

1561 - `CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")`

1562 

1563 - `CONNECTOR_SHAREPOINT("connector_sharepoint")`

1564 

1565 - `Optional<Boolean> deferLoading`

1566 

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

1568 

1569 - `Optional<Headers> headers`

1570 

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

1572 or other purposes.

1573 

1574 - `Optional<RequireApproval> requireApproval`

1575 

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

1577 

1578 - `class McpToolApprovalFilter:`

1579 

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

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

1582 that require approval.

1583 

1584 - `Optional<Always> always`

1585 

1586 A filter object to specify which tools are allowed.

1587 

1588 - `Optional<Boolean> readOnly`

1589 

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

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

1592 it will match this filter.

1593 

1594 - `Optional<List<String>> toolNames`

1595 

1596 List of allowed tool names.

1597 

1598 - `Optional<Never> never`

1599 

1600 A filter object to specify which tools are allowed.

1601 

1602 - `Optional<Boolean> readOnly`

1603 

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

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

1606 it will match this filter.

1607 

1608 - `Optional<List<String>> toolNames`

1609 

1610 List of allowed tool names.

1611 

1612 - `enum McpToolApprovalSetting:`

1613 

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

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

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

1617 

1618 - `ALWAYS("always")`

1619 

1620 - `NEVER("never")`

1621 

1622 - `Optional<String> serverDescription`

1623 

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

1625 

1626 - `Optional<String> serverUrl`

1627 

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

1629 provided.

1630 

1631 - `CodeInterpreter`

1632 

1633 - `Container container`

1634 

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

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

1637 optional `memory_limit` setting.

1638 

1639 - `String`

1640 

1641 - `class CodeInterpreterToolAuto:`

1642 

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

1644 

1645 - `JsonValue; type "auto"constant`

1646 

1647 Always `auto`.

1648 

1649 - `AUTO("auto")`

1650 

1651 - `Optional<List<String>> fileIds`

1652 

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

1654 

1655 - `Optional<MemoryLimit> memoryLimit`

1656 

1657 The memory limit for the code interpreter container.

1658 

1659 - `_1G("1g")`

1660 

1661 - `_4G("4g")`

1662 

1663 - `_16G("16g")`

1664 

1665 - `_64G("64g")`

1666 

1667 - `Optional<NetworkPolicy> networkPolicy`

1668 

1669 Network access policy for the container.

1670 

1671 - `class ContainerNetworkPolicyDisabled:`

1672 

1673 - `JsonValue; type "disabled"constant`

1674 

1675 Disable outbound network access. Always `disabled`.

1676 

1677 - `DISABLED("disabled")`

1678 

1679 - `class ContainerNetworkPolicyAllowlist:`

1680 

1681 - `List<String> allowedDomains`

1682 

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

1684 

1685 - `JsonValue; type "allowlist"constant`

1686 

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

1688 

1689 - `ALLOWLIST("allowlist")`

1690 

1691 - `Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets`

1692 

1693 Optional domain-scoped secrets for allowlisted domains.

1694 

1695 - `String domain`

1696 

1697 The domain associated with the secret.

1698 

1699 - `String name`

1700 

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

1702 

1703 - `String value`

1704 

1705 The secret value to inject for the domain.

1706 

1707 - `JsonValue; type "code_interpreter"constant`

1708 

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

1710 

1711 - `CODE_INTERPRETER("code_interpreter")`

1712 

1713 - `ImageGeneration`

1714 

1715 - `JsonValue; type "image_generation"constant`

1716 

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

1718 

1719 - `IMAGE_GENERATION("image_generation")`

1720 

1721 - `Optional<Action> action`

1722 

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

1724 

1725 - `GENERATE("generate")`

1726 

1727 - `EDIT("edit")`

1728 

1729 - `AUTO("auto")`

1730 

1731 - `Optional<Background> background`

1732 

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

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

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

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

1737 automatically determine the best background for the image.

1738 

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

1740 transparent backgrounds. Requests with `background` set to

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

1742 `auto` instead.

1743 

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

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

1746 

1747 - `TRANSPARENT("transparent")`

1748 

1749 - `OPAQUE("opaque")`

1750 

1751 - `AUTO("auto")`

1752 

1753 - `Optional<InputFidelity> inputFidelity`

1754 

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

1756 

1757 - `HIGH("high")`

1758 

1759 - `LOW("low")`

1760 

1761 - `Optional<InputImageMask> inputImageMask`

1762 

1763 Optional mask for inpainting. Contains `image_url`

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

1765 

1766 - `Optional<String> fileId`

1767 

1768 File ID for the mask image.

1769 

1770 - `Optional<String> imageUrl`

1771 

1772 Base64-encoded mask image.

1773 

1774 - `Optional<Model> model`

1775 

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

1777 

1778 - `GPT_IMAGE_1("gpt-image-1")`

1779 

1780 - `GPT_IMAGE_1_MINI("gpt-image-1-mini")`

1781 

1782 - `GPT_IMAGE_2("gpt-image-2")`

1783 

1784 - `GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")`

1785 

1786 - `GPT_IMAGE_1_5("gpt-image-1.5")`

1787 

1788 - `CHATGPT_IMAGE_LATEST("chatgpt-image-latest")`

1789 

1790 - `Optional<Moderation> moderation`

1791 

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

1793 

1794 - `AUTO("auto")`

1795 

1796 - `LOW("low")`

1797 

1798 - `Optional<Long> outputCompression`

1799 

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

1801 

1802 - `Optional<OutputFormat> outputFormat`

1803 

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

1805 `jpeg`. Default: `png`.

1806 

1807 - `PNG("png")`

1808 

1809 - `WEBP("webp")`

1810 

1811 - `JPEG("jpeg")`

1812 

1813 - `Optional<Long> partialImages`

1814 

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

1816 

1817 - `Optional<Quality> quality`

1818 

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

1820 or `auto`. Default: `auto`.

1821 

1822 - `LOW("low")`

1823 

1824 - `MEDIUM("medium")`

1825 

1826 - `HIGH("high")`

1827 

1828 - `AUTO("auto")`

1829 

1830 - `Optional<Size> size`

1831 

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

1833 

1834 - `_1024X1024("1024x1024")`

1835 

1836 - `_1024X1536("1024x1536")`

1837 

1838 - `_1536X1024("1536x1024")`

1839 

1840 - `AUTO("auto")`

1841 

1842 - `JsonValue;`

1843 

1844 - `JsonValue; type "local_shell"constant`

1845 

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

1847 

1848 - `LOCAL_SHELL("local_shell")`

1849 

1850 - `class FunctionShellTool:`

1851 

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

1853 

1854 - `JsonValue; type "shell"constant`

1855 

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

1857 

1858 - `SHELL("shell")`

1859 

1860 - `Optional<Environment> environment`

1861 

1862 - `class ContainerAuto:`

1863 

1864 - `JsonValue; type "container_auto"constant`

1865 

1866 Automatically creates a container for this request

1867 

1868 - `CONTAINER_AUTO("container_auto")`

1869 

1870 - `Optional<List<String>> fileIds`

1871 

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

1873 

1874 - `Optional<MemoryLimit> memoryLimit`

1875 

1876 The memory limit for the container.

1877 

1878 - `_1G("1g")`

1879 

1880 - `_4G("4g")`

1881 

1882 - `_16G("16g")`

1883 

1884 - `_64G("64g")`

1885 

1886 - `Optional<NetworkPolicy> networkPolicy`

1887 

1888 Network access policy for the container.

1889 

1890 - `class ContainerNetworkPolicyDisabled:`

1891 

1892 - `class ContainerNetworkPolicyAllowlist:`

1893 

1894 - `Optional<List<Skill>> skills`

1895 

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

1897 

1898 - `class SkillReference:`

1899 

1900 - `String skillId`

1901 

1902 The ID of the referenced skill.

1903 

1904 - `JsonValue; type "skill_reference"constant`

1905 

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

1907 

1908 - `SKILL_REFERENCE("skill_reference")`

1909 

1910 - `Optional<String> version`

1911 

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

1913 

1914 - `class InlineSkill:`

1915 

1916 - `String description`

1917 

1918 The description of the skill.

1919 

1920 - `String name`

1921 

1922 The name of the skill.

1923 

1924 - `InlineSkillSource source`

1925 

1926 Inline skill payload

1927 

1928 - `String data`

1929 

1930 Base64-encoded skill zip bundle.

1931 

1932 - `JsonValue; mediaType "application/zip"constant`

1933 

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

1935 

1936 - `APPLICATION_ZIP("application/zip")`

1937 

1938 - `JsonValue; type "base64"constant`

1939 

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

1941 

1942 - `BASE64("base64")`

1943 

1944 - `JsonValue; type "inline"constant`

1945 

1946 Defines an inline skill for this request.

1947 

1948 - `INLINE("inline")`

1949 

1950 - `class LocalEnvironment:`

1951 

1952 - `JsonValue; type "local"constant`

1953 

1954 Use a local computer environment.

1955 

1956 - `LOCAL("local")`

1957 

1958 - `Optional<List<LocalSkill>> skills`

1959 

1960 An optional list of skills.

1961 

1962 - `String description`

1963 

1964 The description of the skill.

1965 

1966 - `String name`

1967 

1968 The name of the skill.

1969 

1970 - `String path`

1971 

1972 The path to the directory containing the skill.

1973 

1974 - `class ContainerReference:`

1975 

1976 - `String containerId`

1977 

1978 The ID of the referenced container.

1979 

1980 - `JsonValue; type "container_reference"constant`

1981 

1982 References a container created with the /v1/containers endpoint

1983 

1984 - `CONTAINER_REFERENCE("container_reference")`

1985 

1986 - `class CustomTool:`

1987 

1988 A custom tool that processes input using a specified format. Learn more about [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)

1989 

1990 - `String name`

1991 

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

1993 

1994 - `JsonValue; type "custom"constant`

1995 

1996 The type of the custom tool. Always `custom`.