Get job status

Returns the current status of a specific job by ID

GET /api/job/{job_id}/status

Get job status

cURL

curl --request GET \
  --url https://cloud.comfy.org/api/job/{job_id}/status \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://cloud.comfy.org/api/job/{job_id}/status"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://cloud.comfy.org/api/job/{job_id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.comfy.org/api/job/{job_id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.comfy.org/api/job/{job_id}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://cloud.comfy.org/api/job/{job_id}/status")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.comfy.org/api/job/{job_id}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_state_update": "2023-11-07T05:31:56Z",
  "assigned_inference": "<string>",
  "error_message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

承認

X-API-Key · string · header · 必須

API key authentication. Generate an API key from your account settings at https://platform.comfy.org/profile/api-keys. Pass the key in the X-API-Key header.

パスパラメータ

job_id · string<uuid> · 必須

The unique ID of the job

レスポンス

200

application/json

Success - Job status returned

Job status information

id · string<uuid> · 必須

The job ID

status · enum<string> · 必須

Current job status

利用可能なオプション: waiting_to_dispatch, pending, in_progress, completed, error, cancelled

created_at · string<date-time> · 必須

When the job was created

updated_at · string<date-time> · 必須

When the job was last updated

last_state_update · string<date-time>

When the job status was last changed

assigned_inference · string | null

The inference instance assigned to this job (if any)

error_message · string | null

Error message if the job failed