I could have swore there used to be documentation for the API response fields but there’s nothing. Not a single API call documents the response fields returned. Furthermore there’s not even an example of the response for functions: [image] OpenAI API Explore developer resources, tutoria…

Are you aware of “The OpenAI Cookbook”? The OpenAI Cookbook shares example code for accomplishing common tasks with the OpenAI API . [image] GitHub - openai/openai-cookbook: Examples and guides for using the OpenAI API Examples and guides for using the OpenAI API. Contribute to openai…

[image] EricGT: Are you aware of “The OpenAI Cookbook”? Yes… But that’s not reference documentation. Those are guides. Sorry not trying to be pedantic but reference docs are (or at least should be) detailed descriptions of every API call and input+ouput parameter. I build SDK’s on top of thi…

It’s details like this that should be in the reference docs, not buried as a comment in an interface definition somewhere: [image] Don't trust the output for functions Prompting Interesting comment in the OpenAI Node.JS Library : The arguments to call the function with, …

Yes, the docs are a little undoc’ed. Here are some other examples you probably know: GPT - OpenAI API Guides

Good feedback, we have wanted to do this for a while but it has not been a priority, I will work with the team on getting this updated!

I have seen examples using well defined type hints, if the team moves these to pydantic generating swagger docs should be trivial from there

There's no Response documentation for any API calls

Documentation

EricGT June 18, 2023, 11:47am 2

Are you aware of “The OpenAI Cookbook”?

The OpenAI Cookbook shares example code for accomplishing common tasks with the OpenAI API.

Topic		Replies	Views
⚠ Responses API is badly documented Documentation api	10	1101	July 19, 2025
Responses API documentation on structured outputs is lacking Documentation structured-output , responses-api	7	2841	December 20, 2025
OpenAI API Response Documentation API	0	908	April 7, 2023
:skull_and_crossbones: GPT-5 update Documentation Errors Documentation api	2	828	August 10, 2025
New Responses reasoning.content, reasoning.mode, prompt_cache_options not documented by rejecting models Documentation chat-completion , responses-api	1	81	July 20, 2026

There's no Response documentation for any API calls

Related topics