openai / openai/openai-python

Realtime API Pydantic Models incomplete for RealtimeResponseStatus type

Open Beginner friendly
#2,502 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug openapi
Dominant language
Python
Stars
31.6k
Forks
5.7k
Avg merge
1d 6h
Merged PRs (30d)
96

Description

Confirm this is an issue with the Python library and not an underlying OpenAI API
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 https://github.com/pipecat-ai/pipecat/issues/2106#issue-3193722974 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: https://github.com/openai/openai-python/blob/e6c6757553bbdb777c31d0daf5916fb9e2b47ff8/src/openai/types/beta/realtime/realtime_response_status.py#L11

Code snippets

OS

Linux

Python version

3.13

Library version

1.84.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/openai/types/beta/realtime/realtime_response_status.py, especially the Error model referenced in the issue, and inspect how the response.done payload is validated. Reproduce the failed response example and verify that validation preserves the nested error message when the model is updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.