Repository navigation
chore(api): clarify image transparency and audio delta docs - #2439
Conversation
Castiron-Internal-PR: openai/openai-node-internal#70 Castiron-Source-SHA: eb589fd77a6cbf4c4d727008507559511ac59eb5 Castiron-Public-Base-SHA: 4317319
Castiron custom code✅ No new custom-code files detected. 32 mixed files remain; 0 existing customizations changed; 3 generated baselines changed. Compared
29 existing customizations unchanged
A changed generated baseline means this report cannot reliably identify which handwritten lines changed. Inspect the custom-code diffDownload the exact patch produced by this run (requires repository access): gh run download 32429414371 --repo openai/openai-node \
--name castiron-custom-code-32429414371-1 --dir /tmp/castiron-custom-code-32429414371-1
git apply --stat /tmp/castiron-custom-code-32429414371-1/custom-code.patch
cat /tmp/castiron-custom-code-32429414371-1/custom-code.patchOr reproduce it from an SDK checkout containing the vendored reporter: git fetch --no-tags origin 43173195e09bc916d58b4caffc6bf2e73002109f 0deb713cb04c8d4ab079d6c532153212fd4e1856
python3 scripts/castiron/custom_code_report.py report \
--base 43173195e09bc916d58b4caffc6bf2e73002109f \
--head 0deb713cb04c8d4ab079d6c532153212fd4e1856 --fetch --require-head-hash --public \
--out /tmp/castiron-custom-code-0deb713cb04c
cat /tmp/castiron-custom-code-0deb713cb04c/custom-code.patchThis is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0deb713cb0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| * Allows to set transparency for the background of the generated image(s). Must be | ||
| * one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used, | ||
| * the model will automatically determine the best background for the image. |
There was a problem hiding this comment.
background
When callers use images.generate with dall-e-2 or dall-e-3—both still accepted by ImageGenerateParamsBase.model—this wording now suggests that opaque and auto are valid because it limits only transparent backgrounds to GPT Image models. Runtime behavior is unchanged, and the removed documentation correctly stated that the entire background parameter is GPT-only, so retain that restriction alongside the new GPT Image 2 preview guidance to prevent unsupported DALL-E requests.
AGENTS.md reference: AGENTS.md:L72-L74
Useful? React with 👍 / 👎.
jbeckwith-oai
left a comment
jbeckwith-oai
left a comment
There was a problem hiding this comment.
The updated description removes the existing parameter-level restriction that background is supported only for GPT Image models. It now limits only transparent backgrounds, incorrectly implying dall-e-2 / dall-e-3 accept background: "opaque" or "auto". Restore the explicit GPT-Image-only restriction in the canonical OpenAPI description while retaining the new transparency preview and PNG/WebP guidance, then regenerate. The existing review thread already covers this; no duplicate inline comment.
|
overriding as docstring only change; api ref authoritative here |
Summary
Clarify image-background documentation and Realtime translation audio-delta sizing. This update changes comments and the transformed API reference only; public TypeScript interfaces and runtime behavior are unchanged.
Changes
gpt-image-2andgpt-image-2-2026-04-21, withpngorwebprequired for transparent output.nullwas already accepted by the image edit/generate interfaces.