Skip to content

Releases: openai/openai-agents-js

v0.6.0

09 Mar 04:03
ec90b90

Choose a tag to compare

Key Changes

Tool search support

As of this version, the Agents SDK supports the tool search tool, including namespaces: https://developers.openai.com/api/docs/guides/tools-tool-search/

Please refer to this concrete example, as well as the updated documentation.

Computer use tool GA

As of this version, you can use the gpt-5.4 model for the computer use tool, in addition to the existing computer-use-preview model: https://developers.openai.com/api/docs/guides/tools-computer-use/

Please refer to this concrete example, as well as the updated documentation.

Import path changes for AI SDK adapter users

If you have been using the @openai/agents-extensions package for the aisdk() helper, please migrate to importing it from @openai/agents-extensions/ai-sdk. The top-level import had been deprecated since version 0.4, and it has now been removed to allow developers to use the extensions package without AI SDK modules.

What's Changed

  • feat: add Responses tool search support by @seratch in #1065
  • fix: migrate ComputerTool to the GA computer tool by @seratch in #1073
  • fix: allow GA computer tools without display metadata by @seratch in #1078
  • fix(agents-extensions): remove deprecated top-level AI SDK exports by @seratch in #1061
  • fix(agents-core): rehydrate custom client tool_search runtime tools on resume by @seratch in #1067
  • fix: #1070 preserve MCP image mimeType in tool outputs by @seratch in #1071
  • fix(agents-core): fold unreleased RunState schema changes into 1.8 by @seratch in #1075

Documents & Other Changes

  • docs: update translated document pages by @github-actions[bot] in #1060
  • chore(deps): bump fastify from 5.7.3 to 5.8.1 in the npm_and_yarn group across 1 directory by @dependabot[bot] in #1063
  • fix: preserve canonical chat completions providerData fields by @seratch in #1064
  • docs: refresh docs and examples to gpt-5.4 by @seratch in #1068
  • docs: update translated document pages by @github-actions[bot] in #1069
  • test: expand coverage for helper and session edge cases by @seratch in #1077
  • fix(ci): serialize tsc-multi builds in GitHub workflows by @seratch in #1076
  • chore: update versions by @github-actions[bot] in #1062

Full Changelog: v0.5.4...v0.6.0

v0.5.4

05 Mar 11:20
50e8db0

Choose a tag to compare

What's Changed

  • feat: add custom rejection messages for approvals by @seratch in #1058

Documents & Other Changes

  • docs: updates for #1036 by @seratch in #1037
  • docs: update translated document pages by @github-actions[bot] in #1042
  • docs: updates for #1040 by @seratch in #1041
  • docs: update translated document pages by @github-actions[bot] in #1043
  • docs: improve TypeScript docs entry points and guide navigation by @seratch in #1044
  • docs: update translated document pages by @github-actions[bot] in #1045
  • docs: update translated document pages by @github-actions[bot] in #1046
  • chore: upgrade pnpm to 10.30.3 and clarify SHA pinning by @seratch in #1047
  • docs: clarify dynamic prompts and runtime doc caveats by @seratch in #1048
  • docs: update translated document pages by @github-actions[bot] in #1049
  • docs: align agent and voice agent guides with current SDK behavior by @seratch in #1050
  • docs: update translated document pages by @github-actions[bot] in #1051
  • chore: upgrade dev & docs dependencies by @seratch in #1052
  • docs: clarify run context, handoffs, and human-in-the-loop guides by @seratch in #1053
  • docs: update translated document pages by @github-actions[bot] in #1054
  • chore(deps): bump hono from 4.12.2 to 4.12.4 in the npm_and_yarn group across 1 directory by @dependabot[bot] in #1055
  • chore: add implementation strategy guidance for compatibility decisions by @seratch in #1056
  • chore: update versions by @github-actions[bot] in #1059

Full Changelog: v0.5.3...v0.5.4

v0.5.3

02 Mar 05:17
68e1b24

Choose a tag to compare

What's Changed

  • feat: expose agent tool invocation metadata on run results by @seratch in #1040
  • feat: #261 add ai-sdk output text transform hook for provider compatibility by @seratch in #1036

Documents & Other Changes

  • docs: update translated document pages by @github-actions[bot] in #1023
  • docs: update translated document pages by @github-actions[bot] in #1024
  • docs: correct toolChoice per the example description by @TheSpiciestDev in #1026
  • docs: refresh SDK guides and source-backed examples by @seratch in #1029
  • docs: update translated document pages by @github-actions[bot] in #1030
  • docs: follow-up changes for #1029 by @seratch in #1031
  • docs: update translated document pages by @github-actions[bot] in #1032
  • docs: update translated document pages by @github-actions[bot] in #1033
  • docs: update README files by @seratch in #1038
  • docs: Fix typo: recieves to receives by @04cb in #1039
  • perf: speed up tracing and realtime unit tests by @seratch in #1027
  • chore(deps): bump the github-actions group with 3 updates by @dependabot[bot] in #1035
  • chore: update versions by @github-actions[bot] in #1028

New Contributors

Full Changelog: v0.5.2...v0.5.3

v0.5.2

26 Feb 09:17
322d2a8

Choose a tag to compare

What's Changed

  • fix(agents-openai): sanitize oversized tracing span payloads by @seratch in #1019
  • fix(agents-openai): preserve OpenAI Responses request IDs in raw responses by @seratch in #1021
  • fix(agents-core): enum missing type field when not nullable by @alexian-ic in #1015

Documents & Other Changes

  • docs: structure improvements by @seratch in #1013
  • docs: update translated document pages by @github-actions[bot] in #1014
  • chore(deps): bump hono from 4.12.0 to 4.12.2 in the npm_and_yarn group across 1 directory by @dependabot[bot] in #1017
  • chore: update versions by @github-actions[bot] in #1016

New Contributors

Full Changelog: v0.5.1...v0.5.2

v0.5.1

24 Feb 01:49
17e99a2

Choose a tag to compare

What's Changed

  • fix(realtime): sync OpenAI realtime model type list by @seratch in #1010

Documents & Other Changes

  • docs: add responses websocket support by @seratch in #1008
  • docs: update translated document pages by @github-actions[bot] in #1009
  • chore: update versions by @github-actions[bot] in #1011

Full Changelog: v0.5.0...v0.5.1

v0.5.0

23 Feb 23:14
d17ec0f

Choose a tag to compare

Key Changes

WebSocket Mode for OpenAI Responses API

This version adds WebSocket mode support for OpenAI's Responses API. This is a new opt-in feature, so the default behavior is unchanged. If you want to switch all Responses API calls to WebSocket mode, call setOpenAIResponsesTransport('websocket') to enable it for all OpenAI Responses model agents.

You can also use withResponsesWebSocketSession o enable a reusable WebSocket connection, as shown below:

import { Agent, withResponsesWebSocketSession } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'You are a helpful assistant.',
  model: 'gpt-5.2-codex',
});
await withResponsesWebSocketSession(async ({ run }) => {
  const streamed = await run(agent, 'Say hello in one sentence.', {
    stream: true,
  });
  for await (const _event of streamed.toStream()) {
    // Drain the stream.
  }
  console.log(streamed.finalOutput);
});

References:

What's Changed

  • feat: add responses websocket transport and websocket session helper by @seratch in #1004

Documents & Other Changes

  • docs: add missing changes by @seratch in #1002
  • docs: update translated document pages by @github-actions[bot] in #1003
  • chore: change #1004 to minor version changes by @seratch in #1007
  • chore: update versions by @github-actions[bot] in #1006

Full Changelog: v0.4.15...v0.5.0

v0.4.15

20 Feb 23:02
b910b73

Choose a tag to compare

What's Changed

  • fix(agents-core): respect tracingDisabled for function tool calls by @anishhegde in #1000

Documents & Other Changes

  • chore(deps): bump the npm_and_yarn group across 1 directory with 2 updates by @dependabot[bot] in #998
  • chore: update versions by @github-actions[bot] in #1001

New Contributors

Full Changelog: v0.4.14...v0.4.15

v0.4.14

20 Feb 04:13
680954b

Choose a tag to compare

What's Changed

  • fix(agents-core): preserve nested agent-tool approval attribution on restore by @seratch in #996

Documents & Other Changes

  • chore: update versions by @github-actions[bot] in #997

Full Changelog: v0.4.13...v0.4.14

v0.4.13

19 Feb 05:06
2de7fbf

Choose a tag to compare

Key Changes

reasoningItemIdPolicy: omit for reasoning models

To mitigate 400 errors caused by an inconsistent set of items when using reasoning models, this release introduces the reasoningItemIdPolicy: 'omit' option for Runner options and the run utility. This is a new, opt-in option, so the default behavior is unchanged.

const result = await run(
  agent,
  'What is the weather in San Francisco?',
  { reasoningItemIdPolicy: 'omit' },
);

What's Changed

  • fix(agents-core): rehydrate RunState interruption items on resume by @seratch in #993
  • fix(agents-core): persist reasoning item ID policy across resumes and clarify filter interaction by @seratch in #991
  • fix(agents-core): await parallel input guardrails before resolving turn in non-streaming run by @panilya in #992

Documents & Other Changes

  • chore: update versions by @github-actions[bot] in #994

New Contributors

Full Changelog: v0.4.12...v0.4.13

v0.4.12

18 Feb 08:57
e0d4ece

Choose a tag to compare

What's Changed

  • feat: #987 pass run context into applyPatch editor operations by @seratch in #990
  • fix: #582 prevent duplicate realtime session events after reconnect by @seratch in #980
  • fix: #551 preserve pre-tool assistant transcript in realtime agent_end events by @seratch in #982
  • fix: #722 normalize data URL images for AI SDK providers by @seratch in #983
  • fix: #479 avoid Bun browser startup crash when shim modules are temporarily unresolved by @seratch in #984
  • fix: #579 use streamed chunk IDs in Chat Completions traces and output items by @seratch in #985
  • fix: #302 propagate output guardrail context types to OutputGuardrailFunctionArgs by @seratch in #986
  • fix: #116 respect toolChoice none overrides after tool lifecycle updates by @seratch in #988
  • fix: #257 normalize response message content metadata into providerData by @seratch in #989

Documents & Other Changes

  • docs: update a few document pages by @seratch in #976
  • docs: update translated document pages by @github-actions[bot] in #978
  • chore: update versions by @github-actions[bot] in #981

Full Changelog: v0.4.11...v0.4.12