GET
/
deployments
import { ComfyDeploy } from "comfydeploy";

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

async function run() {
  const result = await comfyDeploy.deployments.list({});

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

run();
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "<string>",
    "org_id": "<string>",
    "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "share_slug": "<string>",
    "description": "<string>",
    "share_options": {},
    "showcase_media": {},
    "environment": "staging",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "workflow": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "input_types": [
      {
        "type": "<string>",
        "class_type": "<string>",
        "input_id": "<string>",
        "default_value": "<string>",
        "min_value": 123,
        "max_value": 123,
        "display_name": "",
        "description": "",
        "enum_options": [
          "<string>"
        ],
        "step": 123
      }
    ],
    "output_types": [
      {
        "class_type": "<string>",
        "output_id": "<string>"
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

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

Query Parameters

environment
enum<string> | null
Available options:
staging,
production,
public-share,
private-share

Response

200
application/json
Successful Response
id
string
required
user_id
string
required
org_id
string | null
required
workflow_version_id
string
required
workflow_id
string
required
machine_id
string
required
share_slug
string | null
required
description
string | null
required
share_options
object | null
required
showcase_media
object | null
required
environment
enum<string>
required
Available options:
staging,
production,
public-share,
private-share
created_at
string
required
updated_at
string
required
workflow
object
required
input_types
object[] | null
output_types
object[] | null