Skip to content

Add OpenAI env placeholders #12

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
NLACE-COM wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add OpenAI env placeholders #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
HEYGEN_API_KEY="your Heygen API key"
NEXT_PUBLIC_BASE_API_URL=https://api.heygen.com
# Optional OpenAI integration keys
OPENAI_API_KEY="your OpenAI API key"
NEXT_PUBLIC_OPENAI_API_KEY="your OpenAI API key"
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ Feel free to play around with the existing code and please leave any feedback fo

6. Run `npm run dev`

### Environment variables

Copy `.env.example` to `.env` and fill in your credentials. The demo understands the following keys:

- `HEYGEN_API_KEY` – used by `app/api/get-access-token/route.ts` to request streaming tokens.
- `NEXT_PUBLIC_BASE_API_URL` – base URL for HeyGen's API (`https://api.heygen.com` by default).
- `OPENAI_API_KEY` – optional key for sample OpenAI integrations.
- `NEXT_PUBLIC_OPENAI_API_KEY` – optional client-side key for OpenAI demos.

### Starting sessions

NOTE: Make sure you have enter your token into the `.env` file and run `npm run dev`.
Expand Down