API 參考圖片
圖片
API 文件的影像生成能力狀況。
圖片
影像生成在文件導航中呈現,因此API 文件保持一致的產品地圖。公共公共端點的可用性是架構驅動的。在從生產代碼呼叫圖像端點之前檢查 GET /api/openapi.json。
## 要求
啟用影像端點後,預計會出現非同步任務模型:使用提示和模型選項建立任務,然後輪詢是否完成。請求仍然使用承載身份驗證:
Authorization: Bearer KITTA_API_KEY不要從其他文檔推斷其他環境的路徑。僅使用部署環境的OpenAPI 架構中存在的路徑。
回覆
圖像任務回應通常包括任務 ID、狀態、成功時的結果圖像 URL 以及失敗時的錯誤代碼。在輪詢之前儲存任務 ID,以便使用者可以在頁面刷新或工作進程重新啟動後恢復結果。
計費和積分
影像生成可能會按模型、解析度、參考影像或成功任務收費。建立任務之前驗證提示大小和輸入媒體,並在大批量之前檢查設定檔。
錯誤
分別處理不支援的模型、無效的參考影像、學分不足和處理失敗。如果 GET /api/openapi.json 中不存在影像端點,則將該功能視為對該帳戶不公開可用。
正式 OpenAPI 端點
- 模型目錄:
GET /api/open/v1/media/models?mediaType=image - 生成圖片:
POST /api/open/v1/media/images/jobs - 查詢任務:
GET /api/open/v1/media/images/jobs/{jobId}
每個建立請求都必須帶有唯一的 Idempotency-Key 請求標頭。此 API 使用 API 額度而非網站會員積分;供應商、儲存或任務落庫失敗時,系統會冪等退回 API 額度。