Skip to content

docs: clarify API key placeholders and safe diagnostic sharing - #42

Open
JJasonSun wants to merge 2 commits into
mainfrom
codex/docs-344-key-redaction
Open

JJasonSun wants to merge 2 commits into
mainfrom
codex/docs-344-key-redaction

Conversation

@JJasonSun

@JJasonSun JJasonSun commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

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, and can_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 --check passed.

Checklist

  • I kept this change within the documented server SDK scope.
  • I did not add browser/client-side patterns that expose CALL-E API keys.
  • I did not include private collaboration links or unconfirmed public repository references.
  • I updated the relevant documentation.
  • I updated the changelog.
  • I ran the relevant local checks.

Local checks

bash scripts/validate.sh passed from the activated project environment: OpenAPI verification, 51 tests, lint, types, example compilation, public-repository hygiene, wheel/sdist builds and metadata checks, and fresh distribution installation smoke tests. uv run python examples/create_and_wait.py completed the real-service validation described above.

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