From 77549413bf0bdfa122070b3d1bbae948b6c3f3c1 Mon Sep 17 00:00:00 2001 From: Kaung Zin Hein Date: Mon, 14 Sep 2026 08:27:41 -0400 Subject: [PATCH 1/3] docs: use the documented iams_live_ prefix in the README key example A non-iams_ key is rejected with 401 (identical to no key); align the Quickstart placeholder with the Authentication guide's iams_live_ prefix. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8782e40..24115c2 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ details. Set the API key before running call examples: ```bash -export CALLE_API_KEY="calle_test_key" +export CALLE_API_KEY="iams_live_example" export CALLE_BASE_URL="https://api.heycall-e.com" export CALLE_EXAMPLE_PHONE="+14155550100" ``` From c02f12006e64b66e4125dda1edef694ffcc4e31a Mon Sep 17 00:00:00 2001 From: "J.Jason" <130959319+JJasonSun@users.noreply.github.com> Date: Tue, 15 Sep 2026 14:29:35 +0800 Subject: [PATCH 2/3] docs: explain API key placeholders and safe diagnostic sharing --- CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 6 +++++- README.md | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 07b5d62..a6d1677 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- Clarify placeholder API keys and redaction of credentials and private call data in SDK documentation. + ## [0.7.1] - 2026-09-03 ### Added diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65cbbfd..2c3442a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,8 +16,12 @@ generated tarball. The tarball is ignored by Git. ## Local examples +Replace the sample credentials with your own key before running. Read +[API keys and diagnostic output](./README.md#api-keys-and-diagnostic-output) +before sharing example output. + ```bash -export CALLE_API_KEY="calle_test_key" +export CALLE_API_KEY="iams_live_example" export CALLE_BASE_URL="https://api.heycall-e.com" export CALLE_EXAMPLE_PHONE="+14155550100" pnpm run example:create-and-wait diff --git a/README.md b/README.md index 24115c2..50115d2 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,38 @@ Polling helpers accept interval and timeout options. See the method signatures in your editor and the [SDK guide](https://docs.heycall-e.com/#/sdks) for details. +## API keys and diagnostic output + +Use the complete API key issued by the [CALL-E dashboard](https://dashboard.heycall-e.com/account/api-keys). +`iams_live_example` and the fallback keys in example scripts are non-working +placeholders. Replace them with your own key; do not derive key validation or +redaction patterns from a sample prefix. + +Before logging or sharing diagnostics: + +- Prefer a small set of fields such as SDK version, HTTP status, and error + code over dumping a full request, response, or error object. +- Remove the entire `Authorization` header and configured secret values. + Matching one key prefix is not sufficient. +- Review phone fields and free text, including `task`, transcripts, summaries, + evidence, custom results, metadata, and error details. The SDK preserves the + returned task text, which may contain a phone number or other private data. + Dashboard masking does not redact SDK output or raw API responses. + +For example, a manually redacted response excerpt for sharing can omit all +other fields and replace both the task and recipient phone: + +```json +{ + "status": "completed", + "task": "[REDACTED]", + "recipients": [{"phones": ["[REDACTED]"]}] +} +``` + +This is a diagnostic excerpt, not a create request. Inspect the final text +before publishing it; these replacements are not a general-purpose PII filter. + ## Examples Set the API key before running call examples: From 407f2573af355d0c1552fa6d6214e973e7946af2 Mon Sep 17 00:00:00 2001 From: "J.Jason" <130959319+JJasonSun@users.noreply.github.com> Date: Tue, 15 Sep 2026 17:28:37 +0800 Subject: [PATCH 3/3] docs: use explicit API key placeholders --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c3442a..238d4a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ Replace the sample credentials with your own key before running. Read before sharing example output. ```bash -export CALLE_API_KEY="iams_live_example" +export CALLE_API_KEY="" export CALLE_BASE_URL="https://api.heycall-e.com" export CALLE_EXAMPLE_PHONE="+14155550100" pnpm run example:create-and-wait diff --git a/README.md b/README.md index 50115d2..0c5cbe8 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ details. ## API keys and diagnostic output Use the complete API key issued by the [CALL-E dashboard](https://dashboard.heycall-e.com/account/api-keys). -`iams_live_example` and the fallback keys in example scripts are non-working +`` and the fallback keys in example scripts are non-working placeholders. Replace them with your own key; do not derive key validation or redaction patterns from a sample prefix. @@ -94,7 +94,7 @@ before publishing it; these replacements are not a general-purpose PII filter. Set the API key before running call examples: ```bash -export CALLE_API_KEY="iams_live_example" +export CALLE_API_KEY="" export CALLE_BASE_URL="https://api.heycall-e.com" export CALLE_EXAMPLE_PHONE="+14155550100" ```