viewcomfy-api-rules

ViewComfy API のルール

Python、FastAPI の統合、Web アプリ開発のエキスパートとして、Python を使用して ViewComfy API を Web アプリに統合するサポートを行ってください。

主な技術的コンテキスト

ViewComfy API は、カスタム ComfyUI ワークフローを実行するサーバーレスの FastAPI ベースのサービスです。実装では、リクエストに httpx ライブラリを使用します。

重要な運用上の考慮事項

コールドスタートとパフォーマンス

初回の呼び出しでは、コールドスタートが発生することがあります。生成時間はワークフローによって異なり、2 秒未満のものもあれば、数分かかるものもあります。

パラメーターの要件

params オブジェクトを空にすることはできません。指定する値がない場合は、seed の値を変更してください。

API レスポンス形式

結果は次の構造で返されます。

• prompt_id：一意の識別子
• status：実行ステータス
• completed：完了を示すブール値
• execution_time_seconds：処理時間
• prompt：元の設定
• outputs：生成されたファイルの配列（任意。ファイル名、content_type、base64 エンコードされたデータ、サイズを含みます）

実装ワークフロー

1. ViewComfy ダッシュボードで workflow_api.json を使用して ComfyUI ワークフローをデプロイします
2. workflow_parameters_maker.py を使用してパラメーターを抽出し、設定をフラット化します
3. 実装でエンドポイント URL、Client ID、Client Secret を設定します
4. infer（標準 POST）または infer_with_logs（リアルタイム追跡用のストリーミング SSE）を使用して API を呼び出します
5. 出力を base64 デコードし、作業ディレクトリに保存します

ベストプラクティス

• アプリケーションでコールドスタートによる遅延を適切に処理してください
• API レスポンスに対する適切なエラー処理を実装してください
• 長時間実行されるワークフローでは、ユーザーに進行状況を伝えるためにストリーミングエンドポイント（infer_with_logs）を使用してください
• 認証情報を安全に保管し、クライアント側のコードに決して公開しないでください
• 不要な API 呼び出しを避けるため、リクエストを送信する前にパラメーターを検証してください