Skip to main content
POST
/
run
/
deployment
/
queue
SDK (TypeScript)
import { ComfyDeploy } from "comfydeploy";

const comfyDeploy = new ComfyDeploy({
  bearer: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await comfyDeploy.run.deployment.queue({
    inputs: {
      "prompt": "A beautiful landscape",
      "seed": 42,
    },
    webhook: "https://myapp.com/webhook",
    deploymentId: "15e79589-12c9-453c-a41a-348fdd7de957",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
deployment_id
string<uuid>
required
Examples:

"15e79589-12c9-453c-a41a-348fdd7de957"

​
inputs
object

The inputs to the workflow

Example:
{
  "prompt": "A beautiful landscape",
  "seed": 42
}
​
webhook
string
​
webhook_intermediate_status
boolean
default:false
Example:

true

​
gpu
enum<string>

The GPU to override the machine's default GPU

Available options:
T4,
L4,
A10G,
L40S,
A100,
A100-80GB,
H100

Response

Successful Response

​
run_id
string<uuid>
required

The ID of the run, use this to get the run status and outputs