Reference 2026-09-02 01:58 UTC to 2026-09-03 23:00 UTC

4 4 

5### All Models5### All Models

6 6 

7- `AllModels = string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`7- `AllModels = string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

8 8 

9 - `string`9 - `string`

10 10 

11 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`11 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`

12 

13 - `"gpt-6-astra"`

12 14 

13 - `"gpt-5.6-sol"`15 - `"gpt-5.6-sol"`

14 16 

384 386 

385### Error Object387### Error Object

386 388 

387- `ErrorObject object { code, message, param, type }`389- `ErrorObject object { code, message, param, 2 more }`

388 390 

389 - `code: string or null`391 - `code: string or null`

390 392 

394 396 

395 - `type: string`397 - `type: string`

396 398 

399 - `misalignment: optional object { detailed_explanation, error_type, steer }`

400 

401 - `detailed_explanation: optional string`

402 

403 The public explanation for this block.

404 

405 - `error_type: optional string or "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other"`

406 

407 An optional classification; clients must accept additional values.

408 

409 - `string`

410 

411 - `SafetyAlertErrorType = "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other"`

412 

413 An optional classification; clients must accept additional values.

414 

415 - `"potentially_unintended_data_transfer"`

416 

417 - `"potentially_unintended_data_access"`

418 

419 - `"potentially_unintended_destructive_activity"`

420 

421 - `"other"`

422 

423 - `steer: optional object { message }`

424 

425 An optional public continuation instruction.

426 

427 - `message: string`

428 

429 The public continuation instruction.

430 

397### Function Definition431### Function Definition

398 432 

399- `FunctionDefinition object { name, description, parameters, strict }`433- `FunctionDefinition object { name, description, parameters, strict }`

653 687 

654### Responses Model688### Responses Model

655 689 

656- `ResponsesModel = string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`690- `ResponsesModel = string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

657 691 

658 - `string`692 - `string`

659 693 

660 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more`694 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`

695 

696 - `"gpt-6-astra"`

661 697 

662 - `"gpt-5.6-sol"`698 - `"gpt-5.6-sol"`

663 699 

66 "object": "project.model_permissions",66 "object": "project.model_permissions",

67 "mode": "allow_list",67 "mode": "allow_list",

68 "model_ids": [68 "model_ids": [

69 "gpt-5.6-sol",69 "gpt-6-astra",

70 "o3"70 "o3"

71 ]71 ]

72}72}

40 40 

41- `line_items: optional array of string`41- `line_items: optional array of string`

42 42 

43 Return only costs for these exact line item names. Each value must match the complete `line_item` value, for example `gpt-5.6-sol, input_tokens`.43 Return only costs for these exact line item names. Each value must match the complete `line_item` value, for example `gpt-6-astra, input_tokens`.

44 44 

45- `page: optional string`45- `page: optional string`

46 46 

127 127 

128 - `model: optional string`128 - `model: optional string`

129 129 

130 Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI130 Model ID used to process the batch, like `gpt-6-astra`. OpenAI

131 offers a wide range of models with different capabilities, performance131 offers a wide range of models with different capabilities, performance

132 characteristics, and price points. Refer to the [model132 characteristics, and price points. Refer to the [model

133 guide](/docs/models) to browse and compare available models.133 guide](/docs/models) to browse and compare available models.

182 182 

183 - `model: optional string`183 - `model: optional string`

184 184 

185 Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI185 Model ID used to process the batch, like `gpt-6-astra`. OpenAI

186 offers a wide range of models with different capabilities, performance186 offers a wide range of models with different capabilities, performance

187 characteristics, and price points. Refer to the [model187 characteristics, and price points. Refer to the [model

188 guide](/docs/models) to browse and compare available models.188 guide](/docs/models) to browse and compare available models.

133 133 

134 - `model: optional string`134 - `model: optional string`

135 135 

136 Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI136 Model ID used to process the batch, like `gpt-6-astra`. OpenAI

137 offers a wide range of models with different capabilities, performance137 offers a wide range of models with different capabilities, performance

138 characteristics, and price points. Refer to the [model138 characteristics, and price points. Refer to the [model

139 guide](/docs/models) to browse and compare available models.139 guide](/docs/models) to browse and compare available models.

127 127 

128 - `model: optional string`128 - `model: optional string`

129 129 

130 Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI130 Model ID used to process the batch, like `gpt-6-astra`. OpenAI

131 offers a wide range of models with different capabilities, performance131 offers a wide range of models with different capabilities, performance

132 characteristics, and price points. Refer to the [model132 characteristics, and price points. Refer to the [model

133 guide](/docs/models) to browse and compare available models.133 guide](/docs/models) to browse and compare available models.

18 18 

19### Returns19### Returns

20 20 

21- `BetaResponse object { id, created_at, error, 32 more }`21- `BetaResponse object { id, created_at, error, 33 more }`

22 22 

23 - `id: string`23 - `id: string`

24 24 

32 32 

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

34 34 

35 - `code: "server_error" or "rate_limit_exceeded" or "invalid_prompt" or 17 more`35 - `code: "server_error" or "rate_limit_exceeded" or "invalid_prompt" or 18 more`

36 36 

37 The error code for the response.37 The error code for the response.

38 38 

46 46 

47 - `"bio_policy"`47 - `"bio_policy"`

48 48 

49 - `"misalignment_policy_violation"`

50 

49 - `"vector_store_timeout"`51 - `"vector_store_timeout"`

50 52 

51 - `"invalid_image"`53 - `"invalid_image"`

80 82 

81 A human-readable description of the error.83 A human-readable description of the error.

82 84 

85 - `misalignment: optional object { detailed_explanation, error_type, steer }`

86 

87 - `detailed_explanation: optional string`

88 

89 The public explanation for this block.

90 

91 - `error_type: optional string or "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other"`

92 

93 An optional classification; clients must accept additional values.

94 

95 - `string`

96 

97 - `SafetyAlertErrorType = "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other"`

98 

99 An optional classification; clients must accept additional values.

100 

101 - `"potentially_unintended_data_transfer"`

102 

103 - `"potentially_unintended_data_access"`

104 

105 - `"potentially_unintended_destructive_activity"`

106 

107 - `"other"`

108 

109 - `steer: optional object { message }`

110 

111 An optional public continuation instruction.

112 

113 - `message: string`

114 

115 The public continuation instruction.

116 

83 - `incomplete_details: object { reason } or null`117 - `incomplete_details: object { reason } or null`

84 118 

85 Details about why the response is incomplete.119 Details about why the response is incomplete.

86 120 

87 - `reason: optional "max_output_tokens" or "max_messages" or "content_filter"`121 - `reason: optional "max_output_tokens" or "max_messages" or "content_filter" or "steered"`

88 122 

89 The reason why the response is incomplete.123 The reason why the response is incomplete. `steered` means

124 the response stopped at a safe output boundary after a

125 WebSocket `response.steer` event. The server can then create

126 a successor response automatically with the queued input.

90 127 

91 - `"max_output_tokens"`128 - `"max_output_tokens"`

92 129 

94 131 

95 - `"content_filter"`132 - `"content_filter"`

96 133 

97 - `instructions: string or array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 32 more or null`134 - `"steered"`

135 

136 - `instructions: string or array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 33 more or null`

98 137 

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

100 139 

107 A text input to the model, equivalent to a text input with the146 A text input to the model, equivalent to a text input with the

108 `developer` role.147 `developer` role.

109 148 

110 - `InputItemList = array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 32 more`149 - `InputItemList = array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 33 more`

111 150 

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

113 different content types.152 different content types.

1057 1096 

1058 The canonical name of the agent that produced this item.1097 The canonical name of the agent that produced this item.

1059 1098 

1060 - `FunctionCall object { arguments, call_id, name, 6 more }`1099 - `FunctionCall object { arguments, call_id, name, 7 more }`

1061 1100 

1062 A tool call to run a function. See the1101 A tool call to run a function. See the

1063 [function calling guide](/docs/guides/function-calling) for more information.1102 [function calling guide](/docs/guides/function-calling) for more information.

1092 1131 

1093 The canonical name of the agent that produced this item.1132 The canonical name of the agent that produced this item.

1094 1133 

1134 - `async: optional boolean`

1135 

1136 Whether the function tool call runs asynchronously.

1137 

1095 - `caller: optional object { type } or object { caller_id, type } or null`1138 - `caller: optional object { type } or object { caller_id, type } or null`

1096 1139 

1097 The execution context that produced this tool call.1140 The execution context that produced this tool call.

1587 1630 

1588 - `ToolSearchOutput object { tools, type, id, 4 more }`1631 - `ToolSearchOutput object { tools, type, id, 4 more }`

1589 1632 

1590 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`1633 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

1591 1634 

1592 The loaded tool definitions returned by the tool search output.1635 The loaded tool definitions returned by the tool search output.

1593 1636 

1594 - `Function object { name, parameters, strict, 5 more }`1637 - `Function object { name, parameters, strict, 6 more }`

1595 1638 

1596 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).1639 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

1597 1640 

1621 1664 

1622 - `"programmatic"`1665 - `"programmatic"`

1623 1666 

1667 - `async: optional boolean`

1668 

1624 - `defer_loading: optional boolean`1669 - `defer_loading: optional boolean`

1625 1670 

1626 Whether this function is deferred and loaded via tool search.1671 Whether this function is deferred and loaded via tool search.

2463 2508 

2464 - `"container_reference"`2509 - `"container_reference"`

2465 2510 

2466 - `Custom object { name, type, allowed_callers, 3 more }`2511 - `Custom object { name, type, allowed_callers, 4 more }`

2467 2512 

2468 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)2513 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

2469 2514 

2485 2530 

2486 - `"programmatic"`2531 - `"programmatic"`

2487 2532 

2533 - `async: optional boolean`

2534 

2535 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

2536 

2488 - `defer_loading: optional boolean`2537 - `defer_loading: optional boolean`

2489 2538 

2490 Whether this tool should be deferred and discovered via tool search.2539 Whether this tool should be deferred and discovered via tool search.

2541 2590 

2542 The namespace name used in tool calls (for example, `crm`).2591 The namespace name used in tool calls (for example, `crm`).

2543 2592 

2544 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`2593 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

2545 2594 

2546 The function/custom tools available inside this namespace.2595 The function/custom tools available inside this namespace.

2547 2596 

2548 - `Function object { name, type, allowed_callers, 5 more }`2597 - `Function object { name, type, allowed_callers, 6 more }`

2549 2598 

2550 - `name: string`2599 - `name: string`

2551 2600 

2561 2610 

2562 - `"programmatic"`2611 - `"programmatic"`

2563 2612 

2613 - `async: optional boolean`

2614 

2615 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

2616 

2564 - `defer_loading: optional boolean`2617 - `defer_loading: optional boolean`

2565 2618 

2566 Whether this function should be deferred and discovered via tool search.2619 Whether this function should be deferred and discovered via tool search.

2577 2630 

2578 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.2631 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

2579 2632 

2580 - `Custom object { name, type, allowed_callers, 3 more }`2633 - `Custom object { name, type, allowed_callers, 4 more }`

2581 2634 

2582 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)2635 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

2583 2636 

2599 2652 

2600 - `"programmatic"`2653 - `"programmatic"`

2601 2654 

2655 - `async: optional boolean`

2656 

2657 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

2658 

2602 - `defer_loading: optional boolean`2659 - `defer_loading: optional boolean`

2603 2660 

2604 Whether this tool should be deferred and discovered via tool search.2661 Whether this tool should be deferred and discovered via tool search.

2795 2852 

2796 - `"developer"`2853 - `"developer"`

2797 2854 

2798 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`2855 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

2799 2856 

2800 A list of additional tools made available at this item.2857 A list of additional tools made available at this item.

2801 2858 

2802 - `Function object { name, parameters, strict, 5 more }`2859 - `Function object { name, parameters, strict, 6 more }`

2803 2860 

2804 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).2861 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

2805 2862 

2829 2886 

2830 - `"programmatic"`2887 - `"programmatic"`

2831 2888 

2889 - `async: optional boolean`

2890 

2832 - `defer_loading: optional boolean`2891 - `defer_loading: optional boolean`

2833 2892 

2834 Whether this function is deferred and loaded via tool search.2893 Whether this function is deferred and loaded via tool search.

3521 3580 

3522 - `BetaContainerReference object { container_id, type }`3581 - `BetaContainerReference object { container_id, type }`

3523 3582 

3524 - `Custom object { name, type, allowed_callers, 3 more }`3583 - `Custom object { name, type, allowed_callers, 4 more }`

3525 3584 

3526 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)3585 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

3527 3586 

3543 3602 

3544 - `"programmatic"`3603 - `"programmatic"`

3545 3604 

3605 - `async: optional boolean`

3606 

3607 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

3608 

3546 - `defer_loading: optional boolean`3609 - `defer_loading: optional boolean`

3547 3610 

3548 Whether this tool should be deferred and discovered via tool search.3611 Whether this tool should be deferred and discovered via tool search.

3599 3662 

3600 The namespace name used in tool calls (for example, `crm`).3663 The namespace name used in tool calls (for example, `crm`).

3601 3664 

3602 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`3665 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

3603 3666 

3604 The function/custom tools available inside this namespace.3667 The function/custom tools available inside this namespace.

3605 3668 

3606 - `Function object { name, type, allowed_callers, 5 more }`3669 - `Function object { name, type, allowed_callers, 6 more }`

3607 3670 

3608 - `name: string`3671 - `name: string`

3609 3672 

3619 3682 

3620 - `"programmatic"`3683 - `"programmatic"`

3621 3684 

3685 - `async: optional boolean`

3686 

3687 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

3688 

3622 - `defer_loading: optional boolean`3689 - `defer_loading: optional boolean`

3623 3690 

3624 Whether this function should be deferred and discovered via tool search.3691 Whether this function should be deferred and discovered via tool search.

3635 3702 

3636 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.3703 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

3637 3704 

3638 - `Custom object { name, type, allowed_callers, 3 more }`3705 - `Custom object { name, type, allowed_callers, 4 more }`

3639 3706 

3640 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)3707 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

3641 3708 

3657 3724 

3658 - `"programmatic"`3725 - `"programmatic"`

3659 3726 

3727 - `async: optional boolean`

3728 

3729 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

3730 

3660 - `defer_loading: optional boolean`3731 - `defer_loading: optional boolean`

3661 3732 

3662 Whether this tool should be deferred and discovered via tool search.3733 Whether this tool should be deferred and discovered via tool search.

3823 3894 

3824 The canonical name of the agent that produced this item.3895 The canonical name of the agent that produced this item.

3825 3896 

3897 - `ConfigurationUpdate object { type, id, agent, reasoning }`

3898 

3899 An update to the conversation's response configuration. The configuration

3900 remains in effect for subsequent responses until it is replaced by another

3901 configuration update.

3902 

3903 - `type: "configuration_update"`

3904 

3905 The item type. Always `configuration_update`.

3906 

3907 - `"configuration_update"`

3908 

3909 - `id: optional string or null`

3910 

3911 The unique ID of the configuration update item.

3912 

3913 - `agent: optional object { agent_name } or null`

3914 

3915 The agent that produced this item.

3916 

3917 - `agent_name: string`

3918 

3919 The canonical name of the agent that produced this item.

3920 

3921 - `reasoning: optional object { effort }`

3922 

3923 Updates to reasoning configuration. Only effort is supported.

3924 

3925 - `effort: optional "none" or "minimal" or "low" or 4 more or null`

3926 

3927 The reasoning effort to use for subsequent responses until another

3928 configuration update replaces it.

3929 

3930 - `"none"`

3931 

3932 - `"minimal"`

3933 

3934 - `"low"`

3935 

3936 - `"medium"`

3937 

3938 - `"high"`

3939 

3940 - `"xhigh"`

3941 

3942 - `"max"`

3943 

3826 - `Reasoning object { id, summary, type, 4 more }`3944 - `Reasoning object { id, summary, type, 4 more }`

3827 3945 

3828 A description of the chain of thought used by a reasoning model while generating3946 A description of the chain of thought used by a reasoning model while generating

4786 4904 

4787 - `"program"`4905 - `"program"`

4788 4906 

4789 - `CustomToolCall object { call_id, input, name, 5 more }`4907 - `CustomToolCall object { call_id, input, name, 6 more }`

4790 4908 

4791 A call to a custom tool created by the model.4909 A call to a custom tool created by the model.

4792 4910 

4820 4938 

4821 The canonical name of the agent that produced this item.4939 The canonical name of the agent that produced this item.

4822 4940 

4941 - `async: optional boolean`

4942 

4943 Whether the custom tool call runs asynchronously.

4944 

4823 - `caller: optional object { type } or object { caller_id, type } or null`4945 - `caller: optional object { type } or object { caller_id, type } or null`

4824 4946 

4825 The execution context that produced this tool call.4947 The execution context that produced this tool call.

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

4966 with a maximum length of 512 characters.5088 with a maximum length of 512 characters.

4967 5089 

4968 - `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string`5090 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string`

4969 5091 

4970 Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI5092 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

4971 offers a wide range of models with different capabilities, performance5093 offers a wide range of models with different capabilities, performance

4972 characteristics, and price points. Refer to the [model guide](/docs/models)5094 characteristics, and price points. Refer to the [model guide](/docs/models)

4973 to browse and compare available models.5095 to browse and compare available models.

4974 5096 

4975 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`5097 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`

4976 5098 

4977 Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI5099 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

4978 offers a wide range of models with different capabilities, performance5100 offers a wide range of models with different capabilities, performance

4979 characteristics, and price points. Refer to the [model guide](/docs/models)5101 characteristics, and price points. Refer to the [model guide](/docs/models)

4980 to browse and compare available models.5102 to browse and compare available models.

4981 5103 

5104 - `"gpt-6-astra"`

5105 

4982 - `"gpt-5.6-sol"`5106 - `"gpt-5.6-sol"`

4983 5107 

4984 - `"gpt-5.6-terra"`5108 - `"gpt-5.6-terra"`

5282 5406 

5283 The text that was retrieved from the file.5407 The text that was retrieved from the file.

5284 5408 

5285 - `FunctionCall object { arguments, call_id, name, 6 more }`5409 - `FunctionCall object { arguments, call_id, name, 7 more }`

5286 5410 

5287 A tool call to run a function. See the5411 A tool call to run a function. See the

5288 [function calling guide](/docs/guides/function-calling) for more information.5412 [function calling guide](/docs/guides/function-calling) for more information.

5317 5441 

5318 The canonical name of the agent that produced this item.5442 The canonical name of the agent that produced this item.

5319 5443 

5444 - `async: optional boolean`

5445 

5446 Whether the function tool call runs asynchronously.

5447 

5320 - `caller: optional object { type } or object { caller_id, type } or null`5448 - `caller: optional object { type } or object { caller_id, type } or null`

5321 5449 

5322 The execution context that produced this tool call.5450 The execution context that produced this tool call.

6137 6265 

6138 - `"incomplete"`6266 - `"incomplete"`

6139 6267 

6140 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`6268 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

6141 6269 

6142 The loaded tool definitions returned by tool search.6270 The loaded tool definitions returned by tool search.

6143 6271 

6144 - `Function object { name, parameters, strict, 5 more }`6272 - `Function object { name, parameters, strict, 6 more }`

6145 6273 

6146 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).6274 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

6147 6275 

6171 6299 

6172 - `"programmatic"`6300 - `"programmatic"`

6173 6301 

6302 - `async: optional boolean`

6303 

6174 - `defer_loading: optional boolean`6304 - `defer_loading: optional boolean`

6175 6305 

6176 Whether this function is deferred and loaded via tool search.6306 Whether this function is deferred and loaded via tool search.

6863 6993 

6864 - `BetaContainerReference object { container_id, type }`6994 - `BetaContainerReference object { container_id, type }`

6865 6995 

6866 - `Custom object { name, type, allowed_callers, 3 more }`6996 - `Custom object { name, type, allowed_callers, 4 more }`

6867 6997 

6868 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)6998 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

6869 6999 

6885 7015 

6886 - `"programmatic"`7016 - `"programmatic"`

6887 7017 

7018 - `async: optional boolean`

7019 

7020 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

7021 

6888 - `defer_loading: optional boolean`7022 - `defer_loading: optional boolean`

6889 7023 

6890 Whether this tool should be deferred and discovered via tool search.7024 Whether this tool should be deferred and discovered via tool search.

6941 7075 

6942 The namespace name used in tool calls (for example, `crm`).7076 The namespace name used in tool calls (for example, `crm`).

6943 7077 

6944 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`7078 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

6945 7079 

6946 The function/custom tools available inside this namespace.7080 The function/custom tools available inside this namespace.

6947 7081 

6948 - `Function object { name, type, allowed_callers, 5 more }`7082 - `Function object { name, type, allowed_callers, 6 more }`

6949 7083 

6950 - `name: string`7084 - `name: string`

6951 7085 

6961 7095 

6962 - `"programmatic"`7096 - `"programmatic"`

6963 7097 

7098 - `async: optional boolean`

7099 

7100 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

7101 

6964 - `defer_loading: optional boolean`7102 - `defer_loading: optional boolean`

6965 7103 

6966 Whether this function should be deferred and discovered via tool search.7104 Whether this function should be deferred and discovered via tool search.

6977 7115 

6978 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.7116 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

6979 7117 

6980 - `Custom object { name, type, allowed_callers, 3 more }`7118 - `Custom object { name, type, allowed_callers, 4 more }`

6981 7119 

6982 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)7120 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

6983 7121 

6999 7137 

7000 - `"programmatic"`7138 - `"programmatic"`

7001 7139 

7140 - `async: optional boolean`

7141 

7142 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

7143 

7002 - `defer_loading: optional boolean`7144 - `defer_loading: optional boolean`

7003 7145 

7004 Whether this tool should be deferred and discovered via tool search.7146 Whether this tool should be deferred and discovered via tool search.

7191 7333 

7192 - `"tool"`7334 - `"tool"`

7193 7335 

7194 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`7336 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

7195 7337 

7196 The additional tool definitions made available at this item.7338 The additional tool definitions made available at this item.

7197 7339 

7198 - `Function object { name, parameters, strict, 5 more }`7340 - `Function object { name, parameters, strict, 6 more }`

7199 7341 

7200 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).7342 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

7201 7343 

7225 7367 

7226 - `"programmatic"`7368 - `"programmatic"`

7227 7369 

7370 - `async: optional boolean`

7371 

7228 - `defer_loading: optional boolean`7372 - `defer_loading: optional boolean`

7229 7373 

7230 Whether this function is deferred and loaded via tool search.7374 Whether this function is deferred and loaded via tool search.

7917 8061 

7918 - `BetaContainerReference object { container_id, type }`8062 - `BetaContainerReference object { container_id, type }`

7919 8063 

7920 - `Custom object { name, type, allowed_callers, 3 more }`8064 - `Custom object { name, type, allowed_callers, 4 more }`

7921 8065 

7922 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)8066 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

7923 8067 

7939 8083 

7940 - `"programmatic"`8084 - `"programmatic"`

7941 8085 

8086 - `async: optional boolean`

8087 

8088 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

8089 

7942 - `defer_loading: optional boolean`8090 - `defer_loading: optional boolean`

7943 8091 

7944 Whether this tool should be deferred and discovered via tool search.8092 Whether this tool should be deferred and discovered via tool search.

7995 8143 

7996 The namespace name used in tool calls (for example, `crm`).8144 The namespace name used in tool calls (for example, `crm`).

7997 8145 

7998 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`8146 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

7999 8147 

8000 The function/custom tools available inside this namespace.8148 The function/custom tools available inside this namespace.

8001 8149 

8002 - `Function object { name, type, allowed_callers, 5 more }`8150 - `Function object { name, type, allowed_callers, 6 more }`

8003 8151 

8004 - `name: string`8152 - `name: string`

8005 8153 

8015 8163 

8016 - `"programmatic"`8164 - `"programmatic"`

8017 8165 

8166 - `async: optional boolean`

8167 

8168 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

8169 

8018 - `defer_loading: optional boolean`8170 - `defer_loading: optional boolean`

8019 8171 

8020 Whether this function should be deferred and discovered via tool search.8172 Whether this function should be deferred and discovered via tool search.

8031 8183 

8032 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.8184 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

8033 8185 

8034 - `Custom object { name, type, allowed_callers, 3 more }`8186 - `Custom object { name, type, allowed_callers, 4 more }`

8035 8187 

8036 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)8188 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

8037 8189 

8053 8205 

8054 - `"programmatic"`8206 - `"programmatic"`

8055 8207 

8208 - `async: optional boolean`

8209 

8210 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

8211 

8056 - `defer_loading: optional boolean`8212 - `defer_loading: optional boolean`

8057 8213 

8058 Whether this tool should be deferred and discovered via tool search.8214 Whether this tool should be deferred and discovered via tool search.

9023 9179 

9024 Optional reason for the decision.9180 Optional reason for the decision.

9025 9181 

9026 - `CustomToolCall object { call_id, input, name, 5 more }`9182 - `CustomToolCall object { call_id, input, name, 6 more }`

9027 9183 

9028 A call to a custom tool created by the model.9184 A call to a custom tool created by the model.

9029 9185 

9057 9213 

9058 The canonical name of the agent that produced this item.9214 The canonical name of the agent that produced this item.

9059 9215 

9216 - `async: optional boolean`

9217 

9218 Whether the custom tool call runs asynchronously.

9219 

9060 - `caller: optional object { type } or object { caller_id, type } or null`9220 - `caller: optional object { type } or object { caller_id, type } or null`

9061 9221 

9062 The execution context that produced this tool call.9222 The execution context that produced this tool call.

9348 9508 

9349 - `"shell"`9509 - `"shell"`

9350 9510 

9351 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`9511 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

9352 9512 

9353 An array of tools the model may call while generating a response. You9513 An array of tools the model may call while generating a response. You

9354 can specify which tool to use by setting the `tool_choice` parameter.9514 can specify which tool to use by setting the `tool_choice` parameter.

9368 [function calling](/docs/guides/function-calling). You can also use9528 [function calling](/docs/guides/function-calling). You can also use

9369 custom tools to call your own code.9529 custom tools to call your own code.

9370 9530 

9371 - `Function object { name, parameters, strict, 5 more }`9531 - `Function object { name, parameters, strict, 6 more }`

9372 9532 

9373 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).9533 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

9374 9534 

9398 9558 

9399 - `"programmatic"`9559 - `"programmatic"`

9400 9560 

9561 - `async: optional boolean`

9562 

9401 - `defer_loading: optional boolean`9563 - `defer_loading: optional boolean`

9402 9564 

9403 Whether this function is deferred and loaded via tool search.9565 Whether this function is deferred and loaded via tool search.

10090 10252 

10091 - `BetaContainerReference object { container_id, type }`10253 - `BetaContainerReference object { container_id, type }`

10092 10254 

10093 - `Custom object { name, type, allowed_callers, 3 more }`10255 - `Custom object { name, type, allowed_callers, 4 more }`

10094 10256 

10095 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)10257 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

10096 10258 

10112 10274 

10113 - `"programmatic"`10275 - `"programmatic"`

10114 10276 

10277 - `async: optional boolean`

10278 

10279 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

10280 

10115 - `defer_loading: optional boolean`10281 - `defer_loading: optional boolean`

10116 10282 

10117 Whether this tool should be deferred and discovered via tool search.10283 Whether this tool should be deferred and discovered via tool search.

10168 10334 

10169 The namespace name used in tool calls (for example, `crm`).10335 The namespace name used in tool calls (for example, `crm`).

10170 10336 

10171 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`10337 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

10172 10338 

10173 The function/custom tools available inside this namespace.10339 The function/custom tools available inside this namespace.

10174 10340 

10175 - `Function object { name, type, allowed_callers, 5 more }`10341 - `Function object { name, type, allowed_callers, 6 more }`

10176 10342 

10177 - `name: string`10343 - `name: string`

10178 10344 

10188 10354 

10189 - `"programmatic"`10355 - `"programmatic"`

10190 10356 

10357 - `async: optional boolean`

10358 

10359 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

10360 

10191 - `defer_loading: optional boolean`10361 - `defer_loading: optional boolean`

10192 10362 

10193 Whether this function should be deferred and discovered via tool search.10363 Whether this function should be deferred and discovered via tool search.

10204 10374 

10205 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.10375 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

10206 10376 

10207 - `Custom object { name, type, allowed_callers, 3 more }`10377 - `Custom object { name, type, allowed_callers, 4 more }`

10208 10378 

10209 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)10379 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

10210 10380 

10226 10396 

10227 - `"programmatic"`10397 - `"programmatic"`

10228 10398 

10399 - `async: optional boolean`

10400 

10401 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

10402 

10229 - `defer_loading: optional boolean`10403 - `defer_loading: optional boolean`

10230 10404 

10231 Whether this tool should be deferred and discovered via tool search.10405 Whether this tool should be deferred and discovered via tool search.

10570 10744 

10571 Optional version of the prompt template.10745 Optional version of the prompt template.

10572 10746 

10747 - `prompt_cache_diagnostics: optional object { cache_missed_tokens, reason, type, comparison_reusable_tokens } or object { type } or object { type } or object { type }`

10748 

10749 Prompt cache diagnostics requested for this response.

10750 

10751 - `CacheMiss object { cache_missed_tokens, reason, type, comparison_reusable_tokens }`

10752 

10753 - `cache_missed_tokens: number`

10754 

10755 The estimated number of input tokens affected after the first detected divergence.

10756 

10757 - `reason: "model_changed" or "prompt_cache_key_changed" or "tools_changed" or 6 more`

10758 

10759 The reason prompt cache reuse did not occur.

10760 

10761 - `"model_changed"`

10762 

10763 - `"prompt_cache_key_changed"`

10764 

10765 - `"tools_changed"`

10766 

10767 - `"text_format_changed"`

10768 

10769 - `"reasoning_effort_changed"`

10770 

10771 - `"verbosity_changed"`

10772 

10773 - `"context_compacted"`

10774 

10775 - `"input_changed"`

10776 

10777 - `"service_tier_changed"`

10778 

10779 - `type: "cache_miss"`

10780 

10781 - `"cache_miss"`

10782 

10783 - `comparison_reusable_tokens: optional number`

10784 

10785 The raw token count of the reusable prefix in the compared response.

10786 

10787 - `CacheHit object { type }`

10788 

10789 - `type: "cache_hit"`

10790 

10791 - `"cache_hit"`

10792 

10793 - `ComparisonResponseNotFound object { type }`

10794 

10795 - `type: "comparison_response_not_found"`

10796 

10797 - `"comparison_response_not_found"`

10798 

10799 - `Unavailable object { type }`

10800 

10801 - `type: "unavailable"`

10802 

10803 - `"unavailable"`

10804 

10573 - `prompt_cache_key: optional string or null`10805 - `prompt_cache_key: optional string or null`

10574 10806 

10575 Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).10807 Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).

10576 10808 

10577 - `prompt_cache_options: optional object { mode, ttl }`10809 - `prompt_cache_options: optional object { mode, ttl, comparison_response_id }`

10578 10810 

10579 The prompt-caching options that were applied to the response. Supported for `gpt-5.6` and later models.10811 The prompt-caching options that were applied to the response. Supported for `gpt-5.6` and later models.

10580 10812 

10592 10824 

10593 - `"30m"`10825 - `"30m"`

10594 10826 

10827 - `comparison_response_id: optional string or null`

10828 

10829 The response ID supplied as the prompt cache diagnostics comparison.

10830 

10595 - `prompt_cache_retention: optional "in_memory" or "24h" or null`10831 - `prompt_cache_retention: optional "in_memory" or "24h" or null`

10596 10832 

10597 Deprecated. Use `prompt_cache_options.ttl` instead.10833 Deprecated. Use `prompt_cache_options.ttl` instead.

10926 "created_at": 0,11162 "created_at": 0,

10927 "error": {11163 "error": {

10928 "code": "server_error",11164 "code": "server_error",

11165 "message": "message",

11166 "misalignment": {

11167 "detailed_explanation": "detailed_explanation",

11168 "error_type": "potentially_unintended_data_transfer",

11169 "steer": {

10929 "message": "message"11170 "message": "message"

11171 }

11172 }

10930 },11173 },

10931 "incomplete_details": {11174 "incomplete_details": {

10932 "reason": "max_output_tokens"11175 "reason": "max_output_tokens"

10935 "metadata": {11178 "metadata": {

10936 "foo": "string"11179 "foo": "string"

10937 },11180 },

10938 "model": "gpt-5.6-sol",11181 "model": "gpt-6-astra",

10939 "object": "response",11182 "object": "response",

10940 "output": [11183 "output": [

10941 {11184 {

10995 "allowed_callers": [11238 "allowed_callers": [

10996 "direct"11239 "direct"

10997 ],11240 ],

11241 "async": true,

10998 "defer_loading": true,11242 "defer_loading": true,

10999 "description": "description",11243 "description": "description",

11000 "output_schema": {11244 "output_schema": {

11053 },11297 },

11054 "version": "version"11298 "version": "version"

11055 },11299 },

11300 "prompt_cache_diagnostics": {

11301 "cache_missed_tokens": 0,

11302 "reason": "model_changed",

11303 "type": "cache_miss",

11304 "comparison_reusable_tokens": 0

11305 },

11056 "prompt_cache_key": "prompt-cache-key-1234",11306 "prompt_cache_key": "prompt-cache-key-1234",

11057 "prompt_cache_options": {11307 "prompt_cache_options": {

11058 "mode": "implicit",11308 "mode": "implicit",

11059 "ttl": "30m"11309 "ttl": "30m",

11310 "comparison_response_id": "comparison_response_id"

11060 },11311 },

11061 "prompt_cache_retention": "in_memory",11312 "prompt_cache_retention": "in_memory",

11062 "reasoning": {11313 "reasoning": {

11115 "incomplete_details": null,11366 "incomplete_details": null,

11116 "instructions": null,11367 "instructions": null,

11117 "max_output_tokens": null,11368 "max_output_tokens": null,

11118 "model": "gpt-5.6-sol",11369 "model": "gpt-6-astra",

11119 "output": [11370 "output": [

11120 {11371 {

11121 "type": "message",11372 "type": "message",

14 14 

15### Body Parameters15### Body Parameters

16 16 

17- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string or null`17- `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string or null`

18 18 

19 Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.19 Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.

20 20 

21 - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more`21 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`

22 22 

23 Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.23 Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.

24 

25 - `"gpt-6-astra"`

24 26 

25 - `"gpt-5.6-sol"`27 - `"gpt-5.6-sol"`

26 28 

228 230 

229 - `string`231 - `string`

230 232 

231- `input: optional string or array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 32 more or null`233- `input: optional string or array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 33 more or null`

232 234 

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

234 236 

236 238 

237 A text input to the model, equivalent to a text input with the `user` role.239 A text input to the model, equivalent to a text input with the `user` role.

238 240 

239 - `array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 32 more`241 - `array of BetaEasyInputMessage or object { content, role, agent, 2 more } or BetaResponseOutputMessage or 33 more`

240 242 

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

242 244 

1185 1187 

1186 The canonical name of the agent that produced this item.1188 The canonical name of the agent that produced this item.

1187 1189 

1188 - `FunctionCall object { arguments, call_id, name, 6 more }`1190 - `FunctionCall object { arguments, call_id, name, 7 more }`

1189 1191 

1190 A tool call to run a function. See the1192 A tool call to run a function. See the

1191 [function calling guide](/docs/guides/function-calling) for more information.1193 [function calling guide](/docs/guides/function-calling) for more information.

1220 1222 

1221 The canonical name of the agent that produced this item.1223 The canonical name of the agent that produced this item.

1222 1224 

1225 - `async: optional boolean`

1226 

1227 Whether the function tool call runs asynchronously.

1228 

1223 - `caller: optional object { type } or object { caller_id, type } or null`1229 - `caller: optional object { type } or object { caller_id, type } or null`

1224 1230 

1225 The execution context that produced this tool call.1231 The execution context that produced this tool call.

1715 1721 

1716 - `ToolSearchOutput object { tools, type, id, 4 more }`1722 - `ToolSearchOutput object { tools, type, id, 4 more }`

1717 1723 

1718 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`1724 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

1719 1725 

1720 The loaded tool definitions returned by the tool search output.1726 The loaded tool definitions returned by the tool search output.

1721 1727 

1722 - `Function object { name, parameters, strict, 5 more }`1728 - `Function object { name, parameters, strict, 6 more }`

1723 1729 

1724 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).1730 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

1725 1731 

1749 1755 

1750 - `"programmatic"`1756 - `"programmatic"`

1751 1757 

1758 - `async: optional boolean`

1759 

1752 - `defer_loading: optional boolean`1760 - `defer_loading: optional boolean`

1753 1761 

1754 Whether this function is deferred and loaded via tool search.1762 Whether this function is deferred and loaded via tool search.

2591 2599 

2592 - `"container_reference"`2600 - `"container_reference"`

2593 2601 

2594 - `Custom object { name, type, allowed_callers, 3 more }`2602 - `Custom object { name, type, allowed_callers, 4 more }`

2595 2603 

2596 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)2604 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

2597 2605 

2613 2621 

2614 - `"programmatic"`2622 - `"programmatic"`

2615 2623 

2624 - `async: optional boolean`

2625 

2626 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

2627 

2616 - `defer_loading: optional boolean`2628 - `defer_loading: optional boolean`

2617 2629 

2618 Whether this tool should be deferred and discovered via tool search.2630 Whether this tool should be deferred and discovered via tool search.

2669 2681 

2670 The namespace name used in tool calls (for example, `crm`).2682 The namespace name used in tool calls (for example, `crm`).

2671 2683 

2672 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`2684 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

2673 2685 

2674 The function/custom tools available inside this namespace.2686 The function/custom tools available inside this namespace.

2675 2687 

2676 - `Function object { name, type, allowed_callers, 5 more }`2688 - `Function object { name, type, allowed_callers, 6 more }`

2677 2689 

2678 - `name: string`2690 - `name: string`

2679 2691 

2689 2701 

2690 - `"programmatic"`2702 - `"programmatic"`

2691 2703 

2704 - `async: optional boolean`

2705 

2706 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

2707 

2692 - `defer_loading: optional boolean`2708 - `defer_loading: optional boolean`

2693 2709 

2694 Whether this function should be deferred and discovered via tool search.2710 Whether this function should be deferred and discovered via tool search.

2705 2721 

2706 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.2722 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

2707 2723 

2708 - `Custom object { name, type, allowed_callers, 3 more }`2724 - `Custom object { name, type, allowed_callers, 4 more }`

2709 2725 

2710 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)2726 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

2711 2727 

2727 2743 

2728 - `"programmatic"`2744 - `"programmatic"`

2729 2745 

2746 - `async: optional boolean`

2747 

2748 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

2749 

2730 - `defer_loading: optional boolean`2750 - `defer_loading: optional boolean`

2731 2751 

2732 Whether this tool should be deferred and discovered via tool search.2752 Whether this tool should be deferred and discovered via tool search.

2923 2943 

2924 - `"developer"`2944 - `"developer"`

2925 2945 

2926 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`2946 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

2927 2947 

2928 A list of additional tools made available at this item.2948 A list of additional tools made available at this item.

2929 2949 

2930 - `Function object { name, parameters, strict, 5 more }`2950 - `Function object { name, parameters, strict, 6 more }`

2931 2951 

2932 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).2952 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

2933 2953 

2957 2977 

2958 - `"programmatic"`2978 - `"programmatic"`

2959 2979 

2980 - `async: optional boolean`

2981 

2960 - `defer_loading: optional boolean`2982 - `defer_loading: optional boolean`

2961 2983 

2962 Whether this function is deferred and loaded via tool search.2984 Whether this function is deferred and loaded via tool search.

3649 3671 

3650 - `BetaContainerReference object { container_id, type }`3672 - `BetaContainerReference object { container_id, type }`

3651 3673 

3652 - `Custom object { name, type, allowed_callers, 3 more }`3674 - `Custom object { name, type, allowed_callers, 4 more }`

3653 3675 

3654 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)3676 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

3655 3677 

3671 3693 

3672 - `"programmatic"`3694 - `"programmatic"`

3673 3695 

3696 - `async: optional boolean`

3697 

3698 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

3699 

3674 - `defer_loading: optional boolean`3700 - `defer_loading: optional boolean`

3675 3701 

3676 Whether this tool should be deferred and discovered via tool search.3702 Whether this tool should be deferred and discovered via tool search.

3727 3753 

3728 The namespace name used in tool calls (for example, `crm`).3754 The namespace name used in tool calls (for example, `crm`).

3729 3755 

3730 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`3756 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

3731 3757 

3732 The function/custom tools available inside this namespace.3758 The function/custom tools available inside this namespace.

3733 3759 

3734 - `Function object { name, type, allowed_callers, 5 more }`3760 - `Function object { name, type, allowed_callers, 6 more }`

3735 3761 

3736 - `name: string`3762 - `name: string`

3737 3763 

3747 3773 

3748 - `"programmatic"`3774 - `"programmatic"`

3749 3775 

3776 - `async: optional boolean`

3777 

3778 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

3779 

3750 - `defer_loading: optional boolean`3780 - `defer_loading: optional boolean`

3751 3781 

3752 Whether this function should be deferred and discovered via tool search.3782 Whether this function should be deferred and discovered via tool search.

3763 3793 

3764 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.3794 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

3765 3795 

3766 - `Custom object { name, type, allowed_callers, 3 more }`3796 - `Custom object { name, type, allowed_callers, 4 more }`

3767 3797 

3768 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)3798 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

3769 3799 

3785 3815 

3786 - `"programmatic"`3816 - `"programmatic"`

3787 3817 

3818 - `async: optional boolean`

3819 

3820 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

3821 

3788 - `defer_loading: optional boolean`3822 - `defer_loading: optional boolean`

3789 3823 

3790 Whether this tool should be deferred and discovered via tool search.3824 Whether this tool should be deferred and discovered via tool search.

3951 3985 

3952 The canonical name of the agent that produced this item.3986 The canonical name of the agent that produced this item.

3953 3987 

3988 - `ConfigurationUpdate object { type, id, agent, reasoning }`

3989 

3990 An update to the conversation's response configuration. The configuration

3991 remains in effect for subsequent responses until it is replaced by another

3992 configuration update.

3993 

3994 - `type: "configuration_update"`

3995 

3996 The item type. Always `configuration_update`.

3997 

3998 - `"configuration_update"`

3999 

4000 - `id: optional string or null`

4001 

4002 The unique ID of the configuration update item.

4003 

4004 - `agent: optional object { agent_name } or null`

4005 

4006 The agent that produced this item.

4007 

4008 - `agent_name: string`

4009 

4010 The canonical name of the agent that produced this item.

4011 

4012 - `reasoning: optional object { effort }`

4013 

4014 Updates to reasoning configuration. Only effort is supported.

4015 

4016 - `effort: optional "none" or "minimal" or "low" or 4 more or null`

4017 

4018 The reasoning effort to use for subsequent responses until another

4019 configuration update replaces it.

4020 

4021 - `"none"`

4022 

4023 - `"minimal"`

4024 

4025 - `"low"`

4026 

4027 - `"medium"`

4028 

4029 - `"high"`

4030 

4031 - `"xhigh"`

4032 

4033 - `"max"`

4034 

3954 - `Reasoning object { id, summary, type, 4 more }`4035 - `Reasoning object { id, summary, type, 4 more }`

3955 4036 

3956 A description of the chain of thought used by a reasoning model while generating4037 A description of the chain of thought used by a reasoning model while generating

4914 4995 

4915 - `"program"`4996 - `"program"`

4916 4997 

4917 - `CustomToolCall object { call_id, input, name, 5 more }`4998 - `CustomToolCall object { call_id, input, name, 6 more }`

4918 4999 

4919 A call to a custom tool created by the model.5000 A call to a custom tool created by the model.

4920 5001 

4948 5029 

4949 The canonical name of the agent that produced this item.5030 The canonical name of the agent that produced this item.

4950 5031 

5032 - `async: optional boolean`

5033 

5034 Whether the custom tool call runs asynchronously.

5035 

4951 - `caller: optional object { type } or object { caller_id, type } or null`5036 - `caller: optional object { type } or object { caller_id, type } or null`

4952 5037 

4953 The execution context that produced this tool call.5038 The execution context that produced this tool call.

5125 5210 

5126- `service_tier: optional "auto" or "default" or "fast" or 2 more or null`5211- `service_tier: optional "auto" or "default" or "fast" or 2 more or null`

5127 5212 

5128 Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - When not set, the default behavior is 'auto'.5213 Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'.

5129 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.5214 When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

5130 5215 

5131 - `"auto"`5216 - `"auto"`

5630 5715 

5631 The canonical name of the agent that produced this item.5716 The canonical name of the agent that produced this item.

5632 5717 

5633 - `FunctionCall object { arguments, call_id, name, 6 more }`5718 - `FunctionCall object { arguments, call_id, name, 7 more }`

5634 5719 

5635 A tool call to run a function. See the5720 A tool call to run a function. See the

5636 [function calling guide](/docs/guides/function-calling) for more information.5721 [function calling guide](/docs/guides/function-calling) for more information.

5665 5750 

5666 The canonical name of the agent that produced this item.5751 The canonical name of the agent that produced this item.

5667 5752 

5753 - `async: optional boolean`

5754 

5755 Whether the function tool call runs asynchronously.

5756 

5668 - `caller: optional object { type } or object { caller_id, type } or null`5757 - `caller: optional object { type } or object { caller_id, type } or null`

5669 5758 

5670 The execution context that produced this tool call.5759 The execution context that produced this tool call.

5880 5969 

5881 - `"incomplete"`5970 - `"incomplete"`

5882 5971 

5883 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`5972 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

5884 5973 

5885 The loaded tool definitions returned by tool search.5974 The loaded tool definitions returned by tool search.

5886 5975 

5887 - `Function object { name, parameters, strict, 5 more }`5976 - `Function object { name, parameters, strict, 6 more }`

5888 5977 

5889 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).5978 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

5890 5979 

5914 6003 

5915 - `"programmatic"`6004 - `"programmatic"`

5916 6005 

6006 - `async: optional boolean`

6007 

5917 - `defer_loading: optional boolean`6008 - `defer_loading: optional boolean`

5918 6009 

5919 Whether this function is deferred and loaded via tool search.6010 Whether this function is deferred and loaded via tool search.

6756 6847 

6757 - `"container_reference"`6848 - `"container_reference"`

6758 6849 

6759 - `Custom object { name, type, allowed_callers, 3 more }`6850 - `Custom object { name, type, allowed_callers, 4 more }`

6760 6851 

6761 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)6852 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

6762 6853 

6778 6869 

6779 - `"programmatic"`6870 - `"programmatic"`

6780 6871 

6872 - `async: optional boolean`

6873 

6874 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

6875 

6781 - `defer_loading: optional boolean`6876 - `defer_loading: optional boolean`

6782 6877 

6783 Whether this tool should be deferred and discovered via tool search.6878 Whether this tool should be deferred and discovered via tool search.

6834 6929 

6835 The namespace name used in tool calls (for example, `crm`).6930 The namespace name used in tool calls (for example, `crm`).

6836 6931 

6837 - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }`6932 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`

6838 6933 

6839 The function/custom tools available inside this namespace.6934 The function/custom tools available inside this namespace.

6840 6935 

6841 - `Function object { name, type, allowed_callers, 5 more }`6936 - `Function object { name, type, allowed_callers, 6 more }`

6842 6937 

6843 - `name: string`6938 - `name: string`

6844 6939 

6854 6949 

6855 - `"programmatic"`6950 - `"programmatic"`

6856 6951 

6952 - `async: optional boolean`

6953 

6954 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

6955 

6857 - `defer_loading: optional boolean`6956 - `defer_loading: optional boolean`

6858 6957 

6859 Whether this function should be deferred and discovered via tool search.6958 Whether this function should be deferred and discovered via tool search.

6870 6969 

6871 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.6970 Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

6872 6971 

6873 - `Custom object { name, type, allowed_callers, 3 more }`6972 - `Custom object { name, type, allowed_callers, 4 more }`

6874 6973 

6875 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)6974 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

6876 6975 

6892 6991 

6893 - `"programmatic"`6992 - `"programmatic"`

6894 6993 

6994 - `async: optional boolean`

6995 

6996 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

6997 

6895 - `defer_loading: optional boolean`6998 - `defer_loading: optional boolean`

6896 6999 

6897 Whether this tool should be deferred and discovered via tool search.7000 Whether this tool should be deferred and discovered via tool search.

7084 7187 

7085 - `"tool"`7188 - `"tool"`

7086 7189 

7087 - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`7190 - `tools: array of object { name, parameters, strict, 6 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more`

7088 7191 

7089 The additional tool definitions made available at this item.7192 The additional tool definitions made available at this item.

7090 7193 

7091 - `Function object { name, parameters, strict, 5 more }`7194 - `Function object { name, parameters, strict, 6 more }`

7092 7195 

7093 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).7196 Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

7094 7197 

7118 7221 

7119 - `"programmatic"`7222 - `"programmatic"`

7120 7223 

7224 - `async: optional boolean`

7225 

7121 - `defer_loading: optional boolean`7226 - `defer_loading: optional boolean`

7122 7227 

7123 Whether this function is deferred and loaded via tool search.7228 Whether this function is deferred and loaded via tool search.

7810 7915 

7811 - `BetaContainerReference object { container_id, type }`7916 - `BetaContainerReference object { container_id, type }`

7812 7917 

7813 - `Custom object { name, type, allowed_callers, 3 more }`7918 - `Custom object { name, type, allowed_callers, 4 more }`

7814 7919 

7815 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)7920 A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

7816 7921 

7832 7937 

7833 - `"programmatic"`7938 - `"programmatic"`

7834 7939 

7940 - `async: optional boolean`

7941 

7942 Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

7943 

7835 - `defer_loading: optional boolean`7944 - `defer_loading: optional boolean`

7836 7945