Skip to content

README.md

Latest commit

 

History

History
91 lines (56 loc) · 3.93 KB

README.md

File metadata and controls

91 lines (56 loc) · 3.93 KB

Run

(run)

Overview

Available Operations

get

Get Run

Example Usage

from comfydeploy import ComfyDeploy


with ComfyDeploy(
    bearer="<YOUR_BEARER_TOKEN_HERE>",
) as comfy_deploy:

    res = comfy_deploy.run.get(run_id="b888f774-3e7c-4135-a18c-6b985523c4bc")

    assert res.workflow_run_model is not None

    # Handle response
    print(res.workflow_run_model)

Parameters

Parameter Type Required Description
run_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetRunRunRunIDGetResponse

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*

cancel

Cancel Run

Example Usage

from comfydeploy import ComfyDeploy


with ComfyDeploy(
    bearer="<YOUR_BEARER_TOKEN_HERE>",
) as comfy_deploy:

    res = comfy_deploy.run.cancel(run_id="<id>")

    assert res.any is not None

    # Handle response
    print(res.any)

Parameters

Parameter Type Required Description
run_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CancelRunRunRunIDCancelPostResponse

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*