SpyBara
Go Premium

Reference 2026-09-15 22:59 UTC to 2026-09-16 22:58 UTC

42 files changed +1,169 −56. View all changes and history on the product overview
2026
Wed 30 22:59 Tue 29 22:57 Mon 28 22:57 Sun 27 23:58 Sat 26 23:59 Fri 25 23:58 Thu 24 23:58 Wed 23 23:58 Tue 22 23:57 Mon 21 23:00 Sat 19 23:00 Fri 18 22:59 Wed 16 22:58 Fri 11 20:00 Thu 10 18:01 Wed 9 16:02 Fri 4 23:59 Thu 3 23:00 Wed 2 01:58 Tue 1 01:57
Details

4 4 

5### All Models5### All Models

6 6 

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`7- `AllModels = string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 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-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`11 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

12 12 

13 - `"gpt-6-astra"`13 - `"gpt-6-astra"`

14 14 


50 50 

51 - `"gpt-5.1-codex"`51 - `"gpt-5.1-codex"`

52 52 

53 - `"gpt-5.1-mini"`

54 

55 - `"gpt-5.1-chat-latest"`53 - `"gpt-5.1-chat-latest"`

56 54 

57 - `"gpt-5"`55 - `"gpt-5"`


112 110 

113 - `"gpt-4o-2024-05-13"`111 - `"gpt-4o-2024-05-13"`

114 112 

113 - `"gpt-audio-mini"`

114 

115 - `"gpt-audio-mini-2025-12-15"`

116 

115 - `"gpt-4o-audio-preview"`117 - `"gpt-4o-audio-preview"`

116 118 

117 - `"gpt-4o-audio-preview-2024-10-01"`119 - `"gpt-4o-audio-preview-2024-10-01"`


687 689 

688### Responses Model690### Responses Model

689 691 

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`692- `ResponsesModel = string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`

691 693 

692 - `string`694 - `string`

693 695 

694 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`696 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

695 697 

696 - `"gpt-6-astra"`698 - `"gpt-6-astra"`

697 699 


733 735 

734 - `"gpt-5.1-codex"`736 - `"gpt-5.1-codex"`

735 737 

736 - `"gpt-5.1-mini"`

737 

738 - `"gpt-5.1-chat-latest"`738 - `"gpt-5.1-chat-latest"`

739 739 

740 - `"gpt-5"`740 - `"gpt-5"`


795 795 

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

797 797 

798 - `"gpt-audio-mini"`

799 

800 - `"gpt-audio-mini-2025-12-15"`

801 

798 - `"gpt-4o-audio-preview"`802 - `"gpt-4o-audio-preview"`

799 803 

800 - `"gpt-4o-audio-preview-2024-10-01"`804 - `"gpt-4o-audio-preview-2024-10-01"`

Details

2 2 

3**post** `/agents/sessions/{session_id}`3**post** `/agents/sessions/{session_id}`

4 4 

5Updates session metadata. Omitted fields are unchanged. See [managing sessions](/api/docs/guides/agents-api/sessions/manage).5Updates session metadata, model, reasoning effort, or service tier. Model settings apply to subsequent turns. Omitted fields are unchanged. See [managing sessions](/api/docs/guides/agents-api/sessions/manage).

6 6 

7### Path Parameters7### Path Parameters

8 8 


10 10 

11### Body Parameters11### Body Parameters

12 12 

13- `agent: optional object { model, reasoning, service_tier }`

14 

15 Model settings for subsequent turns. Omitted fields stay unchanged.

16 

17 - `model: optional string`

18 

19 The model for subsequent turns. Omit to keep the current model.

20 

21 - `reasoning: optional object { effort }`

22 

23 Reasoning settings to update. Omit to keep the current effort.

24 

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

26 

27 The amount of reasoning effort the model should use.

28 

29 - `"none"`

30 

31 - `"minimal"`

32 

33 - `"low"`

34 

35 - `"medium"`

36 

37 - `"high"`

38 

39 - `"xhigh"`

40 

41 - `"max"`

42 

43 - `service_tier: optional "auto" or "default" or "flex" or 2 more or null`

44 

45 The service tier used for model requests.

46 

47 - `"auto"`

48 

49 Selects the service tier automatically.

50 

51 - `"default"`

52 

53 Uses the default service tier.

54 

55 - `"flex"`

56 

57 Uses the flex service tier.

58 

59 - `"priority"`

60 

61 Uses the priority service tier.

62 

63 - `"fast"`

64 

65 Uses the fast service tier.

66 

13- `metadata: optional map[string] or null`67- `metadata: optional map[string] or null`

14 68 

15 Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.69 Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.

Details

2017 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2017 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2018 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2018 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2019 2019 

2020 This field is deprecated for models released after September 1, 2026.

2021 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2022 connect through a Secure MCP Tunnel.

2023 

2020 Currently supported `connector_id` values are:2024 Currently supported `connector_id` values are:

2021 2025 

2022 - Dropbox: `connector_dropbox`2026 - Dropbox: `connector_dropbox`


3259 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3263 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3260 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3264 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3261 3265 

3266 This field is deprecated for models released after September 1, 2026.

3267 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3268 connect through a Secure MCP Tunnel.

3269 

3262 Currently supported `connector_id` values are:3270 Currently supported `connector_id` values are:

3263 3271 

3264 - Dropbox: `connector_dropbox`3272 - Dropbox: `connector_dropbox`


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

5196 with a maximum length of 512 characters.5204 with a maximum length of 512 characters.

5197 5205 

5198 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string`5206 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more or string`

5199 5207 

5200 Model ID used to generate the response, like `gpt-6-astra`. OpenAI5208 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

5201 offers a wide range of models with different capabilities, performance5209 offers a wide range of models with different capabilities, performance

5202 characteristics, and price points. Refer to the [model guide](/api/docs/models)5210 characteristics, and price points. Refer to the [model guide](/api/docs/models)

5203 to browse and compare available models.5211 to browse and compare available models.

5204 5212 

5205 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`5213 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more`

5206 5214 

5207 Model ID used to generate the response, like `gpt-6-astra`. OpenAI5215 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

5208 offers a wide range of models with different capabilities, performance5216 offers a wide range of models with different capabilities, performance


5249 5257 

5250 - `"gpt-5.1-codex"`5258 - `"gpt-5.1-codex"`

5251 5259 

5252 - `"gpt-5.1-mini"`

5253 

5254 - `"gpt-5.1-chat-latest"`5260 - `"gpt-5.1-chat-latest"`

5255 5261 

5256 - `"gpt-5"`5262 - `"gpt-5"`


5311 5317 

5312 - `"gpt-4o-2024-05-13"`5318 - `"gpt-4o-2024-05-13"`

5313 5319 

5320 - `"gpt-audio-mini"`

5321 

5322 - `"gpt-audio-mini-2025-12-15"`

5323 

5314 - `"gpt-4o-audio-preview"`5324 - `"gpt-4o-audio-preview"`

5315 5325 

5316 - `"gpt-4o-audio-preview-2024-10-01"`5326 - `"gpt-4o-audio-preview-2024-10-01"`


6760 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6770 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6761 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6771 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6762 6772 

6773 This field is deprecated for models released after September 1, 2026.

6774 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6775 connect through a Secure MCP Tunnel.

6776 

6763 Currently supported `connector_id` values are:6777 Currently supported `connector_id` values are:

6764 6778 

6765 - Dropbox: `connector_dropbox`6779 - Dropbox: `connector_dropbox`


7848 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more7862 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

7849 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).7863 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

7850 7864 

7865 This field is deprecated for models released after September 1, 2026.

7866 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

7867 connect through a Secure MCP Tunnel.

7868 

7851 Currently supported `connector_id` values are:7869 Currently supported `connector_id` values are:

7852 7870 

7853 - Dropbox: `connector_dropbox`7871 - Dropbox: `connector_dropbox`


10125 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more10143 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

10126 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).10144 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

10127 10145 

10146 This field is deprecated for models released after September 1, 2026.

10147 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

10148 connect through a Secure MCP Tunnel.

10149 

10128 Currently supported `connector_id` values are:10150 Currently supported `connector_id` values are:

10129 10151 

10130 - Dropbox: `connector_dropbox`10152 - Dropbox: `connector_dropbox`

Details

14 14 

15### Body Parameters15### Body Parameters

16 16 

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

18 18 

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](/api/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](/api/docs/models) to browse and compare available models.

20 20 

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

22 22 

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](/api/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](/api/docs/models) to browse and compare available models.

24 24 


62 62 

63 - `"gpt-5.1-codex"`63 - `"gpt-5.1-codex"`

64 64 

65 - `"gpt-5.1-mini"`

66 

67 - `"gpt-5.1-chat-latest"`65 - `"gpt-5.1-chat-latest"`

68 66 

69 - `"gpt-5"`67 - `"gpt-5"`


124 122 

125 - `"gpt-4o-2024-05-13"`123 - `"gpt-4o-2024-05-13"`

126 124 

125 - `"gpt-audio-mini"`

126 

127 - `"gpt-audio-mini-2025-12-15"`

128 

127 - `"gpt-4o-audio-preview"`129 - `"gpt-4o-audio-preview"`

128 130 

129 - `"gpt-4o-audio-preview-2024-10-01"`131 - `"gpt-4o-audio-preview-2024-10-01"`


2108 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2110 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2109 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2111 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2110 2112 

2113 This field is deprecated for models released after September 1, 2026.

2114 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2115 connect through a Secure MCP Tunnel.

2116 

2111 Currently supported `connector_id` values are:2117 Currently supported `connector_id` values are:

2112 2118 

2113 - Dropbox: `connector_dropbox`2119 - Dropbox: `connector_dropbox`


3350 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3356 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3351 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3357 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3352 3358 

3359 This field is deprecated for models released after September 1, 2026.

3360 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3361 connect through a Secure MCP Tunnel.

3362 

3353 Currently supported `connector_id` values are:3363 Currently supported `connector_id` values are:

3354 3364 

3355 - Dropbox: `connector_dropbox`3365 - Dropbox: `connector_dropbox`


6462 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6472 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6463 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6473 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6464 6474 

6475 This field is deprecated for models released after September 1, 2026.

6476 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6477 connect through a Secure MCP Tunnel.

6478 

6465 Currently supported `connector_id` values are:6479 Currently supported `connector_id` values are:

6466 6480 

6467 - Dropbox: `connector_dropbox`6481 - Dropbox: `connector_dropbox`


7700 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more7714 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

7701 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).7715 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

7702 7716 

7717 This field is deprecated for models released after September 1, 2026.

7718 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

7719 connect through a Secure MCP Tunnel.

7720 

7703 Currently supported `connector_id` values are:7721 Currently supported `connector_id` values are:

7704 7722 

7705 - Dropbox: `connector_dropbox`7723 - Dropbox: `connector_dropbox`

Details

1968 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1968 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1969 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1969 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1970 1970 

1971 This field is deprecated for models released after September 1, 2026.

1972 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1973 connect through a Secure MCP Tunnel.

1974 

1971 Currently supported `connector_id` values are:1975 Currently supported `connector_id` values are:

1972 1976 

1973 - Dropbox: `connector_dropbox`1977 - Dropbox: `connector_dropbox`


3210 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3214 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3211 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3215 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3212 3216 

3217 This field is deprecated for models released after September 1, 2026.

3218 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3219 connect through a Secure MCP Tunnel.

3220 

3213 Currently supported `connector_id` values are:3221 Currently supported `connector_id` values are:

3214 3222 

3215 - Dropbox: `connector_dropbox`3223 - Dropbox: `connector_dropbox`


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

5163 with a maximum length of 512 characters.5171 with a maximum length of 512 characters.

5164 5172 

5165- `model: optional "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string`5173- `model: optional "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more or string`

5166 5174 

5167 Model ID used to generate the response, like `gpt-6-astra`. OpenAI5175 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

5168 offers a wide range of models with different capabilities, performance5176 offers a wide range of models with different capabilities, performance

5169 characteristics, and price points. Refer to the [model guide](/api/docs/models)5177 characteristics, and price points. Refer to the [model guide](/api/docs/models)

5170 to browse and compare available models.5178 to browse and compare available models.

5171 5179 

5172 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`5180 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more`

5173 5181 

5174 Model ID used to generate the response, like `gpt-6-astra`. OpenAI5182 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

5175 offers a wide range of models with different capabilities, performance5183 offers a wide range of models with different capabilities, performance


5216 5224 

5217 - `"gpt-5.1-codex"`5225 - `"gpt-5.1-codex"`

5218 5226 

5219 - `"gpt-5.1-mini"`

5220 

5221 - `"gpt-5.1-chat-latest"`5227 - `"gpt-5.1-chat-latest"`

5222 5228 

5223 - `"gpt-5"`5229 - `"gpt-5"`


5278 5284 

5279 - `"gpt-4o-2024-05-13"`5285 - `"gpt-4o-2024-05-13"`

5280 5286 

5287 - `"gpt-audio-mini"`

5288 

5289 - `"gpt-audio-mini-2025-12-15"`

5290 

5281 - `"gpt-4o-audio-preview"`5291 - `"gpt-4o-audio-preview"`

5282 5292 

5283 - `"gpt-4o-audio-preview-2024-10-01"`5293 - `"gpt-4o-audio-preview-2024-10-01"`


5476 5486 

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

5478 5488 

5479- `prompt_cache_options: optional object { comparison_response_id, mode, ttl }`5489- `prompt_cache_options: optional object { comparison_response_id, mode, prewarm, ttl }`

5480 5490 

5481 Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](/api/docs/guides/prompt-caching) for current details.5491 Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](/api/docs/guides/prompt-caching) for current details.

5482 5492 


5492 5502 

5493 - `"explicit"`5503 - `"explicit"`

5494 5504 

5505 - `prewarm: optional boolean`

5506 

5507 Prepares the prompt cache without generating output. Defaults to `false`. When set to `true`, overrides the `generate` field to `false`.

5508 

5495 - `ttl: optional "30m"`5509 - `ttl: optional "30m"`

5496 5510 

5497 The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.5511 The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.


6338 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6352 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6339 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6353 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6340 6354 

6355 This field is deprecated for models released after September 1, 2026.

6356 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6357 connect through a Secure MCP Tunnel.

6358 

6341 Currently supported `connector_id` values are:6359 Currently supported `connector_id` values are:

6342 6360 

6343 - Dropbox: `connector_dropbox`6361 - Dropbox: `connector_dropbox`


9034 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more9052 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

9035 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).9053 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

9036 9054 

9055 This field is deprecated for models released after September 1, 2026.

9056 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

9057 connect through a Secure MCP Tunnel.

9058 

9037 Currently supported `connector_id` values are:9059 Currently supported `connector_id` values are:

9038 9060 

9039 - Dropbox: `connector_dropbox`9061 - Dropbox: `connector_dropbox`


10276 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more10298 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

10277 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).10299 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

10278 10300 

10301 This field is deprecated for models released after September 1, 2026.

10302 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

10303 connect through a Secure MCP Tunnel.

10304 

10279 Currently supported `connector_id` values are:10305 Currently supported `connector_id` values are:

10280 10306 

10281 - Dropbox: `connector_dropbox`10307 - Dropbox: `connector_dropbox`


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

12213 with a maximum length of 512 characters.12239 with a maximum length of 512 characters.

12214 12240 

12215 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string`12241 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more or string`

12216 12242 

12217 Model ID used to generate the response, like `gpt-6-astra`. OpenAI12243 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

12218 offers a wide range of models with different capabilities, performance12244 offers a wide range of models with different capabilities, performance

12219 characteristics, and price points. Refer to the [model guide](/api/docs/models)12245 characteristics, and price points. Refer to the [model guide](/api/docs/models)

12220 to browse and compare available models.12246 to browse and compare available models.

12221 12247 

12222 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`12248 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more`

12223 12249 

12224 Model ID used to generate the response, like `gpt-6-astra`. OpenAI12250 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

12225 offers a wide range of models with different capabilities, performance12251 offers a wide range of models with different capabilities, performance


12266 12292 

12267 - `"gpt-5.1-codex"`12293 - `"gpt-5.1-codex"`

12268 12294 

12269 - `"gpt-5.1-mini"`

12270 

12271 - `"gpt-5.1-chat-latest"`12295 - `"gpt-5.1-chat-latest"`

12272 12296 

12273 - `"gpt-5"`12297 - `"gpt-5"`


12328 12352 

12329 - `"gpt-4o-2024-05-13"`12353 - `"gpt-4o-2024-05-13"`

12330 12354 

12355 - `"gpt-audio-mini"`

12356 

12357 - `"gpt-audio-mini-2025-12-15"`

12358 

12331 - `"gpt-4o-audio-preview"`12359 - `"gpt-4o-audio-preview"`

12332 12360 

12333 - `"gpt-4o-audio-preview-2024-10-01"`12361 - `"gpt-4o-audio-preview-2024-10-01"`


13777 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more13805 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

13778 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).13806 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

13779 13807 

13808 This field is deprecated for models released after September 1, 2026.

13809 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

13810 connect through a Secure MCP Tunnel.

13811 

13780 Currently supported `connector_id` values are:13812 Currently supported `connector_id` values are:

13781 13813 

13782 - Dropbox: `connector_dropbox`13814 - Dropbox: `connector_dropbox`


14865 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more14897 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

14866 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).14898 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

14867 14899 

14900 This field is deprecated for models released after September 1, 2026.

14901 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

14902 connect through a Secure MCP Tunnel.

14903 

14868 Currently supported `connector_id` values are:14904 Currently supported `connector_id` values are:

14869 14905 

14870 - Dropbox: `connector_dropbox`14906 - Dropbox: `connector_dropbox`


17142 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more17178 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

17143 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).17179 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

17144 17180 

17181 This field is deprecated for models released after September 1, 2026.

17182 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

17183 connect through a Secure MCP Tunnel.

17184 

17145 Currently supported `connector_id` values are:17185 Currently supported `connector_id` values are:

17146 17186 

17147 - Dropbox: `connector_dropbox`17187 - Dropbox: `connector_dropbox`

Details

2061 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2061 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2062 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2062 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2063 2063 

2064 This field is deprecated for models released after September 1, 2026.

2065 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2066 connect through a Secure MCP Tunnel.

2067 

2064 Currently supported `connector_id` values are:2068 Currently supported `connector_id` values are:

2065 2069 

2066 - Dropbox: `connector_dropbox`2070 - Dropbox: `connector_dropbox`


3303 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3307 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3304 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3308 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3305 3309 

3310 This field is deprecated for models released after September 1, 2026.

3311 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3312 connect through a Secure MCP Tunnel.

3313 

3306 Currently supported `connector_id` values are:3314 Currently supported `connector_id` values are:

3307 3315 

3308 - Dropbox: `connector_dropbox`3316 - Dropbox: `connector_dropbox`


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

5240 with a maximum length of 512 characters.5248 with a maximum length of 512 characters.

5241 5249 

5242 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string`5250 - `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more or string`

5243 5251 

5244 Model ID used to generate the response, like `gpt-6-astra`. OpenAI5252 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

5245 offers a wide range of models with different capabilities, performance5253 offers a wide range of models with different capabilities, performance

5246 characteristics, and price points. Refer to the [model guide](/api/docs/models)5254 characteristics, and price points. Refer to the [model guide](/api/docs/models)

5247 to browse and compare available models.5255 to browse and compare available models.

5248 5256 

5249 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`5257 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more`

5250 5258 

5251 Model ID used to generate the response, like `gpt-6-astra`. OpenAI5259 Model ID used to generate the response, like `gpt-6-astra`. OpenAI

5252 offers a wide range of models with different capabilities, performance5260 offers a wide range of models with different capabilities, performance


5293 5301 

5294 - `"gpt-5.1-codex"`5302 - `"gpt-5.1-codex"`

5295 5303 

5296 - `"gpt-5.1-mini"`

5297 

5298 - `"gpt-5.1-chat-latest"`5304 - `"gpt-5.1-chat-latest"`

5299 5305 

5300 - `"gpt-5"`5306 - `"gpt-5"`


5355 5361 

5356 - `"gpt-4o-2024-05-13"`5362 - `"gpt-4o-2024-05-13"`

5357 5363 

5364 - `"gpt-audio-mini"`

5365 

5366 - `"gpt-audio-mini-2025-12-15"`

5367 

5358 - `"gpt-4o-audio-preview"`5368 - `"gpt-4o-audio-preview"`

5359 5369 

5360 - `"gpt-4o-audio-preview-2024-10-01"`5370 - `"gpt-4o-audio-preview-2024-10-01"`


6804 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6814 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6805 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6815 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6806 6816 

6817 This field is deprecated for models released after September 1, 2026.

6818 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6819 connect through a Secure MCP Tunnel.

6820 

6807 Currently supported `connector_id` values are:6821 Currently supported `connector_id` values are:

6808 6822 

6809 - Dropbox: `connector_dropbox`6823 - Dropbox: `connector_dropbox`


7892 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more7906 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

7893 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).7907 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

7894 7908 

7909 This field is deprecated for models released after September 1, 2026.

7910 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

7911 connect through a Secure MCP Tunnel.

7912 

7895 Currently supported `connector_id` values are:7913 Currently supported `connector_id` values are:

7896 7914 

7897 - Dropbox: `connector_dropbox`7915 - Dropbox: `connector_dropbox`


10169 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more10187 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

10170 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).10188 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

10171 10189 

10190 This field is deprecated for models released after September 1, 2026.

10191 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

10192 connect through a Secure MCP Tunnel.

10193 

10172 Currently supported `connector_id` values are:10194 Currently supported `connector_id` values are:

10173 10195 

10174 - Dropbox: `connector_dropbox`10196 - Dropbox: `connector_dropbox`

Details

1841 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1841 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1842 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1842 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1843 1843 

1844 This field is deprecated for models released after September 1, 2026.

1845 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1846 connect through a Secure MCP Tunnel.

1847 

1844 Currently supported `connector_id` values are:1848 Currently supported `connector_id` values are:

1845 1849 

1846 - Dropbox: `connector_dropbox`1850 - Dropbox: `connector_dropbox`


3079 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3083 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3080 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3084 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3081 3085 

3086 This field is deprecated for models released after September 1, 2026.

3087 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3088 connect through a Secure MCP Tunnel.

3089 

3082 Currently supported `connector_id` values are:3090 Currently supported `connector_id` values are:

3083 3091 

3084 - Dropbox: `connector_dropbox`3092 - Dropbox: `connector_dropbox`

Details

1909 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1909 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1910 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1910 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1911 1911 

1912 This field is deprecated for models released after September 1, 2026.

1913 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1914 connect through a Secure MCP Tunnel.

1915 

1912 Currently supported `connector_id` values are:1916 Currently supported `connector_id` values are:

1913 1917 

1914 - Dropbox: `connector_dropbox`1918 - Dropbox: `connector_dropbox`


3151 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3155 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3152 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3156 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3153 3157 

3158 This field is deprecated for models released after September 1, 2026.

3159 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3160 connect through a Secure MCP Tunnel.

3161 

3154 Currently supported `connector_id` values are:3162 Currently supported `connector_id` values are:

3155 3163 

3156 - Dropbox: `connector_dropbox`3164 - Dropbox: `connector_dropbox`


5846 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more5854 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

5847 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).5855 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

5848 5856 

5857 This field is deprecated for models released after September 1, 2026.

5858 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

5859 connect through a Secure MCP Tunnel.

5860 

5849 Currently supported `connector_id` values are:5861 Currently supported `connector_id` values are:

5850 5862 

5851 - Dropbox: `connector_dropbox`5863 - Dropbox: `connector_dropbox`

Details

442 442 

443 - `"function"`443 - `"function"`

444 444 

445- `model: string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`445- `model: string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

446 446 

447 Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI447 Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI

448 offers a wide range of models with different capabilities, performance448 offers a wide range of models with different capabilities, performance


451 451 

452 - `string`452 - `string`

453 453 

454 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`454 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

455 455 

456 Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI456 Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI

457 offers a wide range of models with different capabilities, performance457 offers a wide range of models with different capabilities, performance


498 498 

499 - `"gpt-5.1-codex"`499 - `"gpt-5.1-codex"`

500 500 

501 - `"gpt-5.1-mini"`

502 

503 - `"gpt-5.1-chat-latest"`501 - `"gpt-5.1-chat-latest"`

504 502 

505 - `"gpt-5"`503 - `"gpt-5"`


560 558 

561 - `"gpt-4o-2024-05-13"`559 - `"gpt-4o-2024-05-13"`

562 560 

561 - `"gpt-audio-mini"`

562 

563 - `"gpt-audio-mini-2025-12-15"`

564 

563 - `"gpt-4o-audio-preview"`565 - `"gpt-4o-audio-preview"`

564 566 

565 - `"gpt-4o-audio-preview-2024-10-01"`567 - `"gpt-4o-audio-preview-2024-10-01"`

Details

1525 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1525 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1526 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1526 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1527 1527 

1528 This field is deprecated for models released after September 1, 2026.

1529 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1530 connect through a Secure MCP Tunnel.

1531 

1528 Currently supported `connector_id` values are:1532 Currently supported `connector_id` values are:

1529 1533 

1530 - Dropbox: `connector_dropbox`1534 - Dropbox: `connector_dropbox`


2611 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2615 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2612 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2616 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2613 2617 

2618 This field is deprecated for models released after September 1, 2026.

2619 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2620 connect through a Secure MCP Tunnel.

2621 

2614 Currently supported `connector_id` values are:2622 Currently supported `connector_id` values are:

2615 2623 

2616 - Dropbox: `connector_dropbox`2624 - Dropbox: `connector_dropbox`

Details

1552 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1552 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1553 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1553 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1554 1554 

1555 This field is deprecated for models released after September 1, 2026.

1556 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1557 connect through a Secure MCP Tunnel.

1558 

1555 Currently supported `connector_id` values are:1559 Currently supported `connector_id` values are:

1556 1560 

1557 - Dropbox: `connector_dropbox`1561 - Dropbox: `connector_dropbox`


2638 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2642 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2639 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2643 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2640 2644 

2645 This field is deprecated for models released after September 1, 2026.

2646 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2647 connect through a Secure MCP Tunnel.

2648 

2641 Currently supported `connector_id` values are:2649 Currently supported `connector_id` values are:

2642 2650 

2643 - Dropbox: `connector_dropbox`2651 - Dropbox: `connector_dropbox`


5889 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more5897 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

5890 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).5898 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

5891 5899 

5900 This field is deprecated for models released after September 1, 2026.

5901 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

5902 connect through a Secure MCP Tunnel.

5903 

5892 Currently supported `connector_id` values are:5904 Currently supported `connector_id` values are:

5893 5905 

5894 - Dropbox: `connector_dropbox`5906 - Dropbox: `connector_dropbox`


6971 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6983 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6972 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6984 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6973 6985 

6986 This field is deprecated for models released after September 1, 2026.

6987 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6988 connect through a Secure MCP Tunnel.

6989 

6974 Currently supported `connector_id` values are:6990 Currently supported `connector_id` values are:

6975 6991 

6976 - Dropbox: `connector_dropbox`6992 - Dropbox: `connector_dropbox`

Details

1622 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1622 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1623 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1623 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1624 1624 

1625 This field is deprecated for models released after September 1, 2026.

1626 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1627 connect through a Secure MCP Tunnel.

1628 

1625 Currently supported `connector_id` values are:1629 Currently supported `connector_id` values are:

1626 1630 

1627 - Dropbox: `connector_dropbox`1631 - Dropbox: `connector_dropbox`


2704 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2708 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2705 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2709 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2706 2710 

2711 This field is deprecated for models released after September 1, 2026.

2712 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2713 connect through a Secure MCP Tunnel.

2714 

2707 Currently supported `connector_id` values are:2715 Currently supported `connector_id` values are:

2708 2716 

2709 - Dropbox: `connector_dropbox`2717 - Dropbox: `connector_dropbox`

Details

1593 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1593 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1594 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1594 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1595 1595 

1596 This field is deprecated for models released after September 1, 2026.

1597 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1598 connect through a Secure MCP Tunnel.

1599 

1596 Currently supported `connector_id` values are:1600 Currently supported `connector_id` values are:

1597 1601 

1598 - Dropbox: `connector_dropbox`1602 - Dropbox: `connector_dropbox`


2675 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2679 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2676 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2680 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2677 2681 

2682 This field is deprecated for models released after September 1, 2026.

2683 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2684 connect through a Secure MCP Tunnel.

2685 

2678 Currently supported `connector_id` values are:2686 Currently supported `connector_id` values are:

2679 2687 

2680 - Dropbox: `connector_dropbox`2688 - Dropbox: `connector_dropbox`

Details

1287 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1287 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1288 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1288 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1289 1289 

1290 This field is deprecated for models released after September 1, 2026.

1291 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1292 connect through a Secure MCP Tunnel.

1293 

1290 Currently supported `connector_id` values are:1294 Currently supported `connector_id` values are:

1291 1295 

1292 - Dropbox: `connector_dropbox`1296 - Dropbox: `connector_dropbox`

Details

1277 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1277 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1278 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1278 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1279 1279 

1280 This field is deprecated for models released after September 1, 2026.

1281 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1282 connect through a Secure MCP Tunnel.

1283 

1280 Currently supported `connector_id` values are:1284 Currently supported `connector_id` values are:

1281 1285 

1282 - Dropbox: `connector_dropbox`1286 - Dropbox: `connector_dropbox`


3348 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3352 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3349 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).3353 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

3350 3354 

3355 This field is deprecated for models released after September 1, 2026.

3356 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3357 connect through a Secure MCP Tunnel.

3358 

3351 Currently supported `connector_id` values are:3359 Currently supported `connector_id` values are:

3352 3360 

3353 - Dropbox: `connector_dropbox`3361 - Dropbox: `connector_dropbox`

Details

1321 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1321 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1322 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1322 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1323 1323 

1324 This field is deprecated for models released after September 1, 2026.

1325 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1326 connect through a Secure MCP Tunnel.

1327 

1324 Currently supported `connector_id` values are:1328 Currently supported `connector_id` values are:

1325 1329 

1326 - Dropbox: `connector_dropbox`1330 - Dropbox: `connector_dropbox`

Details

1287 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1287 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1288 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1288 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1289 1289 

1290 This field is deprecated for models released after September 1, 2026.

1291 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1292 connect through a Secure MCP Tunnel.

1293 

1290 Currently supported `connector_id` values are:1294 Currently supported `connector_id` values are:

1291 1295 

1292 - Dropbox: `connector_dropbox`1296 - Dropbox: `connector_dropbox`

Details

348 -H "Content-Type: application/json" \348 -H "Content-Type: application/json" \

349 -H "Authorization: Bearer $OPENAI_API_KEY" \349 -H "Authorization: Bearer $OPENAI_API_KEY" \

350 -d '{350 -d '{

351 "model": "gpt-image-1.5",351 "model": "gpt-image-2.5-flare",

352 "prompt": "A cute baby sea otter",352 "prompt": "A cute baby sea otter",

353 "n": 1,353 "n": 1,

354 "size": "1024x1024"354 "size": "1024x1024"


384 -H "Content-Type: application/json" \384 -H "Content-Type: application/json" \

385 -H "Authorization: Bearer $OPENAI_API_KEY" \385 -H "Authorization: Bearer $OPENAI_API_KEY" \

386 -d '{386 -d '{

387 "model": "gpt-image-1.5",387 "model": "gpt-image-2.5-flare",

388 "prompt": "A cute baby sea otter",388 "prompt": "A cute baby sea otter",

389 "n": 1,389 "n": 1,

390 "size": "1024x1024",390 "size": "1024x1024",

Details

2298 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2298 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2299 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).2299 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

2300 2300 

2301 This field is deprecated for models released after September 1, 2026.

2302 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2303 connect through a Secure MCP Tunnel.

2304 

2301 Currently supported `connector_id` values are:2305 Currently supported `connector_id` values are:

2302 2306 

2303 - Dropbox: `connector_dropbox`2307 - Dropbox: `connector_dropbox`


3384 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3388 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3385 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).3389 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

3386 3390 

3391 This field is deprecated for models released after September 1, 2026.

3392 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3393 connect through a Secure MCP Tunnel.

3394 

3387 Currently supported `connector_id` values are:3395 Currently supported `connector_id` values are:

3388 3396 

3389 - Dropbox: `connector_dropbox`3397 - Dropbox: `connector_dropbox`

Details

2568 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2568 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2569 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).2569 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

2570 2570 

2571 This field is deprecated for models released after September 1, 2026.

2572 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2573 connect through a Secure MCP Tunnel.

2574 

2571 Currently supported `connector_id` values are:2575 Currently supported `connector_id` values are:

2572 2576 

2573 - Dropbox: `connector_dropbox`2577 - Dropbox: `connector_dropbox`


3654 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3658 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3655 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).3659 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

3656 3660 

3661 This field is deprecated for models released after September 1, 2026.

3662 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3663 connect through a Secure MCP Tunnel.

3664 

3657 Currently supported `connector_id` values are:3665 Currently supported `connector_id` values are:

3658 3666 

3659 - Dropbox: `connector_dropbox`3667 - Dropbox: `connector_dropbox`

Details

1987 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1987 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1988 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).1988 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

1989 1989 

1990 This field is deprecated for models released after September 1, 2026.

1991 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1992 connect through a Secure MCP Tunnel.

1993 

1990 Currently supported `connector_id` values are:1994 Currently supported `connector_id` values are:

1991 1995 

1992 - Dropbox: `connector_dropbox`1996 - Dropbox: `connector_dropbox`


3073 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more3077 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

3074 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).3078 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

3075 3079 

3080 This field is deprecated for models released after September 1, 2026.

3081 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

3082 connect through a Secure MCP Tunnel.

3083 

3076 Currently supported `connector_id` values are:3084 Currently supported `connector_id` values are:

3077 3085 

3078 - Dropbox: `connector_dropbox`3086 - Dropbox: `connector_dropbox`

Details

693 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more693 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

694 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).694 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

695 695 

696 This field is deprecated for models released after September 1, 2026.

697 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

698 connect through a Secure MCP Tunnel.

699 

696 Currently supported `connector_id` values are:700 Currently supported `connector_id` values are:

697 701 

698 - Dropbox: `connector_dropbox`702 - Dropbox: `connector_dropbox`


2686 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2690 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2687 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).2691 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

2688 2692 

2693 This field is deprecated for models released after September 1, 2026.

2694 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2695 connect through a Secure MCP Tunnel.

2696 

2689 Currently supported `connector_id` values are:2697 Currently supported `connector_id` values are:

2690 2698 

2691 - Dropbox: `connector_dropbox`2699 - Dropbox: `connector_dropbox`

Details

732 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more732 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

733 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).733 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

734 734 

735 This field is deprecated for models released after September 1, 2026.

736 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

737 connect through a Secure MCP Tunnel.

738 

735 Currently supported `connector_id` values are:739 Currently supported `connector_id` values are:

736 740 

737 - Dropbox: `connector_dropbox`741 - Dropbox: `connector_dropbox`


1744 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1748 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1745 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).1749 about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).

1746 1750 

1751 This field is deprecated for models released after September 1, 2026.

1752 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1753 connect through a Secure MCP Tunnel.

1754 

1747 Currently supported `connector_id` values are:1755 Currently supported `connector_id` values are:

1748 1756 

1749 - Dropbox: `connector_dropbox`1757 - Dropbox: `connector_dropbox`

Details

673 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more673 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

674 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).674 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

675 675 

676 This field is deprecated for models released after September 1, 2026.

677 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

678 connect through a Secure MCP Tunnel.

679 

676 Currently supported `connector_id` values are:680 Currently supported `connector_id` values are:

677 681 

678 - Dropbox: `connector_dropbox`682 - Dropbox: `connector_dropbox`

Details

706 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more706 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

707 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).707 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

708 708 

709 This field is deprecated for models released after September 1, 2026.

710 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

711 connect through a Secure MCP Tunnel.

712 

709 Currently supported `connector_id` values are:713 Currently supported `connector_id` values are:

710 714 

711 - Dropbox: `connector_dropbox`715 - Dropbox: `connector_dropbox`


1671 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1675 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1672 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1676 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1673 1677 

1678 This field is deprecated for models released after September 1, 2026.

1679 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1680 connect through a Secure MCP Tunnel.

1681 

1674 Currently supported `connector_id` values are:1682 Currently supported `connector_id` values are:

1675 1683 

1676 - Dropbox: `connector_dropbox`1684 - Dropbox: `connector_dropbox`

Details

1660 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1660 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1661 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1661 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1662 1662 

1663 This field is deprecated for models released after September 1, 2026.

1664 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1665 connect through a Secure MCP Tunnel.

1666 

1663 Currently supported `connector_id` values are:1667 Currently supported `connector_id` values are:

1664 1668 

1665 - Dropbox: `connector_dropbox`1669 - Dropbox: `connector_dropbox`


2746 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2750 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2747 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2751 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2748 2752 

2753 This field is deprecated for models released after September 1, 2026.

2754 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2755 connect through a Secure MCP Tunnel.

2756 

2749 Currently supported `connector_id` values are:2757 Currently supported `connector_id` values are:

2750 2758 

2751 - Dropbox: `connector_dropbox`2759 - Dropbox: `connector_dropbox`


4451 4459 

4452 - `string`4460 - `string`

4453 4461 

4454 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`4462 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

4455 4463 

4456 - `"gpt-6-astra"`4464 - `"gpt-6-astra"`

4457 4465 


4493 4501 

4494 - `"gpt-5.1-codex"`4502 - `"gpt-5.1-codex"`

4495 4503 

4496 - `"gpt-5.1-mini"`

4497 

4498 - `"gpt-5.1-chat-latest"`4504 - `"gpt-5.1-chat-latest"`

4499 4505 

4500 - `"gpt-5"`4506 - `"gpt-5"`


4555 4561 

4556 - `"gpt-4o-2024-05-13"`4562 - `"gpt-4o-2024-05-13"`

4557 4563 

4564 - `"gpt-audio-mini"`

4565 

4566 - `"gpt-audio-mini-2025-12-15"`

4567 

4558 - `"gpt-4o-audio-preview"`4568 - `"gpt-4o-audio-preview"`

4559 4569 

4560 - `"gpt-4o-audio-preview-2024-10-01"`4570 - `"gpt-4o-audio-preview-2024-10-01"`


5568 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more5578 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

5569 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).5579 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

5570 5580 

5581 This field is deprecated for models released after September 1, 2026.

5582 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

5583 connect through a Secure MCP Tunnel.

5584 

5571 Currently supported `connector_id` values are:5585 Currently supported `connector_id` values are:

5572 5586 

5573 - Dropbox: `connector_dropbox`5587 - Dropbox: `connector_dropbox`


6468 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6482 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6469 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6483 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6470 6484 

6485 This field is deprecated for models released after September 1, 2026.

6486 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6487 connect through a Secure MCP Tunnel.

6488 

6471 Currently supported `connector_id` values are:6489 Currently supported `connector_id` values are:

6472 6490 

6473 - Dropbox: `connector_dropbox`6491 - Dropbox: `connector_dropbox`


8437 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more8455 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

8438 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).8456 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

8439 8457 

8458 This field is deprecated for models released after September 1, 2026.

8459 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

8460 connect through a Secure MCP Tunnel.

8461 

8440 Currently supported `connector_id` values are:8462 Currently supported `connector_id` values are:

8441 8463 

8442 - Dropbox: `connector_dropbox`8464 - Dropbox: `connector_dropbox`

Details

8 8 

9### Body Parameters9### Body Parameters

10 10 

11- `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more or string or null`11- `model: "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more or string or null`

12 12 

13 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](/api/docs/models) to browse and compare available models.13 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](/api/docs/models) to browse and compare available models.

14 14 

15 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 100 more`15 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 101 more`

16 16 

17 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](/api/docs/models) to browse and compare available models.17 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](/api/docs/models) to browse and compare available models.

18 18 


56 56 

57 - `"gpt-5.1-codex"`57 - `"gpt-5.1-codex"`

58 58 

59 - `"gpt-5.1-mini"`

60 

61 - `"gpt-5.1-chat-latest"`59 - `"gpt-5.1-chat-latest"`

62 60 

63 - `"gpt-5"`61 - `"gpt-5"`


118 116 

119 - `"gpt-4o-2024-05-13"`117 - `"gpt-4o-2024-05-13"`

120 118 

119 - `"gpt-audio-mini"`

120 

121 - `"gpt-audio-mini-2025-12-15"`

122 

121 - `"gpt-4o-audio-preview"`123 - `"gpt-4o-audio-preview"`

122 124 

123 - `"gpt-4o-audio-preview-2024-10-01"`125 - `"gpt-4o-audio-preview-2024-10-01"`


1751 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1753 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1752 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1754 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1753 1755 

1756 This field is deprecated for models released after September 1, 2026.

1757 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1758 connect through a Secure MCP Tunnel.

1759 

1754 Currently supported `connector_id` values are:1760 Currently supported `connector_id` values are:

1755 1761 

1756 - Dropbox: `connector_dropbox`1762 - Dropbox: `connector_dropbox`


2837 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2843 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2838 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2844 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2839 2845 

2846 This field is deprecated for models released after September 1, 2026.

2847 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2848 connect through a Secure MCP Tunnel.

2849 

2840 Currently supported `connector_id` values are:2850 Currently supported `connector_id` values are:

2841 2851 

2842 - Dropbox: `connector_dropbox`2852 - Dropbox: `connector_dropbox`


5504 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more5514 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

5505 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).5515 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

5506 5516 

5517 This field is deprecated for models released after September 1, 2026.

5518 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

5519 connect through a Secure MCP Tunnel.

5520 

5507 Currently supported `connector_id` values are:5521 Currently supported `connector_id` values are:

5508 5522 

5509 - Dropbox: `connector_dropbox`5523 - Dropbox: `connector_dropbox`


6586 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6600 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6587 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6601 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6588 6602 

6603 This field is deprecated for models released after September 1, 2026.

6604 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6605 connect through a Secure MCP Tunnel.

6606 

6589 Currently supported `connector_id` values are:6607 Currently supported `connector_id` values are:

6590 6608 

6591 - Dropbox: `connector_dropbox`6609 - Dropbox: `connector_dropbox`

Details

1611 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1611 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1612 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1612 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1613 1613 

1614 This field is deprecated for models released after September 1, 2026.

1615 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1616 connect through a Secure MCP Tunnel.

1617 

1614 Currently supported `connector_id` values are:1618 Currently supported `connector_id` values are:

1615 1619 

1616 - Dropbox: `connector_dropbox`1620 - Dropbox: `connector_dropbox`


2697 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2701 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2698 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2702 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2699 2703 

2704 This field is deprecated for models released after September 1, 2026.

2705 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2706 connect through a Secure MCP Tunnel.

2707 

2700 Currently supported `connector_id` values are:2708 Currently supported `connector_id` values are:

2701 2709 

2702 - Dropbox: `connector_dropbox`2710 - Dropbox: `connector_dropbox`


4418 4426 

4419 - `string`4427 - `string`

4420 4428 

4421 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`4429 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

4422 4430 

4423 - `"gpt-6-astra"`4431 - `"gpt-6-astra"`

4424 4432 


4460 4468 

4461 - `"gpt-5.1-codex"`4469 - `"gpt-5.1-codex"`

4462 4470 

4463 - `"gpt-5.1-mini"`

4464 

4465 - `"gpt-5.1-chat-latest"`4471 - `"gpt-5.1-chat-latest"`

4466 4472 

4467 - `"gpt-5"`4473 - `"gpt-5"`


4522 4528 

4523 - `"gpt-4o-2024-05-13"`4529 - `"gpt-4o-2024-05-13"`

4524 4530 

4531 - `"gpt-audio-mini"`

4532 

4533 - `"gpt-audio-mini-2025-12-15"`

4534 

4525 - `"gpt-4o-audio-preview"`4535 - `"gpt-4o-audio-preview"`

4526 4536 

4527 - `"gpt-4o-audio-preview-2024-10-01"`4537 - `"gpt-4o-audio-preview-2024-10-01"`


4707 4717 

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

4709 4719 

4710- `prompt_cache_options: optional object { comparison_response_id, mode, ttl }`4720- `prompt_cache_options: optional object { comparison_response_id, mode, prewarm, ttl }`

4711 4721 

4712 Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](/api/docs/guides/prompt-caching) for current details.4722 Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](/api/docs/guides/prompt-caching) for current details.

4713 4723 


4723 4733 

4724 - `"explicit"`4734 - `"explicit"`

4725 4735 

4736 - `prewarm: optional boolean`

4737 

4738 Prepares the prompt cache without generating output. Defaults to `false`. When set to `true`, overrides the `generate` field to `false`.

4739 

4726 - `ttl: optional "30m"`4740 - `ttl: optional "30m"`

4727 4741 

4728 The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.4742 The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.


5439 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more5453 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

5440 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).5454 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

5441 5455 

5456 This field is deprecated for models released after September 1, 2026.

5457 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

5458 connect through a Secure MCP Tunnel.

5459 

5442 Currently supported `connector_id` values are:5460 Currently supported `connector_id` values are:

5443 5461 

5444 - Dropbox: `connector_dropbox`5462 - Dropbox: `connector_dropbox`


7720 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more7738 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

7721 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).7739 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

7722 7740 

7741 This field is deprecated for models released after September 1, 2026.

7742 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

7743 connect through a Secure MCP Tunnel.

7744 

7723 Currently supported `connector_id` values are:7745 Currently supported `connector_id` values are:

7724 7746 

7725 - Dropbox: `connector_dropbox`7747 - Dropbox: `connector_dropbox`


8806 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more8828 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

8807 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).8829 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

8808 8830 

8831 This field is deprecated for models released after September 1, 2026.

8832 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

8833 connect through a Secure MCP Tunnel.

8834 

8809 Currently supported `connector_id` values are:8835 Currently supported `connector_id` values are:

8810 8836 

8811 - Dropbox: `connector_dropbox`8837 - Dropbox: `connector_dropbox`


10511 10537 

10512 - `string`10538 - `string`

10513 10539 

10514 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`10540 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

10515 10541 

10516 - `"gpt-6-astra"`10542 - `"gpt-6-astra"`

10517 10543 


10553 10579 

10554 - `"gpt-5.1-codex"`10580 - `"gpt-5.1-codex"`

10555 10581 

10556 - `"gpt-5.1-mini"`

10557 

10558 - `"gpt-5.1-chat-latest"`10582 - `"gpt-5.1-chat-latest"`

10559 10583 

10560 - `"gpt-5"`10584 - `"gpt-5"`


10615 10639 

10616 - `"gpt-4o-2024-05-13"`10640 - `"gpt-4o-2024-05-13"`

10617 10641 

10642 - `"gpt-audio-mini"`

10643 

10644 - `"gpt-audio-mini-2025-12-15"`

10645 

10618 - `"gpt-4o-audio-preview"`10646 - `"gpt-4o-audio-preview"`

10619 10647 

10620 - `"gpt-4o-audio-preview-2024-10-01"`10648 - `"gpt-4o-audio-preview-2024-10-01"`


11628 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more11656 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

11629 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).11657 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

11630 11658 

11659 This field is deprecated for models released after September 1, 2026.

11660 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

11661 connect through a Secure MCP Tunnel.

11662 

11631 Currently supported `connector_id` values are:11663 Currently supported `connector_id` values are:

11632 11664 

11633 - Dropbox: `connector_dropbox`11665 - Dropbox: `connector_dropbox`


12528 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more12560 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

12529 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).12561 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

12530 12562 

12563 This field is deprecated for models released after September 1, 2026.

12564 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

12565 connect through a Secure MCP Tunnel.

12566 

12531 Currently supported `connector_id` values are:12567 Currently supported `connector_id` values are:

12532 12568 

12533 - Dropbox: `connector_dropbox`12569 - Dropbox: `connector_dropbox`


14497 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more14533 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

14498 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).14534 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

14499 14535 

14536 This field is deprecated for models released after September 1, 2026.

14537 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

14538 connect through a Secure MCP Tunnel.

14539 

14500 Currently supported `connector_id` values are:14540 Currently supported `connector_id` values are:

14501 14541 

14502 - Dropbox: `connector_dropbox`14542 - Dropbox: `connector_dropbox`

Details

1704 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1704 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1705 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1705 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1706 1706 

1707 This field is deprecated for models released after September 1, 2026.

1708 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1709 connect through a Secure MCP Tunnel.

1710 

1707 Currently supported `connector_id` values are:1711 Currently supported `connector_id` values are:

1708 1712 

1709 - Dropbox: `connector_dropbox`1713 - Dropbox: `connector_dropbox`


2790 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2794 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2791 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2795 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2792 2796 

2797 This field is deprecated for models released after September 1, 2026.

2798 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2799 connect through a Secure MCP Tunnel.

2800 

2793 Currently supported `connector_id` values are:2801 Currently supported `connector_id` values are:

2794 2802 

2795 - Dropbox: `connector_dropbox`2803 - Dropbox: `connector_dropbox`


4495 4503 

4496 - `string`4504 - `string`

4497 4505 

4498 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 81 more`4506 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`

4499 4507 

4500 - `"gpt-6-astra"`4508 - `"gpt-6-astra"`

4501 4509 


4537 4545 

4538 - `"gpt-5.1-codex"`4546 - `"gpt-5.1-codex"`

4539 4547 

4540 - `"gpt-5.1-mini"`

4541 

4542 - `"gpt-5.1-chat-latest"`4548 - `"gpt-5.1-chat-latest"`

4543 4549 

4544 - `"gpt-5"`4550 - `"gpt-5"`


4599 4605 

4600 - `"gpt-4o-2024-05-13"`4606 - `"gpt-4o-2024-05-13"`

4601 4607 

4608 - `"gpt-audio-mini"`

4609 

4610 - `"gpt-audio-mini-2025-12-15"`

4611 

4602 - `"gpt-4o-audio-preview"`4612 - `"gpt-4o-audio-preview"`

4603 4613 

4604 - `"gpt-4o-audio-preview-2024-10-01"`4614 - `"gpt-4o-audio-preview-2024-10-01"`


5612 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more5622 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

5613 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).5623 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

5614 5624 

5625 This field is deprecated for models released after September 1, 2026.

5626 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

5627 connect through a Secure MCP Tunnel.

5628 

5615 Currently supported `connector_id` values are:5629 Currently supported `connector_id` values are:

5616 5630 

5617 - Dropbox: `connector_dropbox`5631 - Dropbox: `connector_dropbox`


6512 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more6526 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

6513 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).6527 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

6514 6528 

6529 This field is deprecated for models released after September 1, 2026.

6530 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

6531 connect through a Secure MCP Tunnel.

6532 

6515 Currently supported `connector_id` values are:6533 Currently supported `connector_id` values are:

6516 6534 

6517 - Dropbox: `connector_dropbox`6535 - Dropbox: `connector_dropbox`


8481 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more8499 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

8482 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).8500 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

8483 8501 

8502 This field is deprecated for models released after September 1, 2026.

8503 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

8504 connect through a Secure MCP Tunnel.

8505 

8484 Currently supported `connector_id` values are:8506 Currently supported `connector_id` values are:

8485 8507 

8486 - Dropbox: `connector_dropbox`8508 - Dropbox: `connector_dropbox`

Details

1476 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1476 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1477 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1477 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1478 1478 

1479 This field is deprecated for models released after September 1, 2026.

1480 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1481 connect through a Secure MCP Tunnel.

1482 

1479 Currently supported `connector_id` values are:1483 Currently supported `connector_id` values are:

1480 1484 

1481 - Dropbox: `connector_dropbox`1485 - Dropbox: `connector_dropbox`


2558 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2562 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2559 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2563 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2560 2564 

2565 This field is deprecated for models released after September 1, 2026.

2566 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2567 connect through a Secure MCP Tunnel.

2568 

2561 Currently supported `connector_id` values are:2569 Currently supported `connector_id` values are:

2562 2570 

2563 - Dropbox: `connector_dropbox`2571 - Dropbox: `connector_dropbox`

Details

1552 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more1552 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

1553 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).1553 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

1554 1554 

1555 This field is deprecated for models released after September 1, 2026.

1556 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

1557 connect through a Secure MCP Tunnel.

1558 

1555 Currently supported `connector_id` values are:1559 Currently supported `connector_id` values are:

1556 1560 

1557 - Dropbox: `connector_dropbox`1561 - Dropbox: `connector_dropbox`


2638 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more2642 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

2639 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).2643 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

2640 2644 

2645 This field is deprecated for models released after September 1, 2026.

2646 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

2647 connect through a Secure MCP Tunnel.

2648 

2641 Currently supported `connector_id` values are:2649 Currently supported `connector_id` values are:

2642 2650 

2643 - Dropbox: `connector_dropbox`2651 - Dropbox: `connector_dropbox`


4963 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more4971 `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more

4964 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).4972 about service connectors [here](/api/docs/guides/tools-connectors-mcp#connectors).

4965 4973 

4974 This field is deprecated for models released after September 1, 2026.

4975 Use `server_url` to connect to a remote MCP server, or `tunnel_id` to

4976 connect through a Secure MCP Tunnel.

4977 

4966 Currently supported `connector_id` values are:4978 Currently supported `connector_id` values are:

4967 4979 

4968 - Dropbox: `connector_dropbox`4980 - Dropbox: `connector_dropbox`

Details

1## Create Webhook Endpoint

2 

3**post** `/webhook_endpoints`

4 

5Creates a webhook endpoint for the authenticated project.

6 

7### Body Parameters

8 

9- `event_types: array of "batch.completed" or "batch.failed" or "batch.expired" or 15 more`

10 

11 The event types that trigger deliveries to this endpoint.

12 

13 - `"batch.completed"`

14 

15 - `"batch.failed"`

16 

17 - `"batch.expired"`

18 

19 - `"batch.cancelled"`

20 

21 - `"response.completed"`

22 

23 - `"response.failed"`

24 

25 - `"response.cancelled"`

26 

27 - `"response.incomplete"`

28 

29 - `"eval.run.succeeded"`

30 

31 - `"eval.run.failed"`

32 

33 - `"eval.run.canceled"`

34 

35 - `"fine_tuning.job.succeeded"`

36 

37 - `"fine_tuning.job.failed"`

38 

39 - `"fine_tuning.job.cancelled"`

40 

41 - `"realtime.call.incoming"`

42 

43 - `"video.completed"`

44 

45 - `"video.failed"`

46 

47 - `"safety.alert.created"`

48 

49- `name: string`

50 

51 A human-readable name for the webhook endpoint.

52 

53- `url: string`

54 

55 The HTTPS URL that receives webhook deliveries.

56 

57### Returns

58 

59- `WebhookEndpointWithSecret object { id, created_at, event_types, 6 more }`

60 

61 - `id: string`

62 

63 The unique ID of the webhook endpoint.

64 

65 - `created_at: number`

66 

67 The Unix timestamp when the endpoint was created.

68 

69 - `event_types: array of string`

70 

71 The event types that trigger deliveries to this endpoint.

72 

73 - `name: string`

74 

75 The human-readable name of the endpoint.

76 

77 - `object: "webhook_endpoint"`

78 

79 The object type, which is always webhook_endpoint.

80 

81 - `"webhook_endpoint"`

82 

83 - `signing_secret: string`

84 

85 The endpoint's signing secret. This is returned only when the endpoint is created or the secret is rotated.

86 

87 - `signing_secret_hint: string or null`

88 

89 A masked hint for the endpoint's signing secret.

90 

91 - `url: string`

92 

93 The HTTPS URL that receives webhook deliveries.

94 

95 - `updated_at: optional number`

96 

97 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

98 

99### Example

100 

101```http

102curl https://api.openai.com/v1/webhook_endpoints \

103 -H 'Content-Type: application/json' \

104 -H "Authorization: Bearer $OPENAI_API_KEY" \

105 -d '{

106 "event_types": [

107 "batch.completed"

108 ],

109 "name": "x",

110 "url": "https://"

111 }'

112```

113 

114#### Response

115 

116```json

117{

118 "id": "id",

119 "created_at": 0,

120 "event_types": [

121 "string"

122 ],

123 "name": "name",

124 "object": "webhook_endpoint",

125 "signing_secret": "signing_secret",

126 "signing_secret_hint": "signing_secret_hint",

127 "url": "url",

128 "updated_at": 0

129}

130```

Details

1## Delete Webhook Endpoint

2 

3**delete** `/webhook_endpoints/{webhook_endpoint_id}`

4 

5Deletes a webhook endpoint for the authenticated project.

6 

7### Path Parameters

8 

9- `webhook_endpoint_id: string`

10 

11### Returns

12 

13- `DeletedWebhookEndpoint object { id, deleted, object }`

14 

15 - `id: string`

16 

17 The ID of the deleted webhook endpoint.

18 

19 - `deleted: boolean`

20 

21 Whether the endpoint was deleted.

22 

23 - `object: "webhook_endpoint.deleted"`

24 

25 The object type, which is always webhook_endpoint.deleted.

26 

27 - `"webhook_endpoint.deleted"`

28 

29### Example

30 

31```http

32curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID \

33 -X DELETE \

34 -H "Authorization: Bearer $OPENAI_API_KEY"

35```

36 

37#### Response

38 

39```json

40{

41 "id": "id",

42 "deleted": true,

43 "object": "webhook_endpoint.deleted"

44}

45```

Details

1## List Webhook Endpoints

2 

3**get** `/webhook_endpoints`

4 

5Returns webhook endpoints for the authenticated project in newest-first order.

6 

7### Query Parameters

8 

9- `after: optional string or null`

10 

11 ID of the last webhook endpoint from the previous page.

12 

13- `limit: optional number`

14 

15 Maximum number of webhook endpoints to return. Defaults to 20.

16 

17### Returns

18 

19- `WebhookEndpointList object { data, first_id, has_more, 2 more }`

20 

21 - `data: array of WebhookEndpoint`

22 

23 The webhook endpoints in this page.

24 

25 - `id: string`

26 

27 The unique ID of the webhook endpoint.

28 

29 - `created_at: number`

30 

31 The Unix timestamp when the endpoint was created.

32 

33 - `event_types: array of string`

34 

35 The event types that trigger deliveries to this endpoint.

36 

37 - `name: string`

38 

39 The human-readable name of the endpoint.

40 

41 - `object: "webhook_endpoint"`

42 

43 The object type, which is always webhook_endpoint.

44 

45 - `"webhook_endpoint"`

46 

47 - `signing_secret_hint: string or null`

48 

49 A masked hint for the endpoint's signing secret.

50 

51 - `url: string`

52 

53 The HTTPS URL that receives webhook deliveries.

54 

55 - `updated_at: optional number`

56 

57 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

58 

59 - `first_id: string or null`

60 

61 The ID of the first endpoint in this page.

62 

63 - `has_more: boolean`

64 

65 Whether more webhook endpoints are available.

66 

67 - `last_id: string or null`

68 

69 The ID of the last endpoint in this page.

70 

71 - `object: "list"`

72 

73 The object type, which is always list.

74 

75 - `"list"`

76 

77### Example

78 

79```http

80curl https://api.openai.com/v1/webhook_endpoints \

81 -H "Authorization: Bearer $OPENAI_API_KEY"

82```

83 

84#### Response

85 

86```json

87{

88 "data": [

89 {

90 "id": "id",

91 "created_at": 0,

92 "event_types": [

93 "string"

94 ],

95 "name": "name",

96 "object": "webhook_endpoint",

97 "signing_secret_hint": "signing_secret_hint",

98 "url": "url",

99 "updated_at": 0

100 }

101 ],

102 "first_id": "first_id",

103 "has_more": true,

104 "last_id": "last_id",

105 "object": "list"

106}

107```

Details

1## Retrieve Webhook Endpoint

2 

3**get** `/webhook_endpoints/{webhook_endpoint_id}`

4 

5Retrieves a webhook endpoint for the authenticated project.

6 

7### Path Parameters

8 

9- `webhook_endpoint_id: string`

10 

11### Returns

12 

13- `WebhookEndpoint object { id, created_at, event_types, 5 more }`

14 

15 - `id: string`

16 

17 The unique ID of the webhook endpoint.

18 

19 - `created_at: number`

20 

21 The Unix timestamp when the endpoint was created.

22 

23 - `event_types: array of string`

24 

25 The event types that trigger deliveries to this endpoint.

26 

27 - `name: string`

28 

29 The human-readable name of the endpoint.

30 

31 - `object: "webhook_endpoint"`

32 

33 The object type, which is always webhook_endpoint.

34 

35 - `"webhook_endpoint"`

36 

37 - `signing_secret_hint: string or null`

38 

39 A masked hint for the endpoint's signing secret.

40 

41 - `url: string`

42 

43 The HTTPS URL that receives webhook deliveries.

44 

45 - `updated_at: optional number`

46 

47 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

48 

49### Example

50 

51```http

52curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID \

53 -H "Authorization: Bearer $OPENAI_API_KEY"

54```

55 

56#### Response

57 

58```json

59{

60 "id": "id",

61 "created_at": 0,

62 "event_types": [

63 "string"

64 ],

65 "name": "name",

66 "object": "webhook_endpoint",

67 "signing_secret_hint": "signing_secret_hint",

68 "url": "url",

69 "updated_at": 0

70}

71```

Details

1## Rotate Webhook Endpoint Signing Secret

2 

3**post** `/webhook_endpoints/{webhook_endpoint_id}/rotate_secret`

4 

5Rotates the signing secret for a webhook endpoint in the authenticated project.

6 

7### Path Parameters

8 

9- `webhook_endpoint_id: string`

10 

11### Body Parameters

12 

13- `keep_old_secret_active_for_24_hours: optional boolean`

14 

15 Whether to keep the previous signing secret valid for 24 hours after rotation. Defaults to false, which invalidates the previous secret immediately.

16 

17### Returns

18 

19- `WebhookEndpointWithSecret object { id, created_at, event_types, 6 more }`

20 

21 - `id: string`

22 

23 The unique ID of the webhook endpoint.

24 

25 - `created_at: number`

26 

27 The Unix timestamp when the endpoint was created.

28 

29 - `event_types: array of string`

30 

31 The event types that trigger deliveries to this endpoint.

32 

33 - `name: string`

34 

35 The human-readable name of the endpoint.

36 

37 - `object: "webhook_endpoint"`

38 

39 The object type, which is always webhook_endpoint.

40 

41 - `"webhook_endpoint"`

42 

43 - `signing_secret: string`

44 

45 The endpoint's signing secret. This is returned only when the endpoint is created or the secret is rotated.

46 

47 - `signing_secret_hint: string or null`

48 

49 A masked hint for the endpoint's signing secret.

50 

51 - `url: string`

52 

53 The HTTPS URL that receives webhook deliveries.

54 

55 - `updated_at: optional number`

56 

57 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

58 

59### Example

60 

61```http

62curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID/rotate_secret \

63 -X POST \

64 -H "Authorization: Bearer $OPENAI_API_KEY"

65```

66 

67#### Response

68 

69```json

70{

71 "id": "id",

72 "created_at": 0,

73 "event_types": [

74 "string"

75 ],

76 "name": "name",

77 "object": "webhook_endpoint",

78 "signing_secret": "signing_secret",

79 "signing_secret_hint": "signing_secret_hint",

80 "url": "url",

81 "updated_at": 0

82}

83```

Details

1## Test Webhook Endpoint

2 

3**post** `/webhook_endpoints/{webhook_endpoint_id}/test`

4 

5Sends a sample event to a webhook endpoint for the authenticated project.

6 

7### Path Parameters

8 

9- `webhook_endpoint_id: string`

10 

11### Body Parameters

12 

13- `event_type: "batch.completed" or "batch.failed" or "batch.expired" or 15 more`

14 

15 The event type to send as a sample delivery.

16 

17 - `"batch.completed"`

18 

19 - `"batch.failed"`

20 

21 - `"batch.expired"`

22 

23 - `"batch.cancelled"`

24 

25 - `"response.completed"`

26 

27 - `"response.failed"`

28 

29 - `"response.cancelled"`

30 

31 - `"response.incomplete"`

32 

33 - `"eval.run.succeeded"`

34 

35 - `"eval.run.failed"`

36 

37 - `"eval.run.canceled"`

38 

39 - `"fine_tuning.job.succeeded"`

40 

41 - `"fine_tuning.job.failed"`

42 

43 - `"fine_tuning.job.cancelled"`

44 

45 - `"realtime.call.incoming"`

46 

47 - `"video.completed"`

48 

49 - `"video.failed"`

50 

51 - `"safety.alert.created"`

52 

53### Returns

54 

55- `WebhookEndpointTestResult object { event_type, object, status_code, 2 more }`

56 

57 - `event_type: string`

58 

59 The event type sent in the test.

60 

61 - `object: "webhook_endpoint.test"`

62 

63 The object type, which is always webhook_endpoint.test.

64 

65 - `"webhook_endpoint.test"`

66 

67 - `status_code: number`

68 

69 The HTTP status code returned by the endpoint.

70 

71 - `success: true`

72 

73 Whether the test request completed. Always true for returned results; use status_code to determine the endpoint response.

74 

75 - `true`

76 

77 - `webhook_endpoint_id: string`

78 

79 The ID of the webhook endpoint that received the test.

80 

81### Example

82 

83```http

84curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID/test \

85 -H 'Content-Type: application/json' \

86 -H "Authorization: Bearer $OPENAI_API_KEY" \

87 -d '{

88 "event_type": "batch.completed"

89 }'

90```

91 

92#### Response

93 

94```json

95{

96 "event_type": "event_type",

97 "object": "webhook_endpoint.test",

98 "status_code": 0,

99 "success": true,

100 "webhook_endpoint_id": "webhook_endpoint_id"

101}

102```

Details

1## Update Webhook Endpoint

2 

3**post** `/webhook_endpoints/{webhook_endpoint_id}`

4 

5Updates a webhook endpoint for the authenticated project.

6 

7### Path Parameters

8 

9- `webhook_endpoint_id: string`

10 

11### Body Parameters

12 

13- `event_types: optional array of "batch.completed" or "batch.failed" or "batch.expired" or 15 more`

14 

15 The complete set of event types that should trigger deliveries.

16 

17 - `"batch.completed"`

18 

19 - `"batch.failed"`

20 

21 - `"batch.expired"`

22 

23 - `"batch.cancelled"`

24 

25 - `"response.completed"`

26 

27 - `"response.failed"`

28 

29 - `"response.cancelled"`

30 

31 - `"response.incomplete"`

32 

33 - `"eval.run.succeeded"`

34 

35 - `"eval.run.failed"`

36 

37 - `"eval.run.canceled"`

38 

39 - `"fine_tuning.job.succeeded"`

40 

41 - `"fine_tuning.job.failed"`

42 

43 - `"fine_tuning.job.cancelled"`

44 

45 - `"realtime.call.incoming"`

46 

47 - `"video.completed"`

48 

49 - `"video.failed"`

50 

51 - `"safety.alert.created"`

52 

53- `name: optional string`

54 

55 A new human-readable name for the webhook endpoint.

56 

57- `url: optional string`

58 

59 A new HTTPS URL that receives webhook deliveries.

60 

61### Returns

62 

63- `WebhookEndpoint object { id, created_at, event_types, 5 more }`

64 

65 - `id: string`

66 

67 The unique ID of the webhook endpoint.

68 

69 - `created_at: number`

70 

71 The Unix timestamp when the endpoint was created.

72 

73 - `event_types: array of string`

74 

75 The event types that trigger deliveries to this endpoint.

76 

77 - `name: string`

78 

79 The human-readable name of the endpoint.

80 

81 - `object: "webhook_endpoint"`

82 

83 The object type, which is always webhook_endpoint.

84 

85 - `"webhook_endpoint"`

86 

87 - `signing_secret_hint: string or null`

88 

89 A masked hint for the endpoint's signing secret.

90 

91 - `url: string`

92 

93 The HTTPS URL that receives webhook deliveries.

94 

95 - `updated_at: optional number`

96 

97 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

98 

99### Example

100 

101```http

102curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID \

103 -X POST \

104 -H "Authorization: Bearer $OPENAI_API_KEY"

105```

106 

107#### Response

108 

109```json

110{

111 "id": "id",

112 "created_at": 0,

113 "event_types": [

114 "string"

115 ],

116 "name": "name",

117 "object": "webhook_endpoint",

118 "signing_secret_hint": "signing_secret_hint",

119 "url": "url",

120 "updated_at": 0

121}

122```

Details

1## List Webhook Event Types

2 

3**get** `/webhook_event_types`

4 

5Returns webhook event types visible to the authenticated project.

6 

7### Returns

8 

9- `WebhookEventTypeList object { data, object }`

10 

11 - `data: array of string`

12 

13 The webhook event types available to the authenticated project.

14 

15 - `object: "list"`

16 

17 The object type, which is always list.

18 

19 - `"list"`

20 

21### Example

22 

23```http

24curl https://api.openai.com/v1/webhook_event_types \

25 -H "Authorization: Bearer $OPENAI_API_KEY"

26```

27 

28#### Response

29 

30```json

31{

32 "data": [

33 "string"

34 ],

35 "object": "list"

36}

37```