Skip to content

Commit b98f5a3

Browse files
committed
docs: update some docs
1 parent 10f113c commit b98f5a3

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
This repo is for an article I've written about how to use the OpenAI Realtime API with TypeScript + React and WebRTC.
44
It is a working example that you can experience the Realtime API with yourself. The WebRTC client also does some heavy lifting around managing the conversation state and audio streams.
55

6+
Check out **[the demo](https://activescott.github.io/typescript-openai-realtime-api/)**
7+
68
This repo also has an example that demonstrates the [OpenAI Official SDK support for WebSocket API](https://github.com/openai/openai-node/commit/a796d21f06307419f352da8b9943f6745ff4084f) that was released in beta on Jan 17, 2025. As of the time that I'm writing this, the official SDK doesn't provide support for managing the conversation state, audio streams, nor WebRTC which is all demonstrated in the example. See [apps/browser-example/src/pages/WebRTCExample.tsx](apps/browser-example/src/pages/WebRTCExample.tsx) for the complete example code.
79

810
This project also has a reusable package that you can use in your own projects in [packages/browser](packages/browser). I plan to publish this here soon for others. If you're interested in the package let me know and I'll get it pushed to npm!
@@ -12,9 +14,9 @@ More at https://scott.willeke.com/ai-typescript-client-for-openai-realtime-api
1214
## References
1315

1416
- https://platform.openai.com/docs/guides/realtime-webrtc - guide
15-
- https://github.com/openai/openai-openapi - reference
17+
- https://platform.openai.com/docs/api-reference/realtime - reference
18+
- https://github.com/openai/openai-openapi - OpenAPI specs
19+
- https://github.com/openai/openai-node - Official SDK
20+
- https://webrtc.github.io/samples/
1621
- https://reactrouter.com/home
1722
- https://www.typescriptlang.org/docs/handbook/project-references.html
18-
- https://github.com/openai/openai-node
19-
- https://webrtc.github.io/samples/
20-
- https://fly.io/docs/languages-and-frameworks/dockerfile/

apps/browser-example/src/pages/WebRTCExample.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ export function WebRTCExample({
4444
<h1>WebRTC Example</h1>
4545
<p>
4646
This example demonstrates how to use the OpenAI Realtime API directly.
47-
It is using the TypeScript client from the article
48-
https://scott.willeke.com/ai-typescript-client-for-openai-realtime-api .
47+
It is using the TypeScript client from the article{" "}
48+
<a href="https://scott.willeke.com/ai-typescript-client-for-openai-realtime-api">
49+
AI Learns to Listen: TypeScript Client for OpenAI’s Realtime API
50+
</a>{" "}
51+
by Scott Willeke.
4952
</p>
5053
<audio ref={audioElementRef}></audio>
5154
<RealtimeSessionView

0 commit comments

Comments
 (0)