在浏览器里完成第一次调用
试着问一个问题
使用真实 API 密钥调用,按实际用量扣除灵气。已有密钥可直接填写;还没有密钥,请先登录并创建。
智能体回答
等待发送
查看本轮响应数据
我的账户
接入概览
登录日月有数账户
使用手机号与验证码登录后,管理密钥并查看用量。
按当前账户价格结算,支付完成后刷新余额。
手机网页暂不支持支付宝充值,请使用电脑网页或 App 完成充值,再回到这里调用。
访问凭证
API 密钥
密钥仅在创建时显示。撤销后无法恢复,请及时更新使用该密钥的服务。
留空则使用平台默认单次上限。
| 名称 / 前缀 | 状态 | 单次上限 | 最近使用 | 操作 |
|---|---|---|---|---|
| 暂无密钥 | ||||
消费记录
用量汇总
| 密钥 | 模型 | 请求数 | 已扣灵气 | 输入 Token | 输出 Token |
|---|---|---|---|---|---|
| 暂无用量 | |||||
API 参考
开始接入
接口使用独立 API 密钥。请在控制台创建密钥,并将其保存在服务端环境变量中。
快速开始
- 在密钥与用量登录账户,完成一次灵气充值并创建密钥。
- 在在线调试填写密钥与出生资料,验证首次分析或连续追问。
- 将密钥保存在服务端环境变量
RIYUE_API_KEY,按下方示例调用。Python 先安装pip install openai,JavaScript 使用npm install openai。
接入其他 Agent
支持导入 OpenAPI 的 Agent 平台,可使用下面的描述文件创建工具。导入后仍需在该平台配置密钥;文件中不包含你的密钥。
- 复制描述文件地址或下载文件,在 Agent 平台选择「导入 OpenAPI」。
- 将工具鉴权设为 Bearer Token,填入完整的
sk-…密钥。 - 调用
chatWithRiyueAgent,选择riyue-bazi或riyue-ziwei,传入birth与messages。
只支持自定义模型的平台:把 Base URL 设为 https://riyuetcm.com/api/v1。平台还需支持扩展请求体以传入 birth;仅能填写模型名和密钥的客户端无法直接完成排盘调用。
请求参数
GET /api/v1/models 可查询可用模型;POST /api/v1/chat/completions 使用 Authorization: Bearer sk-... 鉴权。
| 字段 | 类型 | 说明 |
|---|---|---|
model | 字符串 | riyue-bazi 或 riyue-ziwei |
messages | 数组 | 对话消息,每项包含 role 和 content;最后一项为用户问题 |
birth.birth_date | 字符串 | 出生日期,格式 YYYY-MM-DD |
birth.birth_time | 字符串 | 出生时间,格式 HH:mm |
birth.gender | 字符串 | male 或 female |
birth.timezone | 字符串 | 首版仅支持 Asia/Shanghai,按阳历民用时间排盘;其他时区返回错误 |
stream | 布尔值 | false 返回完整 JSON;true 返回 SSE 数据流 |
stream_options.include_usage | 布尔值,可选 | 流式请求设置为 true 时,在结束前返回用量帧 |
max_lingqi | 正整数,可选 | 本次请求的灵气上限 |
每次请求都需携带出生资料和所需的完整历史 messages,无需在网站建档。消息仅支持文本 system/user/assistant;不接受工具结果或图片。最多 128 条消息、合计 64 KiB,当前问题最多 4000 字。
首次传入当前问题;追问时依次加入上轮问题、assistant 回答和新问题。调用方消息无法覆盖服务端排盘事实。Python、JavaScript 示例使用 OpenAI SDK,运行前安装 openai。
可发送 Idempotency-Key 请求头:同一密钥、同一参数在 24 小时内重放不重复调用或扣费;同键不同参数返回 409。结果过期返回 410。临时对话在 24 小时后清理,账务与幂等记录保留;待对账内容在结清后清理。
响应与错误
非流式成功响应从 choices[0].message.content 读取回答,usage 返回 Token 用量。billing 返回预留、实扣、释放及结算后余额;references 为引用列表;replayed 标识请求重放。
流式成功响应以 data: 帧传送增量内容,以 [DONE] 结束。结尾帧包含账务与引用;开启 include_usage 后还有一帧用量。流开始后的错误可能在 HTTP 200 的数据帧中返回,且没有 [DONE];重试前请核对用量。
完整字段、约束和错误响应见 OpenAPI 描述文件。
400:参数无效;401:密钥无效;402:余额或消费上限不足;403:尚未充值;409:幂等冲突或处理中;410:结果过期;429:并发或频率超限;503:服务暂不可用或用量待核。每个账户最多 1 个在途请求、每分钟 30 个新请求。
灵气计费
使用接口需要账户有已支付的灵气充值记录,且当前余额足够;无需先开通会员。普通充值 1 元到账 20 灵气,会员充值实付享八折,具体金额以充值页为准。
成功请求按实际计价成本 C(元)计算灵气:ceil(16 × C / 0.03964)。请求失败但已产生计价成本时按 1 × C 结算;未产生成本则不计费。密钥和单次请求都可设置灵气上限。
例如核定成本为 ¥0.0264 的成功请求,扣除 11 灵气。实际费用取决于输入、输出及内部调用总用量。上限取本次请求、密钥与平台上限的最小值。
余额和用量以控制台显示的实际账单为准。集成应用时请将完整密钥保存在服务端,不要嵌入公开网页或提交到代码仓库。