Skip to content

chore: bump speechify SDK to v3.0.1 across recipes and rename api_key -> token - #3

Merged
luke-speechify merged 1 commit into
mainfrom
l/token-rename
Jul 13, 2026
Merged

chore: bump speechify SDK to v3.0.1 across recipes and rename api_key -> token#3
luke-speechify merged 1 commit into
mainfrom
l/token-rename

Conversation

@luke-speechify

Copy link
Copy Markdown
Collaborator

Summary

speechify-api v3.0.0 renamed the constructor kwarg from api_key/apiKey to token, so every recipe that constructed the client needed updating. Also bumps the pnpm catalog + all Python pyproject pins so the recipes actually install v3.0.1 (previously pinned >=2.0.0, which uv/pnpm was still resolving to v3 opportunistically depending on lockfile freshness).

What changed

  • pnpm-workspace.yaml catalog@speechify/api 2.0.03.0.1
  • Python SDK pinsrecipes/audio/python/sdk/{quickstart,streaming,ssml-emotion,speech-marks,voice-cloning}/pyproject.toml, templates/python/recipe/pyproject.toml, and agents/python-recipes.md: speechify-api>=2.0.0>=3.0.1
  • Python SDK recipes (5): api_keytoken everywhere (env-var lookup, guard, Speechify(token=...))
  • Python native recipes (5): renamed the local api_key variable to token for symmetry with the TS native recipes that already used const token = ...
  • TypeScript SDK recipes + template (6): new SpeechifyClient({ apiKey })new SpeechifyClient({ token })
  • Voice-cloning TS recipe: voices.delete({ id })voices.delete({ voice_id }) — unrelated v3 request-shape drift but it blocked tsc against v3 SDK
  • Markdown recipe pages (3): agents/python-recipes.md, agents/typescript-recipes.md, agents/speechify-tts.md — code samples updated to match

Verification

  • All 11 Python main.py files pass python -m py_compile
  • uv sync succeeds cleanly against speechify-api==3.0.1 for every Python SDK recipe
  • npx tsc --noEmit clean for all 5 TypeScript SDK recipes
  • grep -rn -E '\bapi_key\b|\bapiKey\b' returns 0 hits repo-wide (aside from the intentional SPEECHIFY_API_KEY env var name)

… -> token

speechify-api v3.0.0 renamed the constructor kwarg from api_key/apiKey to
token, so every recipe that constructed the client needed updating. Also bumps
the pnpm catalog + all pyproject pins so the recipes actually install v3.0.1.

- pnpm-workspace.yaml catalog: @speechify/api 2.0.0 -> 3.0.1
- recipes/audio/python/sdk/{quickstart,streaming,ssml-emotion,speech-marks,voice-cloning}/pyproject.toml
  and templates/python/recipe/pyproject.toml + agents/python-recipes.md:
  speechify-api>=2.0.0 -> >=3.0.1
- Python SDK recipes: rename api_key -> token everywhere (env var lookup,
  guard, Speechify(token=...))
- Python native recipes: rename api_key -> token for symmetry with the TS
  native recipes that already used `const token = ...`
- TypeScript SDK recipes + template: new SpeechifyClient({ apiKey }) ->
  new SpeechifyClient({ token })
- recipes/audio/typescript/sdk/voice-cloning: voices.delete({ id }) is now
  voices.delete({ voice_id }) in v3.0.0 (unrelated to the rename but blocks
  tsc against v3 SDK)
- Markdown recipe pages (agents/{python-recipes,typescript-recipes,speechify-tts}.md):
  code samples updated to match
@luke-speechify
luke-speechify merged commit d3a5cbf into main Jul 13, 2026
13 checks passed
@luke-speechify
luke-speechify deleted the l/token-rename branch July 13, 2026 21:31
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