Skip to content

Commit 5525bc4

Browse files
authored
oss(da-cli): clarify api key usage (#3598)
1 parent 0f7ba88 commit 5525bc4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/oss/deepagents/cli/configuration.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Providers have the following configuration options:
106106
</ResponseField>
107107

108108
<ResponseField name="api_key_env" type="string" post={["optional"]}>
109-
Override the environment variable name checked for credentials. Most chat model packages read from a default env var automatically. See the [Provider reference](/oss/deepagents/cli/providers#provider-reference) table for which variable each provider checks.
109+
The **name** of the environment variable that holds the API key (e.g., `"OPENAI_API_KEY"`), not the key itself. The CLI reads the credential from this env var at startup to verify access before creating the model. Most chat model packages read from a default env var automatically. See the [Provider reference](/oss/deepagents/cli/providers#provider-reference) table for which variable each provider checks.
110110
</ResponseField>
111111

112112
<ResponseField name="base_url" type="string" post={["optional"]}>
@@ -115,6 +115,8 @@ Providers have the following configuration options:
115115

116116
<ResponseField name="params" type="object" post={["optional"]}>
117117
Extra keyword arguments forwarded to the model constructor. Flat keys (e.g., `temperature = 0`) apply to every model from this provider. Model-keyed sub-tables (e.g., `[params."gpt-4o"]`) override individual values for that model only; the merge is shallow (model wins on conflict).
118+
119+
Do not put credentials (e.g., `api_key`) in `params`. Use [`api_key_env`](#provider-configuration) to point at an environment variable instead.
118120
</ResponseField>
119121

120122
<ResponseField name="profile" type="object" post={["optional"]}>

0 commit comments

Comments
 (0)