概覽

瞭解如何把 KPainter 的創作能力接入你的產品。

把 KPainter 接入你的產品

KPainter OpenAPI 適合需要在自己的產品、自動化流程或 Agent 中創建內容的開發者。它提供三種公開能力:

產品 類型 適合
解說視頻 視頻 課程、培訓、SOP、研究解讀、產品教育和知識講解
AI 生圖 image 海報、封面、插畫和單張視覺創意
AI 應用 應用 互動網頁、模擬器、測驗和小工具

PDF、PPT、文檔和圖片都是輸入素材,不決定最終產品。解說視頻還可以直接使用網頁 URL 作為內容來源。

基礎地址

正式請求都從這裡開始:

https://api.kpainter.ai/openapi/v1

例如,讀取當前賬號可用能力的完整地址是:

https://api.kpainter.ai/openapi/v1/capabilities

一次完整創建流程

  1. 用 GET /me 確認 API Key。
  2. 用 GET /capabilities 獲取當前可用參數。
  3. 如有附件,先用 POST /files 上傳。
  4. 用 POST /creations 創建 video、image 或 app。
  5. 用 GET /creations/{id} 查詢狀態和進度。
  6. 完成後用 GET /creations/{id}/outputs 獲取可用結果。
  7. 解說視頻可用 messages 繼續修改;任務暫停時,只執行 available_actions 中返回的操作。

常用接口

接口 用途
健康 / 健康 檢查服務是否可訪問
我 / 我 校驗當前賬號
能力 / 能力 獲取產品、參數、模板和模型
郵件 / 文件 上傳輸入文件
創作 / 創作 創建內容
創作 / 創作 查詢當前賬號的創建記錄
創作 / 創作{id} 查詢狀態、進度、預計時間和積分
POST / 創作 / {id} / 消息 繼續修改解說視頻
POST / 創作 / {id} / 活動 繼續最新暫停任務
GET /creations /{id} / outputs 獲取已通過檢查的交付結果

接入時需要注意

  • 鑑權統一使用 Bearer API Key。
  • 請求和響應字段統一使用 snake_case。
  • 只發送 capabilities 當前返回的參數值。
  • 普通失敗不會返回實際消費積分。
  • 沒有可靠估算時,不會返回預計剩餘時間。
  • 完成後從輸出接口讀取可用結果,不要自行拼接下載地址。

接下來閱讀