八字喜用神起名大师 - 咕咕数据 API 文档

八字喜用神起名大师
接口详情官网地址: https://www.gugudata.com/api/details/name-generator

基于八字命理和五行相生相克理论

请求方法: POST
接口路径: /ai/name-generator
调试地址: https://api.gugudata.com/ai/name-generator/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

lastname (string, 必填): 姓氏

gender (string, 必填): 性别（男/女）

birthDateTime (string, 必填): 公历出生年月日时，格式：YYYY年MM月DD日 HH:MM

birthPlace (string, 必填): 出生地点（省市），用于规避可能的谐音

parentNames (string, 可选): 父母姓名（可选，用于亲子音韵搭配）

avoidWords (string, 可选): 可选避用字（可选，多个字用逗号分隔）

avoidNames (string|string[], 可选): 禁生成姓名，支持逗号分隔字符串或 JSON 数组

streaming (boolean, 可选): 是否流式响应，如果为 true，那么接口会流式输出纯文本，在最后一个消息输出完整结果的 JSON。当 responseMode=task 时，streaming 必须为 false。

responseMode (string, 可选): 响应模式，可选值：sync、task。为 task 时立即返回任务受理结果，不阻塞等待模型完成。

返回字段:

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 此条件下的总数据量，一般用于分页计算

Data: 接口返回的完整 JSON 数据，包含命盘分析、候选名字清单、最佳推荐、注意事项等所有字段，具体可查看 DEMO 接口返回数据

Data.operationId: 仅 responseMode=task 时返回，任务唯一标识。

Data.status: 仅 responseMode=task 或轮询接口返回，状态枚举：PENDING、RUNNING、SUCCEEDED、FAILED、EXPIRED。

Data.pollingUrl: 仅 responseMode=task 或轮询接口返回，任务状态查询地址。

Data.expiresAt: 仅 responseMode=task 或轮询接口返回，任务结果过期时间。

Data.result: 仅任务状态为 SUCCEEDED 时返回，业务结果结构与同步模式一致。

Data.error: 仅任务状态为 FAILED 时返回，失败原因信息。

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 暂无说明

101 参数错误: 请检查传递的参数是否完整

102 请求频率受限: 每秒请求不能超过 100 次

103 账号欠费: 暂无说明

104 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

110 接口响应错误: 暂无说明

接口特性:

基于传统八字命理学理论；

结合三才五格数理分析；

考虑五行相生相克关系；

提供多个候选姓名供选择；

包含详细的命理分析报告；

支持方言谐音检测；

支持 responseMode=task 任务模式，先返回 operationId，再通过轮询接口查询结果；

围绕“八字喜用神起名大师”提供标准化能力，便于快速接入现有业务；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口调用状态与状态监控：https://www.gugudata.com/status。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

接口正常响应。请求成功，业务状态请结合响应体中的自定义业务码判断。

Bodyapplication/json

示例

{
    "DataStatus": {
        "StatusCode": 0,
        "StatusDescription": "string",
        "ResponseDateTime": "string",
        "DataTotalCount": 0,
        "RequestParameter": null
    },
    "Data": {
        "operationId": "string",
        "status": "string",
        "pollingUrl": "string",
        "expiresAt": "string",
        "result": {
            "property1": "string",
            "property2": "string"
        },
        "error": {
            "property1": "string",
            "property2": "string"
        },
        "property1": "string",
        "property2": "string"
    }
}

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502