Changelog
2.41.0 (2026-06-03)
Full Changelog: v2.40.0...v2.41.0
Features
- api: responses.moderation and chat_completions.moderation (87e46c2)
2.40.0 (2026-06-01)
Full Changelog: v2.39.0...v2.40.0
Features
- api: Add Amazon Bedrock Responses support
Bug Fixes
- api: allow setting bedrock api keys on the client directly (4d5bfde)
2.39.0 (2026-06-01)
Full Changelog: v2.38.0...v2.39.0
Features
- api: workload identity in audit logs, additional_tools item in responses, fix ActionSearch.query to be optional. (ab60d7a)
2.38.0 (2026-05-21)
Full Changelog: v2.37.0...v2.38.0
Features
- api: api update (33d1d01)
- api: manual updates (a21700a)
- api: update OpenAPI spec or Stainless config (00265c5)
Chores
- api: docs updates (ee10152)
- check release PR custom code sync (2638779)
- remove release automation trigger (bd6eea5)
- trigger release automation (f62d082)
2.37.0 (2026-05-13)
Full Changelog: v2.36.0...v2.37.0
Features
- api: add service_tier parameter to responses compact method (625827c)
- internal/types: support eagerly validating pydantic iterators (7e527bc)
- Remove unnecessary client_id when using workload identity provider for auth (c39ea8d)
Bug Fixes
- client: add missing f-string prefix in file type error message (c85ebd9)
2.36.0 (2026-05-07)
Full Changelog: v2.35.1...v2.36.0
Features
2.35.1 (2026-05-06)
Full Changelog: v2.35.0...v2.35.1
Bug Fixes
- api: fix imagegen
size enum regression (4484653)
2.35.0 (2026-05-06)
Full Changelog: v2.34.0...v2.35.0
Features
Chores
- remove legacy python cli (32f36e4)
- rename legacy python cli entrypoint (a3b182d)
Documentation
- api: update top_logprobs parameter description across chat and responses (f9d339f)
2.34.0 (2026-05-04)
Full Changelog: v2.33.0...v2.34.0
Features
- api: add external_key_id to projects, email/metadata params to users, update types (2d232ee)
- api: add support for Admin API Keys per endpoint (b8b176a)
- api: admin API updates (4ae1138)
- api: manual updates (c1870f1)
- api: manual updates (f6bb9c7)
- support setting headers via env (1e89d8b)
Bug Fixes
- allow explicit Azure auth headers (a0626ba)
- api: correct prompt_cache_retention enum value from in-memory to in_memory (d47d9f0)
- api: preserve python api key attribute type (62607f6)
- api: resolve python auth type checks (42a31a7)
- api: support admin api key auth (f029eb9)
- avoid bearer fallback for admin auth (22e01a8)
- preserve selected auth credentials (0d27f9d)
- require bearer auth for stream helpers (d055539)
- types: correct created_at and completed_at to float in Response (7da4b88)
- types: correct timestamp types to int in Response model (e55631c)
- use correct field name format for multipart file arrays (9ee4825)
Performance Improvements
- client: optimize file structure copying in multipart requests (dca474e)
Chores
- internal: more robust bootstrap script (9ec1600)
- internal: reformat pyproject.toml (12ad57b)
- tests: bump steady to v0.22.1 (486dfed)
Documentation
- api: add rate limit and vector store info to files create (4f776df)
- api: update files rate limit documentation (b141a20)
2.33.0 (2026-04-28)
Full Changelog: v2.32.0...v2.33.0
Features
Bug Fixes
- api: correct prompt_cache_retention enum value from in-memory to in_memory (#1822) (f9d2d13)
Chores
- ci: remove release-doctor workflow (00b2091)
2.32.0 (2026-04-15)
Full Changelog: v2.31.0...v2.32.0
Features
- api: Add detail to InputFileContent (60de21d)
- api: add OAuthErrorCode type (0c8d2c3)
- client: add event handler implementation for websockets (0280d05)
- client: allow enqueuing to websockets even when not connected (67aa20e)
- client: support reconnection in websockets (eb72a95)
Bug Fixes
- ensure file data are only sent as 1 parameter (c0c2ecd)
Documentation
2.31.0 (2026-04-08)
Full Changelog: v2.30.0...v2.31.0
Features
- api: add phase field to conversations message (3e5834e)
- api: add web_search_call.results to ResponseIncludable type (ffd8741)
- client: add support for short-lived tokens (#1608) (22fe722)
- client: support sending raw data over websockets (f1bc52e)
- internal: implement indices array format for query and form serialization (49194cf)
Bug Fixes
- client: preserve hardcoded query params when merging with user params (92e109c)
- types: remove web_search_call.results from ResponseIncludable (d3cc401)
Chores
- tests: bump steady to v0.20.1 (d60e2ee)
- tests: bump steady to v0.20.2 (6508d47)
Documentation
- api: update file parameter descriptions in vector_stores files and file_batches (a9e7ebd)
2.30.0 (2026-03-25)
Full Changelog: v2.29.0...v2.30.0
Features
- api: add keys field to Click/DoubleClick/Drag/Move/Scroll computer actions (ee1bbed)
Bug Fixes
- api: align SDK response types with expanded item schemas (f3f258a)
- sanitize endpoint path params (89f6698)
- types: make type required in ResponseInputMessageItem (cfdb167)
Chores
- ci: skip lint on metadata-only changes (faa93e1)
- internal: update gitignore (c468477)
- tests: bump steady to v0.19.4 (f350af8)
- tests: bump steady to v0.19.5 (5c03401)
- tests: bump steady to v0.19.6 (b6353b8)
- tests: bump steady to v0.19.7 (1d654be)
Refactors
- tests: switch from prism to steady (4a82035)
2.29.0 (2026-03-17)
Full Changelog: v2.28.0...v2.29.0
Features
- api: 5.4 nano and mini model slugs (3b45666)
- api: add /v1/videos endpoint to batches create method (c0e7a16)
- api: add defer_loading field to ToolFunction (3167595)
- api: add in and nin operators to ComparisonFilter type (664f02b)
Bug Fixes
- deps: bump minimum typing-extensions version (a2fb2ca)
- pydantic: do not pass
by_alias unless set (8ebe8fb)
Chores
- internal: tweak CI branches (96ccc3c)
2.28.0 (2026-03-13)
Full Changelog: v2.27.0...v2.28.0
Features
2.27.0 (2026-03-13)
Full Changelog: v2.26.0...v2.27.0
Features
- api: api update (60ab24a)
- api: manual updates (b244b09)
- api: manual updates (d806635)
- api: sora api improvements: character api, video extensions/edits, higher resolution exports. (58b70d3)
Bug Fixes
- api: repair merged videos resource (742d8ee)
Chores
- internal: codegen related update (4e6498e)
- internal: codegen related update (93af129)
- match http protocol with ws protocol instead of wss (026f9de)
- use proper capitalization for WebSockets (a2f9b07)
2.26.0 (2026-03-05)
Full Changelog: v2.25.0...v2.26.0
Features
- api: The GA ComputerTool now uses the CompuerTool class. The 'computer_use_preview' tool is moved to ComputerUsePreview (78f5b3c)
2.25.0 (2026-03-05)
Full Changelog: v2.24.0...v2.25.0
Features
- api: gpt-5.4, tool search tool, and new computer tool (6b2043f)
- api: remove prompt_cache_key param from responses, phase field from message types (44fb382)
Bug Fixes
Chores
- internal: codegen related update (bdb837d)
- internal: codegen related update (b1de941)
- internal: reduce warnings (7cdbd06)
2.24.0 (2026-02-24)
Full Changelog: v2.23.0...v2.24.0
Features
Bug Fixes
Chores
- internal: make
test_proxy_environment_variables more resilient to env (65af8fd)
- internal: refactor sse event parsing (2344600)
2.23.0 (2026-02-24)
Full Changelog: v2.22.0...v2.23.0
Features
- api: add gpt-realtime-1.5 and gpt-audio-1.5 model options to realtime calls (3300b61)
Chores
- internal: make
test_proxy_environment_variables more resilient (6b441e2)
2.22.0 (2026-02-23)
Full Changelog: v2.21.0...v2.22.0
Features
- api: websockets for responses api (c01f6fb)
Chores
- internal: add request options to SSE classes (cdb4315)
- update mock server docs (91f4da8)
Documentation
- api: add batch size limit to file_batches parameter descriptions (16ae76a)
- api: enhance method descriptions across audio, chat, realtime, skills, uploads, videos (21f9e5a)
- api: update safety_identifier documentation in chat completions and responses (d74bfff)
2.21.0 (2026-02-13)
Full Changelog: v2.20.0...v2.21.0
Features
- api: container network_policy and skills (d19de2e)
Bug Fixes
- structured outputs: resolve memory leak in parse methods (#2860) (6dcbe21)
- webhooks: preserve method visibility for compatibility checks (44a8936)
Chores
- internal: fix lint error on Python 3.14 (534f215)
Documentation
- split
api.md by standalone resources (96e41b3)
- update comment (63def23)
2.20.0 (2026-02-10)
Full Changelog: v2.19.0...v2.20.0
Features
- api: support for images in batch api (28edb6e)
2.19.0 (2026-02-10)
Full Changelog: v2.18.0...v2.19.0
Features
- api: skills and hosted shell (27fdf68)
Chores
- internal: bump dependencies (fae10fd)
2.18.0 (2026-02-09)
Full Changelog: v2.17.0...v2.18.0
Features
- api: add context_management to responses (137e992)
- api: responses context_management (c3bd017)
2.17.0 (2026-02-05)
Full Changelog: v2.16.0...v2.17.0
Features
- api: add shell_call_output status field (1bbaf88)
- api: image generation actions for responses; ResponseFunctionCallArgumentsDoneEvent.name (7d96513)
- client: add custom JSON encoder for extended type support (9f43c8b)
Bug Fixes
- client: undo change to web search Find action (8f14eb0)
- client: update type for
find_in_page action (ec54dde)
2.16.0 (2026-01-27)
Full Changelog: v2.15.0...v2.16.0
Features
- api: api update (b97f9f2)
- api: api updates (9debcc0)
- client: add support for binary request streaming (49561d8)
Bug Fixes
- api: mark assistants as deprecated (0419cbc)
Chores
- ci: upgrade
actions/github-script (5139f13)
- internal: update
actions/checkout version (f276714)
Documentation
- examples: update Azure Realtime sample to use v1 API (#2829) (3b31981)
2.15.0 (2026-01-09)
Full Changelog: v2.14.0...v2.15.0
Features
- api: add new Response completed_at prop (f077752)
Chores
- internal: codegen related update (e7daba6)
2.14.0 (2025-12-19)
Full Changelog: v2.13.0...v2.14.0
Features
- api: slugs for new audio models; make all
model params accept strings (e517792)
Bug Fixes
- use async_to_httpx_files in patch method (a6af9ee)
Chores
- internal: add
--fix argument to lint script (93107ef)
2.13.0 (2025-12-16)
Full Changelog: v2.12.0...v2.13.0
Features
Chores
- ci: add CI job to detect breaking changes with the Agents SDK (#1436) (237c91e)
- internal: add missing files argument to base client (e6d6fd5)
2.12.0 (2025-12-15)
Full Changelog: v2.11.0...v2.12.0
Features
- api: api update (a95c4d0)
- api: fix grader input list, add dated slugs for sora-2 (b2c389b)
2.11.0 (2025-12-11)
Full Changelog: v2.10.0...v2.11.0
Features
2.10.0 (2025-12-10)
Full Changelog: v2.9.0...v2.10.0
Features
- api: make model required for the responses/compact endpoint (a12936b)
Bug Fixes
- types: allow pyright to infer TypedDict types within SequenceNotStr (8f0d230)
Chores
2.9.0 (2025-12-04)
Full Changelog: v2.8.1...v2.9.0
Features
- api: gpt-5.1-codex-max and responses/compact (22f646e)
Bug Fixes
- client: avoid mutating user-provided response config object (#2700) (e040d22)
- ensure streams are always closed (0b1a27f)
- streaming: correct indentation (575bbac)
Chores
- deps: mypy 1.18.1 has a regression, pin to 1.17 (22cd586)
- docs: use environment variables for authentication in code snippets (c2a3cd5)
- internal: codegen related update (307a066)
- update lockfile (b4109c5)
2.8.1 (2025-11-17)
Full Changelog: v2.8.0...v2.8.1
Bug Fixes
- api: align types of input items / output items for typescript (64c9fb3)
2.8.0 (2025-11-13)
Full Changelog: v2.7.2...v2.8.0
Features
Bug Fixes
- compat: update signatures of
model_dump and model_dump_json for Pydantic v1 (c7bd234)
2.7.2 (2025-11-10)
Full Changelog: v2.7.1...v2.7.2
Bug Fixes
Chores
- package: drop Python 3.8 support (afc14f2)
2.7.1 (2025-11-04)
Full Changelog: v2.7.0...v2.7.1
Bug Fixes
- api: fix nullability of logprobs (373b7f6)
2.7.0 (2025-11-03)
Full Changelog: v2.6.1...v2.7.0
Features
- api: Realtime API token_limits, Hybrid searching ranking options (5b43992)
- api: remove InputAudio from ResponseInputContent (bd70a33)
Bug Fixes
- client: close streams without requiring full consumption (d8bb7d6)
- readme: update realtime examples (#2714) (d0370a8)
- uploads: avoid file handle leak (4f1b691)
Chores
- internal/tests: avoid race condition with implicit client cleanup (933d23b)
- internal: grammar fix (it's -> its) (f7e9e9e)
2.6.1 (2025-10-24)
Full Changelog: v2.6.0...v2.6.1
Bug Fixes
Chores
- client: clean up custom translations code (cfb9e25)
2.6.0 (2025-10-20)
Full Changelog: v2.5.0...v2.6.0
Features
- api: Add responses.input_tokens.count (6dd09e2)
Bug Fixes
- api: internal openapi updates (caabd7c)
2.5.0 (2025-10-17)
Full Changelog: v2.4.0...v2.5.0
Features
Chores
- bump
httpx-aiohttp version to 0.1.9 (67f2f0a)
2.4.0 (2025-10-16)
Full Changelog: v2.3.0...v2.4.0
Features
- api: Add support for gpt-4o-transcribe-diarize on audio/transcriptions endpoint (bdbe9b8)
Chores
- fix dangling comment (da14e99)
- internal: detect missing future annotations with ruff (2672b8f)
2.3.0 (2025-10-10)
Full Changelog: v2.2.0...v2.3.0
Features
- api: comparison filter in/not in (aa49f62)
Chores
- package: bump jiter to >=0.10.0 to support Python 3.14 (#2618) (aa445ca)
2.2.0 (2025-10-06)
Full Changelog: v2.1.0...v2.2.0
Features
- api: dev day 2025 launches (38ac009)
Bug Fixes
- client: add chatkit to beta resource (de3e561)
2.1.0 (2025-10-02)
Full Changelog: v2.0.1...v2.1.0
Features
- api: add support for realtime calls (7f7925b)
2.0.1 (2025-10-01)
Full Changelog: v2.0.0...v2.0.1
Bug Fixes
- api: add status, approval_request_id to MCP tool call (2a02255)
2.0.0 (2025-09-30)
Full Changelog: v1.109.1...v2.0.0
⚠ BREAKING CHANGES
- api:
ResponseFunctionToolCallOutputItem.output and ResponseCustomToolCallOutput.output now return string | Array<ResponseInputText | ResponseInputImage | ResponseInputFile> instead of string only. This may break existing callsites that assume output is always a string.
Features
- api: Support images and files for function call outputs in responses, BatchUsage (4105376)
1.109.1 (2025-09-24)
Full Changelog: v1.109.0...v1.109.1
Bug Fixes
- compat: compat with
pydantic<2.8.0 when using additional fields (5d95ecf)
1.109.0 (2025-09-23)
Full Changelog: v1.108.2...v1.109.0
Features
1.108.2 (2025-09-22)
Full Changelog: v1.108.1...v1.108.2
Bug Fixes
Chores
- api: openapi updates for conversations (3224f6f)
- do not install brew dependencies in ./scripts/bootstrap by default (6764b00)
- improve example values (20b58e1)
1.108.1 (2025-09-19)
Full Changelog: v1.108.0...v1.108.1
Features
Chores
- types: change optional parameter type from NotGiven to Omit (acc190a)
1.108.0 (2025-09-17)
Full Changelog: v1.107.3...v1.108.0
Features
- api: type updates for conversations, reasoning_effort and results for evals (c2ee28c)
Chores
- internal: update pydantic dependency (369d10a)
1.107.3 (2025-09-15)
Full Changelog: v1.107.2...v1.107.3
Chores
- api: docs and spec refactoring (9bab5da)
- tests: simplify
get_platform test (0b1f6a2)
1.107.2 (2025-09-12)
Full Changelog: v1.107.1...v1.107.2