Skip to content

docs(readme): fix two typos and remove duplicate section #1733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joaopalmeiro wants to merge 2 commits into
base: master
Choose a base branch
from
+2 −16
Open

docs(readme): fix two typos and remove duplicate section #1733

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc5ae87
docs(readme): fix two typos and remove duplicate section
joaopalmeiro Jan 16, 2026
796f07c
Merge branch 'master' into fix-typos-duplicated-section-readme
joaopalmeiro Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 2 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ const client = new OpenAI({

## Streaming responses

We provide support for streaming responses using Server Sent Events (SSE).
We provide support for streaming responses using Server-Sent Events (SSE).

```ts
import OpenAI from 'openai';
Expand Down Expand Up @@ -500,20 +500,6 @@ while (page.hasNextPage()) {
}
```

## Realtime API

The Realtime API enables you to build low-latency, multi-modal conversational experiences. It currently supports text and audio as both input and output, as well as [function calling](https://platform.openai.com/docs/guides/function-calling) through a `WebSocket` connection.

```ts
import { OpenAIRealtimeWebSocket } from 'openai/realtime/websocket';

const rt = new OpenAIRealtimeWebSocket({ model: 'gpt-realtime' });

rt.on('response.text.delta', (event) => process.stdout.write(event.delta));
```

For more information see [realtime.md](realtime.md).

## Microsoft Azure OpenAI

To use this library with [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview), use the `AzureOpenAI`
Expand Down Expand Up @@ -775,7 +761,7 @@ The following runtimes are supported:
- Vercel Edge Runtime.
- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
- Nitro v2.6 or greater.
- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.
- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to `true`.
<details>
<summary>More explanation</summary>

Expand Down