鉴权

安全配置并校验你的 API Key。

使用 Bearer API Key

除 GET /health 外,所有 KPainter OpenAPI 请求都使用用户自己的 API Key:

Authorization: Bearer <your_api_key>

如果还没有 Key,请到 API Key 页面 激活并复制。

先校验连接

curl -s "https://api.kpainter.ai/openapi/v1/me" \  -H "Authorization: Bearer $KPAINTER_API_KEY"

成功响应会返回当前账号和套餐的安全摘要。客户端应在创建内容前完成这一步。

安全保存

  • 只在服务端或受信任的 Agent 连接中保存 Key。
  • 不要把 Key 写进浏览器代码、移动端安装包、截图或日志。
  • 不要用一把共享 Key 代表所有终端用户。
  • 不要在错误信息中回显完整 Key。
  • Key 重置后,应要求用户重新连接。

常见响应

  • 401:Key 缺失、无效或已失效。
  • 403:当前账号没有所请求能力。
  • 422:请求字段或参数组合无效。
  • 429:请求过于频繁,请按响应提示稍后重试。
  • 余额不足:creation 会提供明确状态、预估积分和可用操作,不要自动重复创建。

API Key 的激活、重置和删除仍在 KPainter 主站完成,OpenAPI 不提供 Key 管理接口。