Skip to content

docs: fix the install instructions and stale endpoint, add a status section #66

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
darrenapfel wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix the install instructions and stale endpoint, add a status section #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a21e8b
docs: fix the install instructions and stale endpoint, add a status s…
Aug 25, 2026
e589171
docs: neutral status wording variant, held for positioning alignment
darrenapfel Aug 31, 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
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,20 @@ A pair of experimental web components for integrating with Deepgram's Voice Agen
- The hoop component is the animation, standalone. More useful when you've got your own rules for
socket integration, and just want the look and feel!

## Status

These components are pre-1.0, and interfaces may change between versions. If you want an embeddable, framework-free widget rather than a bare web component, see [`@deepgram/agents-widget`](https://github.com/deepgram/agent), which is the more recent embeddable layer.

## Installation

Install via github by adding to your package.json dependencies:
Install from the npm registry:

```json
"@deepgram/browser-agent": "deepgram/browser-agent#main",
```bash
npm install @deepgram/browser-agent
```

Installing from a GitHub reference (for example `"@deepgram/browser-agent": "deepgram/browser-agent#main"` in your package.json dependencies) does not work: the repository does not commit its build output and has no prepare script, so a GitHub install delivers a package without its entry point.

## Using the main component

Import the library anywhere for the component to be registered to `deepgram-agent`:
Expand Down Expand Up @@ -66,7 +72,7 @@ Attributes section.
development you may find it more convenient to use an API key (`token` scheme). **Never use API
keys in a production browser application!**
- `url` (required): The API url
- Chances are you'll set this to `"https://api.deepgram.com/v1/agent"`!
- Chances are you'll set this to `"wss://agent.deepgram.com/v1/agent/converse"`, as in the example above.
- `idle-timeout-ms` (optional): how long to wait for user idleness before closing the socket
- Timer starts whenever the user is expected to speak (meaning right when opening the connection,
and right after each `AgentAudioDone` event).
Expand Down