zodResponseFormat not working with OpenAI Responses interface

Question

If trying to use zodResponseFormat to setup structured outputs (as you did with other OpenAI interfaces) you may get an error that says No overload matches this call.

How can you use zod with structured outputs and the new openai.responses.create interface?

Answer 1

OpenAI added a new helper function zodTextFormat but hasn't updated their docs yet on how to use it with responses.

1. import the new helper -

   import { zodTextFormat } from "openai/helpers/zod";
   

2. Use it in this new format -

   const response = await openai.responses.create({
         model: "gpt-4o",
         input: [
           {
             role: "system",
             content: systemPrompt,
           },
           {
             role: "user",
             content: [
               {
                 type: "input_text",
                 text: userPrompt,
               },
             ],
           },
         ],
         text: {
           format: zodTextFormat(YourZodSchema, "zod_schema"),
         },
       });