4193 4193
4194 Optional version of the prompt template.4194 Optional version of the prompt template.
4195 4195
4196 - `prompt_cache_key?: string`4196 - `prompt_cache_key?: string | null`
4197 4197
4198 Body param: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).4198 Body param: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
4199 4199
4244 - `context?: "auto" | "current_turn" | "all_turns" | null`4244 - `context?: "auto" | "current_turn" | "all_turns" | null`
4245 4245
4246 Controls which reasoning items are rendered back to the model on later turns.4246 Controls which reasoning items are rendered back to the model on later turns.
4247 If omitted or set to `auto`, the model determines the context mode. The
4248 `gpt-5.6` model family defaults to `all_turns`; earlier models default to
4249 `current_turn`.
4250
4247 When returned on a response, this is the effective reasoning context mode4251 When returned on a response, this is the effective reasoning context mode
4248 used for the response.4252 used for the response.
4249 4253
4319 4323
4320 - `"detailed"`4324 - `"detailed"`
4321 4325
4322 - `safety_identifier?: string`4326 - `safety_identifier?: string | null`
4323 4327
4324 Body param: A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.4328 Body param: A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.
4325 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).4329 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
4463 4467
4464 Constrains the verbosity of the model's response. Lower values will result in4468 Constrains the verbosity of the model's response. Lower values will result in
4465 more concise responses, while higher values will result in more verbose responses.4469 more concise responses, while higher values will result in more verbose responses.
4466 Currently supported values are `low`, `medium`, and `high`.4470 Currently supported values are `low`, `medium`, and `high`. The default is
4471 `medium`.
4467 4472
4468 - `"low"`4473 - `"low"`
4469 4474
4803 4808
4804 An error object returned when the model fails to generate a Response.4809 An error object returned when the model fails to generate a Response.
4805 4810
4806 - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt" | 16 more`4811 - `code: "server_error" | "rate_limit_exceeded" | "invalid_prompt" | 17 more`
4807 4812
4808 The error code for the response.4813 The error code for the response.
4809 4814
4813 4818
4814 - `"invalid_prompt"`4819 - `"invalid_prompt"`
4815 4820
4821 - `"data_residency_mismatch"`
4822
4816 - `"bio_policy"`4823 - `"bio_policy"`
4817 4824
4818 - `"vector_store_timeout"`4825 - `"vector_store_timeout"`
10860 10867
10861 Optional version of the prompt template.10868 Optional version of the prompt template.
10862 10869
10863 - `prompt_cache_key?: string`10870 - `prompt_cache_key?: string | null`
10864 10871
10865 Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).10872 Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
10866 10873
10911 - `context?: "auto" | "current_turn" | "all_turns" | null`10918 - `context?: "auto" | "current_turn" | "all_turns" | null`
10912 10919
10913 Controls which reasoning items are rendered back to the model on later turns.10920 Controls which reasoning items are rendered back to the model on later turns.
10921 If omitted or set to `auto`, the model determines the context mode. The
10922 `gpt-5.6` model family defaults to `all_turns`; earlier models default to
10923 `current_turn`.
10924
10914 When returned on a response, this is the effective reasoning context mode10925 When returned on a response, this is the effective reasoning context mode
10915 used for the response.10926 used for the response.
10916 10927
10986 10997
10987 - `"detailed"`10998 - `"detailed"`
10988 10999
10989 - `safety_identifier?: string`11000 - `safety_identifier?: string | null`
10990 11001
10991 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.11002 A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.
10992 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).11003 The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
11114 11125
11115 Constrains the verbosity of the model's response. Lower values will result in11126 Constrains the verbosity of the model's response. Lower values will result in
11116 more concise responses, while higher values will result in more verbose responses.11127 more concise responses, while higher values will result in more verbose responses.
11117 Currently supported values are `low`, `medium`, and `high`.11128 Currently supported values are `low`, `medium`, and `high`. The default is
11129 `medium`.
11118 11130
11119 - `"low"`11131 - `"low"`
11120 11132
11440 "usage": {11452 "usage": {
11441 "input_tokens": 36,11453 "input_tokens": 36,
11442 "input_tokens_details": {11454 "input_tokens_details": {
11443 "cached_tokens": 011455 "cached_tokens": 0,
11456 "cache_write_tokens": 0
11444 },11457 },
11445 "output_tokens": 87,11458 "output_tokens": 87,
11446 "output_tokens_details": {11459 "output_tokens_details": {
11529 "usage": {11542 "usage": {
11530 "input_tokens": 328,11543 "input_tokens": 328,
11531 "input_tokens_details": {11544 "input_tokens_details": {
11532 "cached_tokens": 011545 "cached_tokens": 0,
11546 "cache_write_tokens": 0
11533 },11547 },
11534 "output_tokens": 52,11548 "output_tokens": 52,
11535 "output_tokens_details": {11549 "output_tokens_details": {
11623 "usage": {11637 "usage": {
11624 "input_tokens": 8438,11638 "input_tokens": 8438,
11625 "input_tokens_details": {11639 "input_tokens_details": {
11626 "cached_tokens": 011640 "cached_tokens": 0,
11641 "cache_write_tokens": 0
11627 },11642 },
11628 "output_tokens": 398,11643 "output_tokens": 398,
11629 "output_tokens_details": {11644 "output_tokens_details": {
11741 "usage": {11756 "usage": {
11742 "input_tokens": 328,11757 "input_tokens": 328,
11743 "input_tokens_details": {11758 "input_tokens_details": {
11744 "cached_tokens": 011759 "cached_tokens": 0,
11760 "cache_write_tokens": 0
11745 },11761 },
11746 "output_tokens": 356,11762 "output_tokens": 356,
11747 "output_tokens_details": {11763 "output_tokens_details": {
11894 "usage": {11910 "usage": {
11895 "input_tokens": 18307,11911 "input_tokens": 18307,
11896 "input_tokens_details": {11912 "input_tokens_details": {
11897 "cached_tokens": 011913 "cached_tokens": 0,
11914 "cache_write_tokens": 0
11898 },11915 },
11899 "output_tokens": 348,11916 "output_tokens": 348,
11900 "output_tokens_details": {11917 "output_tokens_details": {
12142 "usage": {12159 "usage": {
12143 "input_tokens": 81,12160 "input_tokens": 81,
12144 "input_tokens_details": {12161 "input_tokens_details": {
12145 "cached_tokens": 012162 "cached_tokens": 0,
12163 "cache_write_tokens": 0
12146 },12164 },
12147 "output_tokens": 1035,12165 "output_tokens": 1035,
12148 "output_tokens_details": {12166 "output_tokens_details": {