Skip to content

Your lightweight open-source personal agent.

docs(providers): align recipes with API declarations

chengyongru432c044f8ea9
diff --git a/docs/guides/configure-openai-compatible-provider.md b/docs/guides/configure-openai-compatible-provider.md
index 1e0c6a84a..e735378c2 100644
--- a/docs/guides/configure-openai-compatible-provider.md
+++ b/docs/guides/configure-openai-compatible-provider.md
@@ -69,7 +69,7 @@ nanobot agent -m "Hello!"
- Use separate provider names for separate endpoints.
- Use a placeholder key such as `EMPTY` only when the endpoint requires a
non-empty key but does not validate it.
-- Leave `apiType` unset for custom endpoints. Declare the endpoint's supported protocols and default with [`providers.<name>.api`](../configuration.md#custom-connection-apis), or use Supported APIs and Default API in the WebUI connection editor. Auto model presets inherit this default.
+- Declare the endpoint's supported protocols and default with [`providers.<name>.api`](../configuration.md#custom-connection-apis), or use Supported APIs and Default API in the WebUI connection editor. Auto model presets inherit this default.
- For models requiring Responses, declare `api.supportedApis: ["responses"]` in their [model preset](../configuration.md#preset-request-api), or select Responses in the WebUI preset editor.
- Custom gateways serving Anthropic Messages can use `api.supportedApis: ["anthropic_messages"]` in the preset, or select Anthropic Messages in the editor. This uses `/v1/messages` with the same provider connection.
diff --git a/docs/provider-cookbook.md b/docs/provider-cookbook.md
index e1cbf031a..1940e8238 100644
--- a/docs/provider-cookbook.md
+++ b/docs/provider-cookbook.md
@@ -200,7 +200,7 @@ Verify:
OPENAI_API_KEY="sk-..." nanobot agent -m "Hello!"
```
-If your shell cannot use inline environment variables, set `OPENAI_API_KEY` first and then run `nanobot agent -m "Hello!"`. If the provider rejects `apiType`, remove `apiType` unless you are using a documented OpenAI-specific mode.
+If your shell cannot use inline environment variables, set `OPENAI_API_KEY` first and then run `nanobot agent -m "Hello!"`. Use `providers.openai.api` for the connection default or a [preset API declaration](./configuration.md#preset-request-api) for an individual model. Existing `apiType` inputs follow the [two-release migration window](./configuration.md#legacy-openai-api-selector-migration).
## Recipe: Anthropic Direct
@@ -378,7 +378,7 @@ For multiple custom endpoints, do not overload the single `custom` block. Name e
}
```
-These custom names behave like direct OpenAI-compatible providers: `apiBase` is required, `apiKey` is optional when the endpoint allows anonymous or placeholder credentials, and `apiType` should be left unset. They do not support Anthropic-compatible endpoints; use the `anthropic` provider with `apiBase` for that case.
+These custom names define direct connections: `apiBase` is required and `apiKey` is optional when the endpoint allows anonymous or placeholder credentials. Declare accepted protocols and a default with [`providers.<name>.api`](./configuration.md#custom-connection-apis). An Anthropic-compatible endpoint uses `supportedApis: ["anthropic_messages"]`; model presets can select any protocol within the connection declaration.
## Recipe: Ollama Local Model