---
title: [ComfyMaster21] ComfyUIのAPI化 – Websocketで外部保存
description: れた画像をリアルタイムに保存するワークフローを紹介し、プロンプトの処理から画像の保存までのプロセスを具体的に説明します。APIの使い方やWebSocketを使った高度な処理に興味のある開発者向けの実践的ガイドです。
image: https://ja.aicu.ai/wp-content/uploads/2024/10/rectangle_large_type_2_4f2a64e103356591a68f0b666cf6bf53.webp.webp
---

[![AICU-LogoWT](https://corp.aicu.ai/hs-fs/hubfs/Logo/AICU-LogoWT.png?width=200&height=512&name=AICU-LogoWT.png "AICU-LogoWT")](https://aicu.ai)

Search toggle

- [AICU](https://aicu.ai/)
  
  AICU 
  
  
  
    - [Blog \[English\]](https://corp.aicu.ai/en)
    - [Blog \[Japanese\]](https://corp.aicu.ai/ja/)
    - [note](https://note.com/aicu)
    - [medium](https://medium.com/@aicu)
- [Products](https://corp.aicu.ai/ja/products)
  
  Products 
  
  
  
    - [AICU media](https://note.com/aicu/)
    - [X(Twitter)@AICUai](https://twitter.com/AICUai)
    - [日本市場向け製品](https://corp.aicu.ai/ja/products)
      
      日本市場向け製品 
      
      
      
          - [特定商取引法](https://corp.aicu.ai/jp-commercial-transactions-act)
    - [AI market dev solutions](https://corp.aicu.ai/products)
    - [LINE Chatbot \[LuC4\] 全力肯定彼氏くん](https://corp.aicu.ai/ja/tag/luc4%E5%85%A8%E5%8A%9B%E8%82%AF%E5%AE%9A%E5%BD%BC%E6%B0%8F%E3%81%8F%E3%82%93)
    - [AICuty](https://corp.aicu.ai/aicuty)
    - [Lecture](https://bit.ly/AICUCEO)
    - [AICU Creator Union Membership](https://note.com/aicu/membership/info)
    - [Pricing](https://corp.aicu.ai/ja/pricing)
- [AICU Japan](https://aicu.jp/)
- [About Us](https://corp.aicu.ai/about)
  
  About Us 
  
  
  
    - [Vision](https://corp.aicu.ai/vision)
    - [Privacy Policy](https://corp.aicu.ai/ja/privacy)
    - [Media Policy](https://corp.aicu.ai/media-policy)
    - [PRTIMES](https://prtimes.jp/main/html/searchrlp/company_id/133647)
    - [Become a partner](https://j.aicu.ai/Creg)
    - [Contact](https://corp.aicu.ai/contact)

[Follow us on Facebook](https://m.me/118997804638852?ref=klE9gy8WjnrE) [Follow us on Twitter](https://www.youtube.com/@AICuty) [Follow us on Instagram](https://twitter.com/AICUai)

[![AICU-LogoWT](https://corp.aicu.ai/hs-fs/hubfs/Logo/AICU-LogoWT.png?width=200&height=512&name=AICU-LogoWT.png "AICU-LogoWT")](https://aicu.ai)

- [AICU](https://aicu.ai/)
  
  AICU 
  
  
  
    - [Blog \[English\]](https://corp.aicu.ai/en)
    - [Blog \[Japanese\]](https://corp.aicu.ai/ja/)
    - [note](https://note.com/aicu)
    - [medium](https://medium.com/@aicu)
- [Products](https://corp.aicu.ai/ja/products)
  
  Products 
  
  
  
    - [AICU media](https://note.com/aicu/)
    - [X(Twitter)@AICUai](https://twitter.com/AICUai)
    - [日本市場向け製品](https://corp.aicu.ai/ja/products)
      
      日本市場向け製品 
      
      
      
          - [特定商取引法](https://corp.aicu.ai/jp-commercial-transactions-act)
    - [AI market dev solutions](https://corp.aicu.ai/products)
    - [LINE Chatbot \[LuC4\] 全力肯定彼氏くん](https://corp.aicu.ai/ja/tag/luc4%E5%85%A8%E5%8A%9B%E8%82%AF%E5%AE%9A%E5%BD%BC%E6%B0%8F%E3%81%8F%E3%82%93)
    - [AICuty](https://corp.aicu.ai/aicuty)
    - [Lecture](https://bit.ly/AICUCEO)
    - [AICU Creator Union Membership](https://note.com/aicu/membership/info)
    - [Pricing](https://corp.aicu.ai/ja/pricing)
- [AICU Japan](https://aicu.jp/)
- [About Us](https://corp.aicu.ai/about)
  
  About Us 
  
  
  
    - [Vision](https://corp.aicu.ai/vision)
    - [Privacy Policy](https://corp.aicu.ai/ja/privacy)
    - [Media Policy](https://corp.aicu.ai/media-policy)
    - [PRTIMES](https://prtimes.jp/main/html/searchrlp/company_id/133647)
    - [Become a partner](https://j.aicu.ai/Creg)
    - [Contact](https://corp.aicu.ai/contact)

Search toggle

[![AICU-LogoWT](https://corp.aicu.ai/hs-fs/hubfs/Logo/AICU-LogoWT.png?width=200&height=512&name=AICU-LogoWT.png "AICU-LogoWT")](https://aicu.ai)

- [AICU](https://aicu.ai/)
  
  AICU 
  
  
  
    - [Blog \[English\]](https://corp.aicu.ai/en)
    - [Blog \[Japanese\]](https://corp.aicu.ai/ja/)
    - [note](https://note.com/aicu)
    - [medium](https://medium.com/@aicu)
- [Products](https://corp.aicu.ai/ja/products)
  
  Products 
  
  
  
    - [AICU media](https://note.com/aicu/)
    - [X(Twitter)@AICUai](https://twitter.com/AICUai)
    - [日本市場向け製品](https://corp.aicu.ai/ja/products)
      
      日本市場向け製品 
      
      
      
          - [特定商取引法](https://corp.aicu.ai/jp-commercial-transactions-act)
    - [AI market dev solutions](https://corp.aicu.ai/products)
    - [LINE Chatbot \[LuC4\] 全力肯定彼氏くん](https://corp.aicu.ai/ja/tag/luc4%E5%85%A8%E5%8A%9B%E8%82%AF%E5%AE%9A%E5%BD%BC%E6%B0%8F%E3%81%8F%E3%82%93)
    - [AICuty](https://corp.aicu.ai/aicuty)
    - [Lecture](https://bit.ly/AICUCEO)
    - [AICU Creator Union Membership](https://note.com/aicu/membership/info)
    - [Pricing](https://corp.aicu.ai/ja/pricing)
- [AICU Japan](https://aicu.jp/)
- [About Us](https://corp.aicu.ai/about)
  
  About Us 
  
  
  
    - [Vision](https://corp.aicu.ai/vision)
    - [Privacy Policy](https://corp.aicu.ai/ja/privacy)
    - [Media Policy](https://corp.aicu.ai/media-policy)
    - [PRTIMES](https://prtimes.jp/main/html/searchrlp/company_id/133647)
    - [Become a partner](https://j.aicu.ai/Creg)
    - [Contact](https://corp.aicu.ai/contact)

[Follow us on Facebook](https://m.me/118997804638852?ref=klE9gy8WjnrE) [Follow us on Twitter](https://www.youtube.com/@AICuty) [Follow us on Instagram](https://twitter.com/AICUai)

Search toggle

What are you looking for?

Search

# \[ComfyMaster21\] ComfyUIのAPI化 – Websocketで外部保存

 2024/10/6

![Picture of AICU Japan](https://corp.aicu.ai/hs-fs/hubfs/2023-09-20_062230-3.png?width=40&name=2023-09-20_062230-3.png) [AICU Japan](https://corp.aicu.ai/ja/author/aidx-lab) 

![\[ComfyMaster21\] ComfyUIのAPI化 – Websocketで外部保存](https://ja.aicu.ai/wp-content/uploads/2024/10/rectangle_large_type_2_4f2a64e103356591a68f0b666cf6bf53.webp.webp)

**「ComfyUIをサービスに組み込みたい！」**  
そんな方は、ComfyUIをAPI化すればOK！ComfyUIは、最初からAPI化する機能を持っているので簡単です！

ComfyUIを自社のサービスに組み込むための基本テクニックは、先日、渋谷で開催されたComfyUIミートアップでも話題になりました。

こんにちは、AICU media編集部です。  
「[ComfyUI マスターガイド](https://ja.aicu.ai/comfyui20240731/)」第21回目になります。  
本記事では、ComfyUIをAPIとして外部から利用する方法を解説します。

前回は[こちら](https://ja.aicu.ai/comfymaster20-20240920/)

今回は、ComfyUI APIサーバー化する上での基本的な使い方を解説します。15,000文字ぐらいでVSCodeやPythonのインストールから、API経由でWebsocketを使った画像保存まで、自分のPythonコードで実装していきます。今回解説する内容は「かなり玄人向け、システム開発などに用途が限られるかも？」という印象があるかもしれませんが、アニメーションシステムへの応用や、インタラクティブな体験開発、AWSでのインスタンスから画像を保存したり、UnityやUnreal Engineなどのリアルタイム処理のアプリから画像をリクエストしたり、DiscordサーバーやDifiなどのチャットシステムのAPIエンドポイントとして使用したり……と、使用するワークフローを多様にすることで、様々な用途で使用することができるでしょう。用途は無限大なので、ぜひ活用して [X@AICUai](https://x.com/AICUai) にてフィードバックをいただければ幸いです。

## 1. 前提条件

今回の記事では、以下の前提条件に基づき、APIを実行します。

- Google ColabでComfyUIを動作させる
- ローカルPCからPythonでComfyUIのAPIを実行する
- ワークフローは、標準ワークフローを使用する
- 生成画像は、ローカルPCにダウンロードして保存する

今回使用するPythonコードは、ComfyUIの公式が提供している**「**[**websockets\_api\_example\_ws\_images.py**](https://github.com/comfyanonymous/ComfyUI/blob/master/script_examples/websockets_api_example_ws_images.py)**」**というサンプルコードを基に、Google Colabで動作するComfyUIと通信できるように改修したものになります。公式のサンプルコードは、以下のリンクより確認できます。

[https://github.com/comfyanonymous/ComfyUI/blob/master/script\_examples/websockets\_api\_example\_ws\_images.py](https://github.com/comfyanonymous/ComfyUI/blob/master/script_examples/websockets_api_example_ws_images.py)

以下が今回使用するPythonコードのフローになります。

[![画像](https://ja.aicu.ai/wp-content/uploads/2024/10/image.png)](https://assets.st-note.com/img/1725843276-NFMoxpSG25HjsTqwztdZDauU.png?width=2000&height=2000&fit=bounds&quality=85)

1. ユーザーがプログラムを開始します。
2. メインプログラムが「workflow\_api.json」ファイルを読み込みます。
3. プロンプトのテキストとシードが修正されます。
4. 修正されたプロンプトがComfyUIサーバーのキューに追加されます。
5. サーバーからprompt\_idが返されます。
6. WebSocket接続が確立され、状態更新の待機が始まります。
7. サーバーが状態更新を送信し、キューが空になるまで続きます。
8. 画像データが送信されます。
9. プログラムが次の画像番号をファイルシステムから取得します。
10. 生成された画像がファイルシステムに保存されます。
11. ユーザーに完了が通知されます。

[![ComfyUI 知らないの？](https://no-cache.hubspot.com/cta/default/43845236/interactive-185006873759.png)](https://corp.aicu.ai/hs/cta/wi/redirect?encryptedPayload=AVxigLJfEP00P7jMr%2B1LbnyY1erd6tpzOEKoCnPrEL%2FSpamHEhORyQDKli8BlLajVEOZidGw7d4EZhCehJ34z6%2BDMGroz7393kGfGa3rFuzmniXp9XI2%2F7bm%2FwISSyYkd5WAWfIhqFJjiMjsqK0jn9wh212G8Kr0jm12QtwbHkk%3D&webInteractiveContentId=185006873759&portalId=43845236&hsLang=ja)

[![画像生成 お困りですか？](https://no-cache.hubspot.com/cta/default/43845236/interactive-185263496576.png)](https://corp.aicu.ai/hs/cta/wi/redirect?encryptedPayload=AVxigLLPMbA11heqBR43Ie971Nm5VUHSuEb05gfqvGrPUs9slWPtYLpTqGxQxRu53ugD1TuJKcTbZMq4OvdGx4hGlXfCbe7qTgIJdu%2BYa5FzRtD8UcEaPBHfbw91oqfZNeWIl%2FtMAyefa0GAkvEm63rvICa6dMBLkz9qsrP8A6w%3D&webInteractiveContentId=185263496576&portalId=43845236&hsLang=ja)

## 2. ComfyUIのAPIについて

ComfyUIは、起動と同時にAPIとして利用することが可能になっています。これは、Prompt Serverで実現されています。Prompt Serverは、API を通じてフロントエンドと連携し、ユーザーが複雑なワークフローを構築し、画像生成プロセスを制御することを可能にします。

旧来のRESTfulなAPIや、FastAPIやAutomatic1111とも異なる設計のようです  
RESTfulならステートレス性(Stateless)が必要ですが、今回の例ではWebsocketを使って画像を転送します。HTTPをベースにしたステートレスなクライアント/サーバプロトコルではないですが、セッション等の状態管理をして、リアルタイム性や高速転送を実現しているように読み取れます。

### WebSocketによる状態把握

Prompt Serverは、WebSocketを利用し、フロントエンドとの双方向通信を実現しています。これにより、キューの状態変化、ノードの実行状況、モデルのダウンロード進捗など、リアルタイムな更新をフロントエンドに通知することができます。本稿を執筆した2024年9月29日時点での実装ベースで分析した主な WebSocket イベントは以下になります。

- **status:** キューの状態 (実行中のタスク数、待機中のタスク数など) を更新します。
- **executing:** 現在実行中のノードの情報を提供します。
- **progress:** KSamplerなどのサンプリング処理の進捗状況を通知します。
- **execution\_success:** ワークフローの実行が完了したことを通知します。

### エンドポイント

- **/:** ComfyUI のフロントエンド (index.html) を提供します。
- **/embeddings:** 使用可能な埋め込みのリストを取得します。
- **/models/{folder}:** 指定されたフォルダ内のモデルのリストを取得します。
- **/extensions:** 使用可能な拡張機能のリストを取得します。
- **/upload/image:** 画像をアップロードします。
- **/upload/mask:** マスク画像をアップロードします。
- **/view:** 画像を表示またはダウンロードします。
- **/view\_metadata/{folder\_name}:** safetensors ファイルのメタデータを取得します。
- **/system\_stats:** システムの統計情報を取得します。
- **/prompt:** プロンプトをキューに追加します (POST) またはキューの状態を取得します (GET)。
- **/queue:** キューを操作 (クリア、プロンプトの削除など) します。
- **/interrupt:** 実行中の処理を中断します。
- **/free:** メモリを解放します。
- **/history:** プロンプトの履歴を取得または操作 (クリア、履歴の削除など) します。
- **/internal/models/download:** 指定された URL からモデルをダウンロードします。
- **/object\_info:** 全てのノードまたは特定のノードクラスの情報を取得します。

## 3. Pythonコード実行環境の準備

今回は初のPythonコード実行環境の準備になります。WindowsやMac環境で共通の解説を行っていきます。一見難しそうですが、初心者向けに丁寧に解説していきますので、ぜひついてきてください！

---

## 画像生成AI「ComfyUI」マスターPlan

画像生成AI「Stable Diffusion」特に「ComfyUI」を中心としたプロ向け映像制作・次世代の画像生成を学びたい方に向けたプランです。最新・実用的な記事を優先して、**ゼロから学ぶ「ComfyUI」マガジン**からまとめて購読できます。 メンバーシップ掲示板を使った質問も歓迎です。

- メンバー限定の会員証が発行されます
- 活動期間に応じたバッジを表示
- メンバー限定掲示板を閲覧できます
- メンバー特典記事を閲覧できます
- メンバー特典マガジンを閲覧できます
- 動画資料やworkflowといった資料への優先アクセスも予定

**ゼロから学ぶ「ComfyUI」マガジン**

[https://note.com/aicu/m/md2f2e57c0f3c](https://note.com/aicu/m/md2f2e57c0f3c)

マガジン単体の販売は1件あたり500円を予定しております。  
2件以上読むのであればメンバーシップ参加のほうがお得です！というのもメンバーシップ参加者にはもれなく「AICU Creator Union」へのDiscordリンクをお伝えし、メンバーオンリー掲示板の利用が可能になります。

[https://note.com/aicu/membership/boards/61ab0aa9374e/posts/db2f06cd3487?from=self](https://note.com/aicu/membership/boards/61ab0aa9374e/posts/db2f06cd3487?from=self)

もちろん、初月は無料でお試しいただけます！  
毎日新鮮で確かな情報が配信されるAICUメンバーシップ。  
退会率はとても低く、みなさまにご満足いただいております。  
**✨️オトクなメンバーシップについての詳細はこちら**

---

[![最新情報はメールニュース  ](https://no-cache.hubspot.com/cta/default/43845236/interactive-185006873894.png)](https://corp.aicu.ai/hs/cta/wi/redirect?encryptedPayload=AVxigLKp%2FthX7%2FBfZGfjlbJwe7z9RASwU7TQvBz0mpJAkQAgGsmcELXdLui7bpmOugenIzoH7q3Z7lo9%2FgLIZL19x%2B%2FoXr43hicq%2Fbi%2FjtHCBaXGciRux59rDXYtnv7v3cHrImGMwvyHKSnqPVLrIhq7pTUJeL%2BcGFZX&webInteractiveContentId=185006873894&portalId=43845236&hsLang=ja)

この記事の続きはこちらから [https://note.com/aicu/n/n1d717357047f](https://note.com/aicu/n/n1d717357047f)

Originally published at [https://note.com](https://note.com/aicu/n/n1d717357047f) on Sept 29, 2024.

### Share:

[Share on Facebook](http://www.facebook.com/share.php?u=https://corp.aicu.ai/ja/comfymaster21-20240929&utm_medium=social&utm_source=facebook) [Share on LinkedIn](http://www.linkedin.com/shareArticle?mini=true&url=https://corp.aicu.ai/ja/comfymaster21-20240929&utm_medium=social&utm_source=linkedin) [Share on X](https://twitter.com/intent/tweet?original_referer=https://corp.aicu.ai/ja/comfymaster21-20240929&utm_medium=social&utm_source=twitter&url=https://corp.aicu.ai/ja/comfymaster21-20240929&utm_medium=social&utm_source=twitter&source=tweetbutton&text=[ComfyMaster21]%20ComfyUIのAPI化%20–%20Websocketで外部保存)

[ComfyUI](https://corp.aicu.ai/ja/tag/comfyui), [ComfyUIマスターガイド](https://corp.aicu.ai/ja/tag/comfyuiマスターガイド), [ComfyUI\_Workflow](https://corp.aicu.ai/ja/tag/comfyui_workflow), [ComfyUIAPI](https://corp.aicu.ai/ja/tag/comfyuiapi)

## AICU Japan

AICU Inc. AIDX Lab - Koto

[info@aicu.ai](mailto:info@aicu.ai)

## Comments

## Related posts

Search [AICU Magazine Vol.5 初版リリース!! 特集は「Stability AI Forever!」KDPで無料](https://corp.aicu.ai/ja/magazine-v5-released?hsLang=ja)

[【Coloso講座】ComfyUIマスター：カスタムノードとアプリ開発](https://corp.aicu.ai/ja/coloso-20240930?hsLang=ja) Search

![AICU-LogoWT](https://corp.aicu.ai/hs-fs/hubfs/Logo/AICU-LogoWT.png?width=210&name=AICU-LogoWT.png "AICU-LogoWT")

AICU Inc. is AIDX company.

[Follow us on Facebook](https://m.me/118997804638852?ref=klE9gy8WjnrE) [Follow us on Twitter](https://twitter.com/AICUai) [Follow us on Instagram](https://www.youtube.com/@AICuty)

Main Office: 830 STWART DR STE277 SUNNYVALE, CA 94085-4513

```json
{
  "@context" : "https://schema.org",
  "@type" : "BlogPosting",
  "author" : {
    "@type" : "Person",
    "name" : "AICU Japan",
    "url" : "https://corp.aicu.ai/ja/author/aidx-lab"
  },
  "dateModified" : "2025-01-31T22:07:29.600Z",
  "datePublished" : "2024-10-06T21:31:07.000Z",
  "headline" : "[ComfyMaster21] ComfyUIのAPI化 – Websocketで外部保存",
  "image" : [ "https://ja.aicu.ai/wp-content/uploads/2024/10/rectangle_large_type_2_4f2a64e103356591a68f0b666cf6bf53.webp.webp" ],
  "mainEntityOfPage" : {
    "@id" : "https://corp.aicu.ai/ja/comfymaster21-20240929",
    "@type" : "WebPage"
  },
  "publisher" : {
    "@type" : "Organization",
    "logo" : {
      "@type" : "ImageObject",
      "url" : "https://corp.aicu.ai/hubfs/android-chrome-512x512.png"
    },
    "name" : "AICU Inc."
  }
}
```