Reference 2026-06-12 00:01 UTC to 2026-06-16 21:57 UTC

1# Shared

2 

3## Domain Types

4 

5### All Models

6 

7- `all_models: string or ChatModel or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`

8 

9 - `union_member_0: string`

10 

11 - `chat_model: "gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more`

12 

13 - `"gpt-5.4"`

14 

15 - `"gpt-5.4-mini"`

16 

17 - `"gpt-5.4-nano"`

18 

19 - `"gpt-5.4-mini-2026-03-17"`

20 

21 - `"gpt-5.4-nano-2026-03-17"`

22 

23 - `"gpt-5.3-chat-latest"`

24 

25 - `"gpt-5.2"`

26 

27 - `"gpt-5.2-2025-12-11"`

28 

29 - `"gpt-5.2-chat-latest"`

30 

31 - `"gpt-5.2-pro"`

32 

33 - `"gpt-5.2-pro-2025-12-11"`

34 

35 - `"gpt-5.1"`

36 

37 - `"gpt-5.1-2025-11-13"`

38 

39 - `"gpt-5.1-codex"`

40 

41 - `"gpt-5.1-mini"`

42 

43 - `"gpt-5.1-chat-latest"`

44 

45 - `"gpt-5"`

46 

47 - `"gpt-5-mini"`

48 

49 - `"gpt-5-nano"`

50 

51 - `"gpt-5-2025-08-07"`

52 

53 - `"gpt-5-mini-2025-08-07"`

54 

55 - `"gpt-5-nano-2025-08-07"`

56 

57 - `"gpt-5-chat-latest"`

58 

59 - `"gpt-4.1"`

60 

61 - `"gpt-4.1-mini"`

62 

63 - `"gpt-4.1-nano"`

64 

65 - `"gpt-4.1-2025-04-14"`

66 

67 - `"gpt-4.1-mini-2025-04-14"`

68 

69 - `"gpt-4.1-nano-2025-04-14"`

70 

71 - `"o4-mini"`

72 

73 - `"o4-mini-2025-04-16"`

74 

75 - `"o3"`

76 

77 - `"o3-2025-04-16"`

78 

79 - `"o3-mini"`

80 

81 - `"o3-mini-2025-01-31"`

82 

83 - `"o1"`

84 

85 - `"o1-2024-12-17"`

86 

87 - `"o1-preview"`

88 

89 - `"o1-preview-2024-09-12"`

90 

91 - `"o1-mini"`

92 

93 - `"o1-mini-2024-09-12"`

94 

95 - `"gpt-4o"`

96 

97 - `"gpt-4o-2024-11-20"`

98 

99 - `"gpt-4o-2024-08-06"`

100 

101 - `"gpt-4o-2024-05-13"`

102 

103 - `"gpt-4o-audio-preview"`

104 

105 - `"gpt-4o-audio-preview-2024-10-01"`

106 

107 - `"gpt-4o-audio-preview-2024-12-17"`

108 

109 - `"gpt-4o-audio-preview-2025-06-03"`

110 

111 - `"gpt-4o-mini-audio-preview"`

112 

113 - `"gpt-4o-mini-audio-preview-2024-12-17"`

114 

115 - `"gpt-4o-search-preview"`

116 

117 - `"gpt-4o-mini-search-preview"`

118 

119 - `"gpt-4o-search-preview-2025-03-11"`

120 

121 - `"gpt-4o-mini-search-preview-2025-03-11"`

122 

123 - `"chatgpt-4o-latest"`

124 

125 - `"codex-mini-latest"`

126 

127 - `"gpt-4o-mini"`

128 

129 - `"gpt-4o-mini-2024-07-18"`

130 

131 - `"gpt-4-turbo"`

132 

133 - `"gpt-4-turbo-2024-04-09"`

134 

135 - `"gpt-4-0125-preview"`

136 

137 - `"gpt-4-turbo-preview"`

138 

139 - `"gpt-4-1106-preview"`

140 

141 - `"gpt-4-vision-preview"`

142 

143 - `"gpt-4"`

144 

145 - `"gpt-4-0314"`

146 

147 - `"gpt-4-0613"`

148 

149 - `"gpt-4-32k"`

150 

151 - `"gpt-4-32k-0314"`

152 

153 - `"gpt-4-32k-0613"`

154 

155 - `"gpt-3.5-turbo"`

156 

157 - `"gpt-3.5-turbo-16k"`

158 

159 - `"gpt-3.5-turbo-0301"`

160 

161 - `"gpt-3.5-turbo-0613"`

162 

163 - `"gpt-3.5-turbo-1106"`

164 

165 - `"gpt-3.5-turbo-0125"`

166 

167 - `"gpt-3.5-turbo-16k-0613"`

168 

169 - `ResponsesOnlyModel: "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`

170 

171 - `"o1-pro"`

172 

173 - `"o1-pro-2025-03-19"`

174 

175 - `"o3-pro"`

176 

177 - `"o3-pro-2025-06-10"`

178 

179 - `"o3-deep-research"`

180 

181 - `"o3-deep-research-2025-06-26"`

182 

183 - `"o4-mini-deep-research"`

184 

185 - `"o4-mini-deep-research-2025-06-26"`

186 

187 - `"computer-use-preview"`

188 

189 - `"computer-use-preview-2025-03-11"`

190 

191 - `"gpt-5-codex"`

192 

193 - `"gpt-5-pro"`

194 

195 - `"gpt-5-pro-2025-10-06"`

196 

197 - `"gpt-5.1-codex-max"`

198 

199### Chat Model

200 

201- `chat_model: "gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more`

202 

203 - `"gpt-5.4"`

204 

205 - `"gpt-5.4-mini"`

206 

207 - `"gpt-5.4-nano"`

208 

209 - `"gpt-5.4-mini-2026-03-17"`

210 

211 - `"gpt-5.4-nano-2026-03-17"`

212 

213 - `"gpt-5.3-chat-latest"`

214 

215 - `"gpt-5.2"`

216 

217 - `"gpt-5.2-2025-12-11"`

218 

219 - `"gpt-5.2-chat-latest"`

220 

221 - `"gpt-5.2-pro"`

222 

223 - `"gpt-5.2-pro-2025-12-11"`

224 

225 - `"gpt-5.1"`

226 

227 - `"gpt-5.1-2025-11-13"`

228 

229 - `"gpt-5.1-codex"`

230 

231 - `"gpt-5.1-mini"`

232 

233 - `"gpt-5.1-chat-latest"`

234 

235 - `"gpt-5"`

236 

237 - `"gpt-5-mini"`

238 

239 - `"gpt-5-nano"`

240 

241 - `"gpt-5-2025-08-07"`

242 

243 - `"gpt-5-mini-2025-08-07"`

244 

245 - `"gpt-5-nano-2025-08-07"`

246 

247 - `"gpt-5-chat-latest"`

248 

249 - `"gpt-4.1"`

250 

251 - `"gpt-4.1-mini"`

252 

253 - `"gpt-4.1-nano"`

254 

255 - `"gpt-4.1-2025-04-14"`

256 

257 - `"gpt-4.1-mini-2025-04-14"`

258 

259 - `"gpt-4.1-nano-2025-04-14"`

260 

261 - `"o4-mini"`

262 

263 - `"o4-mini-2025-04-16"`

264 

265 - `"o3"`

266 

267 - `"o3-2025-04-16"`

268 

269 - `"o3-mini"`

270 

271 - `"o3-mini-2025-01-31"`

272 

273 - `"o1"`

274 

275 - `"o1-2024-12-17"`

276 

277 - `"o1-preview"`

278 

279 - `"o1-preview-2024-09-12"`

280 

281 - `"o1-mini"`

282 

283 - `"o1-mini-2024-09-12"`

284 

285 - `"gpt-4o"`

286 

287 - `"gpt-4o-2024-11-20"`

288 

289 - `"gpt-4o-2024-08-06"`

290 

291 - `"gpt-4o-2024-05-13"`

292 

293 - `"gpt-4o-audio-preview"`

294 

295 - `"gpt-4o-audio-preview-2024-10-01"`

296 

297 - `"gpt-4o-audio-preview-2024-12-17"`

298 

299 - `"gpt-4o-audio-preview-2025-06-03"`

300 

301 - `"gpt-4o-mini-audio-preview"`

302 

303 - `"gpt-4o-mini-audio-preview-2024-12-17"`

304 

305 - `"gpt-4o-search-preview"`

306 

307 - `"gpt-4o-mini-search-preview"`

308 

309 - `"gpt-4o-search-preview-2025-03-11"`

310 

311 - `"gpt-4o-mini-search-preview-2025-03-11"`

312 

313 - `"chatgpt-4o-latest"`

314 

315 - `"codex-mini-latest"`

316 

317 - `"gpt-4o-mini"`

318 

319 - `"gpt-4o-mini-2024-07-18"`

320 

321 - `"gpt-4-turbo"`

322 

323 - `"gpt-4-turbo-2024-04-09"`

324 

325 - `"gpt-4-0125-preview"`

326 

327 - `"gpt-4-turbo-preview"`

328 

329 - `"gpt-4-1106-preview"`

330 

331 - `"gpt-4-vision-preview"`

332 

333 - `"gpt-4"`

334 

335 - `"gpt-4-0314"`

336 

337 - `"gpt-4-0613"`

338 

339 - `"gpt-4-32k"`

340 

341 - `"gpt-4-32k-0314"`

342 

343 - `"gpt-4-32k-0613"`

344 

345 - `"gpt-3.5-turbo"`

346 

347 - `"gpt-3.5-turbo-16k"`

348 

349 - `"gpt-3.5-turbo-0301"`

350 

351 - `"gpt-3.5-turbo-0613"`

352 

353 - `"gpt-3.5-turbo-1106"`

354 

355 - `"gpt-3.5-turbo-0125"`

356 

357 - `"gpt-3.5-turbo-16k-0613"`

358 

359### Comparison Filter

360 

361- `comparison_filter: object { key, type, value }`

362 

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

364 

365 - `key: string`

366 

367 The key to compare against the value.

368 

369 - `type: "eq" or "ne" or "gt" or 5 more`

370 

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

372 

373 - `eq`: equals

374 - `ne`: not equal

375 - `gt`: greater than

376 - `gte`: greater than or equal

377 - `lt`: less than

378 - `lte`: less than or equal

379 - `in`: in

380 - `nin`: not in

381 

382 - `"eq"`

383 

384 - `"ne"`

385 

386 - `"gt"`

387 

388 - `"gte"`

389 

390 - `"lt"`

391 

392 - `"lte"`

393 

394 - `"in"`

395 

396 - `"nin"`

397 

398 - `value: string or number or boolean or array of string or number`

399 

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

401 

402 - `union_member_0: string`

403 

404 - `union_member_1: number`

405 

406 - `union_member_2: boolean`

407 

408 - `union_member_3: array of string or number`

409 

410 - `union_member_0: string`

411 

412 - `union_member_1: number`

413 

414### Compound Filter

415 

416- `compound_filter: object { filters, type }`

417 

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

419 

420 - `filters: array of ComparisonFilter or unknown`

421 

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

423 

424 - `comparison_filter: object { key, type, value }`

425 

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

427 

428 - `key: string`

429 

430 The key to compare against the value.

431 

432 - `type: "eq" or "ne" or "gt" or 5 more`

433 

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

435 

436 - `eq`: equals

437 - `ne`: not equal

438 - `gt`: greater than

439 - `gte`: greater than or equal

440 - `lt`: less than

441 - `lte`: less than or equal

442 - `in`: in

443 - `nin`: not in

444 

445 - `"eq"`

446 

447 - `"ne"`

448 

449 - `"gt"`

450 

451 - `"gte"`

452 

453 - `"lt"`

454 

455 - `"lte"`

456 

457 - `"in"`

458 

459 - `"nin"`

460 

461 - `value: string or number or boolean or array of string or number`

462 

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

464 

465 - `union_member_0: string`

466 

467 - `union_member_1: number`

468 

469 - `union_member_2: boolean`

470 

471 - `union_member_3: array of string or number`

472 

473 - `union_member_0: string`

474 

475 - `union_member_1: number`

476 

477 - `union_member_1: unknown`

478 

479 - `type: "and" or "or"`

480 

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

482 

483 - `"and"`

484 

485 - `"or"`

486 

487### Custom Tool Input Format

488 

489- `custom_tool_input_format: object { type } or object { definition, syntax, type }`

490 

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

492 

493 - `text: object { type }`

494 

495 Unconstrained free-form text.

496 

497 - `grammar: object { definition, syntax, type }`

498 

499 A grammar defined by the user.

500 

501 - `definition: string`

502 

503 The grammar definition.

504 

505 - `syntax: "lark" or "regex"`

506 

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

508 

509 - `"lark"`

510 

511 - `"regex"`

512 

513 - `type: "grammar"`

514 

515 Grammar format. Always `grammar`.

516 

517### Error Object

518 

519- `error_object: object { code, message, param, type }`

520 

521 - `code: string`

522 

523 - `message: string`

524 

525 - `param: string`

526 

527 - `type: string`

528 

529### Function Definition

530 

531- `function_definition: object { name, description, parameters, strict }`

532 

533 - `name: string`

534 

535 The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

536 

537 - `description: optional string`

538 

539 A description of what the function does, used by the model to choose when and how to call the function.

540 

541 - `parameters: optional map[unknown]`

542 

543 The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.

544 

545 Omitting `parameters` defines a function with an empty parameter list.

546 

547 - `strict: optional boolean`

548 

549 Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling).

550 

551### Function Parameters

552 

553- `function_parameters: map[unknown]`

554 

555 The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.

556 

557 Omitting `parameters` defines a function with an empty parameter list.

558 

559### Metadata

560 

561- `metadata: map[string]`

562 

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

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

565 format, and querying for objects via API or the dashboard.

566 

567 Keys are strings with a maximum length of 64 characters. Values are strings

568 with a maximum length of 512 characters.

569 

570### Reasoning

571 

572- `reasoning: object { context, effort, generate_summary, summary }`

573 

574 **gpt-5 and o-series models only**

575 

576 Configuration options for

577 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

578 

579 - `context: optional "auto" or "current_turn" or "all_turns"`

580 

581 Controls which reasoning items are rendered back to the model on later turns.

582 When returned on a response, this is the effective reasoning context mode

583 used for the response.

584 

585 - `"auto"`

586 

587 - `"current_turn"`

588 

589 - `"all_turns"`

590 

591 - `effort: optional "none" or "minimal" or "low" or 3 more`

592 

593 Constrains effort on reasoning for

594 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

595 Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing

596 reasoning effort can result in faster responses and fewer tokens used

597 on reasoning in a response.

598 

599 - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.

600 - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.

601 - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.

602 - `xhigh` is supported for all models after `gpt-5.1-codex-max`.

603 

604 - `"none"`

605 

606 - `"minimal"`

607 

608 - `"low"`

609 

610 - `"medium"`

611 

612 - `"high"`

613 

614 - `"xhigh"`

615 

616 - `generate_summary: optional "auto" or "concise" or "detailed"`

617 

618 **Deprecated:** use `summary` instead.

619 

620 A summary of the reasoning performed by the model. This can be

621 useful for debugging and understanding the model's reasoning process.

622 One of `auto`, `concise`, or `detailed`.

623 

624 - `"auto"`

625 

626 - `"concise"`

627 

628 - `"detailed"`

629 

630 - `summary: optional "auto" or "concise" or "detailed"`

631 

632 A summary of the reasoning performed by the model. This can be

633 useful for debugging and understanding the model's reasoning process.

634 One of `auto`, `concise`, or `detailed`.

635 

636 `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.

637 

638 - `"auto"`

639 

640 - `"concise"`

641 

642 - `"detailed"`

643 

644### Reasoning Effort

645 

646- `reasoning_effort: "none" or "minimal" or "low" or 3 more`

647 

648 Constrains effort on reasoning for

649 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

650 Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing

651 reasoning effort can result in faster responses and fewer tokens used

652 on reasoning in a response.

653 

654 - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.

655 - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.

656 - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.

657 - `xhigh` is supported for all models after `gpt-5.1-codex-max`.

658 

659 - `"none"`

660 

661 - `"minimal"`

662 

663 - `"low"`

664 

665 - `"medium"`

666 

667 - `"high"`

668 

669 - `"xhigh"`

670 

671### Response Format JSON Object

672 

673- `response_format_json_object: object { type }`

674 

675 JSON object response format. An older method of generating JSON responses.

676 Using `json_schema` is recommended for models that support it. Note that the

677 model will not generate JSON without a system or user message instructing it

678 to do so.

679 

680 - `type: "json_object"`

681 

682 The type of response format being defined. Always `json_object`.

683 

684### Response Format JSON Schema

685 

686- `response_format_json_schema: object { json_schema, type }`

687 

688 JSON Schema response format. Used to generate structured JSON responses.

689 Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).

690 

691 - `json_schema: object { name, description, schema, strict }`

692 

693 Structured Outputs configuration options, including a JSON Schema.

694 

695 - `name: string`

696 

697 The name of the response format. Must be a-z, A-Z, 0-9, or contain

698 underscores and dashes, with a maximum length of 64.

699 

700 - `description: optional string`

701 

702 A description of what the response format is for, used by the model to

703 determine how to respond in the format.

704 

705 - `schema: optional map[unknown]`

706 

707 The schema for the response format, described as a JSON Schema object.

708 Learn how to build JSON schemas [here](https://json-schema.org/).

709 

710 - `strict: optional boolean`

711 

712 Whether to enable strict schema adherence when generating the output.

713 If set to true, the model will always follow the exact schema defined

714 in the `schema` field. Only a subset of JSON Schema is supported when

715 `strict` is `true`. To learn more, read the [Structured Outputs

716 guide](https://platform.openai.com/docs/guides/structured-outputs).

717 

718 - `type: "json_schema"`

719 

720 The type of response format being defined. Always `json_schema`.

721 

722### Response Format Text

723 

724- `response_format_text: object { type }`

725 

726 Default response format. Used to generate text responses.

727 

728 - `type: "text"`

729 

730 The type of response format being defined. Always `text`.

731 

732### Response Format Text Grammar

733 

734- `response_format_text_grammar: object { grammar, type }`

735 

736 A custom grammar for the model to follow when generating text.

737 Learn more in the [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars).

738 

739 - `grammar: string`

740 

741 The custom grammar for the model to follow.

742 

743 - `type: "grammar"`

744 

745 The type of response format being defined. Always `grammar`.

746 

747### Response Format Text Python

748 

749- `response_format_text_python: object { type }`

750 

751 Configure the model to generate valid Python code. See the

752 [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars) for more details.

753 

754 - `type: "python"`

755 

756 The type of response format being defined. Always `python`.

757 

758### Responses Model

759 

760- `responses_model: string or ChatModel or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`

761 

762 - `union_member_0: string`

763 

764 - `chat_model: "gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more`

765 

766 - `"gpt-5.4"`

767 

768 - `"gpt-5.4-mini"`

769 

770 - `"gpt-5.4-nano"`

771 

772 - `"gpt-5.4-mini-2026-03-17"`

773 

774 - `"gpt-5.4-nano-2026-03-17"`

775 

776 - `"gpt-5.3-chat-latest"`

777 

778 - `"gpt-5.2"`

779 

780 - `"gpt-5.2-2025-12-11"`

781 

782 - `"gpt-5.2-chat-latest"`

783 

784 - `"gpt-5.2-pro"`

785 

786 - `"gpt-5.2-pro-2025-12-11"`

787 

788 - `"gpt-5.1"`

789 

790 - `"gpt-5.1-2025-11-13"`

791 

792 - `"gpt-5.1-codex"`

793 

794 - `"gpt-5.1-mini"`

795 

796 - `"gpt-5.1-chat-latest"`

797 

798 - `"gpt-5"`

799 

800 - `"gpt-5-mini"`

801 

802 - `"gpt-5-nano"`

803 

804 - `"gpt-5-2025-08-07"`

805 

806 - `"gpt-5-mini-2025-08-07"`

807 

808 - `"gpt-5-nano-2025-08-07"`

809 

810 - `"gpt-5-chat-latest"`

811 

812 - `"gpt-4.1"`

813 

814 - `"gpt-4.1-mini"`

815 

816 - `"gpt-4.1-nano"`

817 

818 - `"gpt-4.1-2025-04-14"`

819 

820 - `"gpt-4.1-mini-2025-04-14"`

821 

822 - `"gpt-4.1-nano-2025-04-14"`

823 

824 - `"o4-mini"`

825 

826 - `"o4-mini-2025-04-16"`

827 

828 - `"o3"`

829 

830 - `"o3-2025-04-16"`

831 

832 - `"o3-mini"`

833 

834 - `"o3-mini-2025-01-31"`

835 

836 - `"o1"`

837 

838 - `"o1-2024-12-17"`

839 

840 - `"o1-preview"`

841 

842 - `"o1-preview-2024-09-12"`

843 

844 - `"o1-mini"`

845 

846 - `"o1-mini-2024-09-12"`

847 

848 - `"gpt-4o"`

849 

850 - `"gpt-4o-2024-11-20"`

851 

852 - `"gpt-4o-2024-08-06"`

853 

854 - `"gpt-4o-2024-05-13"`

855 

856 - `"gpt-4o-audio-preview"`

857 

858 - `"gpt-4o-audio-preview-2024-10-01"`

859 

860 - `"gpt-4o-audio-preview-2024-12-17"`

861 

862 - `"gpt-4o-audio-preview-2025-06-03"`

863 

864 - `"gpt-4o-mini-audio-preview"`

865 

866 - `"gpt-4o-mini-audio-preview-2024-12-17"`

867 

868 - `"gpt-4o-search-preview"`

869 

870 - `"gpt-4o-mini-search-preview"`

871 

872 - `"gpt-4o-search-preview-2025-03-11"`

873 

874 - `"gpt-4o-mini-search-preview-2025-03-11"`

875 

876 - `"chatgpt-4o-latest"`

877 

878 - `"codex-mini-latest"`

879 

880 - `"gpt-4o-mini"`

881 

882 - `"gpt-4o-mini-2024-07-18"`

883 

884 - `"gpt-4-turbo"`

885 

886 - `"gpt-4-turbo-2024-04-09"`

887 

888 - `"gpt-4-0125-preview"`

889 

890 - `"gpt-4-turbo-preview"`

891 

892 - `"gpt-4-1106-preview"`

893 

894 - `"gpt-4-vision-preview"`

895 

896 - `"gpt-4"`

897 

898 - `"gpt-4-0314"`

899 

900 - `"gpt-4-0613"`

901 

902 - `"gpt-4-32k"`

903 

904 - `"gpt-4-32k-0314"`

905 

906 - `"gpt-4-32k-0613"`

907 

908 - `"gpt-3.5-turbo"`

909 

910 - `"gpt-3.5-turbo-16k"`

911 

912 - `"gpt-3.5-turbo-0301"`

913 

914 - `"gpt-3.5-turbo-0613"`

915 

916 - `"gpt-3.5-turbo-1106"`

917 

918 - `"gpt-3.5-turbo-0125"`

919 

920 - `"gpt-3.5-turbo-16k-0613"`

921 

922 - `ResponsesOnlyModel: "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`

923 

924 - `"o1-pro"`

925 

926 - `"o1-pro-2025-03-19"`

927 

928 - `"o3-pro"`

929 

930 - `"o3-pro-2025-06-10"`

931 

932 - `"o3-deep-research"`

933 

934 - `"o3-deep-research-2025-06-26"`

935 

936 - `"o4-mini-deep-research"`

937 

938 - `"o4-mini-deep-research-2025-06-26"`

939 

940 - `"computer-use-preview"`

941 

942 - `"computer-use-preview-2025-03-11"`

943 

944 - `"gpt-5-codex"`

945 

946 - `"gpt-5-pro"`

947 

948 - `"gpt-5-pro-2025-10-06"`

949 

950 - `"gpt-5.1-codex-max"`

10 10 

11- `--name: string`11- `--name: string`

12 12 

13- `--expires-in-seconds: optional number`

14 

15 The number of seconds until the API key expires. Omit this field for a key that does not expire.

16 

13### Returns17### Returns

14 18 

15- `AdminOrganizationAdminAPIKeyNewResponse: AdminAPIKey`19- `AdminOrganizationAdminAPIKeyNewResponse: AdminAPIKey`

34{38{

35 "id": "key_abc",39 "id": "key_abc",

36 "created_at": 1711471533,40 "created_at": 1711471533,

41 "expires_at": 1714063533,

37 "object": "organization.admin_api_key",42 "object": "organization.admin_api_key",

38 "owner": {43 "owner": {

39 "id": "sa_456",44 "id": "sa_456",

1## List all organization and project API keys.

2 

3`$ openai admin:organization:admin-api-keys list`

4 

5**get** `/organization/admin_api_keys`

6 

7List organization API keys

8 

9### Parameters

10 

11- `--after: optional string`

12 

13 Return keys with IDs that come after this ID in the pagination order.

14 

15- `--limit: optional number`

16 

17 Maximum number of keys to return.

18 

19- `--order: optional "asc" or "desc"`

20 

21 Order results by creation time, ascending or descending.

22 

23### Returns

24 

25- `ApiKeyList: object { data, has_more, object, 2 more }`

26 

27 - `data: array of AdminAPIKey`

28 

29 - `id: string`

30 

31 The identifier, which can be referenced in API endpoints

32 

33 - `created_at: number`

34 

35 The Unix timestamp (in seconds) of when the API key was created

36 

37 - `expires_at: number`

38 

39 The Unix timestamp (in seconds) of when the API key expires

40 

41 - `object: "organization.admin_api_key"`

42 

43 The object type, which is always `organization.admin_api_key`

44 

45 - `owner: object { id, created_at, name, 3 more }`

46 

47 - `id: optional string`

48 

49 The identifier, which can be referenced in API endpoints

50 

51 - `created_at: optional number`

52 

53 The Unix timestamp (in seconds) of when the user was created

54 

55 - `name: optional string`

56 

57 The name of the user

58 

59 - `object: optional string`

60 

61 The object type, which is always organization.user

62 

63 - `role: optional string`

64 

65 Always `owner`

66 

67 - `type: optional string`

68 

69 Always `user`

70 

71 - `redacted_value: string`

72 

73 The redacted value of the API key

74 

75 - `last_used_at: optional number`

76 

77 The Unix timestamp (in seconds) of when the API key was last used

78 

79 - `name: optional string`

80 

81 The name of the API key

82 

83 - `has_more: boolean`

84 

85 - `object: "list"`

86 

87 - `first_id: optional string`

88 

89 - `last_id: optional string`

90 

91### Example

92 

93```cli

94openai admin:organization:admin-api-keys list \

95 --admin-api-key 'My Admin API Key'

96```

97 

98#### Response

99 

100```json

101{

102 "data": [

103 {

104 "id": "key_abc",

105 "created_at": 1711471533,

106 "expires_at": 1714063533,

107 "object": "organization.admin_api_key",

108 "owner": {

109 "id": "sa_456",

110 "created_at": 1711471533,

111 "name": "My Service Account",

112 "object": "organization.user",

113 "role": "owner",

114 "type": "user"

115 },

116 "redacted_value": "sk-admin...def",

117 "last_used_at": 1711471534,

118 "name": "Administration Key"

119 }

120 ],

121 "has_more": false,

122 "object": "list",

123 "first_id": "key_abc",

124 "last_id": "key_xyz"

125}

126```

1## Retrieve admin API key

2 

3`$ openai admin:organization:admin-api-keys retrieve`

4 

5**get** `/organization/admin_api_keys/{key_id}`

6 

7Retrieve a single organization API key

8 

9### Parameters

10 

11- `--key-id: string`

12 

13 The ID of the API key.

14 

15### Returns

16 

17- `admin_api_key: object { id, created_at, expires_at, 5 more }`

18 

19 Represents an individual Admin API key in an org.

20 

21 - `id: string`

22 

23 The identifier, which can be referenced in API endpoints

24 

25 - `created_at: number`

26 

27 The Unix timestamp (in seconds) of when the API key was created

28 

29 - `expires_at: number`

30 

31 The Unix timestamp (in seconds) of when the API key expires

32 

33 - `object: "organization.admin_api_key"`

34 

35 The object type, which is always `organization.admin_api_key`

36 

37 - `owner: object { id, created_at, name, 3 more }`

38 

39 - `id: optional string`

40 

41 The identifier, which can be referenced in API endpoints

42 

43 - `created_at: optional number`

44 

45 The Unix timestamp (in seconds) of when the user was created

46 

47 - `name: optional string`

48 

49 The name of the user

50 

51 - `object: optional string`

52 

53 The object type, which is always organization.user

54 

55 - `role: optional string`

56 

57 Always `owner`

58 

59 - `type: optional string`

60 

61 Always `user`

62 

63 - `redacted_value: string`

64 

65 The redacted value of the API key

66 

67 - `last_used_at: optional number`

68 

69 The Unix timestamp (in seconds) of when the API key was last used

70 

71 - `name: optional string`

72 

73 The name of the API key

74 

75### Example

76 

77```cli

78openai admin:organization:admin-api-keys retrieve \

79 --admin-api-key 'My Admin API Key' \

80 --key-id key_id

81```

82 

83#### Response

84 

85```json

86{

87 "id": "key_abc",

88 "created_at": 1711471533,

89 "expires_at": 1714063533,

90 "object": "organization.admin_api_key",

91 "owner": {

92 "id": "sa_456",

93 "created_at": 1711471533,

94 "name": "My Service Account",

95 "object": "organization.user",

96 "role": "owner",

97 "type": "user"

98 },

99 "redacted_value": "sk-admin...def",

100 "last_used_at": 1711471534,

101 "name": "Administration Key"

102}

103```

28 28 

29 Return only events whose `effective_at` (Unix seconds) is in this range.29 Return only events whose `effective_at` (Unix seconds) is in this range.

30 30 

31- `--event-type: optional array of "api_key.created" or "api_key.updated" or "api_key.deleted" or 54 more`31- `--event-type: optional array of "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`

32 32 

33 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).33 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).

34 34 

42 42 

43- `--resource-id: optional array of string`43- `--resource-id: optional array of string`

44 44 

45 Return only events performed on these targets. For example, a project ID updated.45 Return only events performed on these targets. For example, a project ID updated. For ChatGPT connector role events, use the workspace connector resource ID shown in `details.id`, such as `<workspace_id>__<connector_id>`.

46 

47- `--tenant-only: optional boolean`

48 

49 Return only tenant-scoped events associated with this organization. Required for tenant-scoped events such as `role.bound_to_resource` and `role.unbound_from_resource`. When `true`, all supplied event types must be tenant-scoped.

46 50 

47### Returns51### Returns

48 52 

49- `ListAuditLogsResponse: object { data, has_more, object, 2 more }`53- `ListAuditLogsResponse: object { data, has_more, object, 2 more }`

50 54 

51 - `data: array of object { id, effective_at, type, 55 more }`55 - `data: array of object { id, effective_at, type, 57 more }`

52 56 

53 - `id: string`57 - `id: string`

54 58 

58 62 

59 The Unix timestamp (in seconds) of the event.63 The Unix timestamp (in seconds) of the event.

60 64 

61 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 54 more`65 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`

62 66 

63 The event type.67 The event type.

64 68 

160 164 

161 - `"role.assignment.deleted"`165 - `"role.assignment.deleted"`

162 166 

167 - `"role.bound_to_resource"`

168 

169 - `"role.unbound_from_resource"`

170 

163 - `"scim.enabled"`171 - `"scim.enabled"`

164 172 

165 - `"scim.disabled"`173 - `"scim.disabled"`

780 788 

781 The type of resource the role assignment was scoped to.789 The type of resource the role assignment was scoped to.

782 790 

791 - `role.bound_to_resource: optional object { id, connector_id, connector_name, 7 more }`

792 

793 The details for events with this `type`.

794 

795 - `id: optional string`

796 

797 The ID of the resource the role was bound to. ChatGPT workspace connector resources use `<workspace_id>__<connector_id>`.

798 

799 - `connector_id: optional string`

800 

801 The connector ID for a ChatGPT workspace connector resource.

802 

803 - `connector_name: optional string`

804 

805 The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.

806 

807 - `enabled: optional boolean`

808 

809 Whether the connector is enabled for the role.

810 

811 - `permissions: optional array of string`

812 

813 The permissions granted to the role for the resource.

814 

815 - `resource_id: optional string`

816 

817 The ID of the resource the role was bound to.

818 

819 - `resource_type: optional string`

820 

821 The type of resource the role was bound to.

822 

823 - `role_id: optional string`

824 

825 The ID of the role that was bound to the resource.

826 

827 - `source: optional "role_toggle" or "role_connector_update" or "role_delete" or 2 more`

828 

829 The connector role mutation path that produced the event.

830 

831 - `"role_toggle"`

832 

833 - `"role_connector_update"`

834 

835 - `"role_delete"`

836 

837 - `"workspace_permissions"`

838 

839 - `"connector_publish"`

840 

841 - `workspace_id: optional string`

842 

843 The workspace ID for a ChatGPT workspace connector resource.

844 

783 - `role.created: optional object { id, permissions, resource_id, 2 more }`845 - `role.created: optional object { id, permissions, resource_id, 2 more }`

784 846 

785 The details for events with this `type`.847 The details for events with this `type`.

812 874 

813 The role ID.875 The role ID.

814 876 

877 - `role.unbound_from_resource: optional object { id, connector_id, connector_name, 7 more }`

878 

879 The details for events with this `type`.

880 

881 - `id: optional string`

882 

883 The ID of the resource the role was unbound from. ChatGPT workspace connector resources use `<workspace_id>__<connector_id>`.

884 

885 - `connector_id: optional string`

886 

887 The connector ID for a ChatGPT workspace connector resource.

888 

889 - `connector_name: optional string`

890 

891 The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.

892 

893 - `enabled: optional boolean`

894 

895 Whether the connector is enabled for the role.

896 

897 - `permissions: optional array of string`

898 

899 The permissions remaining for the role after the change.

900 

901 - `resource_id: optional string`

902 

903 The ID of the resource the role was unbound from.

904 

905 - `resource_type: optional string`

906 

907 The type of resource the role was unbound from.

908 

909 - `role_id: optional string`

910 

911 The ID of the role that was unbound from the resource.

912 

913 - `source: optional "role_toggle" or "role_connector_update" or "role_delete" or 2 more`

914 

915 The connector role mutation path that produced the event.

916 

917 - `"role_toggle"`

918 

919 - `"role_connector_update"`

920 

921 - `"role_delete"`

922 

923 - `"workspace_permissions"`

924 

925 - `"connector_publish"`

926 

927 - `workspace_id: optional string`

928 

929 The workspace ID for a ChatGPT workspace connector resource.

930 

815 - `role.updated: optional object { id, changes_requested }`931 - `role.updated: optional object { id, changes_requested }`

816 932 

817 The details for events with this `type`.933 The details for events with this `type`.

1283 "resource_id": "resource_id",1399 "resource_id": "resource_id",

1284 "resource_type": "resource_type"1400 "resource_type": "resource_type"

1285 },1401 },

1402 "role.bound_to_resource": {

1403 "id": "id",

1404 "connector_id": "connector_id",

1405 "connector_name": "connector_name",

1406 "enabled": true,

1407 "permissions": [

1408 "string"

1409 ],

1410 "resource_id": "resource_id",

1411 "resource_type": "resource_type",

1412 "role_id": "role_id",

1413 "source": "role_toggle",

1414 "workspace_id": "workspace_id"

1415 },

1286 "role.created": {1416 "role.created": {

1287 "id": "id",1417 "id": "id",

1288 "permissions": [1418 "permissions": [

1295 "role.deleted": {1425 "role.deleted": {

1296 "id": "id"1426 "id": "id"

1297 },1427 },

1428 "role.unbound_from_resource": {

1429 "id": "id",

1430 "connector_id": "connector_id",

1431 "connector_name": "connector_name",

1432 "enabled": true,

1433 "permissions": [

1434 "string"

1435 ],

1436 "resource_id": "resource_id",

1437 "resource_type": "resource_type",

1438 "role_id": "role_id",

1439 "source": "role_toggle",

1440 "workspace_id": "workspace_id"

1441 },

1298 "role.updated": {1442 "role.updated": {

1299 "id": "id",1443 "id": "id",

1300 "changes_requested": {1444 "changes_requested": {

1## Retrieve project spend alert

2 

3`$ openai admin:organization:projects:spend-alerts retrieve`

4 

5**get** `/organization/projects/{project_id}/spend_alerts/{alert_id}`

6 

7Retrieves a project spend alert.

8 

9### Parameters

10 

11- `--project-id: string`

12 

13 The ID of the project.

14 

15- `--alert-id: string`

16 

17 The ID of the spend alert to retrieve.

18 

19### Returns

20 

21- `project_spend_alert: object { id, currency, interval, 3 more }`

22 

23 Represents a spend alert configured at the project level.

24 

25 - `id: string`

26 

27 The identifier, which can be referenced in API endpoints.

28 

29 - `currency: "USD"`

30 

31 The currency for the threshold amount.

32 

33 - `"USD"`

34 

35 - `interval: "month"`

36 

37 The time interval for evaluating spend against the threshold.

38 

39 - `"month"`

40 

41 - `notification_channel: object { recipients, type, subject_prefix }`

42 

43 Email notification settings for a spend alert.

44 

45 - `recipients: array of string`

46 

47 Email addresses that receive the spend alert notification.

48 

49 - `type: "email"`

50 

51 The notification channel type. Currently only `email` is supported.

52 

53 - `subject_prefix: optional string`

54 

55 Optional subject prefix for alert emails.

56 

57 - `object: "project.spend_alert"`

58 

59 The object type, which is always `project.spend_alert`.

60 

61 - `threshold_amount: number`

62 

63 The alert threshold amount, in cents.

64 

65### Example

66 

67```cli

68openai admin:organization:projects:spend-alerts retrieve \

69 --admin-api-key 'My Admin API Key' \

70 --project-id project_id \

71 --alert-id alert_id

72```

73 

74#### Response

75 

76```json

77{

78 "id": "id",

79 "currency": "USD",

80 "interval": "month",

81 "notification_channel": {

82 "recipients": [

83 "string"

84 ],

85 "type": "email",

86 "subject_prefix": "subject_prefix"

87 },

88 "object": "project.spend_alert",

89 "threshold_amount": 0

90}

91```

1## Retrieve organization spend alert

2 

3`$ openai admin:organization:spend-alerts retrieve`

4 

5**get** `/organization/spend_alerts/{alert_id}`

6 

7Retrieves an organization spend alert.

8 

9### Parameters

10 

11- `--alert-id: string`

12 

13 The ID of the spend alert to retrieve.

14 

15### Returns

16 

17- `organization_spend_alert: object { id, currency, interval, 3 more }`

18 

19 Represents a spend alert configured at the organization level.

20 

21 - `id: string`

22 

23 The identifier, which can be referenced in API endpoints.

24 

25 - `currency: "USD"`

26 

27 The currency for the threshold amount.

28 

29 - `"USD"`

30 

31 - `interval: "month"`

32 

33 The time interval for evaluating spend against the threshold.

34 

35 - `"month"`

36 

37 - `notification_channel: object { recipients, type, subject_prefix }`

38 

39 Email notification settings for a spend alert.

40 

41 - `recipients: array of string`

42 

43 Email addresses that receive the spend alert notification.

44 

45 - `type: "email"`

46 

47 The notification channel type. Currently only `email` is supported.

48 

49 - `subject_prefix: optional string`

50 

51 Optional subject prefix for alert emails.

52 

53 - `object: "organization.spend_alert"`

54 

55 The object type, which is always `organization.spend_alert`.

56 

57 - `threshold_amount: number`

58 

59 The alert threshold amount, in cents.

60 

61### Example

62 

63```cli

64openai admin:organization:spend-alerts retrieve \

65 --admin-api-key 'My Admin API Key' \

66 --alert-id alert_id

67```

68 

69#### Response

70 

71```json

72{

73 "id": "id",

74 "currency": "USD",

75 "interval": "month",

76 "notification_channel": {

77 "recipients": [

78 "string"

79 ],

80 "type": "email",

81 "subject_prefix": "subject_prefix"

82 },

83 "object": "organization.spend_alert",

84 "threshold_amount": 0

85}

86```

4779 4779 

4780 - `"24h"`4780 - `"24h"`

4781 4781 

4782 - `reasoning: optional object { effort, generate_summary, summary }`4782 - `reasoning: optional object { context, effort, generate_summary, summary }`

4783 4783 

4784 **gpt-5 and o-series models only**4784 **gpt-5 and o-series models only**

4785 4785 

4786 Configuration options for4786 Configuration options for

4787 [reasoning models](https://platform.openai.com/docs/guides/reasoning).4787 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

4788 4788 

4789 - `context: optional "auto" or "current_turn" or "all_turns"`

4790 

4791 Controls which reasoning items are rendered back to the model on later turns.

4792 When returned on a response, this is the effective reasoning context mode

4793 used for the response.

4794 

4795 - `"auto"`

4796 

4797 - `"current_turn"`

4798 

4799 - `"all_turns"`

4800 

4789 - `effort: optional "none" or "minimal" or "low" or 3 more`4801 - `effort: optional "none" or "minimal" or "low" or 3 more`

4790 4802 

4791 Constrains effort on reasoning for4803 Constrains effort on reasoning for

5167 "prompt_cache_key": "prompt-cache-key-1234",5179 "prompt_cache_key": "prompt-cache-key-1234",

5168 "prompt_cache_retention": "in_memory",5180 "prompt_cache_retention": "in_memory",

5169 "reasoning": {5181 "reasoning": {

5182 "context": "auto",

5170 "effort": "none",5183 "effort": "none",

5171 "generate_summary": "auto",5184 "generate_summary": "auto",

5172 "summary": "auto"5185 "summary": "auto"

117 - Organizations without ZDR enabled default to `24h`.117 - Organizations without ZDR enabled default to `24h`.

118 - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.118 - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.

119 119 

120- `--reasoning: optional object { effort, generate_summary, summary }`120- `--reasoning: optional object { context, effort, generate_summary, summary }`

121 121 

122 **gpt-5 and o-series models only**122 **gpt-5 and o-series models only**

123 123 

4985 4985 

4986 - `"24h"`4986 - `"24h"`

4987 4987 

4988 - `reasoning: optional object { effort, generate_summary, summary }`4988 - `reasoning: optional object { context, effort, generate_summary, summary }`

4989 4989 

4990 **gpt-5 and o-series models only**4990 **gpt-5 and o-series models only**

4991 4991 

4992 Configuration options for4992 Configuration options for

4993 [reasoning models](https://platform.openai.com/docs/guides/reasoning).4993 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

4994 4994 

4995 - `context: optional "auto" or "current_turn" or "all_turns"`

4996 

4997 Controls which reasoning items are rendered back to the model on later turns.

4998 When returned on a response, this is the effective reasoning context mode

4999 used for the response.

5000 

5001 - `"auto"`

5002 

5003 - `"current_turn"`

5004 

5005 - `"all_turns"`

5006 

4995 - `effort: optional "none" or "minimal" or "low" or 3 more`5007 - `effort: optional "none" or "minimal" or "low" or 3 more`

4996 5008 

4997 Constrains effort on reasoning for5009 Constrains effort on reasoning for

5372 "prompt_cache_key": "prompt-cache-key-1234",5384 "prompt_cache_key": "prompt-cache-key-1234",

5373 "prompt_cache_retention": "in_memory",5385 "prompt_cache_retention": "in_memory",

5374 "reasoning": {5386 "reasoning": {

5387 "context": "auto",

5375 "effort": "none",5388 "effort": "none",

5376 "generate_summary": "auto",5389 "generate_summary": "auto",

5377 "summary": "auto"5390 "summary": "auto"

4796 4796 

4797 - `"24h"`4797 - `"24h"`

4798 4798 

4799 - `reasoning: optional object { effort, generate_summary, summary }`4799 - `reasoning: optional object { context, effort, generate_summary, summary }`

4800 4800 

4801 **gpt-5 and o-series models only**4801 **gpt-5 and o-series models only**

4802 4802 

4803 Configuration options for4803 Configuration options for

4804 [reasoning models](https://platform.openai.com/docs/guides/reasoning).4804 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

4805 4805 

4806 - `context: optional "auto" or "current_turn" or "all_turns"`

4807 

4808 Controls which reasoning items are rendered back to the model on later turns.

4809 When returned on a response, this is the effective reasoning context mode

4810 used for the response.

4811 

4812 - `"auto"`

4813 

4814 - `"current_turn"`

4815 

4816 - `"all_turns"`

4817 

4806 - `effort: optional "none" or "minimal" or "low" or 3 more`4818 - `effort: optional "none" or "minimal" or "low" or 3 more`

4807 4819 

4808 Constrains effort on reasoning for4820 Constrains effort on reasoning for

5184 "prompt_cache_key": "prompt-cache-key-1234",5196 "prompt_cache_key": "prompt-cache-key-1234",

5185 "prompt_cache_retention": "in_memory",5197 "prompt_cache_retention": "in_memory",

5186 "reasoning": {5198 "reasoning": {

5199 "context": "auto",

5187 "effort": "none",5200 "effort": "none",

5188 "generate_summary": "auto",5201 "generate_summary": "auto",

5189 "summary": "auto"5202 "summary": "auto"

40 40 

41 The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.41 The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.

42 42 

43- `--reasoning: optional object { effort, generate_summary, summary }`43- `--reasoning: optional object { context, effort, generate_summary, summary }`

44 44 

45 **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).45 **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).

46 46 

1# Shared

2 

3## Domain Types

4 

5### All Models

6 

7- `type AllModels interface{…}`

8 

9 - `string`

10 

11 - `type ChatModel string`

12 

13 - `const ChatModelGPT5_4 ChatModel = "gpt-5.4"`

14 

15 - `const ChatModelGPT5_4Mini ChatModel = "gpt-5.4-mini"`

16 

17 - `const ChatModelGPT5_4Nano ChatModel = "gpt-5.4-nano"`

18 

19 - `const ChatModelGPT5_4Mini2026_03_17 ChatModel = "gpt-5.4-mini-2026-03-17"`

20 

21 - `const ChatModelGPT5_4Nano2026_03_17 ChatModel = "gpt-5.4-nano-2026-03-17"`

22 

23 - `const ChatModelGPT5_3ChatLatest ChatModel = "gpt-5.3-chat-latest"`

24 

25 - `const ChatModelGPT5_2 ChatModel = "gpt-5.2"`

26 

27 - `const ChatModelGPT5_2_2025_12_11 ChatModel = "gpt-5.2-2025-12-11"`

28 

29 - `const ChatModelGPT5_2ChatLatest ChatModel = "gpt-5.2-chat-latest"`

30 

31 - `const ChatModelGPT5_2Pro ChatModel = "gpt-5.2-pro"`

32 

33 - `const ChatModelGPT5_2Pro2025_12_11 ChatModel = "gpt-5.2-pro-2025-12-11"`

34 

35 - `const ChatModelGPT5_1 ChatModel = "gpt-5.1"`

36 

37 - `const ChatModelGPT5_1_2025_11_13 ChatModel = "gpt-5.1-2025-11-13"`

38 

39 - `const ChatModelGPT5_1Codex ChatModel = "gpt-5.1-codex"`

40 

41 - `const ChatModelGPT5_1Mini ChatModel = "gpt-5.1-mini"`

42 

43 - `const ChatModelGPT5_1ChatLatest ChatModel = "gpt-5.1-chat-latest"`

44 

45 - `const ChatModelGPT5 ChatModel = "gpt-5"`

46 

47 - `const ChatModelGPT5Mini ChatModel = "gpt-5-mini"`

48 

49 - `const ChatModelGPT5Nano ChatModel = "gpt-5-nano"`

50 

51 - `const ChatModelGPT5_2025_08_07 ChatModel = "gpt-5-2025-08-07"`

52 

53 - `const ChatModelGPT5Mini2025_08_07 ChatModel = "gpt-5-mini-2025-08-07"`

54 

55 - `const ChatModelGPT5Nano2025_08_07 ChatModel = "gpt-5-nano-2025-08-07"`

56 

57 - `const ChatModelGPT5ChatLatest ChatModel = "gpt-5-chat-latest"`

58 

59 - `const ChatModelGPT4_1 ChatModel = "gpt-4.1"`

60 

61 - `const ChatModelGPT4_1Mini ChatModel = "gpt-4.1-mini"`

62 

63 - `const ChatModelGPT4_1Nano ChatModel = "gpt-4.1-nano"`

64 

65 - `const ChatModelGPT4_1_2025_04_14 ChatModel = "gpt-4.1-2025-04-14"`

66 

67 - `const ChatModelGPT4_1Mini2025_04_14 ChatModel = "gpt-4.1-mini-2025-04-14"`

68 

69 - `const ChatModelGPT4_1Nano2025_04_14 ChatModel = "gpt-4.1-nano-2025-04-14"`

70 

71 - `const ChatModelO4Mini ChatModel = "o4-mini"`

72 

73 - `const ChatModelO4Mini2025_04_16 ChatModel = "o4-mini-2025-04-16"`

74 

75 - `const ChatModelO3 ChatModel = "o3"`

76 

77 - `const ChatModelO3_2025_04_16 ChatModel = "o3-2025-04-16"`

78 

79 - `const ChatModelO3Mini ChatModel = "o3-mini"`

80 

81 - `const ChatModelO3Mini2025_01_31 ChatModel = "o3-mini-2025-01-31"`

82 

83 - `const ChatModelO1 ChatModel = "o1"`

84 

85 - `const ChatModelO1_2024_12_17 ChatModel = "o1-2024-12-17"`

86 

87 - `const ChatModelO1Preview ChatModel = "o1-preview"`

88 

89 - `const ChatModelO1Preview2024_09_12 ChatModel = "o1-preview-2024-09-12"`

90 

91 - `const ChatModelO1Mini ChatModel = "o1-mini"`

92 

93 - `const ChatModelO1Mini2024_09_12 ChatModel = "o1-mini-2024-09-12"`

94 

95 - `const ChatModelGPT4o ChatModel = "gpt-4o"`

96 

97 - `const ChatModelGPT4o2024_11_20 ChatModel = "gpt-4o-2024-11-20"`

98 

99 - `const ChatModelGPT4o2024_08_06 ChatModel = "gpt-4o-2024-08-06"`

100 

101 - `const ChatModelGPT4o2024_05_13 ChatModel = "gpt-4o-2024-05-13"`

102 

103 - `const ChatModelGPT4oAudioPreview ChatModel = "gpt-4o-audio-preview"`

104 

105 - `const ChatModelGPT4oAudioPreview2024_10_01 ChatModel = "gpt-4o-audio-preview-2024-10-01"`

106 

107 - `const ChatModelGPT4oAudioPreview2024_12_17 ChatModel = "gpt-4o-audio-preview-2024-12-17"`

108 

109 - `const ChatModelGPT4oAudioPreview2025_06_03 ChatModel = "gpt-4o-audio-preview-2025-06-03"`

110 

111 - `const ChatModelGPT4oMiniAudioPreview ChatModel = "gpt-4o-mini-audio-preview"`

112 

113 - `const ChatModelGPT4oMiniAudioPreview2024_12_17 ChatModel = "gpt-4o-mini-audio-preview-2024-12-17"`

114 

115 - `const ChatModelGPT4oSearchPreview ChatModel = "gpt-4o-search-preview"`

116 

117 - `const ChatModelGPT4oMiniSearchPreview ChatModel = "gpt-4o-mini-search-preview"`

118 

119 - `const ChatModelGPT4oSearchPreview2025_03_11 ChatModel = "gpt-4o-search-preview-2025-03-11"`

120 

121 - `const ChatModelGPT4oMiniSearchPreview2025_03_11 ChatModel = "gpt-4o-mini-search-preview-2025-03-11"`

122 

123 - `const ChatModelChatgpt4oLatest ChatModel = "chatgpt-4o-latest"`

124 

125 - `const ChatModelCodexMiniLatest ChatModel = "codex-mini-latest"`

126 

127 - `const ChatModelGPT4oMini ChatModel = "gpt-4o-mini"`

128 

129 - `const ChatModelGPT4oMini2024_07_18 ChatModel = "gpt-4o-mini-2024-07-18"`

130 

131 - `const ChatModelGPT4Turbo ChatModel = "gpt-4-turbo"`

132 

133 - `const ChatModelGPT4Turbo2024_04_09 ChatModel = "gpt-4-turbo-2024-04-09"`

134 

135 - `const ChatModelGPT4_0125Preview ChatModel = "gpt-4-0125-preview"`

136 

137 - `const ChatModelGPT4TurboPreview ChatModel = "gpt-4-turbo-preview"`

138 

139 - `const ChatModelGPT4_1106Preview ChatModel = "gpt-4-1106-preview"`

140 

141 - `const ChatModelGPT4VisionPreview ChatModel = "gpt-4-vision-preview"`

142 

143 - `const ChatModelGPT4 ChatModel = "gpt-4"`

144 

145 - `const ChatModelGPT4_0314 ChatModel = "gpt-4-0314"`

146 

147 - `const ChatModelGPT4_0613 ChatModel = "gpt-4-0613"`

148 

149 - `const ChatModelGPT4_32k ChatModel = "gpt-4-32k"`

150 

151 - `const ChatModelGPT4_32k0314 ChatModel = "gpt-4-32k-0314"`

152 

153 - `const ChatModelGPT4_32k0613 ChatModel = "gpt-4-32k-0613"`

154 

155 - `const ChatModelGPT3_5Turbo ChatModel = "gpt-3.5-turbo"`

156 

157 - `const ChatModelGPT3_5Turbo16k ChatModel = "gpt-3.5-turbo-16k"`

158 

159 - `const ChatModelGPT3_5Turbo0301 ChatModel = "gpt-3.5-turbo-0301"`

160 

161 - `const ChatModelGPT3_5Turbo0613 ChatModel = "gpt-3.5-turbo-0613"`

162 

163 - `const ChatModelGPT3_5Turbo1106 ChatModel = "gpt-3.5-turbo-1106"`

164 

165 - `const ChatModelGPT3_5Turbo0125 ChatModel = "gpt-3.5-turbo-0125"`

166 

167 - `const ChatModelGPT3_5Turbo16k0613 ChatModel = "gpt-3.5-turbo-16k-0613"`

168 

169 - `type AllModels string`

170 

171 - `const AllModelsO1Pro AllModels = "o1-pro"`

172 

173 - `const AllModelsO1Pro2025_03_19 AllModels = "o1-pro-2025-03-19"`

174