Skip to content

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.

chore(openapi): sync shared API contract from cloud@bcb8f5f (#14815)

Comfy Org PR Bot5658a68a875e
diff --git a/openapi.yaml b/openapi.yaml
index c09b1eeac..e00643bad 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -7,18 +7,18 @@ components:
description: Timestamp when the asset was created
format: date-time
type: string
- hash:
- description: Blake3 hash of the asset content.
- pattern: ^blake3:[a-f0-9]{64}$
- type: string
- loader_path:
- description: The value a loader consumes to load this asset. Null when no loader can resolve the file.
+ display_name:
+ description: Display name of the asset. Mirrors name for backwards compatibility.
nullable: true
type: string
- display_name:
- description: Human-facing label for the asset. Not unique.
+ file_path:
+ description: Relative path in global-namespace-root form (e.g. "models/checkpoints/flux.safetensors")
nullable: true
type: string
+ hash:
+ description: Blake3 hash of the asset content.
+ pattern: ^blake3:[a-f0-9]{64}$
+ type: string
id:
description: Unique identifier for the asset
format: uuid
@@ -144,6 +144,14 @@ components:
AssetUpdated:
description: Response returned when an existing asset is successfully updated.
properties:
+ display_name:
+ description: Display name of the asset. Mirrors name for backwards compatibility.
+ nullable: true
+ type: string
+ file_path:
+ description: Relative path in global-namespace-root form (e.g. "models/checkpoints/flux.safetensors")
+ nullable: true
+ type: string
hash:
description: Blake3 hash of the asset content.
pattern: ^blake3:[a-f0-9]{64}$
@@ -775,14 +783,6 @@ components:
ModelFolder:
description: Represents a folder containing models
properties:
- extensions:
- description: The folder's registered file-extension allowlist. An empty array means the folder accepts any extension (match-all).
- example:
- - .ckpt
- - .safetensors
- items:
- type: string
- type: array
folders:
description: List of paths where models of this type are stored
example:
@@ -1644,7 +1644,7 @@ paths:
format: uuid
type: string
tags:
- description: JSON-encoded array of tag strings. For new byte uploads, include exactly one destination role (`input`, `output`, or `models`); `models` uploads also require exactly one `model_type:<folder_name>` tag. Extra tags are stored as labels and do not create path components.
+ description: JSON-encoded array of freeform tag strings, e.g. '["models","checkpoint"]'. Common types include "models", "input", "output", and "temp", but any tag can be used in any order.
type: string
user_metadata:
description: Custom JSON metadata as a string
@@ -1829,7 +1829,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Asset'
+ $ref: '#/components/schemas/AssetUpdated'
description: Asset updated successfully
"400":
content:
@@ -2470,9 +2470,6 @@ paths:
supports_preview_metadata:
description: Whether the server supports preview metadata
type: boolean
- supports_model_type_tags:
- description: Whether the server supports namespaced model type asset tags
- type: boolean
type: object
description: Success
headers:
@@ -3300,6 +3297,12 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Invalid request parameters
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized - Authentication required
"500":
content:
application/json: