wangbo/ComfyUI
1
0
Fork 0
mirror of https://github.com/comfyanonymous/ComfyUI.git synced 2026-01-27 14:50:20 +08:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity

Update OpenAPI spec

Browse Source
This commit is contained in:
doctorpangloss 2024-03-21 15:16:52 -07:00
parent 005e370254
commit d73b116446
1 changed files with 22 additions and 210 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

230
comfy/api/openapi.yaml
View File

@ -84,6 +84,8 @@ paths:
get: get:
summary: (UI) View image summary: (UI) View image
operationId: view_image operationId: view_image
description: |
Reads the image with the specified file name and located in the specified subfolder.
parameters: parameters:
- in: query - in: query
name: filename name: filename
@ -110,6 +112,11 @@ paths:
- 'rgba' - 'rgba'
- 'rgb' - 'rgb'
- 'a' - 'a'
- in: query
name: preview
schema:
type: string
pattern: '^(?<format>webp|jpeg);(?<quality>\d{1,2})$'
responses: responses:
'200': '200':
description: Successful retrieval of file description: Successful retrieval of file
@ -322,29 +329,6 @@ paths:
description: >- description: >-
A POST request to /free with: {"unload_models":true} will unload models from vram. A POST request to /free with: {"unload_models":true} will unload models from vram.
A POST request to /free with: {"free_memory":true} will unload models and free all cached data from the last run workflow. A POST request to /free with: {"free_memory":true} will unload models and free all cached data from the last run workflow.
/api/v1/images/{digest}:
get:
summary: (API) Get image
description: |
Returns an image given a content hash.
parameters:
- name: digest
in: path
required: true
description: A digest of the request used to generate the image
schema:
type: string
example: e5187160a7b2c496773c1c5a45bfd3ffbf25eaa5969328e6469d36f31cf240a3
responses:
404:
description: No image was found.
200:
description: An image.
content:
image/png:
schema:
type: string
format: binary
/api/v1/prompts: /api/v1/prompts:
get: get:
summary: (API) Get prompt summary: (API) Get prompt
@ -380,11 +364,6 @@ paths:
responses: responses:
200: 200:
headers: headers:
Location:
description: The URL to the file based on a hash of the request body when exactly one SaveImage node is specified.
example: /api/v1/images/e5187160a7b2c496773c1c5a45bfd3ffbf25eaa5969328e6469d36f31cf240a3
schema:
type: string
Digest: Digest:
description: The digest of the request body description: The digest of the request body
example: SHA256=e5187160a7b2c496773c1c5a45bfd3ffbf25eaa5969328e6469d36f31cf240a3 example: SHA256=e5187160a7b2c496773c1c5a45bfd3ffbf25eaa5969328e6469d36f31cf240a3
@ -402,18 +381,17 @@ paths:
image/png: image/png:
schema: schema:
description: | description: |
Binary image data. This will be the first SaveImage node in the workflow. Binary image data. This will be the contents of the last node that returns image outputs in the workflow.
type: string type: string
format: binary format: binary
application/json: application/json:
schema: schema:
description: | description: |
A list of URLs to retrieve the binary content of the image. The complete outputs dictionary from the workflow.
The first URL is named by the digest of the prompt and references the image returned by the first Additionally, a list of URLs to binary outputs, whenever save nodes are used.
SaveImage URL, allowing you to exactly retrieve the image without re-running the prompt.
Then, for each SaveImage node, there will be two URLs: the internal URL returned by the worker, and For each SaveImage node, there will be two URLs: the internal URL returned by the worker, and
the URL for the image based on the `--external-address` / `COMFYUI_EXTERNAL_ADDRESS` configuration. the URL for the image based on the `--external-address` / `COMFYUI_EXTERNAL_ADDRESS` configuration.
Hashing function for web browsers: Hashing function for web browsers:
@ -468,13 +446,17 @@ paths:
type: object type: object
required: required:
- urls - urls
- outputs
properties: properties:
urls: urls:
type: array type: array
items: items:
type: string type: string
outputs:
$ref: "#/components/schemas/Outputs"
example: example:
urls: [ "/api/v1/images/e5187160a7b2c496773c1c5a45bfd3ffbf25eaa5969328e6469d36f31cf240a3", "http://127.0.0.1:8188/view?filename=ComfyUI_00001_.png&type=output", "https://comfyui.example.com/view?filename=ComfyUI_00001_.png&type=output" ] outputs: {}
urls: [ "http://127.0.0.1:8188/view?filename=ComfyUI_00001_.png&type=output", "https://comfyui.example.com/view?filename=ComfyUI_00001_.png&type=output" ]
204: 204:
description: | description: |
The prompt was run but did not contain any SaveImage outputs, so nothing will be returned. The prompt was run but did not contain any SaveImage outputs, so nothing will be returned.
@ -602,181 +584,6 @@ components:
$ref: "#/components/schemas/Workflow" $ref: "#/components/schemas/Workflow"
Prompt: Prompt:
type: object type: object
example: {
"3": {
"inputs": {
"seed": 732984013877771,
"steps": 25,
"cfg": 100,
"sampler_name": "euler_ancestral",
"scheduler": "normal",
"denoise": 1,
"model": [
"10",
0
],
"positive": [
"6",
0
],
"negative": [
"7",
0
],
"latent_image": [
"5",
0
]
},
"class_type": "KSampler"
},
"4": {
"inputs": {
"ckpt_name": "sd_xl_base_1.0.safetensors"
},
"class_type": "CheckpointLoaderSimple"
},
"5": {
"inputs": {
"width": 512,
"height": 512,
"batch_size": 1
},
"class_type": "EmptyLatentImage"
},
"6": {
"inputs": {
"text": "$POSITIVE_TEXT",
"clip": [
"10",
1
]
},
"class_type": "CLIPTextEncode"
},
"7": {
"inputs": {
"text": "$NEGATIVE_TEXT",
"clip": [
"10",
1
]
},
"class_type": "CLIPTextEncode"
},
"8": {
"inputs": {
"samples": [
"3",
0
],
"vae": [
"4",
2
]
},
"class_type": "VAEDecode"
},
"10": {
"inputs": {
"lora_name": "pixel-art-xl-v1.1.safetensors",
"strength_model": 1,
"strength_clip": 1,
"model": [
"4",
0
],
"clip": [
"4",
1
]
},
"class_type": "LoraLoader"
},
"15": {
"inputs": {
"images": [
"26",
0
]
},
"class_type": "PreviewImage"
},
"16": {
"inputs": {
"images": [
"8",
0
]
},
"class_type": "PreviewImage"
},
"18": {
"inputs": {
"upscale_method": "nearest-exact",
"scale_by": 0.125,
"image": [
"8",
0
]
},
"class_type": "ImageScaleBy"
},
"19": {
"inputs": {
"threshold": 250,
"mask": [
"21",
0
]
},
"class_type": "BinarizeMask"
},
"21": {
"inputs": {
"model": "u2net",
"image": [
"18",
0
]
},
"class_type": "ImageEstimateForegroundMask"
},
"25": {
"inputs": {
"upscale_method": "nearest-exact",
"scale_by": 8,
"image": [
"26",
0
]
},
"class_type": "ImageScaleBy"
},
"26": {
"inputs": {
"image": [
"18",
0
],
"mask": [
"19",
0
]
},
"class_type": "ImageCutout"
},
"27": {
"inputs": {
"filename_prefix": "Downscale",
"images": [
"25",
0
]
},
"class_type": "SaveImage"
}
}
description: | description: |
The keys are stringified integers corresponding to nodes. The keys are stringified integers corresponding to nodes.
@ -958,12 +765,15 @@ components:
type: array type: array
items: items:
$ref: "#/components/schemas/FileOutput" $ref: "#/components/schemas/FileOutput"
additionalProperties:
$ref: "#/components/schemas/FileOutput"
FileOutput: FileOutput:
type: object type: object
required: required:
- filename - filename
- subfolder - subfolder
- type - type
- abs_path
properties: properties:
filename: filename:
type: string type: string
@ -971,3 +781,5 @@ components:
type: string type: string
type: type:
type: string type: string
abs_path:
type: string