logo
登录

快速开始

跟着下面五步，拿到第一份 GEO 监测结果。前两步在控制台完成，之后都是 API 调用。

1. 注册并创建品牌

https://shengliang.cn 开放注册，注册后自动获得 7 天试用，试用期内即可调用 API。

注册后需要先完成新手引导、创建一个品牌，才能进入「API Key」页。GEO 的数据都挂在品牌 之下（意图词、竞品、监测结果、趋势），没有品牌的话 API 也无从调起。

品牌资料（介绍、关键词、卖点）建议认真填写：AI 生成意图词、识别竞品都以它为依据， 填得越准确，生成质量越高。

2. 创建 API Key

控制台 → 右上角头像 → 「API Key」→ 新建。权限默认为全部，也可以切到「自定义」逐项 勾选（见权限范围）。

明文 Key 只在创建时显示一次，离开页面后无法再查看，请当场保存。

export KEY=sk-你的key

3. 验证 Key 可用

Shell
curl -s https://shengliang.cn/openapi/v1/me \
  -H "Authorization: Bearer $KEY"
JSON
{ "code": 0, "msg": "ok",
  "data": { "user_id": "u_…", "key_id": "k_…", "scopes": ["*"] } }

返回 code: 0 说明 Key 可用。建议把这一步放在接入的最前面：先确认 Key 没问题， 后面调业务端点失败时才能判断是参数的问题。

4. 准备意图词

意图词就是「用户会怎么问 AI」，监测就是拿这些问题去问各个 AI 平台。先取得品牌 ID：

Shell
curl -s https://shengliang.cn/openapi/v1/geo/brands \
  -H "Authorization: Bearer $KEY"
export BRAND=brand_xxxxxxxx

看看是否已有启用的意图词：

Shell
curl -s "https://shengliang.cn/openapi/v1/geo/brands/$BRAND/prompts?status=active" \
  -H "Authorization: Bearer $KEY"

如果没有，让 AI 生成一批（异步）：

Shell
curl -s -X POST "https://shengliang.cn/openapi/v1/geo/brands/$BRAND/generate" \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"count": 10}'

⚠️ 生成的意图词默认是停用状态，需要你确认后逐条启用 —— 用 PATCH /geo/prompts/{prompt_id} 把 status 改成 active。 没有启用的意图词，发起监测会返回 3004，这一步不能跳过。

默认不启用是为了让你先过一遍：AI 生成的问法需要人工判断像不像真实用户会问的话， 而每启用一条，都会在每轮监测里乘上平台数去消耗配额。

5. 发起监测

Shell
curl -s -X POST https://shengliang.cn/openapi/v1/geo/runs \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d "{\"brand_id\": \"$BRAND\", \"platforms\": [\"doubao\", \"deepseek\"]}"
JSON
{ "code": 0, "data": { "status": "queued", "run_id": "georun_…" } }

监测是异步的。 一轮需要几分钟到几十分钟（取决于意图词数 × 平台数），接口会立刻 返回。status 返回 queued 而不是 running 属于正常情况 —— 检测资源暂时繁忙时会先 排队，资源空出来后自动开始。

查询进度

Shell
curl -s "https://shengliang.cn/openapi/v1/geo/runs/georun_…" \
  -H "Authorization: Bearer $KEY"
JSON
{ "code": 0,
  "data": {
    "status": "running",
    "progress": { "done": 12, "total": 30 },
    "platforms": [
      { "platform": "doubao", "status": "running", "failed": 0 },
      { "platform": "wenxin", "status": "skipped",
        "reason": "该平台本轮不可用（未实装 / 无已登录运行时）" }
    ]
  } }

建议 30 秒查询一次。一轮监测以分钟计，更密的轮询拿不到更多信息，只会更快触发 频率限制。

⚠️ 留意 platforms[].status 里的 skipped。 监测跑在真实的 AI 客户端上，某个平台 暂时不可用时会被整体跳过，reason 里会说明原因。所以「结果比我选的平台少」通常不是 参数写错了，看一眼 reason 就清楚。

查看结果

Shell
curl -s "https://shengliang.cn/openapi/v1/geo/brands/$BRAND/overview" \
  -H "Authorization: Bearer $KEY"

同一份数据在控制台的 GEO 页面里也看得到。想看得更细，可以调 品牌可见性、口碑分析、 引用来源。

接下来