Getting Started
Introduction
What is Comfy Deploy?
Overview
Comfy Deploy makes it easy for teams to build, manage, and deploy ComfyUI AI workflows.
For example setting up the ts client
client.ts
import { ComfyDeploy } from "comfydeploy";
const cd = new ComfyDeploy({
bearer: "<api-key>",
});
Running any workflow as API
When using queue run, an run id is returned immediately, which you can later use to check the status of the run or get the output. Webhook callback is suggested making sure you have a way to receive the response.
const run = await cd.run.queue({
deploymentId: "<deployment-id>",
inputs: {
prompt: "A beautiful landscape",
},
webhook: "<your domain>/webhook"
})
// run.runId
Install
If you have ComfyUI installed locally, deploy your workflows now
Conceptual overview
Learn the basics of Comfy Deploy and get setup
Explore
Some example workflows to spark your imagination
Was this page helpful?