Queue Run

Create a new deployment run with the given parameters.

POST /run/deployment/queue

SDK (TypeScript)

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: {
      "num_inference_steps": 30,
      "prompt": "A beautiful landscape",
      "seed": 42,
    },
    webhook: "https://myapp.com/webhook",
    deploymentId: "15e79589-12c9-453c-a41a-348fdd7de957",
  });

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

run();

200

{
  "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

Example:

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

inputs · Inputs · object

The inputs to the workflow

Show child attributes

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

200

application/json

Successful Response

run_id · string<uuid> · required

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