Skip to content

Send readers to studio.poly.ai for their key, and name it POLY_API_KEY - #12

Merged
pmckeetx merged 2 commits into
mainfrom
studio-signup
Oct 14, 2026
Merged

pmckeetx merged 2 commits into
mainfrom
studio-signup

Conversation

@pmckeetx

@pmckeetx pmckeetx commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

The README and .env.example now tell readers to sign up or log in at studio.poly.ai and create the key in the API Keys tab. That key works on api.studio.poly.ai, this repo's default host. Docs and README wording only, apart from any code noted below.

The missing-key ValueError and the api_key docstring now point at the API Keys tab at https://studio.poly.ai. uv run pytest 34 passed; ruff, format and mypy clean. The LiveKit demo picks the new message up on its next re-lock. It still works without one.

Paired docs PR: PolyAI-LDN/polyai-mintlify-doc#660

Also: DIALOG_API_KEY renamed to POLY_API_KEY

Peter chose the ADK's name. poly apikey writes the account key to POLY_API_KEY "for use in your own code (the PolyAI APIs, Dialog RSN)" (adk/get-started/get-started.mdx), so one variable now covers both. DIALOG_REALTIME_URL is unchanged. No fallback to the old name, as with the earlier renames: an existing .env needs its key line renamed.

Tested with the key exported as POLY_API_KEY, against api.us.poly.ai (our only keys are internal US keys): plugin pytest 34 passed with ruff and mypy clean; the docs quickstart sample; voice_agent.py --say; the browser relay with a 48 kHz client; after.py --say; speech to text in Python and Node; the streaming TTS agent connects; the voice agent probe with barge-in. The LiveKit demo authenticated and Dialog-RSN-1 sent the greeting, but ElevenLabs refused synthesis (the free-tier key in our .env has used its 10,000 credits), so the rest of that call did not run.
Merge before PolyAI-LDN/dialog-rsn-1-livekit#4, which then needs a re-lock (uv lock --upgrade-package livekit-plugins-polyai). Until then the demo's locked plugin reads DIALOG_API_KEY while its .env.example says POLY_API_KEY.

🤖 Generated with Claude Code

pmckeetx and others added 2 commits October 14, 2026 13:37
Assume every reader signs up or logs in at studio.poly.ai and creates the key
in the API Keys tab, which is what api.studio.poly.ai accepts. Drops the
regional-Studio detours from the setup steps.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Same name the ADK uses: `poly apikey` writes the account key to POLY_API_KEY
for the PolyAI APIs and Dialog-RSN-1, so one variable now works for both.
No fallback to the old name, as with the earlier renames.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pmckeetx pmckeetx changed the title Send readers to studio.poly.ai for their API key Send readers to studio.poly.ai for their key, and name it POLY_API_KEY Oct 14, 2026
@pmckeetx
pmckeetx merged commit 37eb219 into main Oct 14, 2026
7 checks passed
@pmckeetx
pmckeetx deleted the studio-signup branch October 14, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant