Skip to content

chore: sync vendored Comfy API v2 spec (cloud@585fbea) #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wei-hai merged 1 commit into from
Jul 23, 2026
Merged

chore: sync vendored Comfy API v2 spec (cloud@585fbea) #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions spec/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,11 +364,7 @@ paths:
additionalProperties: true
extra_data:
type: object
description: >-
Optional, sibling of `workflow` (never nested inside it).
Omit entirely when there is no key to send — an empty
`extra_data` object is not sent by the SDK and should not
be sent by other clients either.
description: 'Per-prompt ComfyUI `extra_data`, same shape as Comfy Cloud and local ComfyUI. Closed object: only the enumerated keys are accepted, keeping the contract fully typed. Forwarded to the worker per-prompt, never persisted, and excluded from idempotency comparison.'
additionalProperties: false
properties:
api_key_comfy_org:
Expand Down Expand Up @@ -440,6 +436,8 @@ paths:
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/UpstreamError'
/api/v2/jobs/{id}/events:
Expand Down Expand Up @@ -551,6 +549,8 @@ paths:
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/UpstreamError'
components:
Expand Down Expand Up @@ -619,6 +619,15 @@ components:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
RateLimited:
description: '`rate_limited` — the caller has exceeded the request rate limit for this account. Account/rate-scoped, not job-specific — this can be returned even for a job id the caller doesn''t own or that doesn''t exist, without revealing which.'
headers:
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
schemas:
Asset:
type: object
Expand Down
Loading