鲸木文档
把“我要怎么用”变成清楚、可搜索、可验证的一条路径。页面能直接解释的事情不重复写文档；复杂操作才进入这里。
重点先验证布局、交互、搜索和品牌统一；具体业务内容可以后续按真实客户问题逐条替换。
快速开始
下面用一条最短路径演示从 API Key 到第一次请求。Key 使用占位符，不需要在文档里暴露任何真实凭证。
在控制台获取你自己的 Key。不要把 Key 发给别人，也不要写进公开网页。
使用鲸木 API 地址，并保持 HTTPS。
先用一个只读接口验证网络、鉴权和响应是否正常。
API 地址
当前示例以主 API 域名作为入口。具体 SDK 是否需要追加 /v1，取决于客户端配置方式。
https://api.hzjingmu.cncurl https://api.hzjingmu.cn/v1/models \
-H "Authorization: Bearer YOUR_API_KEY"client = OpenAI(
base_url="https://api.hzjingmu.cn/v1",
api_key="YOUR_API_KEY"
)const client = new OpenAI({
baseURL: "https://api.hzjingmu.cn/v1",
apiKey: "YOUR_API_KEY"
})API Playground
这是完全本地的请求构造器：只生成示例 cURL 与模拟响应，不会自动向公网发送请求，也不会保存 API Key。
权限与账号
把账号订阅、权限开通、使用资格放在同一个入口里，用户先知道“我能不能用”，再进入具体教程。
额度与充值
充值页面负责金额、支付方式和实际到账；文档只解释复杂规则、失败场景和退款/异常处理。
KWORK
工具类文档更适合用“安装 → 配置 → 验证 → 常见错误”的结构，而不是把所有功能放在一页。
API 鉴权
所有示例都使用占位符 YOUR_API_KEY。真实 Key 只保存在用户自己的客户端或安全配置中。
Authorization: Bearer YOUR_API_KEY常用参数
参数表的目标是让用户快速确认“叫什么、什么类型、是否必须”，详细行为再链接到具体模型说明。
| 参数 | 类型 | 要求 | 说明 |
|---|---|---|---|
model | string | 必填 | 要调用的模型名称。 |
messages | array | Chat | 对话消息数组。 |
temperature | number | 可选 | 采样随机度；并非所有模型都支持。 |
stream | boolean | 可选 | 是否使用流式响应。 |
模型与路由
把“选模型”和“如何调用”分开。用户先选到可用模型，再看该模型是否有特殊参数。
常见错误
先确认 Key 是否存在、是否完整、请求头格式是否正确。
检查限速、额度、并发和上游渠道状态。
确认模型名、渠道路由和账户权限。
先区分本地网络、域名、反代与上游问题。
常见问答
为什么文档不把所有内容都写进去？
价格、实时状态、当前额度这类信息应该由产品页面直接表达。文档只解释复杂操作、规则和例外，避免重复维护。
API Key 应该放在哪里？
只放在你自己的安全客户端或服务端配置中。不要写进公开网页、截图、聊天记录或教程示例。
遇到 429 应该先检查什么？
先看额度、并发、速率限制和模型路由，再判断是否需要检查上游渠道。
为什么 Playground 不直接发送请求？
这个静态原型的目标是验证文档体验。为了避免误发请求或暴露真实 Key，目前只生成请求并返回模拟结果。
获取支持
遇到问题时，优先带上错误信息、发生时间、使用入口和可公开的请求上下文；不要发送 API Key、密码、Cookie 或验证码。