[BUG] Streaming Error Event Format Mismatch #881

Activity

1. TheGrayFrost

   added

   needs-triageWorkflow: This is a new issue that needs to be triaged.Workflow: This is a new issue that needs to be triaged.

   on Dec 19, 2025
2. ShivangiReja commented on Dec 20, 2025

   

   ShivangiReja

   on Dec 20, 2025

   Last edited by ShivangiReja

   Contributor

   More actions

   Hi @TheGrayFrost, thanks for reaching out. I tried reproducing this and you’re right. The API documentation and the REST API spec currently describes the error event in this flat format:

   {
     "type": "error",
     "code": "ERR_SOMETHING",
     "message": "Something went wrong",
     "param": "input",
     "sequence_number": 1
   }

   However, the service is returning a nested format like this:

   {
     "type": "error",
     "sequence_number": 2,
     "error": {
       "type": "invalid_request_error",
       "code": "context_length_exceeded",
       "message": "Your input exceeds the context window of this model. Please adjust your input and try again.",
       "param": "input"
     }
   }

   Because StreamingResponseErrorUpdate.Serialization.cs expects code, message, and param at the root level, deserialization fails and these properties remain null.

   In this case, it appears that the OpenAI service is not honoring its public contract and is intermittently returning an incorrect error response. This behavior is on the service-side, the client library has no insight nor influence over it. Unfortunately, OpenAI does not offer service support from this repository. The most reliable and direct way to get support is by reaching out to the OpenAI Support Team. You can either email [email protected] or start a new chat session via the Help Center. The OpenAI support team is available 24/7 and is equipped to assist with the full range of requests.

   In the meantime, you can access the fields via the Patch property.

   Example:

   var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY");
   ResponsesClient client = new(model: "gpt-5", apiKey: apiKey);
   
   int repeats = 2000000;
   var sb = new StringBuilder(capacity: repeats * 2);
   for (int i = 0; i < repeats; i++) sb.Append("x ");
   string oversizedPrompt = sb.ToString();
   
   CollectionResult<StreamingResponseUpdate> responseUpdates = client.CreateResponseStreaming(oversizedPrompt);
   
   foreach (StreamingResponseUpdate update in responseUpdates)
   {
       if (update is StreamingResponseErrorUpdate err)
       {
           var type = err.Patch.GetString("$.error.type"u8);
           var code = err.Patch.GetString("$.error.code"u8);
           var message = err.Patch.GetString("$.error.message"u8);
           var param = err.Patch.GetString("$.error.param"u8);
   
           Console.WriteLine($"[STREAM ERROR] type={type} code={code} param={param} message={message}");
       }
   }
3. ShivangiReja

   added

   blocked: upstreamThis issue is blocked on an upstream change, such as to the REST API spec or generator.This issue is blocked on an upstream change, such as to the REST API spec or generator.

   on Dec 20, 2025
4. stephentoub commented on Dec 20, 2025

   

   stephentoub

   on Dec 20, 2025

   Contributor

   More actions

   #849

   #528

   👍React with 👍1Reacted by ShivangiReja
5. ShivangiReja

   closed this as not plannedon Dec 20, 2025
6. ShivangiReja

   added

   bugCategory: Something isn't working and appears to be a defect in the client library.Category: Something isn't working and appears to be a defect in the client library.

   area: serviceThis issue is an inquiry about a bug in the OpenAI service or requesting a new service feature.This issue is an inquiry about a bug in the OpenAI service or requesting a new service feature.

   and removed

   blocked: upstreamThis issue is blocked on an upstream change, such as to the REST API spec or generator.This issue is blocked on an upstream change, such as to the REST API spec or generator.

   on Dec 20, 2025
7. sxwxs

   added a commit that references this issue on Aug 15, 2026

   Restore the keepalive off switch and stop replaying permanent errors

   ...

   9ac5e45