Skip to main content

开始之前

在开始之前,请确保你已经:
拥有一个 Wolian AI 账户
获取了已激活的 API Key(可在 Wolian AI 平台 获取)

第一步:获取 API Key

1

访问平台

2

登录账户

使用你的账户登录(与 huajune.duliday.com 使用相同的账户系统)
3

创建并激活密钥

点击 ”+ 创建” 按钮创建新密钥,确保密钥状态为 “已激活”
4

复制密钥

点击复制按钮复制完整的 API Key 并妥善保存
安全提示:请勿将 API Key 提交到版本控制系统或公开分享。建议使用环境变量来存储密钥。

第二步:发起第一个请求

选择你熟悉的编程语言,发起第一个 API 请求:
记得将 YOUR_API_KEY 替换为你在第一步中获取的实际 API Key。

第三步:理解响应

成功的请求会返回以下格式的 JSON 响应:
  • messages: 包含 AI 助手的回复消息 - usage: Token 使用量统计 - inputTokens: 输入的 token 数量 - outputTokens: 输出的 token 数量 - totalTokens: 总 token 数量 - tools: 工具使用情况 - used: 本次使用的工具列表 - skipped: 跳过的工具列表

第四步:尝试流式输出

现在让我们尝试更流畅的流式输出,实现类似 ChatGPT 的打字机效果。
流式输出使用 Server-Sent Events (SSE) 协议,可以实时接收 AI 生成的内容,非常适合需要即时反馈的聊天场景。
流式响应注意事项
  • 流式响应使用 SSE 格式,每行以 data: 开头
  • 流结束时会收到 data: [DONE] 标记(字面量,非 JSON)
  • 消息完成时会收到 {"type":"finish"} 事件
  • 需要逐行解析 JSON 事件,主要关注 text.delta 类型
  • 某些代理服务器可能会缓冲 SSE 响应,建议在生产环境配置 X-Accel-Buffering: no

第五步:查看响应头信息

API 会在响应头中返回一些有用的信息,帮助你监控和优化调用:
重要响应头说明:
string
请求关联 ID,用于追踪和调试问题,报告 Bug 时请提供此 ID
boolean
是否进行了消息剪裁(值为 “true” 或不存在)
string
被跳过的工具列表(逗号分隔),仅在使用 contextStrategy: "skip" 时出现

常见问题

请检查:
  • API Key 是否正确
  • Authorization 头格式是否为 Bearer YOUR_API_KEY
  • API Key 是否已激活(在 Wolian AI 平台查看状态)
  • API Key 是否已过期或被撤销
可能原因:
  • 使用的模型不在你的许可列表中
  • 账户权限不足
解决方法:使用 GET /api/v1/models 查看可用模型列表
查看响应中的 tools 字段:
注意:花卷会根据对话内容自动选择合适的工具,无需手动指定
可以尝试以下优化:
  1. 使用流式输出 (stream: true),让用户立即看到内容开始生成
  2. 启用消息剪裁 (prune: true),减少输入 token 数量
  3. 选择更快的模型(如 qwen/qwen-plus-latest),牺牲少量质量换取速度
查看 性能优化文档 了解更多技巧

下一步

恭喜!你已经成功完成了第一次 API 调用。接下来你可以:

探索工具调用

让 AI 使用工具完成更复杂的任务

了解核心概念

深入理解模型、消息、上下文等概念

查看 API 参考

完整的 API 端点文档和参数说明

最佳实践

学习性能优化和调试技巧