Skip to content

Jobs

GET
/api/jobs
curl --request GET \
--url 'https://example.com/api/jobs?include_completed=true' \
--header 'Authorization: Bearer <token>'

Return jobs from durable Postgres state — a pure DB read, no live ComfyUI calls.

_reconcile_loop keeps these rows current in the background. This endpoint is polled every few seconds by the gallery to render the “generating” lane, so it must never call into a ComfyUI node itself: a saturated node (mid model-load) stops answering HTTP, and per-job round-trips would then hang the whole endpoint until it times out — blanking the lane even though jobs are actively running.

include_completed
Include Completed
boolean
default: true

Successful Response

Media typeapplication/json
Response Jobs Api Jobs Get
object
key
additional properties
any
Examplegenerated
{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}