Comfy API Quickstart

Start with an agent (recommended)

Start your coding agent in the folder for the local ComfyUI install you want to deploy. Paste this prompt:

Install or update comfy-cli, then read its Build and Deploy skills:

pip install -U comfy-cli
comfy skills show comfy-build
comfy skills show comfy-deploy

Use comfy-build to inspect this local ComfyUI install and package its models, custom nodes, and pinned dependencies into a Comfy API Build. Show me what will be included and create a Linux/NVIDIA release. Then use comfy-deploy to show the available GPU and region options, worker bounds, and current rates. Wait for my approval before creating a deployment. After approval, deploy it and explain how to run a workflow.

Quick start

Use these commands when the local install and an API-format workflow saved as workflow_api.json are ready.

Initialize

comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes

Push and create a release

Push the Build and its assets, check the available targets, then wait for the Linux/NVIDIA release to finish:

comfy build push
comfy build refs build-targets
comfy build release create --target linux/nvidia --watch

Start a deployment

Check the catalog for available GPU and region pairs, then replace the GPU, region, and worker-bound placeholders with your settings:

comfy deploy refs compute
comfy deploy up --gpu <gpu> --region <region> --min <min-workers> --max <max-workers> --watch

Run the workflow

Use the deployment ID printed by comfy deploy up with --deployment:

comfy deploy run \
  --workflow workflow_api.json \
  --deployment <deployment-id> \
  --output-dir ./results

Other ways to start

Use these paths if your environment or workflow already exists in Comfy Desktop, ComfyUI, or a workflow file.

Comfy Desktop snapshot

Export a snapshot from Desktop, then import it into the Build Wizard.

From ComfyUI

Send the open workflow from ComfyUI to the Build Wizard or to your agent.

Import workflow JSON

Start a Build by importing a saved workflow into the Build Wizard.

The Deploy to Comfy API graph-menu action may not be available in every ComfyUI account yet. If you do not see it, open the Comfy API Build Wizard directly.

Develop with Comfy

Deploy ComfyUI

Comfy Router

Comfy CLI

Specifications

Comfy API Quickstart

Start with an agent (recommended)

Quick start

Other ways to start

Comfy Desktop snapshot

From ComfyUI

Import workflow JSON

Next steps

Browse models

Examples

​Start with an agent (recommended)

​Quick start

​Other ways to start

Comfy Desktop snapshot

From ComfyUI

Import workflow JSON

​Next steps

Browse models

Examples

Start with an agent (recommended)

Quick start

Other ways to start

Next steps