Realtime API Pydantic Models incomplete for RealtimeResponseStatus type

[bml1g12]

Confirm this is an issue with the Python library and not an underlying OpenAI API

• This is an issue with the Python library --> It is both and I have informed the issue via https://help.openai.com/en

Describe the bug

And I have got errors like this when using latest Azure deployments of OpenAI Realtime model

{
  "type": "response.done",
  "event_id": "event_BvlnvdNtqw7LLGP7xDfyA",
  "response": {
    "object": "realtime.response",
    "id": "resp_BvlnvRcuxxRLrr5FBygyo",
    "status": "failed",
    "status_details": {
      "type": "failed",
      "error": {
        "type": "invalid_request_error",
        "code": "inference_rate_limit_exceeded",
        "message": "We're currently processing too many requests — please try again later."
      }
    },
    "output": [],
    "conversation_id": "conv_Bvlm1z1fjvrisuRsPx8hC",
    "modalities": ["text", "audio"],
    "voice": "sage",
    "output_audio_format": "pcm16",
    "temperature": 0.6,
    "max_output_tokens": "inf",
    "usage": {
      "total_tokens": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "input_token_details": {
        "text_tokens": 0,
        "audio_tokens": 0,
        "cached_tokens": 0,
        "cached_tokens_details": {
          "text_tokens": 0,
          "audio_tokens": 0
        }
      },
      "output_token_details": {
        "text_tokens": 0,
        "audio_tokens": 0
      }
    },
    "metadata": {
      "client_event_id": "response_create_6448171658c7"
    }
  }
}

I have seen online others report errors like this: https://community.openai.com/t/realtime-api-errors-in-both-playground-and-api-calls/1007933 or here pipecat-ai/pipecat#2106 (comment) etc.

The problem is that the pydantic model for Error is wrong - it does not include the message field (e.g. "We're currently processing too many requests — please try again later." in the above example). This seems to be the case in the API reference itself too https://platform.openai.com/docs/api-reference/realtime-server-events/response/done

A side effect of this is that pydantic validated code sometimes will omit the message which is quite helpeful for debugging.

To Reproduce

Create a response that fails to complete, e.g. due to exceeding the rate limit of your server

The issue is present even in latest code base of openai repo:

openai-python/src/openai/types/beta/realtime/realtime_response_status.py

Line 11 in e6c6757

class Error(BaseModel):

Code snippets

OS

Linux

Python version

3.13

Library version

1.84.0

[bml1g12]

hmm maybe I should make this issue in a more general place as it affects the general API too - will close it

[bml1g12]

I contacted OpenAI via the bot on https://help.openai.com/en to report this documentation/type mismatch issue but it said it was unable to provide me updates on the progress of the bug fix, so I will keep this issue open until it is addressed. If there is a better way to track open bugs for the OpenAI API reference itself, please keep me informed and I will close this

Specifically the bot said to me

the openai/openai-openapi repository is no longer actively maintained, as you’ve noticed, and the README suggests not to open issues there. Here’s the best approach currently: API Documentation/Behavior Mismatches:

If the openai-openapi repo is not active, unfortunately there is no dedicated, public OpenAI GitHub repo for documentation or API-side bugs at this moment. Your Options: If you feel it’s causing significant confusion or breaking something, you can still point out the issue on the OpenAI Developer Forum. Staff do monitor and forward major API documentation issues reported there. If you use the openai-python GitHub repo despite the limitation, clarify in the issue description that it’s not an SDK but an API doc mismatch, and reference the lack of a better channel. Sometimes, maintainers will label and redirect such issues appropriately. Summary:

[bml1g12]

Thanks I have replied on the PR LuminaX-alt@4aa669c#commitcomment-163212994