Dashboard

Discord

Blog

Comfy Deploy

API Reference

v2 API Reference (Beta)

Get a websocket url for a specific deployment

bearerAuth

Introduction

Creating ComfyUI workflows right in the browser

Create

Import

Install Models

Workflow Examples

Upgrade to V2

Callbacks are how you can get notified when a workflow is done

Callbacks

Installation

Overview

Workflows

Machines

Storage

Edit your workflow right in the workspace

Setup

Workflow Json (Beta)

I got some error saying I'm missing a model

Missing model

Env variables

Create a new workflow run with the given parameters. This function sets up the run and initiates the execution process. For callback information, see [Callbacks](#tag/callbacks/POST/\{callback_url\}).

Create a new workflow run

Usually when you run something, you want to upload a file, image etc.

Upload any files to the storage

This endpoints is specifically built for ComfyUI workflow upload.

Get an API Key with code

Upload workflow from ComfyUI

Use this to retrieve comfyui workflow by id

Get comfyui workflow

Create an endpoint for a machine

Retrieve workflows based on optional query parameters

Retrieve workflows

Create a new workflow by analyzing the provided workflow JSON

Create a new workflow

Retrieve the latest version of a specific workflow by its ID

Retrieve a specific workflow by ID

Retrieve the most recent outputs for a workflow

Use this to retrieve comfyui workflow inputs definition by id

Get comfyui workflow inputs definition

Get all deployed workflows

Register a machine event

Get recent gpu events

Retrieve details of all machines for the authenticated user, with pagination and optional field selection

Retrieve all machines for a user

Create a new machine with optional default setting

Create a new machine

Retrieve details of a specific machine by its ID, with optional workspace details

run

files

websocket

comfyui

workflows

deployment

machine

Get a websocket url for a specific deployment

Authorizations

Path Parameters

Response