fofr/comfyui-prototype – API reference

fofr / comfyui-prototype

Experimental. Not ready for use.

Public
143 runs

Run fofr/comfyui-prototype with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
workflow_json	string		Your ComfyUI workflow as JSON. You must use the API version of your workflow. Get it from ComfyUI using ‘Save (API format)’. Instructions here: https://github.com/fofr/cog-comfyui
input_file	string		Input image, tar or zip file. Read guidance on workflows and input files here: https://github.com/fofr/cog-comfyui. Alternatively, you can replace inputs with URLs in your JSON workflow and the model will download them.
return_temp_files	boolean	False	Return any temporary files, such as preprocessed controlnet images. Useful for debugging.
output_format	string (enum)	webp Options: webp, jpg, png	Format of the output images
output_quality	integer	80 Max: 100	Quality of the output images, from 0 to 100. 100 is best quality, 0 is lowest quality.
randomise_seeds	boolean	True	Automatically randomise seeds (seed, noise_seed, rand_seed)
force_reset_cache	boolean	False	Force reset the ComfyUI cache before running the workflow. Useful for debugging.

{
  "type": "object",
  "title": "Input",
  "properties": {
    "input_file": {
      "type": "string",
      "title": "Input File",
      "format": "uri",
      "x-order": 1,
      "description": "Input image, tar or zip file. Read guidance on workflows and input files here: https://github.com/fofr/cog-comfyui. Alternatively, you can replace inputs with URLs in your JSON workflow and the model will download them."
    },
    "output_format": {
      "enum": [
        "webp",
        "jpg",
        "png"
      ],
      "type": "string",
      "title": "output_format",
      "description": "Format of the output images",
      "default": "webp",
      "x-order": 3
    },
    "workflow_json": {
      "type": "string",
      "title": "Workflow Json",
      "default": "",
      "x-order": 0,
      "description": "Your ComfyUI workflow as JSON. You must use the API version of your workflow. Get it from ComfyUI using \u2018Save (API format)\u2019. Instructions here: https://github.com/fofr/cog-comfyui"
    },
    "output_quality": {
      "type": "integer",
      "title": "Output Quality",
      "default": 80,
      "maximum": 100,
      "minimum": 0,
      "x-order": 4,
      "description": "Quality of the output images, from 0 to 100. 100 is best quality, 0 is lowest quality."
    },
    "randomise_seeds": {
      "type": "boolean",
      "title": "Randomise Seeds",
      "default": true,
      "x-order": 5,
      "description": "Automatically randomise seeds (seed, noise_seed, rand_seed)"
    },
    "force_reset_cache": {
      "type": "boolean",
      "title": "Force Reset Cache",
      "default": false,
      "x-order": 6,
      "description": "Force reset the ComfyUI cache before running the workflow. Useful for debugging."
    },
    "return_temp_files": {
      "type": "boolean",
      "title": "Return Temp Files",
      "default": false,
      "x-order": 2,
      "description": "Return any temporary files, such as preprocessed controlnet images. Useful for debugging."
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "format": "uri"
  },
  "title": "Output"
}