docs: clarify API key placeholders and safe diagnostic sharing - #25
Open
Zen-cronic wants to merge 3 commits into
Open
Zen-cronic wants to merge 3 commits into
Zen-cronic wants to merge 3 commits into
Conversation
A non-iams_ key is rejected with 401 (identical to no key); align the Quickstart placeholder with the Authentication guide's iams_live_ prefix.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Use
<YOUR_CALLE_API_KEY>in README and CONTRIBUTING and clarify that example API keys are non-working placeholders and that a sample prefix must not define credential validation or redaction. README adds guidance for secret values, phone fields, and free-text call data, with a redacted diagnostic excerpt. CONTRIBUTING uses the same placeholder and links that guidance; CHANGELOG records the documentation change.Refs CALLE-AI/awesome-phone-call-agents#344.
Documentation only. SDK behavior, API contract, and package version are unchanged; registry documentation updates with a subsequent package release.
Validation
On September 15, 2026, ran the existing TypeScript and Python create-and-wait examples locally against the real service with the official authorized test hotline and SDK source version 0.7.1. TypeScript used Node 26.7.0; Python used Python 3.12.14. Both commands returned zero and a completed call. The identical request and demo idempotency key returned the same Call ID: one attempt with seven transcript turns,
completed_count: 1, andcan_attend: unknown. Both SDKs preserved the original task text. Credentials and call data are excluded from this PR.This validates the credential setup and call-to-result flow. Goal Runs, webhook examples, universal key-prefix rules, automated redaction, and real meeting availability were not validated. The JSON excerpt is illustrative redacted data, not an executable request.
GitHub Markdown rendering and visual inspection passed for both README sections.
git diff --checkpassed.Checklist
Local checks
pnpm run validatepassed: OpenAPI verification, 36 tests, type checks, example type checks, release-version checks, public-repository hygiene, package build, and tarball installation smoke test.pnpm run example:create-and-waitcompleted the real-service validation described above.