space.vars.web\_sdk\_version.
{% embed url="| Web SDK quickstart Connect to a character from React, send a message, and read its reply. | Web SDK quickstart |
| Get started with React Install the package, add the chat widget, and turn on camera and screen share. | Get started with React |
| Get started with vanilla TypeScript Create a client without a framework and mount the vanilla widget. | Get started with vanilla TypeScript |
| Build a website assistant Add a character to every page that knows where the visitor is and can navigate, highlight, and fill in forms. | Build a website assistant |
| Drive facial animation with blendshapes Stream lip sync frames and apply them to a 3D character's morph targets. | Drive facial animation with blendshapes |
| Handle character actions Receive semantic actions or run client tools and return their results. | Handle character actions |
| Use character emotions Read the character's emotion and set its state of mind. | Use character emotions |
| Update character context at runtime Send scene state, template keys, and files during a session. | Update character context at runtime |
| Use long-term memory Let a character remember each person across sessions, and manage those memories. | Use long-term memory |
| Connect with an auth token Keep the API key on your server and connect the browser with a token. | Connect with an auth token |
| Handle errors and disconnects Tell failures, disconnect reasons, and acknowledgments apart, and reconnect. | Handle errors and disconnects |
| Choose a transport Pick SSE, WebRTC or WebSocket, or combine SSE chat with a realtime voice mode. | Choose a transport |
| Chat over the SSE transport Stream text and optional speech over HTTP, with no WebRTC or microphone. | Chat over the SSE transport |
| Use the WebSocket transport Connect over WebSocket instead of WebRTC. | Use the WebSocket transport |
| Connect to a self-hosted deployment Point the SDK at your own hosts instead of api.convai.com. | Connect to a self-hosted deployment |
| Mute the character's voice Silence the character for the listener while it keeps speaking. | Mute the character's voice |
| Host several characters in one room Connect a roster, switch who answers, and change members live (beta). | Host several characters in one room |
| Connect to a character version Use a draft, the latest release, or a tag, and manage versions (beta). | Connect to a character version |
| Connect to a published text chat Run a credential-free, text-only chat from a publication grant. | Connect to a published text chat |
| Render links and link previews Show links the character sends, with optional site cards. | Render links and link previews |
| ConvaiClient reference Every property, method, and control interface on the client. | ConvaiClient reference |
| Configuration and type reference Every connection option, the package entry points, and the shared types. | Configuration and type reference |
| Web SDK event reference Every event the client emits, with its payload. | Web SDK event reference |
| Read raw transport messages Inspect every incoming frame on each transport through rawMessage. | Read raw transport messages |
| useConvaiClient hook reference What the React hook returns and which fields re-render. | useConvaiClient hook reference |