feat: Add support for zod@4 schemas #1666

karpetrosyan · 2025-10-01T05:26:20Z

I understand that this repository is auto-generated and my pull request may not be merged

Changes being requested

Additional context & links

karpetrosyan · 2025-10-02T08:22:41Z

tests/helpers/zod.test.ts

  });

-  it('throws error on optional fields', () => {
+  (version === 'v4' ? it.skip : it)('throws error on optional fields', () => {


as we transform the schema, we actually add missing fields in required property, as we do in python

hmm I don't think this is quite right, in Python it's fine because the property being omitted or explicitly set to null results in the same type, None, but in TS it's different.

so if we add properties that are .optional() to the required array, then the API will send them back as null, which breaks the type promise because it'd be typed as property?: string instead of property?: string | null or property: string | null.

the equivalent behaviour here for python would be to only add properties to required when they're both .optional() and .nullable() which is why we throw the current error.

examples/parsing.ts

RobertCraigie · 2025-10-02T12:45:36Z

tests/helpers/zod.test.ts

+describe.each([
+  { version: 'v3', z: zv3 as any },
+  { version: 'v4', z: zv4 as any },
+])('zodResponseFormat (Zod $version)', ({ version, z }) => {


👌 this is a cool way to test things

src/helpers/zod.ts

RobertCraigie · 2025-10-02T13:16:41Z

tests/helpers/zod.test.ts

  });

-  it('throws error on optional fields', () => {
+  (version === 'v4' ? it.skip : it)('throws error on optional fields', () => {


hmm I don't think this is quite right, in Python it's fine because the property being omitted or explicitly set to null results in the same type, None, but in TS it's different.

so if we add properties that are .optional() to the required array, then the API will send them back as null, which breaks the type promise because it'd be typed as property?: string instead of property?: string | null or property: string | null.

the equivalent behaviour here for python would be to only add properties to required when they're both .optional() and .nullable() which is why we throw the current error.

loky-lp · 2025-10-20T13:16:14Z

Hi, whats blocking this?
Would like to help in any way, the missing support for v4 and v4 mini is a huge pain for us rn.

dtmeadows

2 quick comments.

Thanks so much for this @karpetrosyan !

dtmeadows · 2025-10-22T19:59:48Z

examples/responses/streaming-tools.ts

 import { OpenAI } from 'openai';
 import { zodResponsesFunction } from 'openai/helpers/zod';
-import { z } from 'zod/v3';
+import { z } from 'zod/v4'; // Also works for 'zod/v3'


@karpetrosyan any chance you could run all these examples with v3 on this PR just to make sure things are back-compatible?

ah thats a good callout, I think I asked to switch them to v4 🤦

I checked all of them locally, all worked with v3!

dtmeadows · 2025-10-22T20:00:43Z

src/helpers/zod.ts

+function zodV4ToJsonSchema(schema: z4.ZodType): Record<string, unknown> {
+  return toStrictJsonSchema(
+    z4.toJSONSchema(schema, {
+      target: 'draft-7',


just curious how we picked this value?

I've lost the context here a little bit, but looking at it again, it seems like we shouldn't set the concrete target. I'll remove it.

Ah, I think I did that because the current vendored version that parses Zod schema to JSON Schema is using draft-07 by default

src/helpers/zod.ts

tests/helpers/zod.test.ts

RobertCraigie · 2025-10-22T18:43:23Z

src/lib/transform.ts

+  return ensureStrictJsonSchema(schema, [], schema);
+}
+
+function isNullable(schema: JSONSchemaDefinition): boolean {


this should check schema.nullable as well right?

hmm, maybe? it's not part of the json schema spec tho

wait what, is that openapi only?

src/lib/transform.ts

RobertCraigie · 2025-10-22T20:06:07Z

examples/responses/streaming-tools.ts

 import { OpenAI } from 'openai';
 import { zodResponsesFunction } from 'openai/helpers/zod';
-import { z } from 'zod/v3';
+import { z } from 'zod/v4'; // Also works for 'zod/v3'


ah thats a good callout, I think I asked to switch them to v4 🤦

tests/lib/parser.test.ts

tests/lib/transform.test.ts

src/helpers/zod.ts

tests/lib/transform.test.ts

Co-authored-by: Robert Craigie <robert@craigie.dev>

RobertCraigie · 2025-10-24T11:39:25Z

src/lib/transform.ts

+  // Handle arrays
+  const items = jsonSchema.items;
+  if (isDict(items)) {
+    // @ts-ignore(2345)


fyi that you should basically never use ts-ignore, instead you should use ts-expect-error so that you're notified if the ignore comment is redundant

RobertCraigie

Looks great! FYI I pushed a couple small commits improving the internal types and with some small cleanup

Co-authored-by: Robert Craigie <robert@craigie.dev>

karpetrosyan requested a review from a team as a code owner October 1, 2025 05:26

karpetrosyan marked this pull request as draft October 1, 2025 05:26

feat: add support for zod@4 schemas

8f56474

karpetrosyan force-pushed the support-zod-v4-schemas branch from c482776 to 8f56474 Compare October 1, 2025 05:27

karpetrosyan added 2 commits October 1, 2025 13:01

add v4 schema support for zodFunction

7be8d10

fixes

cbf5f81

karpetrosyan commented Oct 2, 2025

View reviewed changes

Merge branch 'next' into support-zod-v4-schemas

6b4ae77

karpetrosyan marked this pull request as ready for review October 2, 2025 08:24

RobertCraigie reviewed Oct 2, 2025

View reviewed changes

karpetrosyan added 5 commits October 2, 2025 19:11

review fixes + add zod@4 support for tool functions

a1a4718

more tests!!

19713bf

improve tests

747c0df

fix cast

284cfe7

remove name parameter from zodV4ToJsonSchema

7a98adb

karpetrosyan requested a review from RobertCraigie October 3, 2025 08:21

karpetrosyan and others added 2 commits October 3, 2025 12:23

Merge branch 'next' into support-zod-v4-schemas

98e5b8c

mention zod3/zod4 support in all eaxmples

a324c80

RobertCraigie mentioned this pull request Oct 3, 2025

Support for zod 4 #1576

Closed

1 task

stainless-app bot and others added 2 commits October 6, 2025 21:34

chore(internal): use npm pack for build uploads

a532410

Merge branch 'next' into support-zod-v4-schemas

f3ab503

stainless-app bot force-pushed the next branch from 1a733c6 to 86f85b0 Compare October 10, 2025 01:14

karpetrosyan and others added 2 commits October 16, 2025 20:52

Merge branch 'next' into support-zod-v4-schemas

946a7b0

fix(api): internal openapi updates

d4aaef9

Merge branch 'next' into support-zod-v4-schemas

2ddb9c9

stainless-app bot force-pushed the next branch from 520c8a9 to 3595555 Compare October 20, 2025 17:16

Merge branch 'next' into support-zod-v4-schemas

704ba4c

dtmeadows reviewed Oct 22, 2025

View reviewed changes

RobertCraigie reviewed Oct 22, 2025

View reviewed changes

tests/lib/parser.test.ts Outdated Show resolved Hide resolved

RobertCraigie reviewed Oct 22, 2025

View reviewed changes

tests/lib/transform.test.ts Outdated Show resolved Hide resolved

karpetrosyan and others added 2 commits October 23, 2025 15:21

review fixes

1192cb2

Merge branch 'next' into support-zod-v4-schemas

646c820

karpetrosyan requested a review from RobertCraigie October 24, 2025 11:16

RobertCraigie reviewed Oct 24, 2025

View reviewed changes

src/helpers/zod.ts Outdated Show resolved Hide resolved

RobertCraigie reviewed Oct 24, 2025

View reviewed changes

tests/lib/transform.test.ts Outdated Show resolved Hide resolved

karpetrosyan and others added 3 commits October 24, 2025 15:33

remove AI traces

dfed1f0

Update tests/lib/transform.test.ts

195a6ed

Co-authored-by: Robert Craigie <robert@craigie.dev>

improve types

79a8c53

RobertCraigie reviewed Oct 24, 2025

View reviewed changes

RobertCraigie added 3 commits October 24, 2025 12:40

fix doc comment

2fbb1ce

rename isDict

ddeb05e

improve error

95ce1a9

RobertCraigie approved these changes Oct 24, 2025

View reviewed changes

RobertCraigie merged commit 10ef7ff into openai:next Oct 24, 2025
4 of 5 checks passed

stainless-app bot mentioned this pull request Oct 24, 2025

release: 6.7.0 #1689

Merged

stainless-app bot pushed a commit that referenced this pull request Oct 24, 2025

feat: add support for zod@4 schemas (#1666)

40db44f

Co-authored-by: Robert Craigie <robert@craigie.dev>

Uh oh!

feat: Add support for zod@4 schemas #1666

feat: Add support for zod@4 schemas #1666

Uh oh!

Conversation

karpetrosyan commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes being requested

Additional context & links

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

loky-lp commented Oct 20, 2025

Uh oh!

dtmeadows left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RobertCraigie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

karpetrosyan commented Oct 1, 2025 •

edited

Loading