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"`

34 34 

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

36 36 

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

38 38 

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

40 40 

48 48 

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

50 50 

51 Return only events performed on these targets. For example, a project ID updated.51 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>`.

52 

53- `--tenant-only: optional boolean`

54 

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

52 56 

53### Returns57### Returns

54 58 

55- `ListAuditLogsResponse: object { data, has_more, object, 2 more }`59- `ListAuditLogsResponse: object { data, has_more, object, 2 more }`

56 60 

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

58 62 

59 - `id: string`63 - `id: string`

60 64 

64 68 

65 The Unix timestamp (in seconds) of the event.69 The Unix timestamp (in seconds) of the event.

66 70 

67 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 54 more`71 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`

68 72 

69 The event type.73 The event type.

70 74 

166 170 

167 - `"role.assignment.deleted"`171 - `"role.assignment.deleted"`

168 172 

173 - `"role.bound_to_resource"`

174 

175 - `"role.unbound_from_resource"`

176 

169 - `"scim.enabled"`177 - `"scim.enabled"`

170 178 

171 - `"scim.disabled"`179 - `"scim.disabled"`

786 794 

787 The type of resource the role assignment was scoped to.795 The type of resource the role assignment was scoped to.

788 796 

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

798 

799 The details for events with this `type`.

800 

801 - `id: optional string`

802 

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

804 

805 - `connector_id: optional string`

806 

807 The connector ID for a ChatGPT workspace connector resource.

808 

809 - `connector_name: optional string`

810 

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

812 

813 - `enabled: optional boolean`

814 

815 Whether the connector is enabled for the role.

816 

817 - `permissions: optional array of string`

818 

819 The permissions granted to the role for the resource.

820 

821 - `resource_id: optional string`

822 

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

824 

825 - `resource_type: optional string`

826 

827 The type of resource the role was bound to.

828 

829 - `role_id: optional string`

830 

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

832 

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

834 

835 The connector role mutation path that produced the event.

836 

837 - `"role_toggle"`

838 

839 - `"role_connector_update"`

840 

841 - `"role_delete"`

842 

843 - `"workspace_permissions"`

844 

845 - `"connector_publish"`

846 

847 - `workspace_id: optional string`

848 

849 The workspace ID for a ChatGPT workspace connector resource.

850 

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

790 852 

791 The details for events with this `type`.853 The details for events with this `type`.

818 880 

819 The role ID.881 The role ID.

820 882 

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

884 

885 The details for events with this `type`.

886 

887 - `id: optional string`

888 

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

890 

891 - `connector_id: optional string`

892 

893 The connector ID for a ChatGPT workspace connector resource.

894 

895 - `connector_name: optional string`

896 

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

898 

899 - `enabled: optional boolean`

900 

901 Whether the connector is enabled for the role.

902 

903 - `permissions: optional array of string`

904 

905 The permissions remaining for the role after the change.

906 

907 - `resource_id: optional string`

908 

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

910 

911 - `resource_type: optional string`

912 

913 The type of resource the role was unbound from.

914 

915 - `role_id: optional string`

916 

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

918 

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

920 

921 The connector role mutation path that produced the event.

922 

923 - `"role_toggle"`

924 

925 - `"role_connector_update"`

926 

927 - `"role_delete"`

928 

929 - `"workspace_permissions"`

930 

931 - `"connector_publish"`

932 

933 - `workspace_id: optional string`

934 

935 The workspace ID for a ChatGPT workspace connector resource.

936 

821 - `role.updated: optional object { id, changes_requested }`937 - `role.updated: optional object { id, changes_requested }`

822 938 

823 The details for events with this `type`.939 The details for events with this `type`.

1289 "resource_id": "resource_id",1405 "resource_id": "resource_id",

1290 "resource_type": "resource_type"1406 "resource_type": "resource_type"

1291 },1407 },

1408 "role.bound_to_resource": {

1409 "id": "id",

1410 "connector_id": "connector_id",

1411 "connector_name": "connector_name",

1412 "enabled": true,

1413 "permissions": [

1414 "string"

1415 ],

1416 "resource_id": "resource_id",

1417 "resource_type": "resource_type",

1418 "role_id": "role_id",

1419 "source": "role_toggle",

1420 "workspace_id": "workspace_id"

1421 },

1292 "role.created": {1422 "role.created": {

1293 "id": "id",1423 "id": "id",

1294 "permissions": [1424 "permissions": [

1301 "role.deleted": {1431 "role.deleted": {

1302 "id": "id"1432 "id": "id"

1303 },1433 },

1434 "role.unbound_from_resource": {

1435 "id": "id",

1436 "connector_id": "connector_id",

1437 "connector_name": "connector_name",

1438 "enabled": true,

1439 "permissions": [

1440 "string"

1441 ],

1442 "resource_id": "resource_id",

1443 "resource_type": "resource_type",

1444 "role_id": "role_id",

1445 "source": "role_toggle",

1446 "workspace_id": "workspace_id"

1447 },

1304 "role.updated": {1448 "role.updated": {

1305 "id": "id",1449 "id": "id",

1306 "changes_requested": {1450 "changes_requested": {

1428 1572 

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

1430 1574 

1575 - `expires_at: number`

1576 

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

1578 

1431 - `object: "organization.admin_api_key"`1579 - `object: "organization.admin_api_key"`

1432 1580 

1433 The object type, which is always `organization.admin_api_key`1581 The object type, which is always `organization.admin_api_key`

1493 {1641 {

1494 "id": "key_abc",1642 "id": "key_abc",

1495 "created_at": 1711471533,1643 "created_at": 1711471533,

1644 "expires_at": 1714063533,

1496 "object": "organization.admin_api_key",1645 "object": "organization.admin_api_key",

1497 "owner": {1646 "owner": {

1498 "id": "sa_456",1647 "id": "sa_456",

1526 1675 

1527- `--name: string`1676- `--name: string`

1528 1677 

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

1679 

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

1681 

1529### Returns1682### Returns

1530 1683 

1531- `AdminOrganizationAdminAPIKeyNewResponse: AdminAPIKey`1684- `AdminOrganizationAdminAPIKeyNewResponse: AdminAPIKey`

1550{1703{

1551 "id": "key_abc",1704 "id": "key_abc",

1552 "created_at": 1711471533,1705 "created_at": 1711471533,

1706 "expires_at": 1714063533,

1553 "object": "organization.admin_api_key",1707 "object": "organization.admin_api_key",

1554 "owner": {1708 "owner": {

1555 "id": "sa_456",1709 "id": "sa_456",

1582 1736 

1583### Returns1737### Returns

1584 1738 

1585- `admin_api_key: object { id, created_at, object, 4 more }`1739- `admin_api_key: object { id, created_at, expires_at, 5 more }`

1586 1740 

1587 Represents an individual Admin API key in an org.1741 Represents an individual Admin API key in an org.

1588 1742 

1594 1748 

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

1596 1750 

1751 - `expires_at: number`

1752 

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

1754 

1597 - `object: "organization.admin_api_key"`1755 - `object: "organization.admin_api_key"`

1598 1756 

1599 The object type, which is always `organization.admin_api_key`1757 The object type, which is always `organization.admin_api_key`

1650{1808{

1651 "id": "key_abc",1809 "id": "key_abc",

1652 "created_at": 1711471533,1810 "created_at": 1711471533,

1811 "expires_at": 1714063533,

1653 "object": "organization.admin_api_key",1812 "object": "organization.admin_api_key",

1654 "owner": {1813 "owner": {

1655 "id": "sa_456",1814 "id": "sa_456",

1711 1870 

1712### Admin API Key1871### Admin API Key

1713 1872 

1714- `admin_api_key: object { id, created_at, object, 4 more }`1873- `admin_api_key: object { id, created_at, expires_at, 5 more }`

1715 1874 

1716 Represents an individual Admin API key in an org.1875 Represents an individual Admin API key in an org.

1717 1876 

1723 1882 

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

1725 1884 

1885 - `expires_at: number`

1886 

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

1888 

1726 - `object: "organization.admin_api_key"`1889 - `object: "organization.admin_api_key"`

1727 1890 

1728 The object type, which is always `organization.admin_api_key`1891 The object type, which is always `organization.admin_api_key`

10219}10382}

10220```10383```

10221 10384 

10385## Retrieve organization spend alert

10386 

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

10388 

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

10390 

10391Retrieves an organization spend alert.

10392 

10393### Parameters

10394 

10395- `--alert-id: string`

10396 

10397 The ID of the spend alert to retrieve.

10398 

10399### Returns

10400 

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

10402 

10403 Represents a spend alert configured at the organization level.

10404 

10405 - `id: string`

10406 

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

10408 

10409 - `currency: "USD"`

10410 

10411 The currency for the threshold amount.

10412 

10413 - `"USD"`

10414 

10415 - `interval: "month"`

10416 

10417 The time interval for evaluating spend against the threshold.

10418 

10419 - `"month"`

10420 

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

10422 

10423 Email notification settings for a spend alert.

10424 

10425 - `recipients: array of string`

10426 

10427 Email addresses that receive the spend alert notification.

10428 

10429 - `type: "email"`

10430 

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

10432 

10433 - `subject_prefix: optional string`

10434 

10435 Optional subject prefix for alert emails.

10436 

10437 - `object: "organization.spend_alert"`

10438 

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

10440 

10441 - `threshold_amount: number`

10442 

10443 The alert threshold amount, in cents.

10444 

10445### Example

10446 

10447```cli

10448openai admin:organization:spend-alerts retrieve \

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

10450 --alert-id alert_id

10451```

10452 

10453#### Response

10454 

10455```json

10456{

10457 "id": "id",

10458 "currency": "USD",

10459 "interval": "month",

10460 "notification_channel": {

10461 "recipients": [

10462 "string"

10463 ],

10464 "type": "email",

10465 "subject_prefix": "subject_prefix"

10466 },

10467 "object": "organization.spend_alert",

10468 "threshold_amount": 0

10469}

10470```

10471 

10222## Update organization spend alert10472## Update organization spend alert

10223 10473 

10224`$ openai admin:organization:spend-alerts update`10474`$ openai admin:organization:spend-alerts update`

15619}15869}

15620```15870```

15621 15871 

15872## Retrieve project spend alert

15873 

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

15875 

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

15877 

15878Retrieves a project spend alert.

15879 

15880### Parameters

15881 

15882- `--project-id: string`

15883 

15884 The ID of the project.

15885 

15886- `--alert-id: string`

15887 

15888 The ID of the spend alert to retrieve.

15889 

15890### Returns

15891 

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

15893 

15894 Represents a spend alert configured at the project level.

15895 

15896 - `id: string`

15897 

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

15899 

15900 - `currency: "USD"`

15901 

15902 The currency for the threshold amount.

15903 

15904 - `"USD"`

15905 

15906 - `interval: "month"`

15907 

15908 The time interval for evaluating spend against the threshold.

15909 

15910 - `"month"`

15911 

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

15913 

15914 Email notification settings for a spend alert.

15915 

15916 - `recipients: array of string`

15917 

15918 Email addresses that receive the spend alert notification.

15919 

15920 - `type: "email"`

15921 

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

15923 

15924 - `subject_prefix: optional string`

15925 

15926 Optional subject prefix for alert emails.

15927 

15928 - `object: "project.spend_alert"`

15929 

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

15931 

15932 - `threshold_amount: number`

15933 

15934 The alert threshold amount, in cents.

15935 

15936### Example

15937 

15938```cli

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

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

15941 --project-id project_id \

15942 --alert-id alert_id

15943```

15944 

15945#### Response

15946 

15947```json

15948{

15949 "id": "id",

15950 "currency": "USD",

15951 "interval": "month",

15952 "notification_channel": {

15953 "recipients": [

15954 "string"

15955 ],

15956 "type": "email",

15957 "subject_prefix": "subject_prefix"

15958 },

15959 "object": "project.spend_alert",

15960 "threshold_amount": 0

15961}

15962```

15963 

15622## Update project spend alert15964## Update project spend alert

15623 15965 

15624`$ openai admin:organization:projects:spend-alerts update`15966`$ openai admin:organization:projects:spend-alerts update`

32 32 

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

34 34 

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

36 36 

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

38 38 

46 46 

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

48 48 

49 Return only events performed on these targets. For example, a project ID updated.49 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>`.

50 

51- `--tenant-only: optional boolean`

52 

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

50 54 

51### Returns55### Returns

52 56 

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

54 58 

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

56 60 

57 - `id: string`61 - `id: string`

58 62 

62 66 

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

64 68 

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

66 70 

67 The event type.71 The event type.

68 72 

164 168 

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

166 170 

171 - `"role.bound_to_resource"`

172 

173 - `"role.unbound_from_resource"`

174 

167 - `"scim.enabled"`175 - `"scim.enabled"`

168 176 

169 - `"scim.disabled"`177 - `"scim.disabled"`

784 792 

785 The type of resource the role assignment was scoped to.793 The type of resource the role assignment was scoped to.

786 794 

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

796 

797 The details for events with this `type`.

798 

799 - `id: optional string`

800 

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

802 

803 - `connector_id: optional string`

804 

805 The connector ID for a ChatGPT workspace connector resource.

806 

807 - `connector_name: optional string`

808 

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

810 

811 - `enabled: optional boolean`

812 

813 Whether the connector is enabled for the role.

814 

815 - `permissions: optional array of string`

816 

817 The permissions granted to the role for the resource.

818 

819 - `resource_id: optional string`

820 

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

822 

823 - `resource_type: optional string`

824 

825 The type of resource the role was bound to.

826 

827 - `role_id: optional string`

828 

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

830 

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

832 

833 The connector role mutation path that produced the event.

834 

835 - `"role_toggle"`

836 

837 - `"role_connector_update"`

838 

839 - `"role_delete"`

840 

841 - `"workspace_permissions"`

842 

843 - `"connector_publish"`

844 

845 - `workspace_id: optional string`

846 

847 The workspace ID for a ChatGPT workspace connector resource.

848 

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

788 850 

789 The details for events with this `type`.851 The details for events with this `type`.

816 878 

817 The role ID.879 The role ID.

818 880 

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

882 

883 The details for events with this `type`.

884 

885 - `id: optional string`

886 

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

888 

889 - `connector_id: optional string`

890 

891 The connector ID for a ChatGPT workspace connector resource.

892 

893 - `connector_name: optional string`

894 

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

896 

897 - `enabled: optional boolean`

898 

899 Whether the connector is enabled for the role.

900 

901 - `permissions: optional array of string`

902 

903 The permissions remaining for the role after the change.

904 

905 - `resource_id: optional string`

906 

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

908 

909 - `resource_type: optional string`

910 

911 The type of resource the role was unbound from.

912 

913 - `role_id: optional string`

914 

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

916 

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

918 

919 The connector role mutation path that produced the event.

920 

921 - `"role_toggle"`

922 

923 - `"role_connector_update"`

924 

925 - `"role_delete"`

926 

927 - `"workspace_permissions"`

928 

929 - `"connector_publish"`

930 

931 - `workspace_id: optional string`

932 

933 The workspace ID for a ChatGPT workspace connector resource.

934 

819 - `role.updated: optional object { id, changes_requested }`935 - `role.updated: optional object { id, changes_requested }`

820 936 

821 The details for events with this `type`.937 The details for events with this `type`.

1287 "resource_id": "resource_id",1403 "resource_id": "resource_id",

1288 "resource_type": "resource_type"1404 "resource_type": "resource_type"

1289 },1405 },

1406 "role.bound_to_resource": {

1407 "id": "id",

1408 "connector_id": "connector_id",

1409 "connector_name": "connector_name",

1410 "enabled": true,

1411 "permissions": [

1412 "string"

1413 ],

1414 "resource_id": "resource_id",

1415 "resource_type": "resource_type",

1416 "role_id": "role_id",

1417 "source": "role_toggle",

1418 "workspace_id": "workspace_id"

1419 },

1290 "role.created": {1420 "role.created": {

1291 "id": "id",1421 "id": "id",

1292 "permissions": [1422 "permissions": [

1299 "role.deleted": {1429 "role.deleted": {

1300 "id": "id"1430 "id": "id"

1301 },1431 },

1432 "role.unbound_from_resource": {

1433 "id": "id",

1434 "connector_id": "connector_id",

1435 "connector_name": "connector_name",

1436 "enabled": true,

1437 "permissions": [

1438 "string"

1439 ],

1440 "resource_id": "resource_id",

1441 "resource_type": "resource_type",

1442 "role_id": "role_id",

1443 "source": "role_toggle",

1444 "workspace_id": "workspace_id"

1445 },

1302 "role.updated": {1446 "role.updated": {

1303 "id": "id",1447 "id": "id",

1304 "changes_requested": {1448 "changes_requested": {

1426 1570 

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

1428 1572 

1573 - `expires_at: number`

1574 

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

1576 

1429 - `object: "organization.admin_api_key"`1577 - `object: "organization.admin_api_key"`

1430 1578 

1431 The object type, which is always `organization.admin_api_key`1579 The object type, which is always `organization.admin_api_key`

1491 {1639 {

1492 "id": "key_abc",1640 "id": "key_abc",

1493 "created_at": 1711471533,1641 "created_at": 1711471533,

1642 "expires_at": 1714063533,

1494 "object": "organization.admin_api_key",1643 "object": "organization.admin_api_key",

1495 "owner": {1644 "owner": {

1496 "id": "sa_456",1645 "id": "sa_456",

1524 1673 

1525- `--name: string`1674- `--name: string`

1526 1675 

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

1677 

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

1679 

1527### Returns1680### Returns

1528 1681 

1529- `AdminOrganizationAdminAPIKeyNewResponse: AdminAPIKey`1682- `AdminOrganizationAdminAPIKeyNewResponse: AdminAPIKey`

1548{1701{

1549 "id": "key_abc",1702 "id": "key_abc",

1550 "created_at": 1711471533,1703 "created_at": 1711471533,

1704 "expires_at": 1714063533,

1551 "object": "organization.admin_api_key",1705 "object": "organization.admin_api_key",

1552 "owner": {1706 "owner": {

1553 "id": "sa_456",1707 "id": "sa_456",

1580 1734 

1581### Returns1735### Returns

1582 1736 

1583- `admin_api_key: object { id, created_at, object, 4 more }`1737- `admin_api_key: object { id, created_at, expires_at, 5 more }`

1584 1738 

1585 Represents an individual Admin API key in an org.1739 Represents an individual Admin API key in an org.

1586 1740 

1592 1746 

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

1594 1748 

1749 - `expires_at: number`

1750 

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

1752 

1595 - `object: "organization.admin_api_key"`1753 - `object: "organization.admin_api_key"`

1596 1754 

1597 The object type, which is always `organization.admin_api_key`1755 The object type, which is always `organization.admin_api_key`

1648{1806{

1649 "id": "key_abc",1807 "id": "key_abc",

1650 "created_at": 1711471533,1808 "created_at": 1711471533,

1809 "expires_at": 1714063533,

1651 "object": "organization.admin_api_key",1810 "object": "organization.admin_api_key",

1652 "owner": {1811 "owner": {

1653 "id": "sa_456",1812 "id": "sa_456",

1709 1868 

1710### Admin API Key1869### Admin API Key

1711 1870 

1712- `admin_api_key: object { id, created_at, object, 4 more }`1871- `admin_api_key: object { id, created_at, expires_at, 5 more }`

1713 1872 

1714 Represents an individual Admin API key in an org.1873 Represents an individual Admin API key in an org.

1715 1874 

1721 1880 

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

1723 1882 

1883 - `expires_at: number`

1884 

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

1886 

1724 - `object: "organization.admin_api_key"`1887 - `object: "organization.admin_api_key"`

1725 1888 

1726 The object type, which is always `organization.admin_api_key`1889 The object type, which is always `organization.admin_api_key`

10217}10380}

10218```10381```

10219 10382 

10383## Retrieve organization spend alert

10384 

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

10386 

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

10388 

10389Retrieves an organization spend alert.

10390 

10391### Parameters

10392 

10393- `--alert-id: string`

10394 

10395 The ID of the spend alert to retrieve.

10396 

10397### Returns

10398 

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

10400 

10401 Represents a spend alert configured at the organization level.

10402 

10403 - `id: string`

10404 

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

10406 

10407 - `currency: "USD"`

10408 

10409 The currency for the threshold amount.

10410 

10411 - `"USD"`

10412 

10413 - `interval: "month"`

10414 

10415 The time interval for evaluating spend against the threshold.

10416 

10417 - `"month"`

10418 

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

10420 

10421 Email notification settings for a spend alert.

10422 

10423 - `recipients: array of string`

10424 

10425 Email addresses that receive the spend alert notification.

10426 

10427 - `type: "email"`

10428 

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

10430 

10431 - `subject_prefix: optional string`

10432 

10433 Optional subject prefix for alert emails.

10434 

10435 - `object: "organization.spend_alert"`

10436 

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

10438 

10439 - `threshold_amount: number`

10440 

10441 The alert threshold amount, in cents.

10442 

10443### Example

10444 

10445```cli

10446openai admin:organization:spend-alerts retrieve \

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

10448 --alert-id alert_id

10449```

10450 

10451#### Response

10452 

10453```json

10454{

10455 "id": "id",

10456 "currency": "USD",

10457 "interval": "month",

10458 "notification_channel": {

10459 "recipients": [

10460 "string"

10461 ],

10462 "type": "email",

10463 "subject_prefix": "subject_prefix"

10464 },

10465 "object": "organization.spend_alert",

10466 "threshold_amount": 0

10467}

10468```

10469 

10220## Update organization spend alert10470## Update organization spend alert

10221 10471 

10222`$ openai admin:organization:spend-alerts update`10472`$ openai admin:organization:spend-alerts update`

15617}15867}

15618```15868```

15619 15869 

15870## Retrieve project spend alert

15871