开放平台 API

开放平台是给外部系统调用的独立 API。 你可以用这些 API,在自己的系统里接入 HeiChat 的开放能力。

请求地址以后台凭证页展示的 Base URL 为准。所有请求都必须使用 HTTPS。

鉴权

每次请求都需要同时带上这两个请求头:

X-Platform-Access: pk_...
X-Platform-Secret: sk_...

Access Key 用来识别店铺。Secret 用来证明调用方有权使用这把 Key。不要把 Secret 放在查询参数、日志或前端代码里。

以下情况都会返回 401,接口不会区分具体原因:

  • 缺少 Access Key 或 Secret
  • Secret 不匹配
  • 凭证已停用
  • 店铺已停用

Secret 只在后台创建时展示一次,之后无法再查看。

频率限制

限制按店铺计算,不按 Access Key 计算。

套餐每分钟请求数每个自然月请求数
未付费套餐101,000
Pro Basic、Pro105,000
Pro Plus 及以上3020,000

月份按 UTC 自然月计算。套餐变更不会清空已经消耗的用量。上述两个限制对所有开放平台请求都生效。

超出限制时,接口返回 429,并带上 Retry-After 响应头。这个值是建议等待的秒数。分钟限额会在下一分钟重置,月限额会在下一个 UTC 月份重置。

反复使用无效凭证时,可能在影响店铺配额之前就返回 429。

错误码

只有非 2xx 响应才会返回错误对象:

{
  "error": "RATE_LIMITED",
  "message": "rate limit exceeded"
}

error 是给程序判断的稳定错误码。message 是简短的可读说明。

HTTPerror出现场景
400INVALID_REQUEST必填字段缺失、为空,或参数超出允许范围。
401UNAUTHORIZEDAccess Key 或 Secret 缺失、不匹配,或凭证已停用。
403FORBIDDEN调用方已通过鉴权,但当前操作不被允许。
404NOT_FOUND资源不存在,或不属于当前已鉴权的店铺。
409QUOTA_EXCEEDED已达到业务配额。
429RATE_LIMITED超出每分钟限额、每月限额,或鉴权失败限流。
500INTERNAL_ERROR服务端发生未预期错误。

资源不存在,和资源属于其他店铺,都会返回 404。

响应格式

  • 200 和 201 返回 JSON 对象,没有 code、message 或 data 包装层。
  • 204 没有响应体。
  • 时间使用 UTC 和 ISO-8601,例如 2026-09-04T00:00:00Z。
  • 列表接口返回包含 items 和分页字段的对象,不会直接返回数组。
  • 已有字段不会被删除或改名。后续可能会新增字段。解析响应时请忽略未知字段,避免新增字段导致反序列化失败。

可用接口

  • 知识库 API:查询、获取、删除知识条目,以及创建手动输入条目。
  • 会话 API:列出会话,以及获取单条会话和其中的消息。