Reference 2026-08-18 22:02 UTC to 2026-08-19 21:01 UTC

645 645 

646To handle errors, we recommend that you use the `errors.As` pattern:646To handle errors, we recommend that you use the `errors.As` pattern:

647 647 

648> [!WARNING]

649> `Error.DumpRequest`, `Error.DumpResponse`, and `Error.Error` expose raw

650> diagnostics that may include authorization headers, credentials in URLs, and

651> sensitive request or response bodies. The dump `body` option does not redact

652> headers. Sanitize this output before logging, sharing, or storing it.

653 

648```go654```go

649_, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{655_, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{

650 Model: openai.FineTuningJobNewParamsModel("gpt-4o"),656 Model: openai.FineTuningJobNewParamsModel("gpt-4o"),

653if err != nil {659if err != nil {

654 var apierr *openai.Error660 var apierr *openai.Error

655 if errors.As(err, &apierr) {661 if errors.As(err, &apierr) {

656 println(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request662 fmt.Printf("OpenAI API error (status: %d)\n", apierr.StatusCode)

657 println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response

658 }663 }

659 panic(err.Error()) // GET "/fine_tuning/jobs": 400 Bad Request { ... }664 panic("OpenAI request failed")

660}665}

661```666```

662 667 

22227 "kind": "HttpTypeString"22227 "kind": "HttpTypeString"

22228 },22228 },

22229 "constraints": {22229 "constraints": {

22230 "maxLength": 1048576022230 "maxLength": 20971520

22231 },22231 },

22232 "optional": false,22232 "optional": false,

22233 "nullable": false,22233 "nullable": false,

86244 "kind": "HttpTypeString"86244 "kind": "HttpTypeString"

86245 },86245 },

86246 "constraints": {86246 "constraints": {

86247 "maxLength": 1048576086247 "maxLength": 20971520

86248 },86248 },

86249 "optional": false,86249 "optional": false,

86250 "nullable": false,86250 "nullable": false,

150261 "kind": "HttpTypeString"150261 "kind": "HttpTypeString"

150262 },150262 },

150263 "constraints": {150263 "constraints": {

150264 "maxLength": 10485760150264 "maxLength": 20971520

150265 },150265 },

150266 "optional": false,150266 "optional": false,

150267 "nullable": false,150267 "nullable": false,

214295 "kind": "HttpTypeString"214295 "kind": "HttpTypeString"

214296 },214296 },

214297 "constraints": {214297 "constraints": {

214298 "maxLength": 10485760214298 "maxLength": 20971520

214299 },214299 },

214300 "optional": false,214300 "optional": false,

214301 "nullable": false,214301 "nullable": false,

278310 "kind": "HttpTypeString"278310 "kind": "HttpTypeString"

278311 },278311 },

278312 "constraints": {278312 "constraints": {

278313 "maxLength": 10485760278313 "maxLength": 20971520

278314 },278314 },

278315 "optional": false,278315 "optional": false,

278316 "nullable": false,278316 "nullable": false,

407283 "kind": "HttpTypeString"407283 "kind": "HttpTypeString"

407284 },407284 },

407285 "constraints": {407285 "constraints": {

407286 "maxLength": 10485760407286 "maxLength": 20971520

407287 },407287 },

407288 "optional": false,407288 "optional": false,

407289 "nullable": false,407289 "nullable": false,

13888 "kind": "HttpTypeString"13888 "kind": "HttpTypeString"

13889 },13889 },

13890 "constraints": {13890 "constraints": {

13891 "maxLength": 1048576013891 "maxLength": 20971520

13892 },13892 },

13893 "optional": false,13893 "optional": false,

13894 "nullable": false,13894 "nullable": false,

45552 "kind": "HttpTypeString"45552 "kind": "HttpTypeString"

45553 },45553 },

45554 "constraints": {45554 "constraints": {

45555 "maxLength": 1048576045555 "maxLength": 20971520

45556 },45556 },

45557 "optional": false,45557 "optional": false,

45558 "nullable": false,45558 "nullable": false,

74581 "kind": "HttpTypeString"74581 "kind": "HttpTypeString"

74582 },74582 },

74583 "constraints": {74583 "constraints": {

74584 "maxLength": 1048576074584 "maxLength": 20971520

74585 },74585 },

74586 "optional": false,74586 "optional": false,

74587 "nullable": false,74587 "nullable": false,

119703 "kind": "HttpTypeString"119703 "kind": "HttpTypeString"

119704 },119704 },

119705 "constraints": {119705 "constraints": {

119706 "maxLength": 10485760119706 "maxLength": 20971520

119707 },119707 },

119708 "optional": false,119708 "optional": false,

119709 "nullable": false,119709 "nullable": false,

183755 "kind": "HttpTypeString"183755 "kind": "HttpTypeString"

183756 },183756 },

183757 "constraints": {183757 "constraints": {

183758 "maxLength": 10485760183758 "maxLength": 20971520

183759 },183759 },

183760 "optional": false,183760 "optional": false,

183761 "nullable": false,183761 "nullable": false,

247807 "kind": "HttpTypeString"247807 "kind": "HttpTypeString"

247808 },247808 },

247809 "constraints": {247809 "constraints": {

247810 "maxLength": 10485760247810 "maxLength": 20971520

247811 },247811 },

247812 "optional": false,247812 "optional": false,

247813 "nullable": false,247813 "nullable": false,

311876 "kind": "HttpTypeString"311876 "kind": "HttpTypeString"

311877 },311877 },

311878 "constraints": {311878 "constraints": {

311879 "maxLength": 10485760311879 "maxLength": 20971520

311880 },311880 },

311881 "optional": false,311881 "optional": false,

311882 "nullable": false,311882 "nullable": false,

375926 "kind": "HttpTypeString"375926 "kind": "HttpTypeString"

375927 },375927 },

375928 "constraints": {375928 "constraints": {

375929 "maxLength": 10485760375929 "maxLength": 20971520

375930 },375930 },

375931 "optional": false,375931 "optional": false,

375932 "nullable": false,375932 "nullable": false,

506334 "kind": "HttpTypeString"506334 "kind": "HttpTypeString"

506335 },506335 },

506336 "constraints": {506336 "constraints": {

506337 "maxLength": 10485760506337 "maxLength": 20971520

506338 },506338 },

506339 "optional": false,506339 "optional": false,

506340 "nullable": false,506340 "nullable": false,

5683 5683 

5684### Chat Completion Chunk5684### Chat Completion Chunk

5685 5685 

5686- `ChatCompletionChunk object { id, choices, created, 6 more }`5686- `ChatCompletionChunk object { id, choices, created, 7 more }`

5687 5687 

5688 Represents a streamed chunk of a chat completion response returned5688 Represents a streamed chunk of a chat completion response returned

5689 by the model, based on the provided input.5689 by the model, based on the provided input.

5996 5996 

5997 - `"error"`5997 - `"error"`

5998 5998 

5999 - `obfuscation: optional string`

6000 

6001 An obfuscation string added to normalize the size of streamed chunks as a

6002 mitigation to certain side-channel attacks. The field is included by

6003 default and omitted when `stream_options.include_obfuscation` is `false`.

6004 

5999 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`6005 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`

6000 6006 

6001 Specifies the processing type used for serving the request.6007 Specifies the processing type used for serving the request.

5681 5681 

5682### Chat Completion Chunk5682### Chat Completion Chunk

5683 5683 

5684- `ChatCompletionChunk object { id, choices, created, 6 more }`5684- `ChatCompletionChunk object { id, choices, created, 7 more }`

5685 5685 

5686 Represents a streamed chunk of a chat completion response returned5686 Represents a streamed chunk of a chat completion response returned

5687 by the model, based on the provided input.5687 by the model, based on the provided input.

5994 5994 

5995 - `"error"`5995 - `"error"`

5996 5996 

5997 - `obfuscation: optional string`

5998 

5999 An obfuscation string added to normalize the size of streamed chunks as a

6000 mitigation to certain side-channel attacks. The field is included by

6001 default and omitted when `stream_options.include_obfuscation` is `false`.

6002 

5997 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`6003 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null`

5998 6004 

5999 Specifies the processing type used for serving the request.6005 Specifies the processing type used for serving the request.

44 {44 {

45 "ident": "moderation"45 "ident": "moderation"

46 },46 },

47 {

48 "ident": "obfuscation"

49 },

47 {50 {

48 "ident": "service_tier"51 "ident": "service_tier"

49 },52 },

63 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) model",66 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) model",

64 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) object",67 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) object",

65 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation",68 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation",

69 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) obfuscation",

66 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) service_tier",70 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) service_tier",

67 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) system_fingerprint",71 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) system_fingerprint",

68 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) usage"72 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) usage"

201 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output"205 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output"

202 ]206 ]

203 },207 },

208 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) obfuscation": {

209 "kind": "HttpDeclProperty",

210 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/obfuscation",

211 "deprecated": false,

212 "key": "obfuscation",

213 "docstring": "An obfuscation string added to normalize the size of streamed chunks as a\nmitigation to certain side-channel attacks. The field is included by\ndefault and omitted when `stream_options.include_obfuscation` is `false`.\n",

214 "type": {

215 "kind": "HttpTypeString"

216 },

217 "optional": true,

218 "nullable": false,

219 "schemaType": "string",

220 "children": []

221 },

204 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) service_tier": {222 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) service_tier": {

205 "kind": "HttpDeclProperty",223 "kind": "HttpDeclProperty",

206 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/service_tier",224 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/service_tier",

2152### Example2170### Example

2153 2171 

2154```json2172```json

2155{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]}2173{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}],"obfuscation":"r4N7vQ2m"}

2156 2174 

2157{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}]}2175{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}],"obfuscation":"p9K3xT6w"}

2158 2176 

2159....2177....

2160 2178 

2161{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}2179{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}],"obfuscation":""}

2162```2180```

19480 "kind": "HttpTypeString"19480 "kind": "HttpTypeString"

19481 },19481 },

19482 "constraints": {19482 "constraints": {

19483 "maxLength": 1048576019483 "maxLength": 20971520

19484 },19484 },

19485 "optional": false,19485 "optional": false,

19486 "nullable": false,19486 "nullable": false,

73596 "kind": "HttpTypeString"73596 "kind": "HttpTypeString"

73597 },73597 },

73598 "constraints": {73598 "constraints": {

73599 "maxLength": 1048576073599 "maxLength": 20971520

73600 },73600 },

73601 "optional": false,73601 "optional": false,

73602 "nullable": false,73602 "nullable": false,

127712 "kind": "HttpTypeString"127712 "kind": "HttpTypeString"

127713 },127713 },

127714 "constraints": {127714 "constraints": {

127715 "maxLength": 10485760127715 "maxLength": 20971520

127716 },127716 },

127717 "optional": false,127717 "optional": false,

127718 "nullable": false,127718 "nullable": false,

181845 "kind": "HttpTypeString"181845 "kind": "HttpTypeString"

181846 },181846 },

181847 "constraints": {181847 "constraints": {

181848 "maxLength": 10485760181848 "maxLength": 20971520

181849 },181849 },

181850 "optional": false,181850 "optional": false,

181851 "nullable": false,181851 "nullable": false,

235959 "kind": "HttpTypeString"235959 "kind": "HttpTypeString"

235960 },235960 },

235961 "constraints": {235961 "constraints": {

235962 "maxLength": 10485760235962 "maxLength": 20971520

235963 },235963 },

235964 "optional": false,235964 "optional": false,

235965 "nullable": false,235965 "nullable": false,

345447 "kind": "HttpTypeString"345447 "kind": "HttpTypeString"

345448 },345448 },

345449 "constraints": {345449 "constraints": {

345450 "maxLength": 10485760345450 "maxLength": 20971520

345451 },345451 },

345452 "optional": false,345452 "optional": false,

345453 "nullable": false,345453 "nullable": false,

12594 "kind": "HttpTypeString"12594 "kind": "HttpTypeString"

12595 },12595 },

12596 "constraints": {12596 "constraints": {

12597 "maxLength": 1048576012597 "maxLength": 20971520

12598 },12598 },

12599 "optional": false,12599 "optional": false,

12600 "nullable": false,12600 "nullable": false,

54398 "kind": "HttpTypeString"54398 "kind": "HttpTypeString"

54399 },54399 },

54400 "constraints": {54400 "constraints": {

54401 "maxLength": 1048576054401 "maxLength": 20971520

54402 },54402 },

54403 "optional": false,54403 "optional": false,

54404 "nullable": false,54404 "nullable": false,

108549 "kind": "HttpTypeString"108549 "kind": "HttpTypeString"

108550 },108550 },

108551 "constraints": {108551 "constraints": {

108552 "maxLength": 10485760108552 "maxLength": 20971520

108553 },108553 },

108554 "optional": false,108554 "optional": false,

108555 "nullable": false,108555 "nullable": false,

162700 "kind": "HttpTypeString"162700 "kind": "HttpTypeString"

162701 },162701 },

162702 "constraints": {162702 "constraints": {

162703 "maxLength": 10485760162703 "maxLength": 20971520

162704 },162704 },

162705 "optional": false,162705 "optional": false,

162706 "nullable": false,162706 "nullable": false,

216868 "kind": "HttpTypeString"216868 "kind": "HttpTypeString"

216869 },216869 },

216870 "constraints": {216870 "constraints": {

216871 "maxLength": 10485760216871 "maxLength": 20971520

216872 },216872 },

216873 "optional": false,216873 "optional": false,

216874 "nullable": false,216874 "nullable": false,

271017 "kind": "HttpTypeString"271017 "kind": "HttpTypeString"

271018 },271018 },

271019 "constraints": {271019 "constraints": {

271020 "maxLength": 10485760271020 "maxLength": 20971520

271021 },271021 },

271022 "optional": false,271022 "optional": false,

271023 "nullable": false,271023 "nullable": false,

381940 "kind": "HttpTypeString"381940 "kind": "HttpTypeString"

381941 },381941 },

381942 "constraints": {381942 "constraints": {

381943 "maxLength": 10485760381943 "maxLength": 20971520

381944 },381944 },

381945 "optional": false,381945 "optional": false,

381946 "nullable": false,381946 "nullable": false,

938)938)

939```939```

940 940 

941Generic requests use the ordinary API key when one is configured, even if an

942admin API key is also available. A client configured with only an admin API key

943uses that key. To explicitly use an admin API key when both credentials are

944configured, pass `security: {admin_api_key_auth: true}` to `client.request`.

945 

941### Concurrency & connection pooling946### Concurrency & connection pooling

942 947 

943`OpenAI::Client` instances using the default `OpenAI::NetHTTPClient` are threadsafe, but are only fork-safe when there are no in-flight HTTP requests. Injected HTTP clients are responsible for documenting and enforcing their own concurrency guarantees.948`OpenAI::Client` instances using the default `OpenAI::NetHTTPClient` are threadsafe, but are only fork-safe when there are no in-flight HTTP requests. Injected HTTP clients are responsible for documenting and enforcing their own concurrency guarantees.