Skip to main content
GET
ページネーションとフィルタリングでジョブを一覧表示

承認

X-API-Key
string
header
必須

APIキー認証。アカウント設定からAPIキーを生成します (https://platform.comfy.org/profile/api-keys)。X-API-Keyヘッダーでキーを渡します。

クエリパラメータ

status
string

1つ以上のステータスでフィルタ(カンマ区切り)。指定しない場合はすべてのジョブが返されます。

workflow_id
string

ワークフローIDでフィルタ(完全一致)

output_type
enum<string>

出力メディアタイプでフィルタ(出力がある完了ジョブにのみ適用)

利用可能なオプション:
image,
video,
audio
sort_by
enum<string>
デフォルト:create_time

並べ替え条件フィールド(create_time = ジョブが送信された時間、execution_time = ワークフローの実行にかかった時間)

利用可能なオプション:
create_time,
execution_time
sort_order
enum<string>
デフォルト:desc

並び替え方向 (asc = 昇順, desc = 降順)

利用可能なオプション:
asc,
desc
offset
integer
デフォルト:0

ページネーションオフセット (0基準)

必須範囲: x >= 0
limit
integer
デフォルト:100

1ページあたりの最大アイテム数 (1-1000)

必須範囲: 1 <= x <= 1000

レスポンス

成功 - ジョブを取得しました

jobs
object[]
必須

指定された並び替えフィールドで並べられたジョブの配列

pagination
object
必須