API 接口与密钥

通过 hiCreator API,将达人发现、数据查询和分析报告接入你的应用。

获取 API Key

身份验证

使用 API Key 调用接口,在请求中添加以下 HTTP 请求头。

Authorization: Bearer <YOUR_KEY>

API 接入需要付费 Workspace;接口按实际使用计费。

GET/api/openapi/v1/reports/<JOB_ID>

查询状态及结果

接口价格免费

支持平台Instagram / YouTube / TikTok / Twitter / X

查询状态及结果

快速调用示例 (cURL)

curl 'https://app.hicreator.ai/api/openapi/v1/reports/<JOB_ID>?type=audience_analysis' \
  -H 'Authorization: Bearer <YOUR_KEY>'

处理中每 5 秒查询一次,任务结束后停止。

请求参数

参数名类型必填说明
idstring (UUID)是提交时返回的 data.id。
typestring是提交时返回的 data.type。
查看可选值

audience_analysis / fake_follower_check

报告完成后返回 result;null 表示暂无结果。

响应字段

参数名类型始终返回说明
requestIdstring是请求 ID,用于排查问题。
dataobject是任务与报告。
data.idstring (UUID)是报告任务 ID。
data.typestring是报告类型。
查看可选值

audience_analysis / fake_follower_check

data.platformstring | null是所属平台。
data.canonicalUrlstring | null是达人主页链接。
data.statusstring是任务状态。
查看可选值

queued / running / succeeded / unavailable / failed

data.errorCodestring | null是失败原因代码。
data.createdAtstring是创建时间。
data.startedAtstring | null是开始时间。
data.finishedAtstring | null是结束时间。
data.resultobject | null是报告结果。
data.result.countriesobject[]是国家或地区分布。
data.result.ageRangesobject[]是年龄分布。
data.result.gendersobject[]是性别分布。
data.result.countries[].keystring是国家或地区代码,如 US。
data.result.countries[].sharenumber是受众占比(0–1)。
data.result.ageRanges[].keystring是年龄段。
查看可选值

13-17 / 18-34 / 35-64 / 65+

data.result.ageRanges[].sharenumber是受众占比(0–1)。
data.result.genders[].keystring是性别。
查看可选值

male / female

data.result.genders[].sharenumber是受众占比(0–1)。

响应示例 (JSON)

{
  "requestId": "<http-request-id>",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "platform": "twitter",
    "canonicalUrl": "https://x.com/example_creator",
    "status": "succeeded",
    "errorCode": null,
    "createdAt": "2026-10-08T01:00:00.000Z",
    "startedAt": "2026-10-08T01:00:00.000Z",
    "finishedAt": "2026-10-08T01:02:00.000Z",
    "type": "audience_analysis",
    "result": {
      "countries": [
        {
          "key": "US",
          "share": 0.7
        },
        {
          "key": "GB",
          "share": 0.3
        }
      ],
      "ageRanges": [
        {
          "key": "18-34",
          "share": 0.8
        },
        {
          "key": "35-64",
          "share": 0.2
        }
      ],
      "genders": [
        {
          "key": "female",
          "share": 0.6
        },
        {
          "key": "male",
          "share": 0.4
        }
      ]
    }
  }
}

错误与重试

查看 error.message;排查时提供 requestId。结果不确定时请勿自动重试。

任务失败原因见 data.errorCode。

API 接口与密钥 | hiCreator