Job
GET
/api/jobs/{prompt_id}
const url = 'https://example.com/api/jobs/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/jobs/example \ --header 'Authorization: Bearer <token>'Get status, outputs and provenance for a single job, reconciled live against its node.
While its node doesn’t answer, a job keeps its last status with node_unreachable
true. When the node answers again and has no record of the job (a restarted ComfyUI
loses its queue), the job is marked failed.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”prompt_id
required
Prompt Id
string
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
JobStatusResponse
Status, outputs, and what made them.
The provenance fields let an agent answer “do that again but …” from a bare prompt_id, without asking its human for the workflow, model, seed or params. They are null while a job is still queued on a node that never accepted it.
object
ok
required
Ok
boolean
prompt_id
required
Prompt Id
string
status
required
Status
string
outputs
Outputs
Array<object>
JobOutputobject
type
required
Type
string
filename
required
Filename
string
subfolder
Subfolder
string
folder_type
Folder Type
string
url
required
Url
string
node_unreachable
Node Unreachable
The job’s node didn’t answer; status is the last one known
boolean
models
Models
Array<string>
loras
Loras
Array<string>
settings
Settings
object
key
additional properties
any
Example
{ "outputs": [], "node_unreachable": false, "models": [], "loras": [], "settings": {}}Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}