> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-feat-openapi-i18n.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# マスク画像をアップロード

> 既存の画像に適用するマスク画像をアップロードします。

画像制限は、アップロードされたマスクと参照元のオリジナル画像の両方に適用されます：
  - 最大ファイルサイズ：50 MB
  - エッジごとの最大幅/高さ：16384 px
  - 最大総ピクセル数：64メガピクセル（67108864ピクセル）

これらの制限を超えるアップロードはHTTP 400で拒否されます。




## OpenAPI

````yaml /openapi/cloud.ja.yaml post /api/upload/mask
openapi: 3.0.3
info:
  title: Comfy Cloud API
  description: >
    <Warning>

    **実験的API:** このAPIは実験的であり、変更される可能性があります。

    エンドポイント、リクエスト/レスポンス形式、および動作は予告なく変更される場合があります。

    </Warning>


    Comfy CloudのAPI - クラウドインフラ上でComfyUIワークフローを実行します。


    このAPIを使用すると、Comfy Cloudとプログラムで連携できます。内容は次のとおりです。

    - ワークフローの送信と管理

    - ファイルのアップロードとダウンロード

    - ジョブの状態と進捗の監視


    ## クラウド vs OSS ComfyUI 互換性


    Comfy Cloudは最大限の互換性のためにOSS
    ComfyUIと同じAPIインターフェースを実装していますが、一部のフィールドは互換性のために受け入れられますが、異なる処理が行われたり無視されたりします。


    | フィールド | エンドポイント | クラウドの動作 |

    |-------|-----------|----------------|

    | `subfolder` | `/api/view`, `/api/upload/*` | **無視** -
    クラウドはコンテンツアドレスストレージ（ハッシュベース）を使用します。クライアント側の整理のためにレスポンスで返されます。 |

    | `type` (input/output/temp) | `/api/view`, `/api/upload/*` | 部分的に使用 -
    すべてのファイルはディレクトリ構造ではなくタグベースの整理で保存されます。 |

    | `overwrite` | `/api/upload/*` | **無視** -
    コンテンツアドレスストレージでは、同一のコンテンツは常に同じハッシュを持ちます。 |

    | `number`, `front` | `/api/prompt` | **無視** - クラウドはユーザーごとに独自の公平キュー
    スケジューリングを使用します。 |

    | `split`, `full_info` | `/api/userdata` | **無視** -
    クラウドは常に完全なファイルメタデータを返します。 |


    これらのフィールドは、既存のComfyUIクライアントやワークフローとのドロップイン互換性のためにAPIスキーマに保持されています。
  version: 1.0.0
  license:
    name: GNU General Public License v3.0
    url: https://github.com/Comfy-Org/ComfyUI/blob/master/LICENSE
servers:
  - url: https://cloud.comfy.org
    description: Comfy Cloud API
security:
  - ApiKeyAuth: []
tags:
  - name: workflow
    description: |
      ワークフローを実行のために送信し、実行キューを管理します。
      これはクラウド上でComfyUIワークフローを実行するための主要な方法です。
  - name: job
    description: |
      ジョブステータスを監視し、実行履歴を表示し、実行中のジョブを管理します。
      ジョブはPOST /api/promptを介してワークフローを送信するときに作成されます。
  - name: asset
    description: |
      永続的なアセット（画像、モデル、出力）をアップロード、ダウンロード、管理します。
      アセットはタグ付けとメタデータサポートを備えた耐久性のあるストレージを提供します。
  - name: file
    description: |
      ローカルのComfyUIと互換性のあるレガシーファイルのアップロードおよびダウンロードエンドポイント。
      新しい統合には、代わりにAssets APIの使用を検討してください。
  - name: model
    description: |
      利用可能なAIモデルをブラウズします。モデルはクラウドインフラストラクチャにプリロードされています。
  - name: node
    description: |
      利用可能なComfyUIノードとその入力/出力に関する情報を取得します。
      動的なワークフローインターフェースの構築に役立ちます。
  - name: user
    description: |
      ユーザーアカウント情報と個人データの保存。
  - name: system
    description: |
      サーバーステータス、ヘルスチェック、システム情報。
paths:
  /api/upload/mask:
    post:
      tags:
        - file
      summary: マスク画像をアップロード
      description: |
        既存の画像に適用するマスク画像をアップロードします。

        画像制限は、アップロードされたマスクと参照元のオリジナル画像の両方に適用されます：
          - 最大ファイルサイズ：50 MB
          - エッジごとの最大幅/高さ：16384 px
          - 最大総ピクセル数：64メガピクセル（67108864ピクセル）

        これらの制限を超えるアップロードはHTTP 400で拒否されます。
      operationId: uploadMask
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - image
                - original_ref
              properties:
                image:
                  type: string
                  format: binary
                  description: アップロードするマスク画像ファイル
                original_ref:
                  type: string
                  description: オリジナル画像への参照を含むJSON文字列
      responses:
        '200':
          description: マスクが正常にアップロードされました
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    description: アップロードされたマスクのファイル名
                  subfolder:
                    type: string
                    description: マスクが保存されたサブフォルダーパス
                  type:
                    type: string
                    description: アップロードの種類（例："output"）
                  metadata:
                    type: object
                    description: マスク検出と再編集のための追加メタデータ
                    properties:
                      is_mask:
                        type: boolean
                        description: このファイルがマスクであるかどうか
                      original_hash:
                        type: string
                        description: オリジナルのマスクされていない画像のハッシュ
                      mask_type:
                        type: string
                        description: マスクの種類（例："painted_masked"）
                      related_files:
                        type: object
                        description: 関連するマスクレイヤーファイル（利用可能な場合）
                        properties:
                          mask:
                            type: string
                            description: マスクレイヤーのハッシュ
                          paint:
                            type: string
                            description: ペイントレイヤーのハッシュ
                          painted:
                            type: string
                            description: ペイントされた画像のハッシュ
        '400':
          description: 不正なリクエスト
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 認証エラー
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 内部サーバーエラー
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        APIキー認証。アカウント設定からAPIキーを生成します
        （https://platform.comfy.org/profile/api-keys）。X-API-Keyヘッダーでキーを渡します。

````