mirror of
https://git.datalinker.icu/comfyanonymous/ComfyUI
synced 2026-09-08 16:57:05 +08:00
1206 lines
39 KiB
Python
1206 lines
39 KiB
Python
# generated by datamodel-codegen:
|
|
# filename: https://api.comfy.org/openapi
|
|
# timestamp: 2025-04-23T15:56:33+00:00
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime
|
|
from enum import Enum
|
|
from typing import Any, Dict, List, Optional, Union
|
|
from uuid import UUID
|
|
|
|
from pydantic import AnyUrl, BaseModel, Field, confloat, conint
|
|
|
|
class ComfyNode(BaseModel):
|
|
category: Optional[str] = Field(
|
|
None,
|
|
description='UI category where the node is listed, used for grouping nodes.',
|
|
)
|
|
comfy_node_name: Optional[str] = Field(
|
|
None, description='Unique identifier for the node'
|
|
)
|
|
deprecated: Optional[bool] = Field(
|
|
None,
|
|
description='Indicates if the node is deprecated. Deprecated nodes are hidden in the UI.',
|
|
)
|
|
description: Optional[str] = Field(
|
|
None, description="Brief description of the node's functionality or purpose."
|
|
)
|
|
experimental: Optional[bool] = Field(
|
|
None,
|
|
description='Indicates if the node is experimental, subject to changes or removal.',
|
|
)
|
|
function: Optional[str] = Field(
|
|
None, description='Name of the entry-point function to execute the node.'
|
|
)
|
|
input_types: Optional[str] = Field(None, description='Defines input parameters')
|
|
output_is_list: Optional[List[bool]] = Field(
|
|
None, description='Boolean values indicating if each output is a list.'
|
|
)
|
|
return_names: Optional[str] = Field(
|
|
None, description='Names of the outputs for clarity in workflows.'
|
|
)
|
|
return_types: Optional[str] = Field(
|
|
None, description='Specifies the types of outputs produced by the node.'
|
|
)
|
|
|
|
|
|
class ComfyNodeCloudBuildInfo(BaseModel):
|
|
build_id: Optional[str] = None
|
|
location: Optional[str] = None
|
|
project_id: Optional[str] = None
|
|
project_number: Optional[str] = None
|
|
|
|
|
|
class Customer(BaseModel):
|
|
createdAt: Optional[datetime] = Field(
|
|
None, description='The date and time the user was created'
|
|
)
|
|
email: Optional[str] = Field(None, description='The email address for this user')
|
|
id: str = Field(..., description='The firebase UID of the user')
|
|
name: Optional[str] = Field(None, description='The name for this user')
|
|
updatedAt: Optional[datetime] = Field(
|
|
None, description='The date and time the user was last updated'
|
|
)
|
|
|
|
|
|
class Error(BaseModel):
|
|
details: Optional[List[str]] = Field(
|
|
None,
|
|
description='Optional detailed information about the error or hints for resolving it.',
|
|
)
|
|
message: Optional[str] = Field(
|
|
None, description='A clear and concise description of the error.'
|
|
)
|
|
|
|
|
|
class ErrorResponse(BaseModel):
|
|
error: str
|
|
message: str
|
|
|
|
|
|
class GitCommitSummary(BaseModel):
|
|
author: Optional[str] = Field(None, description='The author of the commit')
|
|
branch_name: Optional[str] = Field(
|
|
None, description='The branch where the commit was made'
|
|
)
|
|
commit_hash: Optional[str] = Field(None, description='The hash of the commit')
|
|
commit_name: Optional[str] = Field(None, description='The name of the commit')
|
|
status_summary: Optional[Dict[str, str]] = Field(
|
|
None, description='A map of operating system to status pairs'
|
|
)
|
|
timestamp: Optional[datetime] = Field(
|
|
None, description='The timestamp when the commit was made'
|
|
)
|
|
|
|
|
|
class ImageRequest(BaseModel):
|
|
aspect_ratio: Optional[str] = Field(
|
|
None,
|
|
description="Optional. The aspect ratio (e.g., 'ASPECT_16_9', 'ASPECT_1_1'). Cannot be used with resolution. Defaults to 'ASPECT_1_1' if unspecified.",
|
|
)
|
|
color_palette: Optional[Dict[str, Any]] = Field(
|
|
None, description='Optional. Color palette object. Only for V_2, V_2_TURBO.'
|
|
)
|
|
magic_prompt_option: Optional[str] = Field(
|
|
None, description="Optional. MagicPrompt usage ('AUTO', 'ON', 'OFF')."
|
|
)
|
|
model: str = Field(..., description="The model used (e.g., 'V_2', 'V_2A_TURBO')")
|
|
negative_prompt: Optional[str] = Field(
|
|
None,
|
|
description='Optional. Description of what to exclude. Only for V_1, V_1_TURBO, V_2, V_2_TURBO.',
|
|
)
|
|
num_images: Optional[conint(ge=1, le=8)] = Field(
|
|
1, description='Optional. Number of images to generate (1-8). Defaults to 1.'
|
|
)
|
|
prompt: str = Field(
|
|
..., description='Required. The prompt to use to generate the image.'
|
|
)
|
|
resolution: Optional[str] = Field(
|
|
None,
|
|
description="Optional. Resolution (e.g., 'RESOLUTION_1024_1024'). Only for model V_2. Cannot be used with aspect_ratio.",
|
|
)
|
|
seed: Optional[conint(ge=0, le=2147483647)] = Field(
|
|
None, description='Optional. A number between 0 and 2147483647.'
|
|
)
|
|
style_type: Optional[str] = Field(
|
|
None,
|
|
description="Optional. Style type ('AUTO', 'GENERAL', 'REALISTIC', 'DESIGN', 'RENDER_3D', 'ANIME'). Only for models V_2 and above.",
|
|
)
|
|
|
|
|
|
class Datum(BaseModel):
|
|
is_image_safe: Optional[bool] = Field(
|
|
None, description='Indicates whether the image is considered safe.'
|
|
)
|
|
prompt: Optional[str] = Field(
|
|
None, description='The prompt used to generate this image.'
|
|
)
|
|
resolution: Optional[str] = Field(
|
|
None, description="The resolution of the generated image (e.g., '1024x1024')."
|
|
)
|
|
seed: Optional[int] = Field(
|
|
None, description='The seed value used for this generation.'
|
|
)
|
|
style_type: Optional[str] = Field(
|
|
None,
|
|
description="The style type used for generation (e.g., 'REALISTIC', 'ANIME').",
|
|
)
|
|
url: Optional[str] = Field(None, description='URL to the generated image.')
|
|
|
|
|
|
class Code(Enum):
|
|
int_1100 = 1100
|
|
int_1101 = 1101
|
|
int_1102 = 1102
|
|
int_1103 = 1103
|
|
|
|
|
|
class Code1(Enum):
|
|
int_1000 = 1000
|
|
int_1001 = 1001
|
|
int_1002 = 1002
|
|
int_1003 = 1003
|
|
int_1004 = 1004
|
|
|
|
|
|
class KlingErrorResponse(BaseModel):
|
|
code: int = Field(
|
|
..., description='Error code value as defined in the API documentation'
|
|
)
|
|
message: str = Field(..., description='Human-readable error message')
|
|
request_id: str = Field(
|
|
..., description='Request ID for tracking and troubleshooting'
|
|
)
|
|
|
|
|
|
class AspectRatio(str, Enum):
|
|
field_16_9 = '16:9'
|
|
field_9_16 = '9:16'
|
|
field_1_1 = '1:1'
|
|
|
|
|
|
class Config(BaseModel):
|
|
horizontal: Optional[confloat(ge=-10.0, le=10.0)] = None
|
|
pan: Optional[confloat(ge=-10.0, le=10.0)] = None
|
|
roll: Optional[confloat(ge=-10.0, le=10.0)] = None
|
|
tilt: Optional[confloat(ge=-10.0, le=10.0)] = None
|
|
vertical: Optional[confloat(ge=-10.0, le=10.0)] = None
|
|
zoom: Optional[confloat(ge=-10.0, le=10.0)] = None
|
|
|
|
|
|
class Type(str, Enum):
|
|
simple = 'simple'
|
|
down_back = 'down_back'
|
|
forward_up = 'forward_up'
|
|
right_turn_forward = 'right_turn_forward'
|
|
left_turn_forward = 'left_turn_forward'
|
|
|
|
|
|
class CameraControl(BaseModel):
|
|
config: Optional[Config] = None
|
|
type: Optional[Type] = Field(None, description='Predefined camera movements type')
|
|
|
|
|
|
class Duration(str, Enum):
|
|
field_5 = 5
|
|
field_10 = 10
|
|
|
|
|
|
class Mode(str, Enum):
|
|
std = 'std'
|
|
pro = 'pro'
|
|
|
|
|
|
class TaskInfo(BaseModel):
|
|
external_task_id: Optional[str] = None
|
|
|
|
|
|
class Video(BaseModel):
|
|
duration: Optional[str] = Field(None, description='Total video duration')
|
|
id: Optional[str] = Field(None, description='Generated video ID')
|
|
url: Optional[AnyUrl] = Field(None, description='URL for generated video')
|
|
|
|
|
|
class TaskResult(BaseModel):
|
|
videos: Optional[List[Video]] = None
|
|
|
|
|
|
class TaskStatus(str, Enum):
|
|
submitted = 'submitted'
|
|
processing = 'processing'
|
|
succeed = 'succeed'
|
|
failed = 'failed'
|
|
|
|
|
|
class Data(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_info: Optional[TaskInfo] = None
|
|
task_result: Optional[TaskResult] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class AspectRatio1(str, Enum):
|
|
field_16_9 = '16:9'
|
|
field_9_16 = '9:16'
|
|
field_1_1 = '1:1'
|
|
field_4_3 = '4:3'
|
|
field_3_4 = '3:4'
|
|
field_3_2 = '3:2'
|
|
field_2_3 = '2:3'
|
|
field_21_9 = '21:9'
|
|
|
|
|
|
class ImageReference(str, Enum):
|
|
subject = 'subject'
|
|
face = 'face'
|
|
|
|
|
|
class Image(BaseModel):
|
|
index: Optional[int] = Field(None, description='Image Number (0-9)')
|
|
url: Optional[AnyUrl] = Field(None, description='URL for generated image')
|
|
|
|
|
|
class TaskResult1(BaseModel):
|
|
images: Optional[List[Image]] = None
|
|
|
|
|
|
class Data1(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_result: Optional[TaskResult1] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
task_status_msg: Optional[str] = Field(None, description='Task status information')
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class AspectRatio2(str, Enum):
|
|
field_16_9 = '16:9'
|
|
field_9_16 = '9:16'
|
|
field_1_1 = '1:1'
|
|
|
|
|
|
class CameraControl1(BaseModel):
|
|
config: Optional[Config] = None
|
|
type: Optional[Type] = Field(None, description='Predefined camera movements type')
|
|
|
|
|
|
class ModelName2(str, Enum):
|
|
kling_v1 = 'kling-v1'
|
|
kling_v1_6 = 'kling-v1-6'
|
|
|
|
|
|
class TaskResult2(BaseModel):
|
|
videos: Optional[List[Video]] = None
|
|
|
|
|
|
class Data2(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_info: Optional[TaskInfo] = None
|
|
task_result: Optional[TaskResult2] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class Code2(Enum):
|
|
int_1200 = 1200
|
|
int_1201 = 1201
|
|
int_1202 = 1202
|
|
int_1203 = 1203
|
|
|
|
|
|
class ResourcePackType(str, Enum):
|
|
decreasing_total = 'decreasing_total'
|
|
constant_period = 'constant_period'
|
|
|
|
|
|
class Status(str, Enum):
|
|
toBeOnline = 'toBeOnline'
|
|
online = 'online'
|
|
expired = 'expired'
|
|
runOut = 'runOut'
|
|
|
|
|
|
class ResourcePackSubscribeInfo(BaseModel):
|
|
effective_time: Optional[int] = Field(
|
|
None, description='Effective time, Unix timestamp in ms'
|
|
)
|
|
invalid_time: Optional[int] = Field(
|
|
None, description='Expiration time, Unix timestamp in ms'
|
|
)
|
|
purchase_time: Optional[int] = Field(
|
|
None, description='Purchase time, Unix timestamp in ms'
|
|
)
|
|
remaining_quantity: Optional[float] = Field(
|
|
None, description='Remaining quantity (updated with a 12-hour delay)'
|
|
)
|
|
resource_pack_id: Optional[str] = Field(None, description='Resource package ID')
|
|
resource_pack_name: Optional[str] = Field(None, description='Resource package name')
|
|
resource_pack_type: Optional[ResourcePackType] = Field(
|
|
None,
|
|
description='Resource package type (decreasing_total=decreasing total, constant_period=constant periodicity)',
|
|
)
|
|
status: Optional[Status] = Field(None, description='Resource Package Status')
|
|
total_quantity: Optional[float] = Field(None, description='Total quantity')
|
|
|
|
|
|
class Data3(BaseModel):
|
|
code: Optional[int] = Field(None, description='Error code; 0 indicates success')
|
|
msg: Optional[str] = Field(None, description='Error information')
|
|
resource_pack_subscribe_infos: Optional[List[ResourcePackSubscribeInfo]] = Field(
|
|
None, description='Resource package list'
|
|
)
|
|
|
|
|
|
class Code3(Enum):
|
|
int_5000 = 5000
|
|
int_5001 = 5001
|
|
int_5002 = 5002
|
|
|
|
|
|
class Code4(Enum):
|
|
int_1300 = 1300
|
|
int_1301 = 1301
|
|
int_1302 = 1302
|
|
int_1303 = 1303
|
|
int_1304 = 1304
|
|
|
|
|
|
class CameraControl2(BaseModel):
|
|
config: Optional[Config] = None
|
|
type: Optional[Type] = Field(None, description='Predefined camera movements type')
|
|
|
|
|
|
class TaskResult3(BaseModel):
|
|
videos: Optional[List[Video]] = None
|
|
|
|
|
|
class Data4(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_info: Optional[TaskInfo] = None
|
|
task_result: Optional[TaskResult3] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class CameraControl3(BaseModel):
|
|
config: Optional[Config] = None
|
|
type: Optional[Type] = Field(None, description='Predefined camera movements type')
|
|
|
|
|
|
class TaskResult4(BaseModel):
|
|
videos: Optional[List[Video]] = None
|
|
|
|
|
|
class Data5(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_info: Optional[TaskInfo] = None
|
|
task_result: Optional[TaskResult4] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class CameraControl4(BaseModel):
|
|
config: Optional[Config] = None
|
|
type: Optional[Type] = Field(None, description='Predefined camera movements type')
|
|
|
|
|
|
class TaskResult5(BaseModel):
|
|
videos: Optional[List[Video]] = None
|
|
|
|
|
|
class Data6(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_info: Optional[TaskInfo] = None
|
|
task_result: Optional[TaskResult5] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class ModelName6(str, Enum):
|
|
kolors_virtual_try_on_v1 = 'kolors-virtual-try-on-v1'
|
|
kolors_virtual_try_on_v1_5 = 'kolors-virtual-try-on-v1-5'
|
|
|
|
|
|
class Image1(BaseModel):
|
|
index: Optional[int] = Field(None, description='Image Number')
|
|
url: Optional[AnyUrl] = Field(None, description='URL for generated image')
|
|
|
|
|
|
class TaskResult6(BaseModel):
|
|
images: Optional[List[Image1]] = None
|
|
|
|
|
|
class Data7(BaseModel):
|
|
created_at: Optional[int] = Field(None, description='Task creation time')
|
|
task_id: Optional[str] = Field(None, description='Task ID')
|
|
task_result: Optional[TaskResult6] = None
|
|
task_status: Optional[TaskStatus] = None
|
|
task_status_msg: Optional[str] = Field(None, description='Task status information')
|
|
updated_at: Optional[int] = Field(None, description='Task update time')
|
|
|
|
|
|
class GenerationType(str, Enum):
|
|
add_audio = 'add_audio'
|
|
|
|
|
|
class Type5(str, Enum):
|
|
generation = 'generation'
|
|
|
|
|
|
class GenerationType1(str, Enum):
|
|
video = 'video'
|
|
|
|
|
|
class GenerationType2(str, Enum):
|
|
image = 'image'
|
|
|
|
|
|
class Type6(str, Enum):
|
|
image = 'image'
|
|
|
|
|
|
class MachineStats(BaseModel):
|
|
cpu_capacity: Optional[str] = Field(None, description='Total CPU on the machine.')
|
|
disk_capacity: Optional[str] = Field(
|
|
None, description='Total disk capacity on the machine.'
|
|
)
|
|
gpu_type: Optional[str] = Field(
|
|
None, description='The GPU type. eg. NVIDIA Tesla K80'
|
|
)
|
|
initial_cpu: Optional[str] = Field(
|
|
None, description='Initial CPU available before the job starts.'
|
|
)
|
|
initial_disk: Optional[str] = Field(
|
|
None, description='Initial disk available before the job starts.'
|
|
)
|
|
initial_ram: Optional[str] = Field(
|
|
None, description='Initial RAM available before the job starts.'
|
|
)
|
|
machine_name: Optional[str] = Field(None, description='Name of the machine.')
|
|
memory_capacity: Optional[str] = Field(
|
|
None, description='Total memory on the machine.'
|
|
)
|
|
os_version: Optional[str] = Field(
|
|
None, description='The operating system version. eg. Ubuntu Linux 20.04'
|
|
)
|
|
pip_freeze: Optional[str] = Field(None, description='The pip freeze output')
|
|
vram_time_series: Optional[Dict[str, Any]] = Field(
|
|
None, description='Time series of VRAM usage.'
|
|
)
|
|
|
|
|
|
class File(BaseModel):
|
|
bytes: Optional[int] = Field(None, description='File size in bytes')
|
|
created_at: Optional[int] = Field(
|
|
None, description='Unix timestamp when the file was created, in seconds'
|
|
)
|
|
download_url: Optional[str] = Field(
|
|
None, description='The URL to download the video'
|
|
)
|
|
file_id: Optional[int] = Field(None, description='Unique identifier for the file')
|
|
filename: Optional[str] = Field(None, description='The name of the file')
|
|
purpose: Optional[str] = Field(None, description='The purpose of using the file')
|
|
|
|
|
|
class Status1(str, Enum):
|
|
Queueing = 'Queueing'
|
|
Preparing = 'Preparing'
|
|
Processing = 'Processing'
|
|
Success = 'Success'
|
|
Fail = 'Fail'
|
|
|
|
|
|
class SubjectReferenceItem(BaseModel):
|
|
image: Optional[str] = Field(
|
|
None, description='URL or base64 encoding of the subject reference image.'
|
|
)
|
|
mask: Optional[str] = Field(
|
|
None,
|
|
description='URL or base64 encoding of the mask for the subject reference image.',
|
|
)
|
|
|
|
|
|
class NodeStatus(str, Enum):
|
|
NodeStatusActive = 'NodeStatusActive'
|
|
NodeStatusDeleted = 'NodeStatusDeleted'
|
|
NodeStatusBanned = 'NodeStatusBanned'
|
|
|
|
|
|
class NodeVersionStatus(str, Enum):
|
|
NodeVersionStatusActive = 'NodeVersionStatusActive'
|
|
NodeVersionStatusDeleted = 'NodeVersionStatusDeleted'
|
|
NodeVersionStatusBanned = 'NodeVersionStatusBanned'
|
|
NodeVersionStatusPending = 'NodeVersionStatusPending'
|
|
NodeVersionStatusFlagged = 'NodeVersionStatusFlagged'
|
|
|
|
|
|
class NodeVersionUpdateRequest(BaseModel):
|
|
changelog: Optional[str] = Field(
|
|
None, description='The changelog describing the version changes.'
|
|
)
|
|
deprecated: Optional[bool] = Field(
|
|
None, description='Whether the version is deprecated.'
|
|
)
|
|
|
|
|
|
class Background(str, Enum):
|
|
transparent = 'transparent'
|
|
opaque = 'opaque'
|
|
|
|
|
|
class Moderation(str, Enum):
|
|
low = 'low'
|
|
auto = 'auto'
|
|
|
|
|
|
class OutputFormat(str, Enum):
|
|
png = 'png'
|
|
webp = 'webp'
|
|
jpeg = 'jpeg'
|
|
|
|
|
|
class Quality(str, Enum):
|
|
low = 'low'
|
|
medium = 'medium'
|
|
high = 'high'
|
|
|
|
|
|
class OpenAIImageEditRequest(BaseModel):
|
|
background: Optional[str] = Field(
|
|
None, description='Background transparency', examples=['opaque']
|
|
)
|
|
model: str = Field(
|
|
..., description='The model to use for image editing', examples=['gpt-image-1']
|
|
)
|
|
moderation: Optional[Moderation] = Field(
|
|
None, description='Content moderation setting', examples=['auto']
|
|
)
|
|
n: Optional[int] = Field(
|
|
None, description='The number of images to generate', examples=[1]
|
|
)
|
|
output_compression: Optional[int] = Field(
|
|
None, description='Compression level for JPEG or WebP (0-100)', examples=[100]
|
|
)
|
|
output_format: Optional[OutputFormat] = Field(
|
|
None, description='Format of the output image', examples=['png']
|
|
)
|
|
prompt: str = Field(
|
|
...,
|
|
description='A text description of the desired edit',
|
|
examples=['Give the rocketship rainbow coloring'],
|
|
)
|
|
quality: Optional[str] = Field(
|
|
None, description='The quality of the edited image', examples=['low']
|
|
)
|
|
size: Optional[str] = Field(
|
|
None, description='Size of the output image', examples=['1024x1024']
|
|
)
|
|
user: Optional[str] = Field(
|
|
None,
|
|
description='A unique identifier for end-user monitoring',
|
|
examples=['user-1234'],
|
|
)
|
|
|
|
|
|
class Quality1(str, Enum):
|
|
low = 'low'
|
|
medium = 'medium'
|
|
high = 'high'
|
|
standard = 'standard'
|
|
hd = 'hd'
|
|
|
|
|
|
class ResponseFormat(str, Enum):
|
|
url = 'url'
|
|
b64_json = 'b64_json'
|
|
|
|
|
|
class Style(str, Enum):
|
|
vivid = 'vivid'
|
|
natural = 'natural'
|
|
|
|
|
|
class OpenAIImageGenerationRequest(BaseModel):
|
|
background: Optional[Background] = Field(
|
|
None, description='Background transparency', examples=['opaque']
|
|
)
|
|
model: Optional[str] = Field(
|
|
None, description='The model to use for image generation', examples=['dall-e-3']
|
|
)
|
|
moderation: Optional[Moderation] = Field(
|
|
None, description='Content moderation setting', examples=['auto']
|
|
)
|
|
n: Optional[int] = Field(
|
|
None,
|
|
description='The number of images to generate (1-10). Only 1 supported for dall-e-3.',
|
|
examples=[1],
|
|
)
|
|
output_compression: Optional[int] = Field(
|
|
None, description='Compression level for JPEG or WebP (0-100)', examples=[100]
|
|
)
|
|
output_format: Optional[OutputFormat] = Field(
|
|
None, description='Format of the output image', examples=['png']
|
|
)
|
|
prompt: str = Field(
|
|
...,
|
|
description='A text description of the desired image',
|
|
examples=['Draw a rocket in front of a blackhole in deep space'],
|
|
)
|
|
quality: Optional[Quality1] = Field(
|
|
None, description='The quality of the generated image', examples=['high']
|
|
)
|
|
response_format: Optional[ResponseFormat] = Field(
|
|
None, description='Response format of image data', examples=['b64_json']
|
|
)
|
|
size: Optional[str] = Field(
|
|
None,
|
|
description='Size of the image (e.g., 1024x1024, 1536x1024, auto)',
|
|
examples=['1024x1536'],
|
|
)
|
|
style: Optional[Style] = Field(
|
|
None, description='Style of the image (only for dall-e-3)', examples=['vivid']
|
|
)
|
|
user: Optional[str] = Field(
|
|
None,
|
|
description='A unique identifier for end-user monitoring',
|
|
examples=['user-1234'],
|
|
)
|
|
|
|
|
|
class Datum1(BaseModel):
|
|
b64_json: Optional[str] = Field(None, description='Base64 encoded image data')
|
|
revised_prompt: Optional[str] = Field(None, description='Revised prompt')
|
|
url: Optional[str] = Field(None, description='URL of the image')
|
|
|
|
|
|
class OpenAIImageGenerationResponse(BaseModel):
|
|
data: Optional[List[Datum1]] = None
|
|
|
|
|
|
class PersonalAccessToken(BaseModel):
|
|
createdAt: Optional[datetime] = Field(
|
|
None, description='[Output Only]The date and time the token was created.'
|
|
)
|
|
description: Optional[str] = Field(
|
|
None,
|
|
description="Optional. A more detailed description of the token's intended use.",
|
|
)
|
|
id: Optional[UUID] = Field(None, description='Unique identifier for the GitCommit')
|
|
name: Optional[str] = Field(
|
|
None,
|
|
description='Required. The name of the token. Can be a simple description.',
|
|
)
|
|
token: Optional[str] = Field(
|
|
None,
|
|
description='[Output Only]. The personal access token. Only returned during creation.',
|
|
)
|
|
|
|
|
|
class PublisherStatus(str, Enum):
|
|
PublisherStatusActive = 'PublisherStatusActive'
|
|
PublisherStatusBanned = 'PublisherStatusBanned'
|
|
|
|
|
|
class PublisherUser(BaseModel):
|
|
email: Optional[str] = Field(None, description='The email address for this user.')
|
|
id: Optional[str] = Field(None, description='The unique id for this user.')
|
|
name: Optional[str] = Field(None, description='The name for this user.')
|
|
|
|
|
|
class RecraftImageGenerationRequest(BaseModel):
|
|
model: str = Field(
|
|
..., description='The model to use for generation (e.g., "recraftv3")'
|
|
)
|
|
n: conint(ge=1, le=4) = Field(..., description='The number of images to generate')
|
|
prompt: str = Field(
|
|
..., description='The text prompt describing the image to generate'
|
|
)
|
|
size: str = Field(
|
|
..., description='The size of the generated image (e.g., "1024x1024")'
|
|
)
|
|
style: Optional[str] = Field(
|
|
None,
|
|
description='The style to apply to the generated image (e.g., "digital_illustration")',
|
|
)
|
|
|
|
|
|
class Datum2(BaseModel):
|
|
image_id: Optional[str] = Field(
|
|
None, description='Unique identifier for the generated image'
|
|
)
|
|
url: Optional[str] = Field(None, description='URL to access the generated image')
|
|
|
|
|
|
class RecraftImageGenerationResponse(BaseModel):
|
|
created: int = Field(
|
|
..., description='Unix timestamp when the generation was created'
|
|
)
|
|
credits: int = Field(..., description='Number of credits used for the generation')
|
|
data: List[Datum2] = Field(..., description='Array of generated image information')
|
|
|
|
|
|
class StorageFile(BaseModel):
|
|
file_path: Optional[str] = Field(None, description='Path to the file in storage')
|
|
id: Optional[UUID] = Field(
|
|
None, description='Unique identifier for the storage file'
|
|
)
|
|
public_url: Optional[str] = Field(None, description='Public URL')
|
|
|
|
|
|
class StripeAddress(BaseModel):
|
|
city: Optional[str] = None
|
|
country: Optional[str] = None
|
|
line1: Optional[str] = None
|
|
line2: Optional[str] = None
|
|
postal_code: Optional[str] = None
|
|
state: Optional[str] = None
|
|
|
|
|
|
class StripeAmountDetails(BaseModel):
|
|
tip: Optional[Dict[str, Any]] = None
|
|
|
|
|
|
class StripeBillingDetails(BaseModel):
|
|
address: Optional[StripeAddress] = None
|
|
email: Optional[str] = None
|
|
name: Optional[str] = None
|
|
phone: Optional[str] = None
|
|
tax_id: Optional[Any] = None
|
|
|
|
|
|
class Checks(BaseModel):
|
|
address_line1_check: Optional[Any] = None
|
|
address_postal_code_check: Optional[Any] = None
|
|
cvc_check: Optional[str] = None
|
|
|
|
|
|
class ExtendedAuthorization(BaseModel):
|
|
status: Optional[str] = None
|
|
|
|
|
|
class IncrementalAuthorization(BaseModel):
|
|
status: Optional[str] = None
|
|
|
|
|
|
class Multicapture(BaseModel):
|
|
status: Optional[str] = None
|
|
|
|
|
|
class NetworkToken(BaseModel):
|
|
used: Optional[bool] = None
|
|
|
|
|
|
class Overcapture(BaseModel):
|
|
maximum_amount_capturable: Optional[int] = None
|
|
status: Optional[str] = None
|
|
|
|
|
|
class StripeCardDetails(BaseModel):
|
|
amount_authorized: Optional[int] = None
|
|
authorization_code: Optional[Any] = None
|
|
brand: Optional[str] = None
|
|
checks: Optional[Checks] = None
|
|
country: Optional[str] = None
|
|
exp_month: Optional[int] = None
|
|
exp_year: Optional[int] = None
|
|
extended_authorization: Optional[ExtendedAuthorization] = None
|
|
fingerprint: Optional[str] = None
|
|
funding: Optional[str] = None
|
|
incremental_authorization: Optional[IncrementalAuthorization] = None
|
|
installments: Optional[Any] = None
|
|
last4: Optional[str] = None
|
|
mandate: Optional[Any] = None
|
|
multicapture: Optional[Multicapture] = None
|
|
network: Optional[str] = None
|
|
network_token: Optional[NetworkToken] = None
|
|
network_transaction_id: Optional[str] = None
|
|
overcapture: Optional[Overcapture] = None
|
|
regulated_status: Optional[str] = None
|
|
three_d_secure: Optional[Any] = None
|
|
wallet: Optional[Any] = None
|
|
|
|
|
|
class Object(str, Enum):
|
|
charge = 'charge'
|
|
|
|
|
|
class Object1(str, Enum):
|
|
event = 'event'
|
|
|
|
|
|
class Type7(str, Enum):
|
|
payment_intent_succeeded = 'payment_intent.succeeded'
|
|
|
|
|
|
class StripeOutcome(BaseModel):
|
|
advice_code: Optional[Any] = None
|
|
network_advice_code: Optional[Any] = None
|
|
network_decline_code: Optional[Any] = None
|
|
network_status: Optional[str] = None
|
|
reason: Optional[Any] = None
|
|
risk_level: Optional[str] = None
|
|
risk_score: Optional[int] = None
|
|
seller_message: Optional[str] = None
|
|
type: Optional[str] = None
|
|
|
|
|
|
class Object2(str, Enum):
|
|
payment_intent = 'payment_intent'
|
|
|
|
|
|
class StripePaymentMethodDetails(BaseModel):
|
|
card: Optional[StripeCardDetails] = None
|
|
type: Optional[str] = None
|
|
|
|
|
|
class Card(BaseModel):
|
|
installments: Optional[Any] = None
|
|
mandate_options: Optional[Any] = None
|
|
network: Optional[Any] = None
|
|
request_three_d_secure: Optional[str] = None
|
|
|
|
|
|
class StripePaymentMethodOptions(BaseModel):
|
|
card: Optional[Card] = None
|
|
|
|
|
|
class StripeRefundList(BaseModel):
|
|
data: Optional[List[Dict[str, Any]]] = None
|
|
has_more: Optional[bool] = None
|
|
object: Optional[str] = None
|
|
total_count: Optional[int] = None
|
|
url: Optional[str] = None
|
|
|
|
|
|
class StripeRequestInfo(BaseModel):
|
|
id: Optional[str] = None
|
|
idempotency_key: Optional[str] = None
|
|
|
|
|
|
class StripeShipping(BaseModel):
|
|
address: Optional[StripeAddress] = None
|
|
carrier: Optional[str] = None
|
|
name: Optional[str] = None
|
|
phone: Optional[str] = None
|
|
tracking_number: Optional[str] = None
|
|
|
|
|
|
class User(BaseModel):
|
|
email: Optional[str] = Field(None, description='The email address for this user.')
|
|
id: Optional[str] = Field(None, description='The unique id for this user.')
|
|
isAdmin: Optional[bool] = Field(
|
|
None, description='Indicates if the user has admin privileges.'
|
|
)
|
|
isApproved: Optional[bool] = Field(
|
|
None, description='Indicates if the user is approved.'
|
|
)
|
|
name: Optional[str] = Field(None, description='The name for this user.')
|
|
|
|
|
|
class Image2(BaseModel):
|
|
bytesBase64Encoded: str
|
|
gcsUri: Optional[str] = None
|
|
mimeType: Optional[str] = None
|
|
|
|
|
|
class Image3(BaseModel):
|
|
bytesBase64Encoded: Optional[str] = None
|
|
gcsUri: str
|
|
mimeType: Optional[str] = None
|
|
|
|
|
|
class Instance(BaseModel):
|
|
image: Optional[Union[Image2, Image3]] = Field(
|
|
None, description='Optional image to guide video generation'
|
|
)
|
|
prompt: str = Field(..., description='Text description of the video')
|
|
|
|
|
|
class PersonGeneration(str, Enum):
|
|
ALLOW = 'ALLOW'
|
|
BLOCK = 'BLOCK'
|
|
|
|
|
|
class Parameters(BaseModel):
|
|
aspectRatio: Optional[str] = Field(None, examples=['16:9'])
|
|
durationSeconds: Optional[int] = None
|
|
enhancePrompt: Optional[bool] = None
|
|
negativePrompt: Optional[str] = None
|
|
personGeneration: Optional[PersonGeneration] = None
|
|
sampleCount: Optional[int] = None
|
|
seed: Optional[int] = None
|
|
storageUri: Optional[str] = Field(
|
|
None, description='Optional Cloud Storage URI to upload the video'
|
|
)
|
|
|
|
|
|
class VeoRequestBody(BaseModel):
|
|
instances: Optional[List[Instance]] = None
|
|
parameters: Optional[Parameters] = None
|
|
|
|
|
|
class WorkflowRunStatus(str, Enum):
|
|
WorkflowRunStatusStarted = 'WorkflowRunStatusStarted'
|
|
WorkflowRunStatusFailed = 'WorkflowRunStatusFailed'
|
|
WorkflowRunStatusCompleted = 'WorkflowRunStatusCompleted'
|
|
|
|
|
|
class ActionJobResult(BaseModel):
|
|
action_job_id: Optional[str] = Field(
|
|
None, description='Identifier of the job this result belongs to'
|
|
)
|
|
action_run_id: Optional[str] = Field(
|
|
None, description='Identifier of the run this result belongs to'
|
|
)
|
|
author: Optional[str] = Field(None, description='The author of the commit')
|
|
avg_vram: Optional[int] = Field(
|
|
None, description='The average VRAM used by the job'
|
|
)
|
|
branch_name: Optional[str] = Field(
|
|
None, description='Name of the relevant git branch'
|
|
)
|
|
comfy_run_flags: Optional[str] = Field(
|
|
None, description='The comfy run flags. E.g. `--low-vram`'
|
|
)
|
|
commit_hash: Optional[str] = Field(None, description='The hash of the commit')
|
|
commit_id: Optional[str] = Field(None, description='The ID of the commit')
|
|
commit_message: Optional[str] = Field(None, description='The message of the commit')
|
|
commit_time: Optional[int] = Field(
|
|
None, description='The Unix timestamp when the commit was made'
|
|
)
|
|
cuda_version: Optional[str] = Field(None, description='CUDA version used')
|
|
end_time: Optional[int] = Field(
|
|
None, description='The end time of the job as a Unix timestamp.'
|
|
)
|
|
git_repo: Optional[str] = Field(None, description='The repository name')
|
|
id: Optional[UUID] = Field(None, description='Unique identifier for the job result')
|
|
job_trigger_user: Optional[str] = Field(
|
|
None, description='The user who triggered the job.'
|
|
)
|
|
machine_stats: Optional[MachineStats] = None
|
|
operating_system: Optional[str] = Field(None, description='Operating system used')
|
|
peak_vram: Optional[int] = Field(None, description='The peak VRAM used by the job')
|
|
pr_number: Optional[str] = Field(None, description='The pull request number')
|
|
python_version: Optional[str] = Field(None, description='PyTorch version used')
|
|
pytorch_version: Optional[str] = Field(None, description='PyTorch version used')
|
|
start_time: Optional[int] = Field(
|
|
None, description='The start time of the job as a Unix timestamp.'
|
|
)
|
|
status: Optional[WorkflowRunStatus] = None
|
|
storage_file: Optional[StorageFile] = None
|
|
workflow_name: Optional[str] = Field(None, description='Name of the workflow')
|
|
|
|
|
|
class NodeVersion(BaseModel):
|
|
changelog: Optional[str] = Field(
|
|
None, description='Summary of changes made in this version'
|
|
)
|
|
comfy_node_extract_status: Optional[str] = Field(
|
|
None, description='The status of comfy node extraction process.'
|
|
)
|
|
createdAt: Optional[datetime] = Field(
|
|
None, description='The date and time the version was created.'
|
|
)
|
|
dependencies: Optional[List[str]] = Field(
|
|
None, description='A list of pip dependencies required by the node.'
|
|
)
|
|
deprecated: Optional[bool] = Field(
|
|
None, description='Indicates if this version is deprecated.'
|
|
)
|
|
downloadUrl: Optional[str] = Field(
|
|
None, description='[Output Only] URL to download this version of the node'
|
|
)
|
|
id: Optional[str] = None
|
|
node_id: Optional[str] = Field(
|
|
None, description='The unique identifier of the node.'
|
|
)
|
|
status: Optional[NodeVersionStatus] = None
|
|
status_reason: Optional[str] = Field(
|
|
None, description='The reason for the status change.'
|
|
)
|
|
version: Optional[str] = Field(
|
|
None,
|
|
description='The version identifier, following semantic versioning. Must be unique for the node.',
|
|
)
|
|
|
|
|
|
class PublisherMember(BaseModel):
|
|
id: Optional[str] = Field(
|
|
None, description='The unique identifier for the publisher member.'
|
|
)
|
|
role: Optional[str] = Field(
|
|
None, description='The role of the user in the publisher.'
|
|
)
|
|
user: Optional[PublisherUser] = None
|
|
|
|
|
|
class StripeCharge(BaseModel):
|
|
amount: Optional[int] = None
|
|
amount_captured: Optional[int] = None
|
|
amount_refunded: Optional[int] = None
|
|
application: Optional[str] = None
|
|
application_fee: Optional[str] = None
|
|
application_fee_amount: Optional[int] = None
|
|
balance_transaction: Optional[str] = None
|
|
billing_details: Optional[StripeBillingDetails] = None
|
|
calculated_statement_descriptor: Optional[str] = None
|
|
captured: Optional[bool] = None
|
|
created: Optional[int] = None
|
|
currency: Optional[str] = None
|
|
customer: Optional[str] = None
|
|
description: Optional[str] = None
|
|
destination: Optional[Any] = None
|
|
dispute: Optional[Any] = None
|
|
disputed: Optional[bool] = None
|
|
failure_balance_transaction: Optional[Any] = None
|
|
failure_code: Optional[Any] = None
|
|
failure_message: Optional[Any] = None
|
|
fraud_details: Optional[Dict[str, Any]] = None
|
|
id: Optional[str] = None
|
|
invoice: Optional[Any] = None
|
|
livemode: Optional[bool] = None
|
|
metadata: Optional[Dict[str, Any]] = None
|
|
object: Optional[Object] = None
|
|
on_behalf_of: Optional[Any] = None
|
|
order: Optional[Any] = None
|
|
outcome: Optional[StripeOutcome] = None
|
|
paid: Optional[bool] = None
|
|
payment_intent: Optional[str] = None
|
|
payment_method: Optional[str] = None
|
|
payment_method_details: Optional[StripePaymentMethodDetails] = None
|
|
radar_options: Optional[Dict[str, Any]] = None
|
|
receipt_email: Optional[str] = None
|
|
receipt_number: Optional[str] = None
|
|
receipt_url: Optional[str] = None
|
|
refunded: Optional[bool] = None
|
|
refunds: Optional[StripeRefundList] = None
|
|
review: Optional[Any] = None
|
|
shipping: Optional[StripeShipping] = None
|
|
source: Optional[Any] = None
|
|
source_transfer: Optional[Any] = None
|
|
statement_descriptor: Optional[Any] = None
|
|
statement_descriptor_suffix: Optional[Any] = None
|
|
status: Optional[str] = None
|
|
transfer_data: Optional[Any] = None
|
|
transfer_group: Optional[Any] = None
|
|
|
|
|
|
class StripeChargeList(BaseModel):
|
|
data: Optional[List[StripeCharge]] = None
|
|
has_more: Optional[bool] = None
|
|
object: Optional[str] = None
|
|
total_count: Optional[int] = None
|
|
url: Optional[str] = None
|
|
|
|
|
|
class StripePaymentIntent(BaseModel):
|
|
amount: Optional[int] = None
|
|
amount_capturable: Optional[int] = None
|
|
amount_details: Optional[StripeAmountDetails] = None
|
|
amount_received: Optional[int] = None
|
|
application: Optional[str] = None
|
|
application_fee_amount: Optional[int] = None
|
|
automatic_payment_methods: Optional[Any] = None
|
|
canceled_at: Optional[int] = None
|
|
cancellation_reason: Optional[str] = None
|
|
capture_method: Optional[str] = None
|
|
charges: Optional[StripeChargeList] = None
|
|
client_secret: Optional[str] = None
|
|
confirmation_method: Optional[str] = None
|
|
created: Optional[int] = None
|
|
currency: Optional[str] = None
|
|
customer: Optional[str] = None
|
|
description: Optional[str] = None
|
|
id: Optional[str] = None
|
|
invoice: Optional[str] = None
|
|
last_payment_error: Optional[Any] = None
|
|
latest_charge: Optional[str] = None
|
|
livemode: Optional[bool] = None
|
|
metadata: Optional[Dict[str, Any]] = None
|
|
next_action: Optional[Any] = None
|
|
object: Optional[Object2] = None
|
|
on_behalf_of: Optional[Any] = None
|
|
payment_method: Optional[str] = None
|
|
payment_method_configuration_details: Optional[Any] = None
|
|
payment_method_options: Optional[StripePaymentMethodOptions] = None
|
|
payment_method_types: Optional[List[str]] = None
|
|
processing: Optional[Any] = None
|
|
receipt_email: Optional[str] = None
|
|
review: Optional[Any] = None
|
|
setup_future_usage: Optional[Any] = None
|
|
shipping: Optional[StripeShipping] = None
|
|
source: Optional[Any] = None
|
|
statement_descriptor: Optional[Any] = None
|
|
statement_descriptor_suffix: Optional[Any] = None
|
|
status: Optional[str] = None
|
|
transfer_data: Optional[Any] = None
|
|
transfer_group: Optional[Any] = None
|
|
|
|
|
|
class Publisher(BaseModel):
|
|
createdAt: Optional[datetime] = Field(
|
|
None, description='The date and time the publisher was created.'
|
|
)
|
|
description: Optional[str] = None
|
|
id: Optional[str] = Field(
|
|
None,
|
|
description="The unique identifier for the publisher. It's akin to a username. Should be lowercase.",
|
|
)
|
|
logo: Optional[str] = Field(None, description="URL to the publisher's logo.")
|
|
members: Optional[List[PublisherMember]] = Field(
|
|
None, description='A list of members in the publisher.'
|
|
)
|
|
name: Optional[str] = None
|
|
source_code_repo: Optional[str] = None
|
|
status: Optional[PublisherStatus] = None
|
|
support: Optional[str] = None
|
|
website: Optional[str] = None
|
|
|
|
|
|
class Data8(BaseModel):
|
|
object: Optional[StripePaymentIntent] = None
|
|
|
|
|
|
class StripeEvent(BaseModel):
|
|
api_version: Optional[str] = None
|
|
created: Optional[int] = None
|
|
data: Data8
|
|
id: str
|
|
livemode: Optional[bool] = None
|
|
object: Object1
|
|
pending_webhooks: Optional[int] = None
|
|
request: Optional[StripeRequestInfo] = None
|
|
type: Type7
|
|
|
|
|
|
class Node(BaseModel):
|
|
author: Optional[str] = None
|
|
category: Optional[str] = Field(None, description='The category of the node.')
|
|
description: Optional[str] = None
|
|
downloads: Optional[int] = Field(
|
|
None, description='The number of downloads of the node.'
|
|
)
|
|
icon: Optional[str] = Field(None, description="URL to the node's icon.")
|
|
id: Optional[str] = Field(None, description='The unique identifier of the node.')
|
|
latest_version: Optional[NodeVersion] = None
|
|
license: Optional[str] = Field(
|
|
None, description="The path to the LICENSE file in the node's repository."
|
|
)
|
|
name: Optional[str] = Field(None, description='The display name of the node.')
|
|
publisher: Optional[Publisher] = None
|
|
rating: Optional[float] = Field(None, description='The average rating of the node.')
|
|
repository: Optional[str] = Field(None, description="URL to the node's repository.")
|
|
status: Optional[NodeStatus] = None
|
|
status_detail: Optional[str] = Field(
|
|
None, description='The status detail of the node.'
|
|
)
|
|
tags: Optional[List[str]] = None
|
|
translations: Optional[Dict[str, Dict[str, Any]]] = None
|