This commit is contained in:
bennykok
2024-07-16 14:45:28 -07:00
commit 6ea0b09d80
207 changed files with 8190 additions and 0 deletions

30
.devcontainer/README.md Normal file
View File

@@ -0,0 +1,30 @@
> **Remember to shutdown a GitHub Codespace when it is not in use!**
# Dev Containers Quick Start
The default location for usage snippets is the `samples` directory.
## Running a Usage Sample
A sample usage example has been provided in a `root.py` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
```
python root.py
```
## Generating Additional Usage Samples
The speakeasy CLI allows you to generate more usage snippets. Here's how:
- To generate a sample for a specific operation by providing an operation ID, use:
```
speakeasy generate usage -s https://www.comfydeploy.com/api/openapi.json -l python -i {INPUT_OPERATION_ID} -o ./samples
```
- To generate samples for an entire namespace (like a tag or group name), use:
```
speakeasy generate usage -s https://www.comfydeploy.com/api/openapi.json -l python -n {INPUT_TAG_NAME} -o ./samples
```

View File

@@ -0,0 +1,38 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/images/tree/main/src/python
{
"name": "Python",
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"ms-python.vscode-pylance",
"github.vscode-pull-request-github"
],
"settings": {
"files.eol": "\n",
"editor.formatOnSave": true,
"python.formatting.provider": "black",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.linting.flake8Enabled": true,
"python.linting.banditEnabled": true,
"python.testing.pytestEnabled": true
}
},
"codespaces": {
"openFiles": [
".devcontainer/README.md"
]
}
}
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}

14
.devcontainer/setup.sh Normal file
View File

@@ -0,0 +1,14 @@
#!/bin/bash
# Install the speakeasy CLI
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh
# Setup samples directory
rmdir samples || true
mkdir samples
python -m pip install --upgrade pip
pip install -e .
# Generate starter usage sample with speakeasy
speakeasy generate usage -s https://www.comfydeploy.com/api/openapi.json -l python -o samples/root.py

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.py linguist-generated=false

29
.github/workflows/sdk_generation.yaml vendored Normal file
View File

@@ -0,0 +1,29 @@
name: Generate
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
"on":
workflow_dispatch:
inputs:
force:
description: Force generation of SDKs
type: boolean
default: false
set_version:
description: optionally set a specific SDK version
type: string
schedule:
- cron: 0 0 * * *
jobs:
generate:
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
with:
force: ${{ github.event.inputs.force }}
mode: pr
set_version: ${{ github.event.inputs.set_version }}
speakeasy_version: latest
secrets:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

6
.gitignore vendored Normal file
View File

@@ -0,0 +1,6 @@
venv/
src/*.egg-info/
__pycache__/
.pytest_cache/
.python-version
.DS_Store

226
.speakeasy/gen.lock Normal file
View File

@@ -0,0 +1,226 @@
lockVersion: 2.0.0
id: 2c1d440e-25e4-46e2-a435-ebd1f72a7373
management:
docChecksum: 751bbee351db5354325a9ef968014e0d
docVersion: 0.0.1
speakeasyVersion: 1.335.2
generationVersion: 2.372.3
releaseVersion: 0.0.1
configChecksum: 146d1ec1460e43d80975a87764babb15
features:
python:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.3
core: 4.8.1
devContainers: 2.86.0
flattening: 2.81.1
globalSecurity: 2.83.5
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.2
nameOverrides: 2.81.2
nullables: 0.1.0
responseFormat: 0.1.0
sdkHooks: 0.1.0
unions: 2.82.8
generatedFiles:
- src/comfydeploy/sdkconfiguration.py
- src/comfydeploy/run.py
- src/comfydeploy/files.py
- src/comfydeploy/workflows.py
- src/comfydeploy/comfyui.py
- src/comfydeploy/machines.py
- src/comfydeploy/sdk.py
- py.typed
- pylintrc
- scripts/publish.sh
- setup.py
- src/comfydeploy/__init__.py
- src/comfydeploy/utils/__init__.py
- src/comfydeploy/utils/retries.py
- src/comfydeploy/utils/utils.py
- src/comfydeploy/models/errors/sdkerror.py
- src/comfydeploy/models/operations/get_run.py
- src/comfydeploy/models/operations/post_run.py
- src/comfydeploy/models/operations/get_upload_url.py
- src/comfydeploy/models/operations/get_websocket_deployment_id_.py
- src/comfydeploy/models/operations/post_machine_endpoint.py
- src/comfydeploy/models/operations/get_v1_workflows.py
- src/comfydeploy/models/operations/post_v1_workflows.py
- src/comfydeploy/models/operations/get_v1_workflows_workflow_id_.py
- src/comfydeploy/models/operations/get_v1_workflows_workflow_id_outputs.py
- src/comfydeploy/models/operations/get_auth_response_request_id_.py
- src/comfydeploy/models/operations/post_workflow.py
- src/comfydeploy/models/operations/get_workflow_version_version_id_.py
- src/comfydeploy/models/operations/get_workflow_id_.py
- src/comfydeploy/models/operations/get_deployment_id_inputs.py
- src/comfydeploy/models/operations/get_deployment.py
- src/comfydeploy/models/operations/post_gpu_event.py
- src/comfydeploy/models/operations/get_v1_machines.py
- src/comfydeploy/models/operations/post_v1_machines.py
- src/comfydeploy/models/operations/get_v1_machines_machine_id_.py
- src/comfydeploy/models/components/httpmetadata.py
- src/comfydeploy/models/components/security.py
- src/comfydeploy/models/errors/get_run.py
- src/comfydeploy/models/errors/post_run.py
- src/comfydeploy/models/errors/get_upload_url.py
- src/comfydeploy/models/errors/get_websocket_deployment_id_.py
- src/comfydeploy/models/errors/post_machine_endpoint.py
- src/comfydeploy/models/errors/get_v1_workflows.py
- src/comfydeploy/models/errors/post_v1_workflows.py
- src/comfydeploy/models/errors/get_v1_workflows_workflow_id_.py
- src/comfydeploy/models/errors/get_v1_workflows_workflow_id_outputs.py
- src/comfydeploy/models/errors/get_auth_response_request_id_.py
- src/comfydeploy/models/errors/post_workflow.py
- src/comfydeploy/models/errors/get_workflow_version_version_id_.py
- src/comfydeploy/models/errors/get_workflow_id_.py
- src/comfydeploy/models/errors/get_deployment_id_inputs.py
- src/comfydeploy/models/errors/get_deployment.py
- src/comfydeploy/models/errors/post_gpu_event.py
- src/comfydeploy/models/errors/get_v1_machines.py
- src/comfydeploy/models/errors/post_v1_machines.py
- src/comfydeploy/models/errors/get_v1_machines_machine_id_.py
- src/comfydeploy/models/__init__.py
- src/comfydeploy/models/errors/__init__.py
- src/comfydeploy/models/operations/__init__.py
- src/comfydeploy/models/components/__init__.py
- docs/models/operations/getrunrequest.md
- docs/models/operations/workflowinputs.md
- docs/models/operations/getrunworkflowapi.md
- docs/models/operations/origin.md
- docs/models/operations/status.md
- docs/models/operations/getrungpu.md
- docs/models/operations/machinetype.md
- docs/models/operations/runlog.md
- docs/models/operations/webhookstatus.md
- docs/models/operations/getrunresponsebody.md
- docs/models/operations/getrunresponse.md
- docs/models/operations/gpu.md
- docs/models/operations/runorigin.md
- docs/models/operations/inputs.md
- docs/models/operations/postrunrequestbody.md
- docs/models/operations/postrunresponsebody.md
- docs/models/operations/postrunresponse.md
- docs/models/operations/type.md
- docs/models/operations/getuploadurlrequest.md
- docs/models/operations/getuploadurlresponsebody.md
- docs/models/operations/getuploadurlresponse.md
- docs/models/operations/getwebsocketdeploymentidrequest.md
- docs/models/operations/getwebsocketdeploymentidresponsebody.md
- docs/models/operations/getwebsocketdeploymentidresponse.md
- docs/models/operations/postmachineendpointrequestbody.md
- docs/models/operations/postmachineendpointresponsebody.md
- docs/models/operations/postmachineendpointresponse.md
- docs/models/operations/getv1workflowsrequest.md
- docs/models/operations/user.md
- docs/models/operations/versions.md
- docs/models/operations/getv1workflowsresponsebody.md
- docs/models/operations/getv1workflowsresponse.md
- docs/models/operations/workflowjson.md
- docs/models/operations/postv1workflowsrequestbody.md
- docs/models/operations/postv1workflowsresponsebody.md
- docs/models/operations/postv1workflowsresponse.md
- docs/models/operations/getv1workflowsworkflowidrequest.md
- docs/models/operations/getv1workflowsworkflowidversions.md
- docs/models/operations/getv1workflowsworkflowidresponsebody.md
- docs/models/operations/getv1workflowsworkflowidresponse.md
- docs/models/operations/queryparamrunorigin.md
- docs/models/operations/getv1workflowsworkflowidoutputsrequest.md
- docs/models/operations/outputs.md
- docs/models/operations/getv1workflowsworkflowidoutputsresponsebody.md
- docs/models/operations/getv1workflowsworkflowidoutputsresponse.md
- docs/models/operations/getauthresponserequestidrequest.md
- docs/models/operations/getauthresponserequestidcomfyuiresponsebody.md
- docs/models/operations/getauthresponserequestidresponsebody.md
- docs/models/operations/getauthresponserequestidresponse.md
- docs/models/operations/workflowapi.md
- docs/models/operations/gitcustomnodes.md
- docs/models/operations/snapshot.md
- docs/models/operations/node.md
- docs/models/operations/one.md
- docs/models/operations/installtype.md
- docs/models/operations/customnodes.md
- docs/models/operations/models.md
- docs/models/operations/files.md
- docs/models/operations/dependencies.md
- docs/models/operations/postworkflowrequestbody.md
- docs/models/operations/postworkflowresponsebody.md
- docs/models/operations/postworkflowresponse.md
- docs/models/operations/getworkflowversionversionidrequest.md
- docs/models/operations/workflow.md
- docs/models/operations/getworkflowversionversionidworkflowapi.md
- docs/models/operations/getworkflowversionversionidsnapshot.md
- docs/models/operations/getworkflowversionversioniddependencies.md
- docs/models/operations/getworkflowversionversionidresponsebody.md
- docs/models/operations/getworkflowversionversionidresponse.md
- docs/models/operations/getworkflowidrequest.md
- docs/models/operations/getworkflowidworkflow.md
- docs/models/operations/getworkflowidworkflowapi.md
- docs/models/operations/getworkflowidsnapshot.md
- docs/models/operations/getworkflowiddependencies.md
- docs/models/operations/getworkflowidresponsebody.md
- docs/models/operations/getworkflowidresponse.md
- docs/models/operations/getdeploymentidinputsrequest.md
- docs/models/operations/responsebody.md
- docs/models/operations/getdeploymentidinputsresponse.md
- docs/models/operations/environment.md
- docs/models/operations/getdeploymentrequest.md
- docs/models/operations/getdeploymentresponsebody.md
- docs/models/operations/getdeploymentresponse.md
- docs/models/operations/gputype.md
- docs/models/operations/wsgputype.md
- docs/models/operations/eventtype.md
- docs/models/operations/gpuprovider.md
- docs/models/operations/postgpueventrequestbody.md
- docs/models/operations/postgpueventresponsebody.md
- docs/models/operations/postgpueventresponse.md
- docs/models/operations/fields.md
- docs/models/operations/getv1machinesrequest.md
- docs/models/operations/machines.md
- docs/models/operations/getv1machinesresponsebody.md
- docs/models/operations/getv1machinesresponse.md
- docs/models/operations/postv1machinesrequestbody.md
- docs/models/operations/postv1machinestype.md
- docs/models/operations/postv1machinesstatus.md
- docs/models/operations/postv1machinesgpu.md
- docs/models/operations/postv1machinesresponsebody.md
- docs/models/operations/postv1machinesresponse.md
- docs/models/operations/getv1machinesmachineidrequest.md
- docs/models/operations/getv1machinesmachineidresponsebody.md
- docs/models/operations/getv1machinesmachineidresponse.md
- docs/models/components/httpmetadata.md
- docs/models/components/security.md
- docs/models/errors/getrunrunresponsebody.md
- docs/models/errors/getrunresponsebody.md
- docs/models/errors/postrunresponsebody.md
- docs/models/errors/getuploadurlresponsebody.md
- docs/models/errors/getwebsocketdeploymentidresponsebody.md
- docs/models/errors/postmachineendpointresponsebody.md
- docs/models/errors/getv1workflowsresponsebody.md
- docs/models/errors/postv1workflowsresponsebody.md
- docs/models/errors/getv1workflowsworkflowidresponsebody.md
- docs/models/errors/getv1workflowsworkflowidoutputsresponsebody.md
- docs/models/errors/getauthresponserequestidresponsebody.md
- docs/models/errors/postworkflowresponsebody.md
- docs/models/errors/getworkflowversionversionidresponsebody.md
- docs/models/errors/getworkflowidresponsebody.md
- docs/models/errors/getdeploymentidinputsresponsebody.md
- docs/models/errors/getdeploymentresponsebody.md
- docs/models/errors/postgpueventresponsebody.md
- docs/models/errors/getv1machinesresponsebody.md
- docs/models/errors/postv1machinesresponsebody.md
- docs/models/errors/getv1machinesmachineidresponsebody.md
- docs/sdks/comfydeploy/README.md
- docs/sdks/run/README.md
- docs/sdks/files/README.md
- docs/sdks/workflows/README.md
- docs/sdks/comfyui/README.md
- docs/sdks/machines/README.md
- USAGE.md
- .gitattributes
- .devcontainer/README.md
- .devcontainer/devcontainer.json
- .devcontainer/setup.sh
- src/comfydeploy/_hooks/sdkhooks.py
- src/comfydeploy/_hooks/types.py
- src/comfydeploy/_hooks/__init__.py

42
.speakeasy/gen.yaml Normal file
View File

@@ -0,0 +1,42 @@
configVersion: 2.0.0
generation:
devContainers:
enabled: true
schemaPath: https://www.comfydeploy.com/api/openapi.json
sdkClassName: ComfyDeploy
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: false
python:
version: 0.0.1
additionalDependencies:
dependencies: {}
extraDependencies:
dev: {}
author: Speakeasy
clientServerStatusCodesAsErrors: true
description: Python Client SDK Generated by Speakeasy
flattenGlobalSecurity: true
imports:
option: openapi
paths:
callbacks: models/callbacks
errors: models/errors
operations: models/operations
shared: models/components
webhooks: models/webhooks
inputModelSuffix: input
maxMethodParams: 4
methodArguments: require-security-and-request
outputModelSuffix: output
packageName: comfydeploy
projectUrls: {}
responseFormat: envelope-http
templateVersion: v1

27
.speakeasy/workflow.lock Normal file
View File

@@ -0,0 +1,27 @@
speakeasyVersion: 1.335.2
sources:
comfydeploy-api:
sourceNamespace: comfydeploy-api
sourceRevisionDigest: sha256:9de04a7a79c20e6734a6f6a554ad832ef07d8d0e10e0b0f4f2bd5d6a3c3a2440
sourceBlobDigest: sha256:16bb126ace5178a46f34a6530b3983db437d0652b4e44a0077d730f801d83884
tags:
- latest
targets:
comfy-deploy:
source: comfydeploy-api
sourceNamespace: comfydeploy-api
sourceRevisionDigest: sha256:9de04a7a79c20e6734a6f6a554ad832ef07d8d0e10e0b0f4f2bd5d6a3c3a2440
sourceBlobDigest: sha256:16bb126ace5178a46f34a6530b3983db437d0652b4e44a0077d730f801d83884
outLocation: /Users/bennykok/Documents/GitHub/comfy-deploy-python
workflow:
workflowVersion: 1.0.0
sources:
comfydeploy-api:
inputs:
- location: https://www.comfydeploy.com/api/openapi.json
registry:
location: registry.speakeasyapi.dev/comfydeploy/comfydeploy/comfydeploy-api
targets:
comfy-deploy:
target: python
source: comfydeploy-api

11
.speakeasy/workflow.yaml Normal file
View File

@@ -0,0 +1,11 @@
workflowVersion: 1.0.0
sources:
comfydeploy-api:
inputs:
- location: https://www.comfydeploy.com/api/openapi.json
registry:
location: registry.speakeasyapi.dev/comfydeploy/comfydeploy/comfydeploy-api
targets:
comfy-deploy:
target: python
source: comfydeploy-api

241
README.md Normal file
View File

@@ -0,0 +1,241 @@
# comfydeploy
<div align="left">
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
## 🏗 **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](https://www.speakeasyapi.dev/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/advanced-setup/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
<!-- Start SDK Installation [installation] -->
## SDK Installation
```bash
pip install git+<UNSET>.git
```
<!-- End SDK Installation [installation] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
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
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
### [run](docs/sdks/run/README.md)
* [get](docs/sdks/run/README.md#get) - Get workflow run output
* [create](docs/sdks/run/README.md#create) - Run a workflow via deployment_id
### [files](docs/sdks/files/README.md)
* [get_upload_url](docs/sdks/files/README.md#get_upload_url) - Upload any files to the storage
### [workflows](docs/sdks/workflows/README.md)
* [get_websocket_deployment_id_](docs/sdks/workflows/README.md#get_websocket_deployment_id_) - Get a websocket url for a specific deployment
* [post_machine_endpoint](docs/sdks/workflows/README.md#post_machine_endpoint) - Create an endpoint for a machine
* [get_v1_workflows](docs/sdks/workflows/README.md#get_v1_workflows) - Retrieve workflows
* [post_v1_workflows](docs/sdks/workflows/README.md#post_v1_workflows) - Create a new workflow
* [get_v1_workflows_workflow_id_](docs/sdks/workflows/README.md#get_v1_workflows_workflow_id_) - Retrieve a specific workflow by ID
* [get_v1_workflows_workflow_id_outputs](docs/sdks/workflows/README.md#get_v1_workflows_workflow_id_outputs) - Retrieve the most recent outputs for a workflow
### [comfyui](docs/sdks/comfyui/README.md)
* [get_auth_response_request_id_](docs/sdks/comfyui/README.md#get_auth_response_request_id_) - Get an API Key with code
* [post_workflow](docs/sdks/comfyui/README.md#post_workflow) - Upload workflow from ComfyUI
* [get_workflow_version_version_id_](docs/sdks/comfyui/README.md#get_workflow_version_version_id_) - Get comfyui workflow
* [get_workflow_id_](docs/sdks/comfyui/README.md#get_workflow_id_) - Get comfyui workflow
* [get_deployment_id_inputs](docs/sdks/comfyui/README.md#get_deployment_id_inputs) - Get comfyui workflow inputs definition
* [get_deployment](docs/sdks/comfyui/README.md#get_deployment) - Get all deployed workflows
### [machines](docs/sdks/machines/README.md)
* [post_gpu_event](docs/sdks/machines/README.md#post_gpu_event) - Register a machine event
* [get_v1_machines](docs/sdks/machines/README.md#get_v1_machines) - Retrieve all machines for a user
* [post_v1_machines](docs/sdks/machines/README.md#post_v1_machines) - Create a new machine
* [get_v1_machines_machine_id_](docs/sdks/machines/README.md#get_v1_machines_machine_id_) - Retrieve a specific machine by ID
<!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] -->
## 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
```python
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
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## 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
```python
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:
```python
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
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [requests](https://pypi.org/project/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:
```python
import comfydeploy
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = comfydeploy.ComfyDeploy(client=http_client)
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## 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:
```python
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
```
<!-- End Authentication [security] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

17
USAGE.md Normal file
View File

@@ -0,0 +1,17 @@
<!-- Start SDK Example Usage [usage] -->
```python
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
```
<!-- End SDK Example Usage [usage] -->

View File

@@ -0,0 +1,9 @@
# HTTPMetadata
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `request` | [requests.Request](https://requests.readthedocs.io/en/latest/api/#requests.Request) | :heavy_check_mark: | Raw HTTP request; suitable for debugging |

View File

@@ -0,0 +1,8 @@
# Security
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `bearer_auth` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetAuthResponseRequestIDResponseBody
Error when fetching the API Key with code
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetDeploymentIDInputsResponseBody
Error when uploading the workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetDeploymentResponseBody
error
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,12 @@
# GetRunResponseBody
Workflow not found
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `code` | *str* | :heavy_check_mark: | N/A | 400 |
| `message` | *str* | :heavy_check_mark: | N/A | Workflow not found |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A | |

View File

@@ -0,0 +1,11 @@
# GetRunRunResponseBody
Error getting output
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetUploadURLResponseBody
Error when generating upload url
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetV1MachinesMachineIDResponseBody
Error in retrieving the specific machine
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetV1MachinesResponseBody
Error in retrieving machines
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetV1WorkflowsResponseBody
Error in retrieving workflows
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetV1WorkflowsWorkflowIDOutputsResponseBody
Error in retrieving the specific workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetV1WorkflowsWorkflowIDResponseBody
Error in retrieving the specific workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetWebsocketDeploymentIDResponseBody
Error creating run
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetWorkflowIDResponseBody
Error when uploading the workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# GetWorkflowVersionVersionIDResponseBody
Error when uploading the workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# PostGpuEventResponseBody
Error creating run
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# PostMachineEndpointResponseBody
Error creating run
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# PostRunResponseBody
Error creating run
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# PostV1MachinesResponseBody
Error in creating machine
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# PostV1WorkflowsResponseBody
Error in creating workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,11 @@
# PostWorkflowResponseBody
Error when uploading the workflow
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `error` | *str* | :heavy_check_mark: | N/A |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,15 @@
# CustomNodes
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | N/A |
| `url` | *str* | :heavy_check_mark: | N/A |
| `node` | List[[operations.Node](../../models/operations/node.md)] | :heavy_minus_sign: | N/A |
| `hash` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `files` | List[*str*] | :heavy_minus_sign: | N/A |
| `install_type` | [Optional[operations.InstallType]](../../models/operations/installtype.md) | :heavy_minus_sign: | N/A |
| `warning` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `pip` | List[*str*] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,12 @@
# Dependencies
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `comfyui` | *str* | :heavy_check_mark: | N/A |
| `missing_nodes` | List[*str*] | :heavy_check_mark: | N/A |
| `custom_nodes` | Dict[str, [operations.CustomNodes](../../models/operations/customnodes.md)] | :heavy_check_mark: | N/A |
| `models` | Dict[str, List[[operations.Models](../../models/operations/models.md)]] | :heavy_check_mark: | N/A |
| `files` | Dict[str, List[[operations.Files](../../models/operations/files.md)]] | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# Environment
## Values
| Name | Value |
| ------------ | ------------ |
| `PRODUCTION` | production |
| `STAGING` | staging |

View File

@@ -0,0 +1,9 @@
# EventType
## Values
| Name | Value |
| ----------- | ----------- |
| `GPU_START` | gpu_start |
| `GPU_END` | gpu_end |

View File

@@ -0,0 +1,9 @@
# Fields
## Values
| Name | Value |
| --------- | --------- |
| `FULL` | full |
| `MINIMAL` | minimal |

View File

@@ -0,0 +1,10 @@
# Files
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *str* | :heavy_check_mark: | N/A |
| `hash` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `url` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# GetAuthResponseRequestIDComfyuiResponseBody
The API key is not yet ready
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `message` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,8 @@
# GetAuthResponseRequestIDRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `request_id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# GetAuthResponseRequestIDResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `two_hundred_application_json_object` | [Optional[operations.GetAuthResponseRequestIDResponseBody]](../../models/operations/getauthresponserequestidresponsebody.md) | :heavy_minus_sign: | The returned API Key |
| `two_hundred_and_one_application_json_object` | [Optional[operations.GetAuthResponseRequestIDComfyuiResponseBody]](../../models/operations/getauthresponserequestidcomfyuiresponsebody.md) | :heavy_minus_sign: | The API key is not yet ready |

View File

@@ -0,0 +1,11 @@
# GetAuthResponseRequestIDResponseBody
The returned API Key
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `api_key` | *str* | :heavy_check_mark: | N/A |
| `name` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,8 @@
# GetDeploymentIDInputsRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetDeploymentIDInputsResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `response_bodies` | List[[operations.ResponseBody](../../models/operations/responsebody.md)] | :heavy_minus_sign: | Retrieve the output |

View File

@@ -0,0 +1,8 @@
# GetDeploymentRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `environment` | [Optional[operations.Environment]](../../models/operations/environment.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,9 @@
# GetDeploymentResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `response_bodies` | List[[operations.GetDeploymentResponseBody](../../models/operations/getdeploymentresponsebody.md)] | :heavy_minus_sign: | Display all production workflows |

View File

@@ -0,0 +1,7 @@
# GetDeploymentResponseBody
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,12 @@
# GetRunGpu
## Values
| Name | Value |
| ------- | ------- |
| `T4` | T4 |
| `L4` | L4 |
| `A10_G` | A10G |
| `A100` | A100 |
| `H100` | H100 |

View File

@@ -0,0 +1,8 @@
# GetRunRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `run_id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetRunResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetRunResponseBody]](../../models/operations/getrunresponsebody.md) | :heavy_minus_sign: | Retrieve the output |

View File

@@ -0,0 +1,33 @@
# GetRunResponseBody
Retrieve the output
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | N/A | |
| `workflow_version_id` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `workflow_inputs` | [operations.WorkflowInputs](../../models/operations/workflowinputs.md) | :heavy_check_mark: | N/A | {<br/>"input_text": "some external text input",<br/>"input_image": "https://somestatic.png"<br/>} |
| `workflow_id` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `workflow_api` | [operations.GetRunWorkflowAPI](../../models/operations/getrunworkflowapi.md) | :heavy_check_mark: | N/A | {} |
| `machine_id` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `origin` | [operations.Origin](../../models/operations/origin.md) | :heavy_check_mark: | N/A | |
| `status` | [operations.Status](../../models/operations/status.md) | :heavy_check_mark: | N/A | |
| `ended_at` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `created_at` | *str* | :heavy_check_mark: | N/A | |
| `queued_at` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `started_at` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `gpu` | [Optional[operations.GetRunGpu]](../../models/operations/getrungpu.md) | :heavy_check_mark: | N/A | |
| `machine_version` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `machine_type` | [Optional[operations.MachineType]](../../models/operations/machinetype.md) | :heavy_check_mark: | N/A | |
| `modal_function_call_id` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `user_id` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `org_id` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `run_log` | [operations.RunLog](../../models/operations/runlog.md) | :heavy_check_mark: | N/A | [<br/>{<br/>"logs": "some logs",<br/>"timestamp": 1706631877.3831277<br/>}<br/>] |
| `live_status` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `progress` | *float* | :heavy_check_mark: | N/A | |
| `is_realtime` | *bool* | :heavy_check_mark: | N/A | |
| `webhook` | *Optional[str]* | :heavy_check_mark: | N/A | |
| `webhook_status` | [Optional[operations.WebhookStatus]](../../models/operations/webhookstatus.md) | :heavy_check_mark: | N/A | |

View File

@@ -0,0 +1,7 @@
# GetRunWorkflowAPI
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,9 @@
# GetUploadURLRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | N/A |
| `file_size` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetUploadURLResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetUploadURLResponseBody]](../../models/operations/getuploadurlresponsebody.md) | :heavy_minus_sign: | Retrieve the output |

View File

@@ -0,0 +1,12 @@
# GetUploadURLResponseBody
Retrieve the output
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `upload_url` | *str* | :heavy_check_mark: | N/A |
| `file_id` | *str* | :heavy_check_mark: | N/A |
| `download_url` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetV1MachinesMachineIDRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `machine_id` | *str* | :heavy_check_mark: | N/A |
| `ext_urls` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,9 @@
# GetV1MachinesMachineIDResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetV1MachinesMachineIDResponseBody]](../../models/operations/getv1machinesmachineidresponsebody.md) | :heavy_minus_sign: | Specific machine retrieved successfully |

View File

@@ -0,0 +1,16 @@
# GetV1MachinesMachineIDResponseBody
Specific machine retrieved successfully
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `status` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# GetV1MachinesRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `page` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `page_size` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `fields` | [Optional[operations.Fields]](../../models/operations/fields.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,9 @@
# GetV1MachinesResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetV1MachinesResponseBody]](../../models/operations/getv1machinesresponsebody.md) | :heavy_minus_sign: | Machines retrieved successfully |

View File

@@ -0,0 +1,11 @@
# GetV1MachinesResponseBody
Machines retrieved successfully
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `machines` | List[[operations.Machines](../../models/operations/machines.md)] | :heavy_check_mark: | N/A |
| `total` | *float* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# GetV1WorkflowsRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `page` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `page_size` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `search` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,9 @@
# GetV1WorkflowsResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `response_bodies` | List[[operations.GetV1WorkflowsResponseBody](../../models/operations/getv1workflowsresponsebody.md)] | :heavy_minus_sign: | Workflows retrieved successfully |

View File

@@ -0,0 +1,16 @@
# GetV1WorkflowsResponseBody
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | N/A |
| `updated_at` | *str* | :heavy_check_mark: | N/A |
| `name` | *str* | :heavy_check_mark: | N/A |
| `selected_machine_id` | *Optional[str]* | :heavy_check_mark: | N/A |
| `count` | *str* | :heavy_check_mark: | N/A |
| `user` | [operations.User](../../models/operations/user.md) | :heavy_check_mark: | N/A |
| `versions` | List[[operations.Versions](../../models/operations/versions.md)] | :heavy_check_mark: | N/A |
| `deployments` | List[*Any*] | :heavy_check_mark: | N/A |
| `runs` | List[*Any*] | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,12 @@
# GetV1WorkflowsWorkflowIDOutputsRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `workflow_id` | *str* | :heavy_check_mark: | N/A |
| `page` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `page_size` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `search` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `run_origin` | [Optional[operations.QueryParamRunOrigin]](../../models/operations/queryparamrunorigin.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,9 @@
# GetV1WorkflowsWorkflowIDOutputsResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetV1WorkflowsWorkflowIDOutputsResponseBody]](../../models/operations/getv1workflowsworkflowidoutputsresponsebody.md) | :heavy_minus_sign: | Specific workflow retrieved successfully |

View File

@@ -0,0 +1,11 @@
# GetV1WorkflowsWorkflowIDOutputsResponseBody
Specific workflow retrieved successfully
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `outputs` | List[[operations.Outputs](../../models/operations/outputs.md)] | :heavy_check_mark: | N/A |
| `total` | *float* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,8 @@
# GetV1WorkflowsWorkflowIDRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `workflow_id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetV1WorkflowsWorkflowIDResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetV1WorkflowsWorkflowIDResponseBody]](../../models/operations/getv1workflowsworkflowidresponsebody.md) | :heavy_minus_sign: | Specific workflow retrieved successfully |

View File

@@ -0,0 +1,17 @@
# GetV1WorkflowsWorkflowIDResponseBody
Specific workflow retrieved successfully
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | N/A |
| `user_id` | *str* | :heavy_check_mark: | N/A |
| `id` | *str* | :heavy_check_mark: | N/A |
| `selected_machine_id` | *Optional[str]* | :heavy_check_mark: | N/A |
| `created_at` | *str* | :heavy_check_mark: | N/A |
| `updated_at` | *str* | :heavy_check_mark: | N/A |
| `versions` | List[[operations.GetV1WorkflowsWorkflowIDVersions](../../models/operations/getv1workflowsworkflowidversions.md)] | :heavy_check_mark: | N/A |
| `org_id` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# GetV1WorkflowsWorkflowIDVersions
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `workflow_id` | *str* | :heavy_check_mark: | N/A |
| `id` | *str* | :heavy_check_mark: | N/A |
| `comment` | *Optional[str]* | :heavy_check_mark: | N/A |
| `version` | *float* | :heavy_check_mark: | N/A |
| `snapshot` | *Optional[str]* | :heavy_check_mark: | N/A |
| `dependencies` | *Optional[str]* | :heavy_check_mark: | N/A |
| `created_at` | *str* | :heavy_check_mark: | N/A |
| `updated_at` | *str* | :heavy_check_mark: | N/A |
| `workflow` | *Optional[Any]* | :heavy_minus_sign: | N/A |
| `workflow_api` | *Optional[Any]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,8 @@
# GetWebsocketDeploymentIDRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `deployment_id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetWebsocketDeploymentIDResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetWebsocketDeploymentIDResponseBody]](../../models/operations/getwebsocketdeploymentidresponsebody.md) | :heavy_minus_sign: | Workflow queued |

View File

@@ -0,0 +1,10 @@
# GetWebsocketDeploymentIDResponseBody
Workflow queued
## Fields
| Field | Type | Required | Description |
| ------------------- | ------------------- | ------------------- | ------------------- |
| `ws_connection_url` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,7 @@
# GetWorkflowIDDependencies
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,8 @@
# GetWorkflowIDRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetWorkflowIDResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetWorkflowIDResponseBody]](../../models/operations/getworkflowidresponsebody.md) | :heavy_minus_sign: | Retrieve the output |

View File

@@ -0,0 +1,20 @@
# GetWorkflowIDResponseBody
Retrieve the output
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `workflow_id` | *str* | :heavy_check_mark: | N/A |
| `id` | *str* | :heavy_check_mark: | N/A |
| `workflow` | [operations.GetWorkflowIDWorkflow](../../models/operations/getworkflowidworkflow.md) | :heavy_check_mark: | N/A |
| `workflow_api` | [operations.GetWorkflowIDWorkflowAPI](../../models/operations/getworkflowidworkflowapi.md) | :heavy_check_mark: | N/A |
| `user_id` | *Optional[str]* | :heavy_check_mark: | N/A |
| `comment` | *Optional[str]* | :heavy_check_mark: | N/A |
| `version` | *float* | :heavy_check_mark: | N/A |
| `snapshot` | [operations.GetWorkflowIDSnapshot](../../models/operations/getworkflowidsnapshot.md) | :heavy_check_mark: | N/A |
| `dependencies` | [operations.GetWorkflowIDDependencies](../../models/operations/getworkflowiddependencies.md) | :heavy_check_mark: | N/A |
| `created_at` | *str* | :heavy_check_mark: | N/A |
| `updated_at` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,7 @@
# GetWorkflowIDSnapshot
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,7 @@
# GetWorkflowIDWorkflow
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,7 @@
# GetWorkflowIDWorkflowAPI
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,7 @@
# GetWorkflowVersionVersionIDDependencies
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,8 @@
# GetWorkflowVersionVersionIDRequest
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `version_id` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,9 @@
# GetWorkflowVersionVersionIDResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [Optional[operations.GetWorkflowVersionVersionIDResponseBody]](../../models/operations/getworkflowversionversionidresponsebody.md) | :heavy_minus_sign: | Retrieve the output |

View File

@@ -0,0 +1,20 @@
# GetWorkflowVersionVersionIDResponseBody
Retrieve the output
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `workflow_id` | *str* | :heavy_check_mark: | N/A |
| `id` | *str* | :heavy_check_mark: | N/A |
| `workflow` | [operations.Workflow](../../models/operations/workflow.md) | :heavy_check_mark: | N/A |
| `workflow_api` | [operations.GetWorkflowVersionVersionIDWorkflowAPI](../../models/operations/getworkflowversionversionidworkflowapi.md) | :heavy_check_mark: | N/A |
| `user_id` | *Optional[str]* | :heavy_check_mark: | N/A |
| `comment` | *Optional[str]* | :heavy_check_mark: | N/A |
| `version` | *float* | :heavy_check_mark: | N/A |
| `snapshot` | [operations.GetWorkflowVersionVersionIDSnapshot](../../models/operations/getworkflowversionversionidsnapshot.md) | :heavy_check_mark: | N/A |
| `dependencies` | [operations.GetWorkflowVersionVersionIDDependencies](../../models/operations/getworkflowversionversioniddependencies.md) | :heavy_check_mark: | N/A |
| `created_at` | *str* | :heavy_check_mark: | N/A |
| `updated_at` | *str* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,7 @@
# GetWorkflowVersionVersionIDSnapshot
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,7 @@
# GetWorkflowVersionVersionIDWorkflowAPI
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,9 @@
# GitCustomNodes
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `hash` | *str* | :heavy_check_mark: | N/A |
| `disabled` | *bool* | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,12 @@
# Gpu
## Values
| Name | Value |
| ------- | ------- |
| `T4` | T4 |
| `L4` | L4 |
| `A10_G` | A10G |
| `A100` | A100 |
| `H100` | H100 |

View File

@@ -0,0 +1,9 @@
# GpuProvider
## Values
| Name | Value |
| -------- | -------- |
| `MODAL` | modal |
| `RUNPOD` | runpod |

View File

@@ -0,0 +1,12 @@
# GpuType
## Values
| Name | Value |
| ------- | ------- |
| `T4` | T4 |
| `L4` | L4 |
| `A10_G` | A10G |
| `A100` | A100 |
| `H100` | H100 |

View File

@@ -0,0 +1,17 @@
# Inputs
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `float`
```python
value: float = /* values here */
```

View File

@@ -0,0 +1,17 @@
# InstallType
## Supported Types
### `operations.One`
```python
value: operations.One = /* values here */
```
### `str`
```python
value: str = /* values here */
```

View File

@@ -0,0 +1,15 @@
# Machines
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *str* | :heavy_check_mark: | N/A |
| `endpoints` | List[*str*] | :heavy_check_mark: | N/A |
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `status` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `object_info` | *Optional[Any]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,13 @@
# MachineType
## Values
| Name | Value |
| ------------------------- | ------------------------- |
| `CLASSIC` | classic |
| `RUNPOD_SERVERLESS` | runpod-serverless |
| `MODAL_SERVERLESS` | modal-serverless |
| `COMFY_DEPLOY_SERVERLESS` | comfy-deploy-serverless |
| `WORKSPACE` | workspace |
| `WORKSPACE_V2` | workspace-v2 |

View File

@@ -0,0 +1,10 @@
# Models
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *str* | :heavy_check_mark: | N/A |
| `hash` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `url` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,9 @@
# Node
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `inputs` | Dict[str, *Any*] | :heavy_check_mark: | N/A |
| `class_type` | *Optional[str]* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# One
## Values
| Name | Value |
| ----------- | ----------- |
| `COPY` | copy |
| `UNZIP` | unzip |
| `GIT_CLONE` | git-clone |

Some files were not shown because too many files have changed in this diff Show More