Skip to content

chore: add missing .env.sample files to voice-agents examples - #80

Open
ayushsingh82 wants to merge 1 commit into
smallest-inc:mainfrom
ayushsingh82:chore/add-missing-env-samples
Open

chore: add missing .env.sample files to voice-agents examples#80
ayushsingh82 wants to merge 1 commit into
smallest-inc:mainfrom
ayushsingh82:chore/add-missing-env-samples

Conversation

@ayushsingh82

Copy link
Copy Markdown

The root README.md ("a .env.sample [is] included in every example directory") and CONTRIBUTING.md ("Create a .env.sample listing all required variables") both treat a per-example .env.sample as standard, but these 11 voice-agent examples shipped without one — even though their code calls load_dotenv() / os.getenv(...). Following the README as written leaves you with a missing-credentials error and no hint which vars to set.

Each new file lists exactly the variables that example reads, styled to match the existing telephony/ and pipecat-voice-agent/ samples:

Example Variables
agent_with_tools, call_control, getting_started, inbound_ivr, interrupt_control, language_switching SMALLEST_API_KEY, OPENAI_API_KEY
appointment_scheduler + CAL_API_KEY, CAL_EVENT_TYPE_ID, CAL_TIMEZONE
bank_csr + TRANSFER_NUMBER
campaigns SMALLEST_API_KEY, AGENT_ID, AUDIENCE_ID, CAMPAIGN_ID
form_filler + JOTFORM_API_KEY, JOTFORM_FORM_ID
observability + LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY, LANGFUSE_HOST

Docs-only / config-only — no code changes.

Scope note: examples under integrations/langchain/, blog-code-samples/, speech-to-text/benchmarks, speech-to-text/youtube-summarizer and text-to-speech/quickstart are also missing a sample, and a few dirs use .env.example instead of the documented .env.sample name. Happy to follow up on those separately if you'd like.

The root README and CONTRIBUTING state every example ships a
.env.sample, but these 11 voice-agent examples had none despite
their code calling load_dotenv() / os.getenv(). Add a sample for
each listing exactly the variables that example reads:

- agent_with_tools, call_control, getting_started, inbound_ivr,
  interrupt_control, language_switching: SMALLEST_API_KEY, OPENAI_API_KEY
- appointment_scheduler: + CAL_API_KEY, CAL_EVENT_TYPE_ID, CAL_TIMEZONE
- bank_csr: + TRANSFER_NUMBER
- campaigns: SMALLEST_API_KEY, AGENT_ID, AUDIENCE_ID, CAMPAIGN_ID
- form_filler: + JOTFORM_API_KEY, JOTFORM_FORM_ID
- observability: + LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY, LANGFUSE_HOST

Style matches the existing telephony/ and pipecat-voice-agent/ samples.
@crim-app

crim-app Bot commented Sep 3, 2026

Copy link
Copy Markdown

crim doesn't review pull requests automatically here.

Comment crim review on this pull request whenever you want a review.

@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown

@ayushsingh82 is attempting to deploy a commit to the developer-2074's projects Team on Vercel.

A member of the Team first needs to authorize it.

@ayushsingh82

Copy link
Copy Markdown
Author

@abhishekmishragithub mind taking a look? Config-only — adds the per-example .env.sample that the root README already says every example ships, for 11 voice-agent dirs that were missing it. No code touched. Can split further or scope down if you prefer.

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