End User Guide

API使用文档

从注册、充值、创建 API Key,到在客户端或代码里完成第一次模型调用。

API使用文档

本文档给 Tenway AI 平台最终用户使用,目标是让用户尽快完成注册、充值、创建 API Key,并在自己的客户端或代码里调用国内大模型。

1. 登录平台

打开 Tenway AI 平台首页,注册或登录账号。

登录后重点看这几个位置:

  • 余额:查看账户剩余额度。
  • 令牌/API Key:创建和管理调用密钥。
  • 模型/价格:查看可用模型和计费规则。
  • 日志/用量:查看每次请求的消耗、状态和错误信息。

2. 充值和余额

调用模型前需要账户有可用余额。

余额会在每次 API 调用后自动扣减。不同模型、不同输入输出长度、不同功能类型,消耗会不同。

建议新用户先小额充值并完成一次测试调用,确认客户端配置正确后再正式使用。

3. 创建 API Key

进入“令牌”或“API Key”页面,创建一个新的密钥。

建议配置:

  • 名称:写清用途,例如 my-app-productioncursor-test
  • 额度限制:测试密钥可以设置较小额度,避免误调用。
  • 过期时间:临时测试建议设置过期时间,正式业务可按内部安全要求设置。

API Key 创建后请妥善保存。不要发到微信群、截图、公开仓库或前端代码里。

4. 接口地址

Tenway AI 提供统一的聊天补全接口,客户端只需要配置平台 Base URL 和 API Key。

常用 Base URL:

https://tenwayclaw.com/v1

请求时使用 Bearer Token 鉴权:

Authorization: Bearer 你的_API_Key

5. 快速测试

把下面的 YOUR_API_KEY 替换成你自己的 API Key。

curl https://tenwayclaw.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-v3",
    "messages": [
      { "role": "user", "content": "你好,请用一句话介绍 Tenway AI。" }
    ]
  }'

如果返回了模型回复,说明配置成功。

6. 在客户端里使用

大多数支持自定义 API 地址的客户端,只需要填写两项:

Base URL: https://tenwayclaw.com/v1
API Key: 你的_API_Key

如果客户端需要填写模型名,请到平台模型列表复制对应模型名称。

常见客户端配置思路:

  • Chatbox、Cherry Studio、NextChat:选择自定义 API/兼容接口,填写 Base URL 和 API Key。
  • Cursor、Code 工具:在自定义模型供应商中填写 Base URL 和 API Key。
  • 自研系统:按客户端 SDK 的 baseURL/base_url 配置方式接入。

7. 模型怎么选

不同国内模型适合不同任务。可以按下面方式快速选择:

  • 日常对话、摘要、简单写作:选择轻量、低价模型。
  • 代码生成、复杂分析、长文档处理:选择能力更强的模型。
  • 图片理解、截图分析:选择支持视觉输入的模型。
  • 需要函数调用、工具调用:选择支持 tool calling/function calling 的模型。
  • 对速度敏感:优先选择低延迟模型。
  • 对成本敏感:优先选择轻量版、快速版或平台活动专区模型。

平台上的模型名称以实际可用列表为准。

8. 功能配置说明

常见参数如下。

model:模型名称。必须填写平台支持的模型名。

messages:对话内容。一般包含用户输入,也可以包含 system 指令。

temperature:控制创造性。数值越低越稳定,越高越发散。普通问答可用 0.3-0.7

max_tokens:限制最大输出长度。设置过大可能增加费用。

stream:是否流式输出。聊天产品建议开启,后台批处理可以关闭。

tools:工具调用配置。只有支持工具调用的模型才可使用。

response_format:结构化输出配置。需要 JSON 输出时可使用,但要确认模型支持。

图片输入:选择支持视觉的模型,并按客户端要求上传图片或传入图片 URL/base64。

9. 计费说明

Tenway AI 按模型使用量计费。不同模型价格不同,通常参考模型厂商官方刊例价,并结合平台实际服务成本展示。

一般会按下面维度计算:

  • 输入 tokens:你发送给模型的内容。
  • 输出 tokens:模型生成的内容。
  • 图片/视觉输入:部分模型会按图片大小、数量或折算 tokens 计费。
  • 长上下文:输入越长,消耗越高。
  • 工具调用:工具调用本身可能增加输入输出 tokens。

简单理解:

一次请求费用 = 输入费用 + 输出费用 + 可能的图片/特殊能力费用

实际扣费以平台账单、用量日志和模型价格页为准。

10. 控制成本建议

  • 测试阶段使用轻量模型。
  • 给测试 API Key 设置额度限制。
  • 不要把完整日志、超长文档反复塞进上下文。
  • 能摘要就先摘要,再让模型处理摘要结果。
  • 对固定格式任务设置 max_tokens
  • 定期查看用量日志,发现异常及时停用密钥。

11. 常见问题

API Key 泄露了怎么办?

立即在平台禁用或删除该 API Key,然后创建新的 API Key。

为什么余额扣得比预期快?

通常是因为输入内容太长、输出太长、使用了高价模型,或客户端开启了多轮上下文。请检查用量日志。

为什么模型调用失败?

常见原因包括余额不足、API Key 错误、模型名写错、客户端 Base URL 填错、请求参数不被模型支持。

Base URL 要不要带 /v1

建议填写:

https://tenwayclaw.com/v1

如果某些客户端会自动拼接 /v1,则按客户端提示填写,避免重复成 /v1/v1

可以在前端网页里直接放 API Key 吗?

不建议。API Key 应放在服务端环境变量或后端配置里,不要暴露给浏览器端用户。

12. 推荐新用户流程

  1. 登录平台。
  2. 充值少量余额。
  3. 创建一个测试 API Key。
  4. 在客户端填写 Base URL 和 API Key。
  5. 选择一个低价模型发起测试。
  6. 查看用量日志确认扣费。
  7. 测试无误后,再接入正式业务。