Responses API documentation on structured outputs is lacking

[_j]

@John_Doe5

This still needs to be formally documented somewhere though.

I offer a function that can take the primitives, a schema and the “container metadata”, a parameter whether it is for_chat_completions, and delivers your API call’s “text” for Responses or “response_format” for Chat Completions:

@_j

From other code, I pulled out and made a Python function to address a knowledge and documentation shortcoming, and code itself is readable as documentation.

Or you can just use the function. Builds the correct structured response output format for JSON schema for either:

• the Responses API text container (for the request’s text parameter), or
• the Chat Completions response_format container, using for_chat_completions=True,

Run the full python script and it even runs the same schema against both endpoints as “proof”.

So, I gave that forum topic a title including, “documentation improved a bit”