鑑權

安全配置並校驗你的 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 管理接口。