Skip to content

docs: use explicit API key placeholders #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JJasonSun merged 2 commits into from
Sep 15, 2026
Merged

docs: use explicit API key placeholders #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
570cb41
docs: use explicit API key placeholders
JJasonSun Sep 15, 2026
0f644bf
docs: retain production API key prefix guidance
JJasonSun Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions content/guides/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ Create and manage API keys in the [CALL-E dashboard](https://dashboard.heycall-e
Production API keys use the `iams_live_` prefix.
Pass the complete dashboard value directly to the SDK; no client-side token exchange is required.

Store the key in your backend secret manager or runtime environment:
Store the key in your backend secret manager or runtime environment. Replace
`<YOUR_CALLE_API_KEY>` below with the complete key from the dashboard; the
placeholder is not a working credential:

```bash
export CALLE_API_KEY="iams_live_example"
export CALLE_API_KEY="<YOUR_CALLE_API_KEY>"
```

Do not commit API keys, print them in logs, send them to browser code, or store them in mobile apps. The CALL-E SDKs are server SDKs for trusted backend services and workers.
Expand Down
6 changes: 4 additions & 2 deletions content/guides/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ pnpm add @call-e/calle
pip install calle-ai
```

Set your API key before running the examples:
Set your API key before running the examples. Replace `<YOUR_CALLE_API_KEY>`
with the complete key from the dashboard; the placeholder is not a working
credential:

```bash
export CALLE_API_KEY="iams_live_example"
export CALLE_API_KEY="<YOUR_CALLE_API_KEY>"
```

You can view your API keys in the [CALL-E dashboard](https://dashboard.heycall-e.com/account/api-keys).
Expand Down