apiKeyHelper
A Claude Code settings key, read out of the shipped bundle. It has been in the build since v2.1.138, including the newest one read.
What it is
Generate the [API credential](/docs/en/authentication#credential-management) with your own command
Anthropic's own wording. Read off Claude Code settings reference, captured 2026-08-28.
Presence across releases
| Releases | Reading | Declared type | Default |
|---|---|---|---|
| 2.1.245 – 2.1.250 5 releases | never mined | — | — |
| 2.1.138 – 2.1.243 95 releases | in the build | — | — |
A row reading never mined is a release with no archived bundle behind it. Nothing was read out of it, so nothing here says whether the name was in it. A declared type or a default is only ever what that release's own bundle stated.
Changelog entries naming it
-
v2.1.248Gateway model discovery explains why it skipped, and can use apiKeyHelper
Gateway model discovery can authenticate with apiKeyHelper and logs why it skipped.
named in this entry
-
v2.1.234SDK reports where an API key actually came from
The SDK now reports where an API key really came from, like the env var or an apiKeyHelper.
named in this entry
-
v2.1.227apiKeyHelper output is validated before it is sent
Your apiKeyHelper output is now checked for junk characters and length before being used.
named in this entry
-
v2.1.227Bad HTTP header values are rejected before the request instead of crashing
Illegal header values from your env or key helper now fail clearly instead of crashing.
named in this entry
-
v2.1.224Artifact tool now explains exactly which credential is blocking it
The artifact tool now names the exact credential blocking you, with a fix for each.
named in this entry
Documentation pages
- Claude Code settings reference reference table Claude Code CLI
- Claude Code settings reference table Claude Code CLI
- Set up Claude Code for your organization mentions it Claude Code CLI
- Persist sessions to external storage mentions it Claude Code CLI
- Agent SDK reference - TypeScript mentions it Claude Code CLI
- Authentication mentions it Claude Code CLI
- Claude Code changelog mentions it Claude Code CLI
- Claude apps gateway for Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry mentions it Claude Code CLI
- Claude apps gateway configuration mentions it Claude Code CLI
- Environment variables mentions it Claude Code CLI
- Error reference mentions it Claude Code CLI
- Speed up responses with fast mode mentions it Claude Code CLI
- Run Claude Code programmatically mentions it Claude Code CLI
- Other LLM gateways mentions it Claude Code CLI
A reference table page is one whose own table defines this name, and it is where the description above came from. A page that mentions it carries the name somewhere in its text and may say nothing about it at all. Every page carrying it.
Read out of the published npm bundle release by release, and out of Anthropic's own documentation as this site captured it. Nothing on this page is a description anybody here wrote about what the settings key does. All settings keys.