comfydeploy 0.0.3

Python Client SDK Generated by Speakeasy

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

pip install comfydeploy

SDK Example Usage

Example

import comfydeploy

s = comfydeploy.ComfyDeploy(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


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

if res.object is not None:
    # handle response
    pass

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

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object	Status Code	Content Type
errors.GetRunResponseBody	400	application/json
errors.GetRunRunResponseBody	500	application/json
errors.SDKError	4xx-5xx	/

Example

import comfydeploy
from comfydeploy.models import errors

s = comfydeploy.ComfyDeploy(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

res = None
try:
    res = s.run.get(run_id='<value>')

except errors.GetRunResponseBody as e:
    # handle exception
    raise(e)
except errors.GetRunRunResponseBody as e:
    # handle exception
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

if res.object is not None:
    # handle response
    pass

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:///api	None

Example

import comfydeploy

s = comfydeploy.ComfyDeploy(
    server_idx=0,
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


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

if res.object is not None:
    # handle response
    pass

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:

import comfydeploy

s = comfydeploy.ComfyDeploy(
    server_url="https:///api",
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


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

if res.object is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import comfydeploy
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = comfydeploy.ComfyDeploy(client=http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
bearer_auth	http	HTTP Bearer

To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:

import comfydeploy

s = comfydeploy.ComfyDeploy(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


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

if res.object is not None:
    # handle response
    pass

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