v0.4.0

Key changes

In this version, openai package v1.x versions are no longer supported. Please use openai v2.x along with this SDK.

What's Changed

• fix: making input_file's filename optional in code for supporting non-OpenAI models by @ant31 in #1839
• feat: #1829 add httpx_client_factory to MCPServerStreamableHttp initialization options by @jjcampana in #1833
• fix: #1789 Fix multi-turn handling for conversation_id and previous_response_id: only send new items by @ihower in #1827
• Update all translated document pages by @github-actions[bot] in #1842
• docs: improve formatting consistency in tools documentation by @AbdulSamad94 in #1856
• Update all translated document pages by @github-actions[bot] in #1858
• docs: add documentation for extension feature EncryptedSession by @maxmekiska in #1872
• Update all translated document pages by @github-actions[bot] in #1873
• Fix: Correct streaming order for ReasoningItem and RawResponsesStreamEvent events by @ihower in #1869
• fix: adjust realtime handoff import by @mcbortolozzo in #1861
• Migrate openai from 1.x to 2.2.0 by @seratch in #1874
• fix: #1840 roll back session changes when Guardrail tripwire is triggered by @seratch in #1843
• docs: Add Chinese translation for documents by @SepineTam in #1878
• docs: add ToolContext section for advanced tool metadata by @MuhammadSaqib786 in #1868
• Fix: Exclude unset fields in OpenAIConversationsSession.get_items() by @ihower in #1883
• Update all translated document pages by @github-actions[bot] in #1891
• Feat: Expose MCP message handler configuration by @freeznet in #1795
• fix: handle omit type in _remove_not_given() for litellm model by @HareeshBahuleyan in #1893
• fix: convert oneOf to anyOf in strict schema for OpenAI compatibility by @ruskaruma in #1884
• Fix Local shell tool: return tool output to the LLM by @ihower in #1855
• Image, file output types for functions by @rm-openai in #1898
• Update all translated document pages by @github-actions[bot] in #1910
• Add graceful cancel mode for streaming runs by @habema in #1896
• Document AdvancedSQLiteSession and refactor session docs by @habema in #1791
• Update all translated document pages by @github-actions[bot] in #1913
• Fixes realtime example app stability issues by @thli-openai in #1905
• fix: #1900 fix a bug where SQLAlchemySession could return items in an invalid order by @seratch in #1917
• fix: #1916 openai_chatcompletions.Converter.extract_all_content does not support input_audio type items by @seratch in #1918
• v0.4.0 by @seratch in #1919

New Contributors

• @jjcampana made their first contribution in #1833
• @mcbortolozzo made their first contribution in #1861
• @SepineTam made their first contribution in #1878
• @MuhammadSaqib786 made their first contribution in #1868
• @freeznet made their first contribution in #1795
• @HareeshBahuleyan made their first contribution in #1893
• @ruskaruma made their first contribution in #1884
• @thli-openai made their first contribution in #1905

Full Changelog: v0.3.3...v0.4.0

v0.3.3

What's Changed

• Feat: Add AdvancedSQLiteSession with conversation branching & usage tracking by @habema in #1662
• Fix extended thinking bug by reordering tool messages by @habema in #1798
• feat: add Redis session support for scalable distributed memory by @damianoneill in #1785
• Add agent hooks to lifecycle_example by @seratch in #1809
• Update models in docs by @seratch in #1810
• Update all translated document pages by @github-actions[bot] in #1811
• Fix code snippet error in MCP docs by @seratch in #1812
• Update all translated document pages by @github-actions[bot] in #1813
• Adding tool input and output guardrails by @steven10a in #1792
• Korean translation by @tylerryu-oai in #1816
• Update all translated document pages by @github-actions[bot] in #1818
• docs: update examples.md to match current examples directory structure by @AbdulSamad94 in #1819
• Update all translated document pages by @github-actions[bot] in #1820
• Add guidelines for translation script contributors by @seratch in #1821
• Add missing parens in docs links by @tcbegley in #1825
• Update all translated document pages by @github-actions[bot] in #1826
• docs: fix link errors in sessions document page by @seratch in #1835
• Update all translated document pages by @github-actions[bot] in #1836
• fix: #1834 minor error in docstring by @seratch in #1837
• v0.3.3 by @rm-openai in #1838

New Contributors

• @damianoneill made their first contribution in #1785
• @steven10a made their first contribution in #1792
• @tylerryu-oai made their first contribution in #1816
• @AbdulSamad94 made their first contribution in #1819
• @tcbegley made their first contribution in #1825

Full Changelog: v0.3.2...v0.3.3

v0.3.2

What's Changed

• fix #1750 better error message when passing AgentHooks to Runner by @seratch in #1752
• Enhance function tool schemas with Annotated types by @MuhammadHassaanArain in #1777
• fix(chatcmpl): preserve all LiteLLM thinking-block signatures in converter by @serialx in #1779
• Update dynamic_system_prompt.py example to use dataclass for simiplicity by @SheikhMuhammadHamza-HS in #1774
• fix(chatcmpl): preserve text content when adding Anthropic thinking blocks to tool calls by @serialx in #1784
• fix: #556 add llms.txt / llms-full.txt by @seratch in #1782
• Add tool call arguments in ToolContext for RunHooks by @ihower in #1765
• Allow headers override instead of just ua by @jiwon-oai in #1787
• v0.3.2 by @rm-openai in #1793

New Contributors

• @SheikhMuhammadHamza-HS made their first contribution in #1774

Full Changelog: v0.3.1...v0.3.2

v0.3.1

What's Changed

• Update all translated document pages by @github-actions[bot] in #1720
• Fix missing imports in MCP documentation examples by @MariumAfzal2703 in #1718
• Update all translated document pages by @github-actions[bot] in #1721
• fix(streaming): push processed_response.new_items (including HandoffCallItem) to event_queue by @Wujiaxuan007 in #1703
• fix: #1704 Preserve thinking blocks in Anthropic conversations with tool calls by @habema in #1706
• Wait for input guardrails in streaming runs by @rm-openai in #1730
• docs: add docstring for parameter session in run, run_sync and run_streamed functions by @LokinDev in #1739
• docs: #1722 LiteLLM usage tracking by @seratch in #1743
• Update all translated document pages by @github-actions[bot] in #1747
• docs: Fix tracing setup documentation by @abdul-kabir-jawed in #1734
• Fixed Race Condition in RunResultStreaming.stream_events() Method by @AnkanMisra in #1745
• feat: Support Anthropic extended thinking and interleaved thinking by @serialx in #1744
• feat(realtime): #1560 add input audio noise reduction by @notV3NOM in #1749
• feat(voice)!: migrate STT streaming to match GA Realtime API by @notV3NOM in #1759
• Add encryption support using cryptography to Sessions implementation by @maxmekiska in #1674
• docs: reformat run module docstrings to Google style for better mkdocstrings rendering by @MuhammedSuhaib in #1740
• fix: #1668 Handoffs with gpt-5* model + store=False + remove_all_tools fails due to 404 error response by @ihower in #1757
• Add warning for agent names that transform into conflicting function names by @ihower in #1758
• feat: #1731 Enable developers to use Annotated types for function tool param description by @seratch in #1753
• feat: add more options to Agent#as_tool function by @seratch in #1751
• Export user_agent_override contextmanager by @jiwon-oai in #1768
• v0.3.1 by @rm-openai in #1773

New Contributors

• @MariumAfzal2703 made their first contribution in #1718
• @Wujiaxuan007 made their first contribution in #1703
• @LokinDev made their first contribution in #1739
• @AnkanMisra made their first contribution in #1745
• @serialx made their first contribution in #1744
• @notV3NOM made their first contribution in #1749
• @maxmekiska made their first contribution in #1674
• @jiwon-oai made their first contribution in #1768

Full Changelog: v0.3.0...v0.3.1

v0.3.0

Key changes

• New realtime updates based on the GA Realtime API

What's Changed

• Use head commit in docs workflow PR body by @seratch in #1657
• Code snippet error in "Running Agents" document by @iliailmer in #1665
• Update all translated document pages by @github-actions[bot] in #1667
• fix(voice/stt): accept conversation.item.input_audio_transcription.completed (keep legacy alias) by @dudududukim in #1537
• Fix instructions not being applied by @michieldwitte in #1688
• Fix a bug where the default behavior of loading the debug flag differs from the documentation by @seratch in #1682
• fix: #1661 Preserve realtime session voice settings when updating agents by @seratch in #1684
• Update MCP server tool documentation to cover all available options by @seratch in #1685
• Fix a minor bug in #1601 by @seratch in #1669
• Update all translated document pages by @github-actions[bot] in #1691
• docs: fix typo in connectors.py by @hxreborn in #1693
• docs: #1686 update the document to mention the end of voice stream by @majklost in #1687
• Save session on turn rather than at final response by @spokeydokeys in #1550
• Prevent preamble messages from being treated as final output when tool calls are pending by @ihower in #1689
• Delete an unused local var (I forgot deleting in #1587) by @seratch in #1696
• Fix session history duplication after PR #1550 by @habema in #1700
• Fix CI failure in make old_version_tests by @habema in #1710
• Allow to pass both session and input list by @DanieleMorotti in #1298
• Update Realtime Agent documents (ref #1646) by @seratch in #1695
• feat: #1614 gpt-realtime migration (Realtime API GA) by @seratch in #1646
• Fix a bug where debug logging fails with Iterable objects by @seratch in #1683
• v0.3.0 by @rm-openai in #1717

New Contributors

• @iliailmer made their first contribution in #1665
• @dudududukim made their first contribution in #1537
• @hxreborn made their first contribution in #1693
• @majklost made their first contribution in #1687
• @spokeydokeys made their first contribution in #1550
• @ihower made their first contribution in #1689

Full Changelog: v0.2.11...v0.3.0

v0.2.11

What's Changed

• docs: Fix #1625 code snippet error by @aiwithwhitehat in #1626
• Update all translated document pages by @github-actions[bot] in #1627
• fixed_typo: wiht -> with by @MuhammedSuhaib in #1624
• Update all translated document pages by @github-actions[bot] in #1628
• fix(run): fire on_llm_start / on_llm_end in Runner.run() for streaming & non-streaming (aligns with docs) by @erikanstine in #1619
• Fix #1629 Empty tool call arguments in streaming events by @habema in #1636
• Docs: Fix confusing session usage docs by @habema in #1637
• Update all translated document pages by @github-actions[bot] in #1643
• fix: #1594 support Azure OpenAI Realtime connection using headers by @seratch in #1633
• fix: Fix #1640 openai package breaking changes by @seratch in #1641
• Fix an error with make mypy on local machine by @seratch in #1642
• Improve translation prompt guidance by @seratch in #1647
• Update all translated document pages by @github-actions[bot] in #1648
• Document OpenAI Conversations session option by @seratch in #1649
• docs: Add more clarity on multi-agent design patterns by @seratch in #1650
• Update all translated document pages by @github-actions[bot] in #1654
• v0.2.11 by @rm-openai in #1655

New Contributors

• @aiwithwhitehat made their first contribution in #1626
• @MuhammedSuhaib made their first contribution in #1624
• @erikanstine made their first contribution in #1619

Full Changelog: v0.2.10...v0.2.11

v0.2.10

What's Changed

• Performance: only create the OpenAIRealtimeServerEvent TypeAdapter once by @michieldwitte in #1548
• Realtime: fix typecheck error by @rm-openai in #1558
• Docs: Add SQLAlchemy-powered sessions by @habema in #1549
• Update all translated document pages by @github-actions[bot] in #1561
• Add tests for Agent default model settings when using GPT-5 by @seratch in #1562
• Re: #1534 Update models document page to cover gpt-5 use cases by @seratch in #1535
• Update all translated document pages by @github-actions[bot] in #1563
• Docs: Improvements for SQLAlchemy Sessions by @habema in #1576
• Update all translated document pages by @github-actions[bot] in #1577
• Fix: Emit tool_called events immediately in streaming runs by @habema in #1300
• Feature: Make trace_include_sensitive_data configurable via environment variable by @Kunmeer-SyedMohamedHyder in #1192
• Docs: Improve example for custom Session class implementation. by @luke-wriglesworth in #1582
• Update all translated document pages by @github-actions[bot] in #1589
• Remove CI job we no longer actively use by @seratch in #1590
• Upgrade underlying oepnai package to the latest version by @seratch in #1599
• Fix #1585 supporting connectors by @seratch in #1600
• Fix #1592 Web search tool updates by @seratch in #1601
• Handle LiteLLM's json_tool_call addition for structured outputs by @seratch in #1602
• Add reasoning text delta event support for gpt-oss models by @seratch in #1586
• Fix #1564 Add conversations API support by @seratch in #1587
• fix: copy extra_kwargs to prevent litellm from polluting metadata by @zhowzeng in #1610
• v0.2.10 by @rm-openai in #1607

New Contributors

• @michieldwitte made their first contribution in #1548
• @luke-wriglesworth made their first contribution in #1582
• @zhowzeng made their first contribution in #1610

Full Changelog: v0.2.9...v0.2.10

v0.2.9

What's Changed

• Fix #1494 by adding a link to Responses API documentation by @seratch in #1502
• Add conditional tool enabling feature to agent as tool. by @thoo in #1193
• Update all translated document pages by @github-actions[bot] in #1503
• feat(agents): Add on_llm_start and on_llm_end Lifecycle Hooks by @uzair330 in #987
• clarify docs for tool_use_behavior and simplify description of stop_on_first_tool behavior by @Abishai-kashif in #1510
• Fix: filename not provided in chatcmpl_converter.py by @Nifury in #1513
• Add local_file example to align with TS SDK repo by @seratch in #1514
• Imrpove "Getting Started" on README by @seratch in #1516
• Add documentation for token usage tracking by @habema in #1518
• Update all translated document pages by @github-actions[bot] in #1524
• Add context parameter to run_demo_loop by @SeeYangZhi in #1527
• docs(visualization): clarify MCP server support and update screenshot by @Subhi-Sadiyev in #1529
• Update all translated document pages by @github-actions[bot] in #1532
• Update tracing.md with Agenta by @mmabrouk in #1541
• Update all translated document pages by @github-actions[bot] in #1543
• docs: Add external documentation link to LocalShellTool docstring by @MuhammadHamidRaza in #1547
• Add SQLAlchemy session backend for conversation history management by @habema in #1357
• feat: add retry logic to MCP server operations by @rm-openai in #1554
• Realtime: input timeout trigger event by @rm-openai in #1552
• Add a quick opt-in option to switch to gpt-5 model by @seratch in #1534
• v0.2.9 by @rm-openai in #1555

New Contributors

• @uzair330 made their first contribution in #987
• @Abishai-kashif made their first contribution in #1510
• @Nifury made their first contribution in #1513
• @SeeYangZhi made their first contribution in #1527
• @Subhi-Sadiyev made their first contribution in #1529
• @mmabrouk made their first contribution in #1541

Full Changelog: 0.2.8...v0.2.9

v0.2.8

What's Changed

• Fix: Clarify random_number function docstring for inclusive range by @Abbas-Asad in #1475
• Add input validation and type conversion for user input by @Abbas-Asad in #1476
• Docs: Add missing docstring to get_weather function by @Abbas-Asad in #1478
• Docs: Clarify that guardrails apply to both user input and agent output by @Abbas-Asad in #1482
• Docs: Add missing docstring to how_many_jokes tool by @Abbas-Asad in #1479
• Update all translated document pages by @github-actions[bot] in #1484
• Allow modifying the input sent to the model by @rm-openai in #1483
• Make shallow copies of lists instead of deep copies by @rm-openai in #1490
• Realtime: fix history bug by @rm-openai in #1495
• Realtime: allow arbitrarily sized messages by @rm-openai in #1500
• 0.2.8 by @rm-openai in #1501

Full Changelog: v0.2.7...0.2.8

v0.2.7

What's Changed

• Added runtime validation for Agent constructor arguments by @DanielHashmi in #998
• Realtime: add handoff prompt prefix by @rm-openai in #1382
• feat(tests): add tests for unicode content, special characters, and concurrent access in SQLiteSession by @PatrykBochenek in #1399
• Fix: enforce strict instructions function signature in get_system_prompt by @abdullahimran49 in #1426
• Fix #1407 Add reasoning.effort="minimal" and "verbosity" params to ModelSettings by @seratch in #1439
• Add a simple gpt-oss example by @seratch in #1440
• Fix: Clarify random_number function docstring for inclusive range by @Abbas-Asad in #1461
• Add input validation and type conversion for user input by @Abbas-Asad in #1462
• docs: Add a comprehensive example for handling function tool errors. by @MurtazaAliCode in #1354
• Update all translated document pages by @github-actions[bot] in #1469
• Migrate document translation script to gpt-5 by @seratch in #1470
• Update all translated document pages by @github-actions[bot] in #1471
• docs: Clarify the is_enabled parameter in handoff() documentation by @Hafiz-Muhammad-Umar12 in #1472
• Update all translated document pages by @github-actions[bot] in #1473
• Realtime: one guardrail trip event per response by @rm-openai in #1458
• v0.2.7 by @rm-openai in #1480

New Contributors

• @PatrykBochenek made their first contribution in #1399
• @abdullahimran49 made their first contribution in #1426
• @MurtazaAliCode made their first contribution in #1354
• @Hafiz-Muhammad-Umar12 made their first contribution in #1472

Full Changelog: v0.2.6...v0.2.7