Sign in

Nodes Browser

ComfyDeploy: How comfyui_extra_api works in ComfyUI?

What is comfyui_extra_api?

Add more endpoints to make easy for utilizing ComfyUI API.

How to install it in ComfyDeploy?

Head over to the machine page

  1. Click on the "Create a new machine" button
  2. Select the Edit build steps
  3. Add a new step -> Custom Node
  4. Search for comfyui_extra_api and select it
  5. Close the build step dialig and then click on the "Save" button to rebuild the machine

ComfyUI Extra API

This is a collection of extra API functions that are not included in the default ComfyUI API.

Get started

  1. go to custom_nodes

     cd custom_nodes

  2. clone the repository

     git clone https://github.com/injet-zhou/comfyui_extra_api.git
 cd comfyui_extra_api

  3. install the dependencies

    use poetry(Recommended)

     poetry install

    or use pip

     pip install -r requirements.txt

    start using the extra API functions in your ComfyUI project.

Endpoints

  1. /comfyapi/v1/checkpoints

    Method: Get

    Description: Get all the checkpoints.

  2. /comfyapi/v1/refresh-checkpoints

    Method: Post

    Description: Refresh the list of checkpoints and return the updated list.

  3. /comfyapi/v1/loras

    Method: Get

    Description: Get all the LoRa.

  4. /comfyapi/v1/refresh-loras

    Method: Post

    Description: Refresh the list of LoRa and return the updated list.

  5. /comfyapi/v1/output-images

    Method: Get

    Query: temp true or false

    Description: List all the output images, if temp is true, only list the temporary output images which are generated in PreviewImage node.

  6. comfyapi/v1/output-images/{filename}

    Method: Delete

    Query: temp true or false

    Description: Delete the output image with the given filename, if temp is true, only delete the temporary output image which is generated in PreviewImage node.

  7. /comfyapi/v1/pnginfo

    Method: Post

    Body: {"img_base64": "base64 string of the image"}

    Description: Get the metadata of the PNG image. If the image is generated by ComfyUI, it's a workflow json.