GET
/
run
/
{run_id}
import { ComfyDeploy } from "comfydeploy";

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

async function run() {
  const result = await comfyDeploy.run.get({
    runId: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  });

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

run();
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_inputs": "<any>",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_api": "<any>",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "origin": "<string>",
  "status": "<string>",
  "ended_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "queued_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "gpu_event_id": "<string>",
  "gpu": "<string>",
  "machine_version": "<string>",
  "machine_type": "<string>",
  "modal_function_call_id": "<string>",
  "user_id": "<string>",
  "org_id": "<string>",
  "live_status": "<string>",
  "progress": 0,
  "is_realtime": false,
  "webhook": "<string>",
  "webhook_status": "<string>",
  "webhook_intermediate_status": false,
  "outputs": [],
  "number": 123,
  "duration": 123,
  "cold_start_duration": 123,
  "cold_start_duration_total": 123,
  "run_duration": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
run_id
string
required

Response

200
application/json
Successful Response
​
id
string
required
​
workflow_version_id
string | null
required
​
workflow_inputs
any | null
required
​
workflow_id
string
required
​
workflow_api
any | null
required
​
machine_id
string | null
required
​
origin
string
required
​
status
string
required
​
created_at
string
required
​
updated_at
string
required
​
gpu_event_id
string | null
required
​
gpu
string | null
required
​
machine_version
string | null
required
​
machine_type
string | null
required
​
modal_function_call_id
string | null
required
​
user_id
string | null
required
​
org_id
string | null
required
​
live_status
string | null
required
​
webhook
string | null
required
​
webhook_status
string | null
required
​
number
integer
required
​
duration
number | null
required
​
cold_start_duration
number | null
required
​
cold_start_duration_total
number | null
required
​
run_duration
number | null
required
​
ended_at
string | null
​
queued_at
string | null
​
started_at
string | null
​
progress
number
default:0
​
is_realtime
boolean
default:false
​
webhook_intermediate_status
boolean
default:false
​
outputs
object[]

Was this page helpful?

Suggest editsRaise issue