# There's no Response documentation for any API calls

**URL:** <https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514>\
**Category:** Documentation\
**Tags:** api\
**Created:** [June 18, 2023, 11:43am UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514 "2023-06-18T11:43:54Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![stevenic](https://avatars.discourse-cdn.com/v4/letter/s/e480ec/32.png) [@stevenic](https://community.openai.com/u/stevenic)\
**Post date:** [June 18, 2023, 11:43am UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/1 "2023-06-18T11:43:54Z")

</div>

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:

> **[OpenAI API](https://platform.openai.com/docs/api-reference/chat/create)**
>
> Explore developer resources, tutorials, API docs, and dynamic examples to get the most out of OpenAI's platform.

Can we get this fixed?

---

<div class="post-metadata">

**Author:** ![EricGT](https://sea2.discourse-cdn.com/openai1/user_avatar/community.openai.com/ericgt/32/20571_2.png) [@EricGT](https://community.openai.com/u/EricGT)\
**Post date:** [June 18, 2023, 11:47am UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/2 "2023-06-18T11:47:13Z")

</div>

Are you aware of “The OpenAI Cookbook”?

> The OpenAI Cookbook shares example code for accomplishing common tasks with the [OpenAI API](https://openai.com/api/).

> **[GitHub - openai/openai-cookbook: Examples and guides for using the OpenAI API](https://github.com/openai/openai-cookbook)**
>
> Examples and guides for using the OpenAI API. Contribute to openai/openai-cookbook development by creating an account on GitHub.

---

<div class="post-metadata">

**Author:** ![stevenic](https://avatars.discourse-cdn.com/v4/letter/s/e480ec/32.png) [@stevenic](https://community.openai.com/u/stevenic)\
**Post date:** [June 18, 2023, 11:56am UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/3 "2023-06-18T11:56:21Z")

</div>

> [@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 this stuff so I’m going off the reference docs to build my various SDK’s…

---

<div class="post-metadata">

**Author:** ![stevenic](https://avatars.discourse-cdn.com/v4/letter/s/e480ec/32.png) [@stevenic](https://community.openai.com/u/stevenic)\
**Post date:** [June 18, 2023, 12:07pm UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/4 "2023-06-18T12:07:32Z")

</div>

It’s details like this that should be in the reference docs, not buried as a comment in an interface definition somewhere:

> [@Don't trust the output for functions](https://community.openai.com/t/dont-trust-the-output-for-functions/269522/1):
>
> Interesting comment in the [OpenAI Node.JS Library](https://github.com/openai/openai-node/blob/master/dist/api.d.ts#L94): The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. This is from the schema definition for the return value for a function\_call: /\*\* \* The name and arguments of a function that should be called, as generated by the model.…

---

<div class="post-metadata">

**Author:** ![PriNova](https://sea2.discourse-cdn.com/openai1/user_avatar/community.openai.com/prinova/32/752175_2.png) [@PriNova](https://community.openai.com/u/PriNova)\
**Post date:** [June 18, 2023, 5:14pm UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/5 "2023-06-18T17:14:39Z")

</div>

Yes, the docs are a little undoc’ed. Here are some other examples you probably know: [GPT - OpenAI API Guides](https://platform.openai.com/docs/guides/gpt/function-calling)

---

<div class="post-metadata">

**Author:** ![logankilpatrick](https://sea2.discourse-cdn.com/openai1/user_avatar/community.openai.com/logankilpatrick/32/14116_2.png) [@logankilpatrick](https://community.openai.com/u/logankilpatrick)\
**Post date:** [July 6, 2023, 5:28pm UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/6 "2023-07-06T17:28:10Z")

</div>

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!

---

<div class="post-metadata">

**Author:** ![lxk](https://avatars.discourse-cdn.com/v4/letter/l/ad7895/32.png) [@lxk](https://community.openai.com/u/lxk)\
**Post date:** [July 6, 2023, 6:58pm UTC](https://community.openai.com/t/theres-no-response-documentation-for-any-api-calls/269514/7 "2023-07-06T18:58:37Z")

</div>

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