> ## 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.

# ページネーションとフィルタリングでジョブを一覧表示

> 認証されたユーザーのジョブのページネーション付きリストを取得します。
リストビューに最適化された軽量なジョブデータを返します。
ペイロードサイズを削減するため、ワークフローと完全な出力は除外されています。




## OpenAPI

````yaml /openapi/cloud.ja.yaml get /api/jobs
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/jobs:
    get:
      tags:
        - job
      summary: ページネーションとフィルタリングでジョブを一覧表示
      description: |
        認証されたユーザーのジョブのページネーション付きリストを取得します。
        リストビューに最適化された軽量なジョブデータを返します。
        ペイロードサイズを削減するため、ワークフローと完全な出力は除外されています。
      operationId: listJobs
      parameters:
        - name: status
          in: query
          required: false
          description: 1つ以上のステータスでフィルタ（カンマ区切り）。指定しない場合はすべてのジョブが返されます。
          schema:
            type: string
          example: pending,in_progress
        - name: workflow_id
          in: query
          required: false
          description: ワークフローIDでフィルタ（完全一致）
          schema:
            type: string
          example: 550e8400-e29b-41d4-a716-446655440000
        - name: output_type
          in: query
          required: false
          description: 出力メディアタイプでフィルタ（出力がある完了ジョブにのみ適用）
          schema:
            type: string
            enum:
              - image
              - video
              - audio
          example: image
        - name: sort_by
          in: query
          required: false
          description: >-
            並べ替え条件フィールド（create_time = ジョブが送信された時間、execution_time =
            ワークフローの実行にかかった時間）
          schema:
            type: string
            enum:
              - create_time
              - execution_time
            default: create_time
          example: execution_time
        - name: sort_order
          in: query
          required: false
          description: 並び替え方向 (asc = 昇順, desc = 降順)
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: offset
          in: query
          required: false
          description: ページネーションオフセット (0基準)
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: limit
          in: query
          required: false
          description: 1ページあたりの最大アイテム数 (1-1000)
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
      responses:
        '200':
          description: 成功 - ジョブを取得しました
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobsListResponse'
        '401':
          description: 認証エラー - 認証が必要です
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 内部サーバーエラー
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    JobsListResponse:
      type: object
      required:
        - jobs
        - pagination
      properties:
        jobs:
          type: array
          description: 指定された並び替えフィールドで並べられたジョブの配列
          items:
            $ref: '#/components/schemas/JobEntry'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
    JobEntry:
      type: object
      description: リスト表示用の軽量ジョブデータ（ワークフローと完全な出力は除外）
      required:
        - id
        - status
        - create_time
      properties:
        id:
          type: string
          format: uuid
          description: 一意のジョブ識別子
        status:
          type: string
          enum:
            - pending
            - in_progress
            - completed
            - failed
            - cancelled
          description: ユーザーフレンドリーなジョブステータス
        execution_error:
          $ref: '#/components/schemas/ExecutionError'
          description: ComfyUIからの詳細な実行エラー（構造化エラーデータがある失敗ジョブのみ）
        create_time:
          type: integer
          format: int64
          description: ジョブ作成タイムスタンプ（秒単位のUnixタイムスタンプ）
        preview_output:
          type: object
          description: プライマリ出力のプレビュー（ターミナル状態のみ存在）
          additionalProperties: true
        outputs_count:
          type: integer
          description: 出力ファイルの総数（非ターミナル状態では省略）
        workflow_id:
          type: string
          description: ワークフローグラフ定義を識別するUUID
        execution_start_time:
          type: integer
          format: int64
          description: ワークフロー実行開始タイムスタンプ（ミリ秒単位のUnixタイムスタンプ、ターミナル状態のみ存在）
        execution_end_time:
          type: integer
          format: int64
          description: ワークフロー実行完了タイムスタンプ（ミリ秒単位のUnixタイムスタンプ、ターミナル状態のみ存在）
    PaginationInfo:
      type: object
      required:
        - offset
        - limit
        - total
        - has_more
      properties:
        offset:
          type: integer
          minimum: 0
          description: 現在のオフセット（0ベース）
        limit:
          type: integer
          minimum: 1
          description: 1ページあたりのアイテム数
        total:
          type: integer
          minimum: 0
          description: フィルターに一致するアイテムの総数
        has_more:
          type: boolean
          description: このページ以降にさらにアイテムがあるかどうか
    ExecutionError:
      type: object
      description: ComfyUIからの詳細な実行エラー情報
      required:
        - node_id
        - node_type
        - exception_message
        - exception_type
        - traceback
        - current_inputs
        - current_outputs
      properties:
        node_id:
          type: string
          description: 失敗したノードのID
        node_type:
          type: string
          description: 'ノードのタイプ名（例: "KSampler"）'
        exception_message:
          type: string
          description: 人間が読めるエラーメッセージ
        exception_type:
          type: string
          description: 'Pythonの例外タイプ（例: "RuntimeError"）'
        traceback:
          type: array
          items:
            type: string
          description: トレースバック行の配列（利用不可の場合は空の配列）
        current_inputs:
          type: object
          additionalProperties: true
          description: 障害発生時の入力値（利用不可の場合は空のオブジェクト）
        current_outputs:
          type: object
          additionalProperties: true
          description: 失敗時の出力値（利用不可の場合は空オブジェクト）
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        APIキー認証。アカウント設定からAPIキーを生成します
        （https://platform.comfy.org/profile/api-keys）。X-API-Keyヘッダーでキーを渡します。

````