概覽/OpenAPI/創建與查詢

創建與查詢

上傳素材,創建內容,並查詢進度、積分和輸出。

創建與查詢

三種產品共用同一組創作任務接口。無論創建視頻、圖片還是應用,都可以使用相同的列表、詳情和輸出讀取方式。

上傳附件

三種產品都支持 input_file_ids。先上傳文件:

curl -s "https://api.kpainter.ai/openapi/v1/files" \  -H "Authorization: Bearer $KPAINTER_API_KEY" \  -F "file=@./handbook.pdf"

響應示例:

{  "file_id": "file_xxx",  "name": "handbook.pdf",  "mime_type": "application/pdf",  "size_bytes": 248391}

只在當前賬號的創建請求中使用返回的 file_id。

創建

POST /creations

公共字段:

字段 必填 說明
類型 video、image 或 app
快速 想要創建的內容
指示 補充要求
input_file_ids 中的內容 已上傳的文件編號
max 信用 本次任務允許使用的積分上限
視頻 / 圖像 / 應用程序 只發送與 type 對應的設置對象

示例:

{  "type": "app",  "prompt": "根据培训手册做一个带即时反馈的安全知识测验",  "input_file_ids": ["file_xxx"],  "app": {    "language": "zh"  }}

列表與詳情

GET /creations?page=1&page_size=20GET /creations?type=video&page=1&page_size=20GET /creations/{id}

詳情中的常用字段:

字段 說明
狀態 planning、producing、paused、ready 或 failed
進展 / PCT 0–100 的單調進度
估計_remaining_seconds 可靠時才返回的剩餘時間
估計 - 信用 當前任務的預估積分
真實信貸 成功後本次任務的實際積分
可用 - 交付 是否已有可用結果
可用 - 活動 當前允許執行的繼續操作
評論 解說視頻可安全展示的大綱
結果 - 代碼 可向用戶解釋的安全結果碼

普通失敗不會返回實際消費積分。沒有可靠估算時,estimated_remaining_seconds 會省略。

獲取輸出

GET /creations/{id}/outputs

僅展示接口返回的 outputs。不要猜測 URL,也不要使用未完成任務的中間文件。

穩定的客戶端流程

  1. 讀取 capabilities。
  2. 只提交一次參數有效的創建請求。
  3. 每隔數秒查詢同一個 creation。
  4. ready 後讀取 outputs。
  5. paused 時讀取 available_actions,等待用戶完成所需操作。
  6. failed 時展示安全原因,修改輸入後再發起新請求。
  7. 網絡狀態不明時先查詢現有 creation,不要直接重複創建。