API 文件

v1

Solo Works REST API 完整參考。使用這些端點將 AI 圖片編輯整合到您的應用程式中。更新日期：2026-03-05

問 AI 怎麼用這個 API

複製以下提示詞，貼給你的 AI 助手（ChatGPT、Claude 等）即可快速上手。

閱讀 https://soloworks.app/llms.txt 然後告訴我這些 API 如何使用，附上程式碼範例。
llms.txt
認證方式
所有 API 請求需透過 Authorization 標頭傳送 API 金鑰。

Base URL

https://soloworks.app/api/v1

認證標頭

Authorization: Bearer sk_live_YOUR_API_KEY

協議

這是標準 REST API。使用 GET 讀取資料，POST 執行工作流程。所有回應為 JSON 格式。圖片輸入接受 HTTP/HTTPS URL 或 base64 data URL。

取得 API 金鑰

快速開始

  1. GET /api/v1/workflows — 查詢可用工作流程
  2. GET /api/v1/workflows/:id — 取得工作流程所需輸入
  3. POST /api/v1/workflows/:id/execute — 傳入圖片和參數執行
  4. GET /api/v1/executions/:id — 輪詢直到狀態為 completed

查詢

GET
/api/v1/workflows
查詢
列出所有可用的 AI 圖片編輯工作流程。回傳工作流程 ID、名稱、說明和點數費用。

參數

名稱類型位置必填說明
tagstringquery選填用於篩選工作流程的標籤（如 'fashion'、'product'）。
GET
/api/v1/workflows/{id}
查詢
取得特定工作流程的詳情和輸入 schema，包含圖片欄位、文字欄位和選擇欄位。有預設選項的文字欄位會包含 presetOptions 陣列 — 執行時請使用此陣列中的值。

參數

名稱類型位置必填說明
idstringpath必填要查詢詳情的工作流程 ID。

執行

POST
/api/v1/workflows/{id}/execute
執行
非同步執行 AI 圖片編輯工作流程。回傳執行 ID，透過 GET /api/v1/executions/:id 輪詢結果。

參數

名稱類型位置必填說明
idstringpath必填要執行的工作流程 ID（路徑參數）。
imagesRecord<string, string>body必填圖片輸入，格式為 fieldId → url 或 base64。URL 會由伺服器自動下載。
textsRecord<string, string>body選填文字輸入，以鍵值對方式傳入：fieldId → value。
switchSelectionsRecord<string, string[]>body選填選擇輸入，格式為 switchFieldId → [optionId]。
globalOverrides{ aspectRatio?: string, imageSize?: string }body選填可選的輸出覆蓋設定。aspectRatio："1:1"、"2:3"、"3:2"、"3:4"、"4:3"、"9:16"、"16:9"、"21:9"。imageSize："1K" 或 "2K"。
GET
/api/v1/executions/{id}
執行
查詢工作流程執行狀態。回傳進度百分比，完成後回傳結果 URL。

參數

名稱類型位置必填說明
idstringpath必填執行端點回傳的執行 ID。

帳戶

GET
/api/v1/balance
帳戶
查詢目前的 API 點數餘額和網頁點數明細。

此端點不需要參數。

可用的工作流程

以下工作流程目前可透過 API 使用。請使用工作流程 ID 搭配上方的 API 端點。

ID名稱Tags點數
79c9e172-637f-44db-9beb-39092ff4d462
單色棚拍風
FashionModel
4