Add unified jobs API with /api/jobs endpoints #11054
Open
+915
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ric-yu
force-pushed
the
feature/unified-jobs-api
branch
2 times, most recently
from
ae57e94 to
c4b7a84
Compare
There was a problem hiding this comment.
similar comment to before -- likely out of scope for this, but can we start introducing some structure to this repo and start breaking up this superclass to separate files for maintainability and extensibility
execution.py
Outdated
| jobs = [] | ||
|
|
||
| if status_filter is None: | ||
| status_filter = ['pending', 'in_progress', 'completed', 'error'] |
There was a problem hiding this comment.
Are these statuses defined elsewhere in this file? Worth breaking out to an enum to ensure consistency within this file?
ric-yu
force-pushed
the
feature/unified-jobs-api
branch
from
57fd19f to
c860cc6
Compare
Contributor
Author
|
Rebasing |
bigcat88
reviewed
Dec 5, 2025
Owner
|
Can you test this properly? The endpoint doesn't work after I run a regular workflow. |
Contributor
Author
Fixed an issue with preview as text. This endpoint has been working for me otherwise, but I'm stuck with testing light workflows since I'm on a Mac |
ric-yu
force-pushed
the
feature/unified-jobs-api
branch
from
c5c3db7 to
1f7c1a9
Compare
ric-yu
force-pushed
the
feature/unified-jobs-api
branch
from
1371f61 to
ed61899
Compare
Contributor
Author
|
rebasing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
GET /api/jobsendpoint with filtering, sorting, and paginationpending,in_progress,completed,errorcreate_timeorexecution_timelimit/offsetGET /api/jobs/{job_id}for single job details with full outputsexecution_timein history for completed jobsoutputs_countandpreview_outputin job responsestype=output, supports images/video/audio/3D)Motivation
Currently
/queueand/historyare separate endpoints with different response shapes. This unified API provides:outputs_count,preview_output) for list views without fetching full outputsTest plan
pytest tests/execution/test_execution.py -v/api/jobsreturns jobs from queue and history on https://www.github.com/Comfy-Org/ComfyUI_frontend/commit/a57ea57a09a274efdc8444b949452509d7cf49de/api/jobs/{id}returns full job with outputsexecution_timeis tracked for completed jobs