Skip to content

Update documents once #187 fix is released #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 16, 2025
Merged

Update documents once #187 fix is released #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,8 @@ Experimental support:

### Installation

This SDK currently does not work with `zod@3.25.68` and above. Please install `zod@3.25.67` (or any older version) explicitly. We will resolve this dependency issue soon. Please check [this issue](https://github.com/openai/openai-agents-js/issues/187) for updates.

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
Copy link
Member Author

@seratch seratch Aug 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This SDK and its underlying openai package are not compatible with zod@4 in TS compilation phase. So, still having zod@3 should be reasonable.

```

## Hello world example
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import quickstartExample from '../../../../../examples/docs/quickstart/index.ts?
2. Install the Agents SDK.

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
```

3. Set an OpenAI API key. If you don't have one, follow [these instructions](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) to create an OpenAI API key.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/voice-agents/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import thinClientExample from '../../../../../../examples/docs/voice-agents/thin
1. **Install the Agents SDK**

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
```

Alternatively you can install `@openai/agents-realtime` for a standalone browser package.
Expand Down
4 changes: 1 addition & 3 deletions docs/src/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,8 @@ Here are the main features of the SDK:

## Installation

This SDK currently does not work with `zod@3.25.68` and above. Please install `zod@3.25.67` (or any older version) explicitly. We will resolve this dependency issue soon. Please check [this issue](https://github.com/openai/openai-agents-js/issues/187) for updates.

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
```

## Hello world example
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/ja/guides/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import quickstartExample from '../../../../../../examples/docs/quickstart/index.
2. Agents SDK をインストールします。

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
```

3. OpenAI API キーを設定します。まだお持ちでない場合は、 [こちらの手順](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) に従って OpenAI API キーを作成してください。
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/ja/guides/voice-agents/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import thinClientExample from '../../../../../../../examples/docs/voice-agents/t
1. **Agents SDK のインストール**

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
```

代わりに、スタンドアロンのブラウザ パッケージとして `@openai/agents-realtime` をインストールすることもできます。
Expand Down
4 changes: 1 addition & 3 deletions docs/src/content/docs/ja/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,8 @@ TypeScript と組み合わせることで、これらの基本コンポーネン

## インストール

この SDK は現在 `zod@3.25.68` 以上では動作しません。明示的に `zod@3.25.67`（またはそれ以前のバージョン）をインストールしてください。依存関係の問題はまもなく解決します。最新情報は [this issue](https://github.com/openai/openai-agents-js/issues/187) をご確認ください。

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents 'zod@3'
```

## Hello World の例
Expand Down
4 changes: 1 addition & 3 deletions packages/agents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,8 @@ Experimental support:

### Installation

This SDK currently does not work with `zod@3.25.68` and above. Please install `zod@3.25.67` (or any older version) explicitly. We will resolve this dependency issue soon. Please check [this issue](https://github.com/openai/openai-agents-js/issues/187) for updates.

```bash
npm install @openai/agents 'zod@<=3.25.67'
npm install @openai/agents zod@3
```

## Hello world example
Expand Down