Skip to content

Commit 0d1cce2

Browse files
docs(readme): add link to api.md (openai#291)
1 parent a10b895 commit 0d1cce2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ yarn add openai
1818

1919
## Usage
2020

21-
> [!IMPORTANT]
22-
> Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
21+
The full API of this library can be found in [api.md file](https://github.com/openai/openai-node/blob/master/api.md). The code below shows how to get started using the chat completions API.
2322

2423
```js
2524
import OpenAI from 'openai';
@@ -90,6 +89,9 @@ main();
9089

9190
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
9291

92+
> [!IMPORTANT]
93+
> Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
94+
9395
## File Uploads
9496

9597
Request parameters that correspond to file uploads can be passed in many different forms:

0 commit comments

Comments
 (0)