# 八字关系合参
> 来源页面: https://www.gugudata.com/api/details/bazi-relationship-insight
## 概览
- API 标识: `bazi-relationship-insight`
- 分类: 国学/娱乐
- 描述: 双人排盘与关系文化洞察
- 标签: 传统文化 / 八字关系 / 关系分析 / AI
- 短标签: 传统文化 / AI
- 详情页: https://www.gugudata.com/api/details/bazi-relationship-insight
- LLM Markdown: https://www.gugudata.com/api/details/bazi-relationship-insight/llm.md
- 数据预览: https://www.gugudata.com/preview/bazi-relationship-insight
- 购买开通: https://www.gugudata.com/order/bazi-relationship-insight
- APP KEY 管理: https://www.gugudata.com/portal/
- 订单与续费: https://www.gugudata.com/portal/orders
## 给大模型的接入指令
如果你正在帮助用户接入这个 API，请优先使用本文档中的接口地址、请求方式、请求参数、返回参数、状态码、cURL 示例和预览数据生成代码或排查问题。
- 接入目标: 调用 `八字关系合参`，不要臆造未在文档中出现的参数或返回字段。
- AppKey 获取: 用户登录咕咕数据开发者中心后，在 `APP KEY 管理` 页面复制对应产品的 AppKey。
- AppKey 替换: 示例中的 `YOUR_APPKEY`、`APPKEY`、`{{YOUR_APPKEY}}`、`{{appkey}}`、`{{appKey}}` 都应替换为用户自己的 AppKey。
- AppKey 传递: 推荐使用 `X-GUGUDATA-APPKEY` 或 `X-API-Key` 请求头；OpenAI 兼容客户端可使用 `Authorization: Bearer <AppKey>`；历史 query 参数 `appkey` 继续有效。
- 开通与续费: 未开通时引导用户访问购买开通页；已开通或需要续费时，引导用户进入开发者中心或订单与续费页。
- 错误处理: HTTP 状态码代表传输层结果，响应体内的业务状态码代表接口业务结果，代码中应分别处理。
- 生产建议: AppKey 应保存在服务端环境变量或密钥配置中，由服务端统一发起请求，不要写入网页、App 客户端或公开仓库。
关键链接:
- 接口详情页: https://www.gugudata.com/api/details/bazi-relationship-insight
- LLM Markdown: https://www.gugudata.com/api/details/bazi-relationship-insight/llm.md
- 数据预览: https://www.gugudata.com/preview/bazi-relationship-insight
- 购买开通页: https://www.gugudata.com/order/bazi-relationship-insight
- 开发者中心 APP KEY 管理: https://www.gugudata.com/portal/
- 订单与续费: https://www.gugudata.com/portal/orders
## API 功能
- 支持分别填写双方出生资料，适合双人传统文化解读与关系主题的阅读产品；
- 双方可独立选择公历或农历并标明闰月，无需先把两份出生记录手工换算成同一历法；
- 分别返回双方的公农历换算和四柱排盘，便于在双栏页面中核对每个人的基础资料；
- 可提交关系关注方向，让文化解读围绕沟通方式、价值观或长期相处等指定主题展开；
- 返回整体关系摘要与关键词，适合在结果页顶部呈现阅读提要并连接完整解读章节；
- 按维度提供双方互补特点及相应说明，便于制作分项阅读卡片并保留具体解释；
- 分别列出适合的沟通方式与需要避免的情形，帮助读者区分不同类型的文化建议；
- 提供长期相处建议和注意事项，可作为关系主题文章或报告中的独立阅读章节；
- 双方资料支持统一选择简体中文、繁体中文或英文，以对应同一份报告的阅读语言；
- 支持同步、异步任务与流式获取，便于在完整报告和逐步阅读两种产品体验中使用；
- 默认最大 QPS:5，可在开发者中心自助升级，月付年付订单接口调用次数不限。
- [接口调用状态与状态监控](https://www.gugudata.com/status)
## API 文档
- 接口地址: `https://api.gugudata.com/ai/bazi-relationship-insight`
- 返回格式: `application/json; charset=utf-8`
- 请求方式: `POST`
- 请求协议: `HTTPS`
- 请求示例: `https://api.gugudata.com/ai/bazi-relationship-insight?appkey=YOUR_APPKEY`
- 接口测试: https://api.gugudata.com/ai/bazi-relationship-insight/demo
- Apifox: https://doc.gugudata.com/
- Postman: https://www.postman.com/gugudata/gugudata-official/collection/1163860-22cb92f5-771a-48fd-89c0-f20a0790a8ce/?action=share&creator=1163860&active-environment=1163860-a95b31ef-324f-43db-b2fc-faa41f45bd35
- OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json
## 鉴权方式
接口支持以下 AppKey 传递方式，任选一种即可；已有请求示例、Postman 集合和历史代码仍可继续使用原来的 `appkey` 参数方式。
| 传输载体 | 参数 | 示例 | 说明 |
| --- | --- | --- | --- |
| HTTP Header | `X-GUGUDATA-APPKEY` | `X-GUGUDATA-APPKEY: YOUR_APPKEY` | 推荐方式，适合服务端接入和统一封装。 |
| HTTP Header | `X-API-Key` | `X-API-Key: YOUR_APPKEY` | 通用 API Key Header，便于和常见 API 客户端集成。 |
| HTTP Header | `Authorization` | `Authorization: Bearer YOUR_APPKEY` | 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。 |
| Query 参数 | `appkey` | `?appkey=YOUR_APPKEY` | 兼容现有示例、Postman 集合、浏览器调试和历史代码。 |
> 部分历史 POST 接口仍兼容表单或 JSON body 中的 `appkey`；新接入建议优先使用 Header 或 Query 参数。
## 请求参数
| 参数名 | 参数类型 | 是否必须 | 默认值 | 备注 |
| --- | --- | --- | --- | --- |
| appkey | string | 是 | YOUR_APPKEY | 支持 Query、X-GUGUDATA-APPKEY、Bearer 或 JSON body。 |
| personA | object | 是 | N/A | 甲方完整出生资料对象。 |
| personB | object | 是 | N/A | 乙方完整出生资料对象。 |
| personA.name | string | 否 | N/A | 可选称呼，最多 50 个字符。 |
| personA.gender | string | 是 | 男 | 支持男、女及常见英文写法。 |
| personA.calendarType | string | 是 | 公历 | 支持公历、农历及英文写法。 |
| personA.birthDate | string | 是 | 1990-12-01 | 出生日期，范围 1901-01-01 至 2100-12-31。 |
| personA.birthTime | string | 是 | 07:30:00 | 24 小时制出生时间。 |
| personA.birthPlace | string | 否 | N/A | 可选出生地点，最多 100 个字符。 |
| personA.isLeapMonth | boolean | 否 | false | 仅农历日期可设置为 true。 |
| personA.language | string | 否 | zh-CN | 双方必须一致，支持 zh-CN、zh-TW、en-US。 |
| personB.name | string | 否 | N/A | 可选称呼，最多 50 个字符。 |
| personB.gender | string | 是 | 女 | 支持男、女及常见英文写法。 |
| personB.calendarType | string | 是 | 公历 | 支持公历、农历及英文写法。 |
| personB.birthDate | string | 是 | 1992-06-15 | 出生日期，范围 1901-01-01 至 2100-12-31。 |
| personB.birthTime | string | 是 | 09:20:00 | 24 小时制出生时间。 |
| personB.birthPlace | string | 否 | N/A | 可选出生地点，最多 100 个字符。 |
| personB.isLeapMonth | boolean | 否 | false | 仅农历日期可设置为 true。 |
| personB.language | string | 否 | zh-CN | 双方必须一致，支持 zh-CN、zh-TW、en-US。 |
| focusAreas | array | 否 | [] | 1～6 个关注方向，每项最多 20 字；空数组使用默认方向。 |
| responseMode | string | 否 | sync | 支持 sync 或 task。 |
| streaming | boolean | 否 | false | SSE 仅支持同步模式。 |
## 返回参数
| 参数名 | 参数类型 | 备注 |
| --- | --- | --- |
| DataStatus.StatusCode | integer | 业务码，100 表示成功。 |
| DataStatus.StatusDescription | string | 业务状态说明。 |
| Data.基础数据 | object | 双方出生资料、真实历法换算与关注方向。 |
| Data.基础数据.甲方.排盘基础 | object | 甲方标准化输入、历法换算、四柱和八字。 |
| Data.基础数据.乙方.排盘基础 | object | 乙方标准化输入、历法换算、四柱和八字。 |
| Data.文化解读 | object | 固定结构的关系文化解读。 |
| Data.免责声明 | string | 文化研究与娱乐参考边界。 |
| Data.operationId | string | 任务模式的任务标识。 |
| Data.status | string | 任务状态。 |
| Data.pollingUrl | string | 任务状态查询地址。 |
| Data.result | object | 任务成功时的完整结果。 |
| Data.error | object | 任务失败信息。 |
| SSE.done.result | object | 流式完成事件的完整已校验结果。 |
## 相关接口
### 任务状态查询
- 请求方式: `GET`
- 资源路径: `/ai/operations/{operation_id}?appkey=YOUR_APPKEY`
- 接口地址: `https://api.gugudata.com/ai/operations/{operation_id}?appkey=YOUR_APPKEY`
- 描述: 查询任务状态和完整结果。
## 接口常见 HTTP 响应状态码
> 以下为接口调用中常见的 HTTP 传输层状态码，不等同于响应体内的业务状态码；完整状态码注册表以 IANA HTTP Status Code Registry 为准。
| 状态码 | 状态码解释 | 备注 |
| --- | --- | --- |
| 200 | 请求成功 | HTTP 请求已成功处理；业务状态请结合响应体中的自定义业务码判断。 |
| 201 | 资源已创建 | 创建类接口请求成功，并已生成对应资源。 |
| 202 | 请求已接受 | 请求已被接受处理，结果可能异步完成。 |
| 204 | 无响应内容 | 请求成功但响应体为空，适用于无需返回数据的操作。 |
| 400 | 请求参数错误 | 请求参数缺失、格式错误或参数组合不合法。 |
| 401 | 认证失败 | 缺少、无效或未通过认证的访问凭证（如 AppKey）。 |
| 403 | 无权限访问 | 订单到期、权限不足或接口额度不可用。 |
| 404 | 资源不存在 | 请求路径不存在。 |
| 405 | 请求方法不允许 | 当前路径不支持该 HTTP 方法。 |
| 408 | 请求超时 | 客户端请求在服务端等待时间内未完成，可稍后重试。 |
| 409 | 请求冲突 | 请求与当前资源状态冲突，调整参数或业务状态后重试。 |
| 413 | 请求内容过大 | 上传文件或请求体超过接口限制。 |
| 414 | 请求地址过长 | 请求 URL 超过服务端可处理长度，建议减少查询参数或改用 POST。 |
| 415 | 请求内容类型不支持 | 上传或请求体的内容类型不符合接口要求。 |
| 422 | 请求语义错误 | 请求格式正确，但参数取值、语义或业务约束无法处理。 |
| 429 | 请求频率受限 | 默认按来源 IP 限速，单 IP 最多 5 QPS，可满足常规业务调用。超出限制时接口会返回 429 请求频率受限；已购买接口订单可加购 10 QPS 扩展。 |
| 431 | 请求头过大 | 请求头字段过大或过多，建议精简 Header 后重试。 |
| 500 | 服务器内部错误 | 服务端处理异常，请稍后重试。 |
| 502 | 服务暂时不可用 | 请稍后重试。 |
| 503 | 服务暂时不可用 | 请稍后重试。 |
| 504 | 请求超时 | 请稍后重试。 |
## 接口自定义业务状态码
| 业务状态码 | 业务状态码解释 | 备注 |
| --- | --- | --- |
| 100 | 请求成功 | HTTP 200 |
| 501 | 参数错误 | HTTP 400 |
| 502 | 请求频率受限 | HTTP 429 |
| 503 | 订单已到期 | HTTP 403 |
| 504 | APPKEY 错误 | HTTP 401，包含缺少 APPKEY |
| 505 | 调用额度耗尽 | HTTP 403 |
| 900 | 内部错误 | HTTP 500 |
| 901 | 依赖服务不可用 | HTTP 503 |
## cURL 请求示例
```bash
curl --location --request POST 'https://api.gugudata.com/ai/bazi-relationship-insight?appkey=YOUR_APPKEY' \
--header 'Content-Type: application/json' \
--data '{
"personA": {
"gender": "男",
"calendarType": "公历",
"birthDate": "1990-12-01",
"birthTime": "07:30:00",
"language": "zh-CN"
},
"personB": {
"gender": "女",
"calendarType": "农历",
"birthDate": "1992-05-15",
"birthTime": "09:20:00",
"isLeapMonth": false,
"language": "zh-CN"
},
"focusAreas": [
"沟通方式",
"长期相处"
]
}'
```
## 常见问题 Q&A
### Q: 如何完成第一次 API 调用？
A: 先确认当前接口的请求方法、必填参数和成功状态，再使用对应产品的 AppKey 发起请求；以实际响应中的业务状态判断结果。 [查看接入指南](https://www.gugudata.com/developers/getting-started)
### Q: 如何保证请求时 AppKey 的安全性？
A: 在开发者中心的 APP KEY 管理页面复制对应产品的 AppKey，并保存在服务端环境变量或密钥管理服务中。不要写入网页、App 客户端、公开仓库或日志。
### Q: 接口可以用于哪些开发语言？
A: Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等支持 HTTP 请求的语言均可接入；也可以通过 OpenAPI、Postman 或 Apifox 查看和调试接口。
### Q: 请求失败或超时后可以重试吗？
A: 先区分 HTTP 状态与业务错误。参数、鉴权和权限错误应修正后再请求；超时并不表示服务端未执行，重试前需确认接口是否会重复计费或产生副作用。 [查看接入指南](https://www.gugudata.com/developers/errors-and-retries)
### Q: 接口的性能可以保证吗？
A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发，生产接入前完成联调与容量评估。
## 服务协议以及服务免责声明
- [服务协议](https://www.gugudata.com/license)
- [服务免责声明](https://www.gugudata.com/disclaimer)
## 技术支持
- 技术支持邮箱: support@gugudata.com
- 微信客服: https://work.weixin.qq.com/kfid/kfcf9a60a6afe3337b7