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..238d4a2 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="" 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 8782e40..0c5cbe8 100644 --- a/README.md +++ b/README.md @@ -57,12 +57,44 @@ 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). +`` 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: ```bash -export CALLE_API_KEY="calle_test_key" +export CALLE_API_KEY="" export CALLE_BASE_URL="https://api.heycall-e.com" export CALLE_EXAMPLE_PHONE="+14155550100" ```