openai / openai/openai-openapi

ChatCompletionStreamResponseDelta omits streamed audio data

Open
#577 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation specification
Dominant language
No language data
Stars
2.5k
Forks
527
Avg merge
1h 46m
Merged PRs (30d)
2

Description

Source reports

Current specification gap

Affected surface: POST /chat/completions stream; ChatCompletionStreamResponseDelta.audio.

The source reports audio fields returned by streaming gpt-4o-audio-preview and gpt-4o-mini-audio-preview calls, while the SDK and API reference omit the field. The current public delta component still has no audio property.

Specification reviewed at b61ced9.

Minimal shape

{
  "audio": {
    "expires_at": 1234567890
  }
}

This is a sanitized illustration of the reported shape, not a new live API capture.

Expected reconciliation

Describe the streamed audio delta shape and per-chunk optional fields, including the final expiry update, then regenerate SDK types.

Verification scope

Reviewed the source reports, relevant comments, and current published schema. No new live API request was made. This mirrors the specification gap and preserves the original reproduction; it does not claim that a fix has shipped.

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 openapi.yaml at the reviewed ChatCompletionStreamResponseDelta definition around line 31939, then compare it with the linked source report and comments. Document the streamed audio delta shape and its optional per-chunk fields, including the final expiry update, and regenerate the SDK types; done means the public schema includes the audio property.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.