comfydeploy

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

SDK Installation

gem install comfydeploy

SDK Example Usage

Example

require 'comfydeploy'


s = ::OpenApiSDK::ComfyDeploy.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    bearer_auth: "<YOUR_BEARER_TOKEN_HERE>",
  )
)

    
res = s.run.get(run_id="<value>")

if ! res.two_hundred_application_json_object.nil?
  # handle response
end

Available Resources and Operations

Run

• get - Get workflow run output
• create - Run a workflow via deployment_id

Files

• get_upload_url - Upload any files to the storage

Workflows

• get_websocket_deployment_id_ - Get a websocket url for a specific deployment
• post_machine_endpoint - Create an endpoint for a machine
• get_v1_workflows - Retrieve workflows
• post_v1_workflows - Create a new workflow
• get_v1_workflows_workflow_id_ - Retrieve a specific workflow by ID
• get_v1_workflows_workflow_id_outputs - Retrieve the most recent outputs for a workflow

Comfyui

• get_auth_response_request_id_ - Get an API Key with code
• post_workflow - Upload workflow from ComfyUI
• get_workflow_version_version_id_ - Get comfyui workflow
• get_workflow_id_ - Get comfyui workflow
• get_deployment_id_inputs - Get comfyui workflow inputs definition
• get_deployment - Get all deployed workflows

Machines

• post_gpu_event - Register a machine event
• get_v1_machines - Retrieve all machines for a user
• post_v1_machines - Create a new machine
• get_v1_machines_machine_id_ - Retrieve a specific machine by ID

Server Selection

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://www.comfydeploy.com/api	None

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy