• API 功能

    • 结合姓氏、性别、出生时间和地点生成姓名候选,适合起名参考与姓名文化阅读应用;
    • 可填写父母姓名作为补充信息,让生成内容结合家庭命名偏好进行音韵搭配参考;
    • 支持提交避用字,在请求中表达不希望使用的字,便于整理家庭已有的命名要求;
    • 支持指定禁生成姓名,可使用列表或分隔文本提交,便于排除已经看过或不希望采用的名字;
    • 返回多个姓名候选,便于在同一页面中逐项比较名字、读音和相关文化解释;
    • 候选条目提供汉语拼音,可辅助整理读音展示;具体方言发音仍需结合当地实际核对;
    • 提供五行补益相关的传统文化说明,便于了解每个候选名字采用的文化解释角度;
    • 提供三才五格相关的数理文化解读,适合制作姓名文化资料卡与分项阅读内容;
    • 包含现代寓意与推荐理由,便于读者结合自己的审美、家庭偏好和实际使用习惯比较名字;
    • 支持异步提交并在完成后获取姓名结果,适合需要等待完整候选清单的起名报告页面;
    • 默认最大 QPS:5,可在开发者中心自助升级,月付年付订单接口调用次数不限。
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/ai/name-generator

    返回格式: application/json; charset=utf-8

    请求方式: POST

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY

    数据预览: https://www.gugudata.com/preview/name-generator

    接口测试:  https://api.gugudata.com/ai/name-generator/demo

    OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

    请求参数(POST 请求参数以 application/json 格式传递;鉴权方式请参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string 是 无 保留 Query、JSON/表单、AppKey、X-API-Key、X-GUGUDATA-APPKEY 与 Bearer 鉴权;多处一致凭据允许,重复或冲突凭据失败。
    lastname string 是 无 姓氏;与出生资料一起用于姓名文化参考,不是业务默认值。
    gender string 是 无 保留男/女及已有英文表达:male/female、m/f、boy/girl、男生/女生。
    birthDateTime string 是 无 公历出生日期时间;支持 YYYY年MM月DD日 HH:MM、YYYY-MM-DD HH:MM 及已有 ISO、秒级表达,日期时间必须有效。
    birthPlace string 是 无 出生地点,作为姓名文化解读的补充信息;不提供方言读音检测。
    parentNames string 否 无 父母姓名,可选;作为家庭命名偏好的补充信息。不传时使用空字符串。
    avoidWords string 否 无 可选避用字;保持既有逗号分隔表达。不传时使用空字符串。
    avoidNames string/array 否 无 禁生成姓名;支持逗号、中文逗号、顿号分隔的字符串或 JSON 字符串数组。表单使用分隔字符串。
    streaming boolean 否 false 实时片段沿用 content 事件;片段是未完成内容,可能含最终排除的名字,以校验后的唯一 done.full_text 完整 JSON 和 end/[DONE] 为成功终态。responseMode=task 时不能为 true。
    responseMode string 否 sync 保留 sync/task;task 首响应为任务受理信息,须通过 /ai/operations/{operation_id} 轮询至终态。任务受理不代表结果成功。

    返回参数

    参数名 参数类型 备注
    DataStatus.RequestParameter string 本次真实业务请求参数,不含鉴权凭据;Demo 与公开样例输入对应。
    DataStatus.StatusCode integer 成功为 100;参数错误 501/HTTP 400,依赖及处理失败 901/HTTP 503;公共鉴权、权益和限流契约保持。
    DataStatus.StatusDescription string 本次业务处理结果说明;任务受理不等于完成。
    DataStatus.ResponseDateTime string 接口响应时间,不表示姓名分析经过事实核验。
    DataStatus.DataTotalCount integer 成功业务对象数量为 1,不表示候选名字数量。
    Data object 同步返回命盘分析摘要、候选名字清单、最佳推荐和注意事项;免责声明可选,不补写模型未返回的内容。task 首响应返回既有任务对象。
    Data.命盘分析摘要 string 输入出生资料对应的传统文化说明。
    Data.候选名字清单 array 候选条目保留姓名全称、汉语拼音、五行补益分析、三才五格分析、经典出处和现代寓意解读。候选数量以有效生成结果为准。
    Data.最佳推荐 array 推荐姓名均来自本次有效候选;保留模型返回的综合评分与推荐理由,不补造评分。
    Data.注意事项 string 供用户结合家庭审美与实际使用习惯审阅的说明。
    Data.免责声明 string 可选的生成内容参考边界;模型返回时为非空字符串。
    Data.operationId string 仅任务模式返回的任务标识。
    Data.status string PENDING/RUNNING/SUCCEEDED/FAILED/EXPIRED;终态结果或失败须结合该字段判断。
    Data.pollingUrl string 既有任务状态查询路径。
    Data.expiresAt string 结果保留的到期时间,不表示模型可以持续执行到该时间。
    Data.result object 仅 SUCCEEDED 返回,结构与同步 Data 一致。
    Data.error object 仅 FAILED 返回安全失败信息。

    响应示例(真实数据节选)

    接口数据预览

    仅展示部分示例数据,数组最多展示 3 项,长内容已省略;完整数据请调用接口获取。

    {
      "DataStatus": {
        "RequestParameter": "{\"lastname\":\"王\",\"gender\":\"女\",\"birthDateTime\":\"2023-05-12 14:30\",\"birthPlace\":\"江苏苏州\",\"parentNames\":\"\",\"avoidWords\":\"伟、强\",\"avoidNames\":[\"王清涵\"],\"responseMode\":\"sync\",\"streaming\":false}",
        "StatusCode": 100,
        "StatusDescription": "固定示例,仅用于展示响应格式。",
        "ResponseDateTime": "2026-10-22 08:58:46.112",
        "DataTotalCount": 1
      },
      "Data": {
        "命盘分析摘要": "日主癸水生于巳月(初夏),火旺土相,水气休囚。地支巳火当令,时支未土燥热,全局火土较旺,癸水身弱。喜用神首取金(印星)以生水并泄土气,次取水(比劫)以帮身抗火。忌火、土。命名策略宜选用五行属金、水的字,兼顾音韵优美与女性柔美特质,避免刚硬或过于阳刚的字眼。",
        "候选名字清单": [
          {
            "姓名全称": "王舒涵",
            "汉语拼音": "Wáng Shū Hán",
            "五行补益分析": "舒字五行属金,涵字五行属水。金水相生,既补足了日主癸水之弱,又通过金来化解命中过旺的土气,格局流通有情。",
            "三才五格分析": "天格5(土),人格13(火),地格20(水)。总格24(火)。三才配置土火水,虽有人格克地格之象,但数理吉凶搭配得当,主智慧与才艺。",
            "经典出处": "《楚辞·离骚》:“前望舒使先驱兮”,望舒为月神驾车者,寓意舒展、从容;涵意为包容、涵养。",
            "现代寓意解读": "寓意女孩性格从容优雅,内涵丰富,知书达理,生活舒适安逸。"
          },
          {
            "姓名全称": "王钰汐",
            "汉语拼音": "Wáng Yù Xī",
            "五行补益分析": "钰字五行属金,汐字五行属水。金生水旺,强力补充日主元气,且钰为珍宝,汐为晚潮,金水相涵,清贵之象。",
            "三才五格分析": "天格5(土),人格17(金),地格19(水)。总格23(火)。三才土金水,相生有情,大吉。人格17为刚健之数,地格19虽有波折但配合人格金生水,主才华横溢。",
            "经典出处": "钰出自《五音集韵》:“宝也”;汐出自宋代诗词,指夜间的海潮。",
            "现代寓意解读": "寓意如珍宝般珍贵,如潮汐般有规律且充满生命力,气质高雅,坚韧而不失温柔。"
          },
          {
            "姓名全称": "王诗漫",
            "汉语拼音": "Wáng Shī Màn",
            "五行补益分析": "诗字五行属金,漫字五行属水。金水组合,润泽日主。诗代表文化修养,漫代表自由洒脱,符合癸水灵动之性。",
            "三才五格分析": "天格5(土),人格17(金),地格28(金)。总格32(木)。三才土金金,比和吉利。人格17权威刚强,地格28豪气生离,但总格32为侥幸多望的贵人运,整体平衡。",
            "经典出处": "诗出自《诗经》;漫出自“漫江碧透”,寓意广阔、无边际。",
            "现代寓意解读": "寓意生活如诗如画,性格浪漫自由,富有艺术气息和想象力。"
          }
        ],
        "最佳推荐": [
          {
            "姓名": "王舒涵",
            "综合评分": 98,
            "推荐理由": "五行金水完美相生,精准补益日主癸水之弱,且化解火土燥气。音韵平仄协调(平平平,虽全平但声母差异大,听感柔和),寓意优雅从容,符合苏州文化底蕴,无禁忌字,三才配置虽有小瑕但总体吉祥,极具大家闺秀之风。"
          },
          {
            "姓名": "王钰汐",
            "综合评分": 96,
            "推荐理由": "金水组合强劲,‘钰’为珍宝,‘汐’为潮汐,动静结合。数理大吉(土金水相生),音律优美(阳平去声阴平),现代感强且不失古典韵味,完全避开禁字,适合现代独立女性形象。"
          }
        ],
        "注意事项": "以上姓名方案基于传统姓名学与八字五行理论进行推演,仅供文化参考与娱乐。名字对人的影响是潜移默化的,并非决定性因素。请家长结合家族辈分、个人喜好及实际读音感受进行最终选择。所有健康、运势等解读均不构成专业医疗或人生决策建议,如有实际需求请咨询相关专业人士。"
      }
    }
  • 鉴权方式

    接口支持以下 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 参数。

  • 接口常见 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
    901 处理、依赖失败或超时 HTTP 503
    502 请求频率限制 HTTP 429
    503 权益过期 HTTP 403
    504 凭据无效或无权限 HTTP 401
    505 调用额度不足 HTTP 403
  • 请求示例代码

    curl --location --request POST 'https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY' \
    --header 'Content-Type: application/json' \
    --data '{
      "lastname": "王",
      "gender": "女",
      "birthDateTime": "2023-05-12 14:30",
      "birthPlace": "江苏苏州",
      "avoidNames": [
        "王清涵"
      ],
      "responseMode": "sync",
      "streaming": false
    }'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY");
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Content-Type: application/json");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }");
        CURLcode res = curl_easy_perform(curl);
        (void)res;
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
      }
      return 0;
    }
    
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Net.Http;
    using System.Text;
    
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY");
    request.Content = new StringContent("{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }", Encoding.UTF8, "application/json");
    var response = client.SendAsync(request).Result;
    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
    
    package main
    
    import (
      "strings"
      "fmt"
      "io"
      "net/http"
    )
    
    func main() {
      url := "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY"
      payload := strings.NewReader("{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }")
      req, err := http.NewRequest("POST", url, payload)
      if err != nil {
        fmt.Println(err)
        return
      }
      req.Header.Add("Content-Type", "application/json")
      res, err := http.DefaultClient.Do(req)
      if err != nil {
        fmt.Println(err)
        return
      }
      defer res.Body.Close()
      body, err := io.ReadAll(res.Body)
      if err != nil {
        fmt.Println(err)
        return
      }
      fmt.Println(string(body))
    }
    
    OkHttpClient client = new OkHttpClient().newBuilder().build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }");
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY")
      .method("POST", body)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
    
    $.ajax({
      url: "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY",
      method: "POST",
      contentType: "application/json",
      data: JSON.stringify({
      "lastname": "王",
      "gender": "女",
      "birthDateTime": "2023-05-12 14:30",
      "birthPlace": "江苏苏州",
      "avoidNames": [
        "王清涵"
      ],
      "responseMode": "sync",
      "streaming": false
    }),
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    const url = "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY";
    const body = JSON.stringify({
      "lastname": "王",
      "gender": "女",
      "birthDateTime": "2023-05-12 14:30",
      "birthPlace": "江苏苏州",
      "avoidNames": [
        "王清涵"
      ],
      "responseMode": "sync",
      "streaming": false
    });
    
    const request = https.request(url, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Content-Length": Buffer.byteLength(body)
      }
    }, handleResponse);
    request.on("error", console.error);
    request.write(body);
    request.end();
    
    function handleResponse(response) {
      const chunks = [];
      response.on("data", function (chunk) {
        chunks.push(chunk);
      });
      response.on("end", function () {
        console.log(Buffer.concat(chunks).toString("utf8"));
      });
    }
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY"]];
    [request setHTTPMethod:@"POST"];
    NSString *body = @"{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }";
    [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [request setHTTPBody:[body dataUsingEncoding:NSUTF8StringEncoding]];
    NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
      if (error) {
        NSLog(@"%@", error);
        return;
      }
      NSLog(@"%@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
    }];
    [task resume];
    
    <?php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_POSTFIELDS => "{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }",
      CURLOPT_HTTPHEADER => array(
        "Content-Type: application/json",
      ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    import requests
    import json
    
    url = "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY"
    payload = json.loads('{
      "lastname": "王",
      "gender": "女",
      "birthDateTime": "2023-05-12 14:30",
      "birthPlace": "江苏苏州",
      "avoidNames": [
        "王清涵"
      ],
      "responseMode": "sync",
      "streaming": false
    }')
    response = requests.post(url, json=payload)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY")
    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true
    request = Net::HTTP::Post.new(url)
    request["Content-Type"] = "application/json"
    request.body = "{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }"
    response = https.request(request)
    puts response.read_body
    
    import Foundation
    
    let semaphore = DispatchSemaphore(value: 0)
    var request = URLRequest(url: URL(string: "https://api.gugudata.com/ai/name-generator?appkey=YOUR_APPKEY")!, timeoutInterval: .infinity)
    request.httpMethod = "POST"
    request.addValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = "{
      \"lastname\": \"王\",
      \"gender\": \"女\",
      \"birthDateTime\": \"2023-05-12 14:30\",
      \"birthPlace\": \"江苏苏州\",
      \"avoidNames\": [
        \"王清涵\"
      ],
      \"responseMode\": \"sync\",
      \"streaming\": false
    }".data(using: .utf8)
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
      defer { semaphore.signal() }
      guard let data = data else {
        print(String(describing: error))
        return
      }
      print(String(data: data, encoding: .utf8)!)
    }
    task.resume()
    semaphore.wait()
    
  • 常见问题 Q&A

    • Q: 如何完成第一次 API 调用?

      A: 先确认当前接口的请求方法、必填参数和成功状态,再使用对应产品的 AppKey 发起请求;以实际响应中的业务状态判断结果。 查看接入指南

    • 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 状态与业务错误。参数、鉴权和权限错误应修正后再请求;超时并不表示服务端未执行,重试前需确认接口是否会重复计费或产生副作用。 查看接入指南

    • Q: 接口的性能可以保证吗?

      A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发,生产接入前完成联调与容量评估。

  • 服务协议与免责声明

    购买或使用 GuGuData API 服务前,请充分阅读服务协议、免责声明与数据合规声明。相关页面均支持在浏览器中快速导出 PDF,便于内部归档、评审和合规留存。

  • 技术支持

    技术支持邮箱:
    support@gugudata.com
    企业微信客服:
    联系客服
  • 专业软件开发与系统工程服务

    GuGuData 官方认证工程合作伙伴,专注企业级数据接口集成、AI 工程化与大规模数据处理。团队深度理解 GuGuData 数据接口体系,具备海量数据采集、治理、检索与高并发接口服务经验,可围绕业务场景构建 AI Agent、MCP 接入、智能工作流和生产级数据应用,让数据能力稳定进入现有流程、内部平台和核心业务系统。

    了解工程服务