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}
検索
特定のワークフローの詳細と入力スキーマを取得します。画像フィールド、テキストフィールド、選択フィールドを含みます。プリセットオプションのあるテキストフィールドには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クレジット残高とWebクレジットの内訳を取得します。

このエンドポイントにはパラメータは不要です。

利用可能なワークフロー

以下のワークフローがAPI経由で利用可能です。上記のエンドポイントでワークフローIDを使用してください。

ID名前Tagsクレジット
79c9e172-637f-44db-9beb-39092ff4d462
單色棚拍風
FashionModel
4