{"components":{"parameters":{"PixverseAiTraceId":{"description":"Unique UUID for each request.","in":"header","name":"Ai-trace-id","required":true,"schema":{"type":"string"}}},"schemas":{"APIKey":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"key_prefix":{"type":"string"},"name":{"type":"string"}},"type":"object"},"APIKeyWithPlaintext":{"allOf":[{"$ref":"#/components/schemas/APIKey"},{"properties":{"plaintext_key":{"description":"The full API key (only returned at creation)","type":"string"}},"type":"object"}]},"ActionJobResult":{"properties":{"action_job_id":{"description":"Identifier of the job this result belongs to","type":"string"},"action_run_id":{"description":"Identifier of the run this result belongs to","type":"string"},"author":{"description":"The author of the commit","type":"string"},"avg_vram":{"description":"The average VRAM used by the job","type":"integer"},"branch_name":{"description":"Name of the relevant git branch","type":"string"},"comfy_run_flags":{"description":"The comfy run flags. E.g. `--low-vram`","type":"string"},"commit_hash":{"description":"The hash of the commit","type":"string"},"commit_id":{"description":"The ID of the commit","type":"string"},"commit_message":{"description":"The message of the commit","type":"string"},"commit_time":{"description":"The Unix timestamp when the commit was made","format":"int64","type":"integer"},"cuda_version":{"description":"CUDA version used","type":"string"},"end_time":{"description":"The end time of the job as a Unix timestamp.","format":"int64","type":"integer"},"git_repo":{"description":"The repository name","type":"string"},"id":{"description":"Unique identifier for the job result","format":"uuid","type":"string"},"job_trigger_user":{"description":"The user who triggered the job.","type":"string"},"machine_stats":{"$ref":"#/components/schemas/MachineStats"},"operating_system":{"description":"Operating system used","type":"string"},"peak_vram":{"description":"The peak VRAM used by the job","type":"integer"},"pr_number":{"description":"The pull request number","type":"string"},"python_version":{"description":"PyTorch version used","type":"string"},"pytorch_version":{"description":"PyTorch version used","type":"string"},"start_time":{"description":"The start time of the job as a Unix timestamp.","format":"int64","type":"integer"},"status":{"$ref":"#/components/schemas/WorkflowRunStatus"},"storage_file":{"$ref":"#/components/schemas/StorageFile"},"workflow_name":{"description":"Name of the workflow","type":"string"}},"type":"object"},"AuditLog":{"properties":{"createdAt":{"description":"The date and time the event was created","format":"date-time","type":"string"},"event_id":{"description":"the id of the event","type":"string"},"event_type":{"description":"the type of the event","type":"string"},"params":{"additionalProperties":true,"description":"data related to the event","type":"object"}},"type":"object"},"BFLAsyncResponse":{"properties":{"id":{"title":"Id","type":"string"},"polling_url":{"title":"Polling Url","type":"string"}},"required":["id","polling_url"],"title":"AsyncResponse","type":"object"},"BFLAsyncWebhookResponse":{"properties":{"id":{"title":"Id","type":"string"},"status":{"title":"Status","type":"string"},"webhook_url":{"title":"Webhook Url","type":"string"}},"required":["id","status","webhook_url"],"title":"AsyncWebhookResponse","type":"object"},"BFLCannyInputs":{"properties":{"canny_high_threshold":{"anyOf":[{"maximum":500,"minimum":0,"type":"integer"}],"default":200,"description":"High threshold for Canny edge detection","title":"Canny High Threshold"},"canny_low_threshold":{"anyOf":[{"maximum":500,"minimum":0,"type":"integer"}],"default":50,"description":"Low threshold for Canny edge detection","title":"Canny Low Threshold"},"control_image":{"anyOf":[{"type":"string"}],"description":"Base64 encoded image to use as control input if no preprocessed image is provided","title":"Control Image"},"guidance":{"anyOf":[{"maximum":100,"minimum":1,"type":"number"}],"default":30,"description":"Guidance strength for the image generation process","title":"Guidance"},"output_format":{"anyOf":[{"$ref":"#/components/schemas/BFLOutputFormat"}],"default":"jpeg","description":"Output format for the generated image. Can be 'jpeg' or 'png'."},"preprocessed_image":{"anyOf":[{"type":"string"}],"description":"Optional pre-processed image that will bypass the control preprocessing step","title":"Preprocessed Image"},"prompt":{"description":"Text prompt for image generation","example":"ein fantastisches bild","title":"Prompt","type":"string"},"prompt_upsampling":{"anyOf":[{"type":"boolean"}],"default":false,"description":"Whether to perform upsampling on the prompt","title":"Prompt Upsampling"},"safety_tolerance":{"default":2,"description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","maximum":6,"minimum":0,"title":"Safety Tolerance","type":"integer"},"seed":{"anyOf":[{"type":"integer"}],"description":"Optional seed for reproducibility","example":42,"title":"Seed"},"steps":{"anyOf":[{"maximum":50,"minimum":15,"type":"integer"}],"default":50,"description":"Number of steps for the image generation process","title":"Steps"},"webhook_secret":{"anyOf":[{"type":"string"}],"description":"Optional secret for webhook signature verification","title":"Webhook Secret"},"webhook_url":{"anyOf":[{"format":"uri","maxLength":2083,"minLength":1,"type":"string"}],"description":"URL to receive webhook notifications","title":"Webhook Url"}},"required":["prompt"],"title":"CannyInputs","type":"object"},"BFLDepthInputs":{"properties":{"control_image":{"anyOf":[{"type":"string"}],"description":"Base64 encoded image to use as control input","title":"Control Image"},"guidance":{"anyOf":[{"maximum":100,"minimum":1,"type":"number"}],"default":15,"description":"Guidance strength for the image generation process","title":"Guidance"},"output_format":{"anyOf":[{"$ref":"#/components/schemas/BFLOutputFormat"}],"default":"jpeg","description":"Output format for the generated image. Can be 'jpeg' or 'png'."},"preprocessed_image":{"anyOf":[{"type":"string"}],"description":"Optional pre-processed image that will bypass the control preprocessing step","title":"Preprocessed Image"},"prompt":{"description":"Text prompt for image generation","example":"ein fantastisches bild","title":"Prompt","type":"string"},"prompt_upsampling":{"anyOf":[{"type":"boolean"}],"default":false,"description":"Whether to perform upsampling on the prompt","title":"Prompt Upsampling"},"safety_tolerance":{"default":2,"description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","maximum":6,"minimum":0,"title":"Safety Tolerance","type":"integer"},"seed":{"anyOf":[{"type":"integer"}],"description":"Optional seed for reproducibility","example":42,"title":"Seed"},"steps":{"anyOf":[{"maximum":50,"minimum":15,"type":"integer"}],"default":50,"description":"Number of steps for the image generation process","title":"Steps"},"webhook_secret":{"anyOf":[{"type":"string"}],"description":"Optional secret for webhook signature verification","title":"Webhook Secret"},"webhook_url":{"anyOf":[{"format":"uri","maxLength":2083,"minLength":1,"type":"string"}],"description":"URL to receive webhook notifications","title":"Webhook Url"}},"required":["prompt"],"title":"DepthInputs","type":"object"},"BFLFlux2ProGenerateRequest":{"description":"Request body for the BFL Flux 2 Pro image generation API.","properties":{"height":{"default":1024,"description":"Height of the image.","maximum":2048,"minimum":256,"type":"integer"},"input_image":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_2":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_3":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_4":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_5":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_6":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_7":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_8":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"input_image_9":{"description":"Base64 encoded image for image-to-image generation.","type":"string"},"output_format":{"default":"jpeg","description":"Output format for the generated image.","enum":["jpeg","png"],"type":"string"},"prompt":{"description":"Text description of the image to generate.","type":"string"},"prompt_upsampling":{"default":true,"description":"Automatically modify prompt for generation.","type":"boolean"},"safety_tolerance":{"default":2,"description":"Moderation tolerance level (Flux 2 Max only).","maximum":5,"minimum":0,"type":"integer"},"seed":{"description":"Seed for reproducibility.","type":"integer"},"width":{"default":1024,"description":"Width of the image.","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"type":"object"},"BFLFluxKontextMaxGenerateRequest":{"properties":{"guidance":{"default":3,"description":"The guidance scale for generation","maximum":20,"minimum":1,"type":"number"},"input_image":{"description":"Base64 encoded image to be edited","type":"string"},"prompt":{"description":"The text prompt describing what to edit on the image","type":"string"},"steps":{"default":50,"description":"Number of inference steps","maximum":50,"minimum":1,"type":"integer"}},"required":["prompt","input_image"],"type":"object"},"BFLFluxKontextMaxGenerateResponse":{"properties":{"id":{"description":"Job ID for tracking","type":"string"},"polling_url":{"description":"URL to poll for results","type":"string"}},"required":["id","polling_url"],"type":"object"},"BFLFluxKontextProGenerateRequest":{"properties":{"guidance":{"default":3,"description":"The guidance scale for generation","maximum":20,"minimum":1,"type":"number"},"input_image":{"description":"Base64 encoded image to be edited","type":"string"},"prompt":{"description":"The text prompt describing what to edit on the image","type":"string"},"steps":{"default":50,"description":"Number of inference steps","maximum":50,"minimum":1,"type":"integer"}},"required":["prompt","input_image"],"type":"object"},"BFLFluxKontextProGenerateResponse":{"properties":{"id":{"description":"Job ID for tracking","type":"string"},"polling_url":{"description":"URL to poll for results","type":"string"}},"required":["id","polling_url"],"type":"object"},"BFLFluxPro1_1GenerateRequest":{"properties":{"height":{"description":"Height of the generated image","type":"integer"},"image_prompt":{"description":"Optional image prompt","type":"string"},"output_format":{"description":"Output image format","enum":["jpeg","png"],"type":"string"},"prompt":{"description":"The main text prompt for image generation","type":"string"},"prompt_upsampling":{"description":"Whether to use prompt upsampling","type":"boolean"},"safety_tolerance":{"description":"Safety tolerance level","type":"integer"},"seed":{"description":"Random seed for reproducibility","type":"integer"},"webhook_secret":{"description":"Optional webhook secret for async processing","type":"string"},"webhook_url":{"description":"Optional webhook URL for async processing","type":"string"},"width":{"description":"Width of the generated image","type":"integer"}},"required":["prompt","width","height"],"type":"object"},"BFLFluxPro1_1GenerateResponse":{"properties":{"id":{"description":"Job ID for tracking","type":"string"},"polling_url":{"description":"URL to poll for results","type":"string"}},"required":["id","polling_url"],"type":"object"},"BFLFluxProExpandInputs":{"properties":{"bottom":{"anyOf":[{"maximum":2048,"minimum":0,"type":"integer"}],"default":0,"description":"Number of pixels to expand at the bottom of the image","title":"Bottom"},"guidance":{"anyOf":[{"maximum":100,"minimum":1.5,"type":"number"}],"default":60,"description":"Guidance strength for the image generation process","title":"Guidance"},"image":{"description":"A Base64-encoded string representing the image you wish to expand.","title":"Image","type":"string"},"left":{"anyOf":[{"maximum":2048,"minimum":0,"type":"integer"}],"default":0,"description":"Number of pixels to expand on the left side of the image","title":"Left"},"output_format":{"anyOf":[{"$ref":"#/components/schemas/BFLOutputFormat"}],"default":"jpeg","description":"Output format for the generated image. Can be 'jpeg' or 'png'."},"prompt":{"anyOf":[{"type":"string"}],"default":"","description":"The description of the changes you want to make. This text guides the expansion process, allowing you to specify features, styles, or modifications for the expanded areas.","example":"ein fantastisches bild","title":"Prompt"},"prompt_upsampling":{"anyOf":[{"type":"boolean"}],"default":false,"description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation","title":"Prompt Upsampling"},"right":{"anyOf":[{"maximum":2048,"minimum":0,"type":"integer"}],"default":0,"description":"Number of pixels to expand on the right side of the image","title":"Right"},"safety_tolerance":{"default":2,"description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","example":2,"maximum":6,"minimum":0,"title":"Safety Tolerance","type":"integer"},"seed":{"anyOf":[{"type":"integer"}],"description":"Optional seed for reproducibility","title":"Seed"},"steps":{"anyOf":[{"maximum":50,"minimum":15,"type":"integer"}],"default":50,"description":"Number of steps for the image generation process","example":50,"title":"Steps"},"top":{"anyOf":[{"maximum":2048,"minimum":0,"type":"integer"}],"default":0,"description":"Number of pixels to expand at the top of the image","title":"Top"},"webhook_secret":{"anyOf":[{"type":"string"}],"description":"Optional secret for webhook signature verification","title":"Webhook Secret"},"webhook_url":{"anyOf":[{"format":"uri","maxLength":2083,"minLength":1,"type":"string"}],"description":"URL to receive webhook notifications","title":"Webhook Url"}},"required":["image"],"title":"FluxProExpandInputs","type":"object"},"BFLFluxProFillInputs":{"properties":{"guidance":{"anyOf":[{"maximum":100,"minimum":1.5,"type":"number"}],"default":60,"description":"Guidance strength for the image generation process","title":"Guidance"},"image":{"description":"A Base64-encoded string representing the image you wish to modify. Can contain alpha mask if desired.","title":"Image","type":"string"},"mask":{"anyOf":[{"type":"string"}],"description":"A Base64-encoded string representing a mask for the areas you want to modify in the image. The mask should be the same dimensions as the image and in black and white. Black areas (0%) indicate no modification, while white areas (100%) specify areas for inpainting. Optional if you provide an alpha mask in the original image. Validation: The endpoint verifies that the dimensions of the mask match the original image.","title":"Mask"},"output_format":{"anyOf":[{"$ref":"#/components/schemas/BFLOutputFormat"}],"default":"jpeg","description":"Output format for the generated image. Can be 'jpeg' or 'png'."},"prompt":{"anyOf":[{"type":"string"}],"default":"","description":"The description of the changes you want to make. This text guides the inpainting process, allowing you to specify features, styles, or modifications for the masked area.","example":"ein fantastisches bild","title":"Prompt"},"prompt_upsampling":{"anyOf":[{"type":"boolean"}],"default":false,"description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation","title":"Prompt Upsampling"},"safety_tolerance":{"default":2,"description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","example":2,"maximum":6,"minimum":0,"title":"Safety Tolerance","type":"integer"},"seed":{"anyOf":[{"type":"integer"}],"description":"Optional seed for reproducibility","title":"Seed"},"steps":{"anyOf":[{"maximum":50,"minimum":15,"type":"integer"}],"default":50,"description":"Number of steps for the image generation process","example":50,"title":"Steps"},"webhook_secret":{"anyOf":[{"type":"string"}],"description":"Optional secret for webhook signature verification","title":"Webhook Secret"},"webhook_url":{"anyOf":[{"format":"uri","maxLength":2083,"minLength":1,"type":"string"}],"description":"URL to receive webhook notifications","title":"Webhook Url"}},"required":["image"],"title":"FluxProFillInputs","type":"object"},"BFLFluxProGenerateRequest":{"description":"Request body for the BFL Flux Pro 1.1 Ultra image generation API.","properties":{"guidance_scale":{"description":"The guidance scale for generation.","maximum":20,"minimum":1,"type":"number"},"height":{"description":"The height of the image to generate.","maximum":2048,"minimum":64,"type":"integer"},"negative_prompt":{"description":"The negative prompt for image generation.","type":"string"},"num_images":{"description":"The number of images to generate.","maximum":4,"minimum":1,"type":"integer"},"num_inference_steps":{"description":"The number of inference steps.","maximum":100,"minimum":1,"type":"integer"},"prompt":{"description":"The text prompt for image generation.","type":"string"},"seed":{"description":"The seed value for reproducibility.","type":"integer"},"width":{"description":"The width of the image to generate.","maximum":2048,"minimum":64,"type":"integer"}},"required":["prompt","width","height"],"type":"object"},"BFLFluxProGenerateResponse":{"description":"Response from the BFL Flux Pro 1.1 Ultra image generation API.","properties":{"cost":{"description":"The cost of the generation task.","format":"float","type":"number"},"id":{"description":"The unique identifier for the generation task.","type":"string"},"input_mp":{"description":"Input megapixels.","format":"float","type":"number"},"output_mp":{"description":"Output megapixels.","format":"float","type":"number"},"polling_url":{"description":"URL to poll for the generation result.","type":"string"}},"required":["id","polling_url"],"type":"object"},"BFLHTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/BFLValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"BFLOutputFormat":{"enum":["jpeg","png"],"title":"OutputFormat","type":"string"},"BFLValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"BriaAsyncResponse":{"description":"Asynchronous response from Bria API (202 Accepted)","properties":{"request_id":{"description":"Unique identifier for the request.","type":"string"},"status_url":{"description":"URL to poll for the result.","type":"string"},"warning":{"description":"Optional warning message.","type":"string"}},"type":"object"},"BriaErrorResponse":{"description":"Error response from Bria API","properties":{"error":{"properties":{"code":{"description":"Error code.","type":"integer"},"details":{"description":"Additional error details.","type":"string"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"request_id":{"description":"Unique identifier for the request.","type":"string"}},"type":"object"},"BriaFiboEditRequest":{"description":"Request body for Bria FIBO Edit API","properties":{"guidance_scale":{"default":5,"description":"Determines how closely the generated image should adhere to the instruction.","format":"float","maximum":5,"minimum":3,"type":"number"},"images":{"description":"The source image to be edited. Publicly available URL or Base64-encoded. Accepted formats JPEG, JPG, PNG, WEBP. Must contain exactly one item.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"instruction":{"description":"Text-based edit instruction (e.g., \"make the sky blue\", \"add a cat\"). Either instruction or structured_instruction must be provided.","type":"string"},"ip_signal":{"default":false,"description":"If true, returns a warning for potential IP content in the instruction.","type":"boolean"},"mask":{"description":"Optional mask image URL or Base64-encoded. Black areas will be preserved, white areas will be edited.","type":"string"},"model_version":{"default":"FIBO","description":"The version of the model to use.","enum":["FIBO"],"type":"string"},"negative_prompt":{"description":"A text prompt specifying concepts, styles, or objects to exclude from the edited image.","type":"string"},"prompt_content_moderation":{"default":true,"description":"If true, returns 422 on instruction moderation failure.","type":"boolean"},"seed":{"description":"Seed for deterministic generation. If omitted, a random seed is used.","type":"integer"},"steps_num":{"default":50,"description":"Number of diffusion steps.","maximum":50,"minimum":20,"type":"integer"},"structured_instruction":{"description":"A string containing the structured edit instruction in JSON format. Use this instead of instruction for precise, programmatic control.","type":"string"},"visual_input_content_moderation":{"default":true,"description":"If true, returns 422 on images or mask moderation failure.","type":"boolean"},"visual_output_content_moderation":{"default":true,"description":"If true, returns 422 on visual output moderation failure.","type":"boolean"}},"required":["images"],"type":"object"},"BriaImageRemoveBackgroundRequest":{"description":"Request body for Bria Image Remove Background API","properties":{"image":{"description":"The image to remove background from. Supported input types are Base64-encoded string or URL pointing to a publicly accessible image file. Accepted formats JPEG, JPG, PNG, WEBP.","type":"string"},"preserve_alpha":{"description":"Controls whether partially transparent areas from the input image are retained in the output after background removal.","type":"boolean"},"sync":{"description":"When false (default), the request is processed asynchronously. When true, the API holds the connection open until complete.","type":"boolean"},"visual_input_content_moderation":{"description":"When enabled, applies content moderation to input visual. Returns 422 if the image fails moderation.","type":"boolean"},"visual_output_content_moderation":{"description":"When enabled, applies content moderation to result visual. Returns 422 if the output fails moderation.","type":"boolean"}},"required":["image"],"type":"object"},"BriaStatusNotFoundResponse":{"description":"Response when request_id is not found or expired","properties":{"status":{"enum":["NOT_FOUND"],"type":"string"}},"required":["status"],"type":"object"},"BriaStatusResponse":{"description":"Status response from Bria API","properties":{"error":{"description":"Error object (only present when status is ERROR)","properties":{"code":{"description":"Error code.","type":"integer"},"details":{"description":"Additional error details.","type":"string"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"request_id":{"description":"Unique identifier for the request.","type":"string"},"result":{"description":"Result object (only present when status is COMPLETED)","properties":{"image_url":{"description":"URL of the generated/edited image.","type":"string"},"prompt":{"description":"Original prompt.","type":"string"},"refined_prompt":{"description":"Refined version of the prompt.","type":"string"},"seed":{"description":"Seed used for generation.","type":"integer"},"structured_prompt":{"description":"The detailed JSON structured prompt.","type":"string"},"video_url":{"description":"URL of the generated video.","type":"string"}},"type":"object"},"status":{"description":"Current status of the request.","enum":["IN_PROGRESS","COMPLETED","ERROR","UNKNOWN"],"type":"string"}},"type":"object"},"BriaStructuredInstructionRequest":{"description":"Request body for Bria Structured Instruction Generate API","properties":{"images":{"description":"The source image to be edited. Publicly available URL or Base64-encoded. Must contain exactly one item.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"instruction":{"description":"Required. Text-based edit instruction (e.g., \"make the sky blue\", \"add a cat\").","type":"string"},"ip_signal":{"default":false,"description":"If true, returns a warning for potential IP content in the instruction.","type":"boolean"},"mask":{"description":"Optional mask image URL or Base64-encoded. Black areas will be preserved, white areas will be edited.","type":"string"},"prompt_content_moderation":{"default":true,"description":"If true, returns 422 on instruction moderation failure.","type":"boolean"},"seed":{"description":"Seed for deterministic generation. If omitted, a random seed is used.","type":"integer"},"visual_input_content_moderation":{"default":true,"description":"If true, returns 422 on images or mask moderation failure.","type":"boolean"}},"required":["images","instruction"],"type":"object"},"BriaVideoRemoveBackgroundRequest":{"description":"Request body for Bria Video Remove Background API","properties":{"background_color":{"description":"Background color for the output video. If Transparent, the output codec must support alpha.","enum":["Transparent","Black","White","Gray","Red","Green","Blue","Yellow","Cyan","Magenta","Orange"],"type":"string"},"output_container_and_codec":{"description":"Output container and codec preset.","enum":["mp4_h264","mp4_h265","webm_vp9","mov_h265","mov_proresks","mkv_h264","mkv_h265","mkv_vp9","gif"],"type":"string"},"preserve_audio":{"description":"Whether to preserve audio from the input video.","type":"boolean"},"video":{"description":"Publicly accessible URL of the input video. Input resolution supported up to 16000x16000 (16K). Max duration 60 seconds.","type":"string"}},"required":["video"],"type":"object"},"BulkNodeVersionResult":{"properties":{"error_message":{"description":"Error message if retrieval failed (only present if status is error)","type":"string"},"identifier":{"$ref":"#/components/schemas/NodeVersionIdentifier"},"node_version":{"$ref":"#/components/schemas/NodeVersion"},"status":{"description":"Status of the retrieval operation","enum":["success","not_found","error"],"type":"string"}},"required":["identifier","status"],"type":"object"},"BulkNodeVersionsRequest":{"properties":{"node_versions":{"description":"List of node ID and version pairs to retrieve","items":{"$ref":"#/components/schemas/NodeVersionIdentifier"},"type":"array"}},"required":["node_versions"],"type":"object"},"BulkNodeVersionsResponse":{"properties":{"node_versions":{"description":"List of retrieved node versions with their status","items":{"$ref":"#/components/schemas/BulkNodeVersionResult"},"type":"array"}},"required":["node_versions"],"type":"object"},"BytePlusImageGenerationRequest":{"properties":{"guidance_scale":{"description":"Controls how closely the output image aligns with the input prompt. Range [1, 10]. Higher values result in stronger prompt adherence. Default 2.5 for seedream-3-0-t2i-250415 and 5.5 for seededit-3-0-i2i-250628. Not supported by seedream-5.0-lite, 4.5 and 4.0.","format":"float","maximum":10,"minimum":1,"type":"number"},"image":{"description":"Seedream-5.0-lite, 4.5 and 4.0, and seededit-3.0-i2i support this parameter.\n\nEnter the Base64 encoding or an accessible URL of the image to edit. Seedream-5.0-lite, 4.5 and 4.0 support inputting a single image or multiple images (see the multi-image blending example), while seededit-3.0-i2i only supports single-image input.\n\n• Image URL: Make sure that the image URL is accessible.\n• Base64 encoding: The format must be data:image/\u003cimage format\u003e;base64,\u003cBase64 encoding\u003e. Note: \u003cimage format\u003e must be in lowercase, e.g., data:image/png;base64,\u003cbase64_image\u003e.\n\nAn input image must meet the following requirements:\n• Image format: jpeg, png (seedream-5.0-lite, 4.5 and 4.0 also support webp, bmp, tiff and gif)\n• Aspect ratio (width/height): In the range [1/16, 16] for seedream-5.0-lite, 4.5 and 4.0; [1/3, 3] for seededit-3.0-i2i\n• Width and height (px): \u003e 14\n• Size: No more than 10 MB\n• Maximum of 14 reference images\n","oneOf":[{"description":"Single image (URL or Base64)","type":"string"},{"description":"Multiple images (URLs or Base64) - supported by seedream-5.0-lite, 4.5 and 4.0","items":{"type":"string"},"maxItems":14,"type":"array"}]},"model":{"enum":["seedream-3-0-t2i-250415","seededit-3-0-i2i-250628","seedream-4-0-250828","seedream-4-5-251128","seedream-5-0-260128"],"type":"string"},"optimize_prompt_options":{"description":"Configuration for prompt optimization feature. Only seedream-5.0-lite/4.5 (only supports standard mode) and seedream-4.0 support this parameter.\n","properties":{"mode":{"default":"standard","description":"Set the mode for the prompt optimization feature. standard = Higher quality, longer generation time. fast = Faster but at a more average quality.","enum":["standard","fast"],"type":"string"}},"type":"object"},"output_format":{"default":"jpeg","description":"Specifies the format of the output image. Only seedream-5.0-lite supports this parameter.","enum":["png","jpeg"],"type":"string"},"prompt":{"description":"Text description for image generation or transformation","type":"string"},"response_format":{"default":"url","description":"Specifies the format of the generated image returned in the response","enum":["url","b64_json"],"type":"string"},"seed":{"default":-1,"description":"Random seed to control the stochasticity of image generation. Range: [-1, 2147483647]. If not specified, a seed will be automatically generated. To reproduce the same output, use the same seed value.","type":"integer"},"sequential_image_generation":{"description":"Controls whether to disable the batch generation feature. This parameter is only supported on seedream-5.0-lite, 4.5 and 4.0. Valid values:\nauto: In automatic mode, the model automatically determines whether to return multiple images and how many images it will contain based on the user's prompt.\ndisabled: Disables batch generation feature. The model will only generate one image.\n","type":"string"},"sequential_image_generation_options":{"description":"Only seedream-5.0-lite, 4.5 and 4.0 support this parameter.\nConfiguration for the batch image generation feature. This parameter is only effective when sequential_image_generation is set to auto.\n","properties":{"max_images":{"default":15,"description":"Specifies the maximum number of images to generate in this request. Number of input reference images + Number of generated images ≤ 15.","maximum":15,"minimum":1,"type":"integer"}},"type":"object"},"size":{"description":"\"seedream-3-0-t2i-250415\": Specifies the dimensions (width x height in pixels) of the generated image. Must be between [512x512, 2048x2048]\n\"seededit-3-0-i2i-250628\": The width and height pixels of the generated image. Currently only supports adaptive.\n\"seedream-4-0-250828\": Set the specification for the generated image. Two methods are available but cannot be used together.\n  Method 1 | Specify the resolution. Optional values: 1K, 2K, 4K\n  Method 2 | Specify width and height in pixels. Default: 2048x2048, total pixels: [1024x1024, 4096x4096], aspect ratio: [1/16, 16]\n\"seedream-4-5-251128\": Two methods available.\n  Method 1 | Specify the resolution. Optional values: 2K, 4K\n  Method 2 | Specify width and height in pixels. Default: 2048x2048, total pixels: [2560x1440, 4096x4096], aspect ratio: [1/16, 16]\n\"seedream-5-0-260128\": Two methods available.\n  Method 1 | Specify the resolution. Optional values: 2K, 3K\n  Method 2 | Specify width and height in pixels. Default: 2048x2048, total pixels: [2560x1440, ~3072x3072], aspect ratio: [1/16, 16]\n","type":"string"},"stream":{"default":false,"description":"Whether to enable streaming output mode. Only seedream-5.0-lite, 4.5 and 4.0 support this parameter. false = All output images are returned at once. true = Each output image is returned immediately after generated.","type":"boolean"},"watermark":{"default":true,"description":"Specifies whether to add a watermark to the generated image. false = No watermark, true = Adds watermark with 'AI generated' label","type":"boolean"}},"required":["prompt","model"],"type":"object"},"BytePlusImageGenerationResponse":{"properties":{"created":{"description":"Unix timestamp (in seconds) indicating the time when the request was created","type":"integer"},"data":{"description":"Contains information about the generated image(s)","items":{"properties":{"b64_json":{"description":"Base64-encoded image data (if response_format is \"b64_json\")","type":"string"},"size":{"description":"The width and height of the image in pixels, in the format \u003cwidth\u003ex\u003cheight\u003e. Only seedream-5.0-lite, 4.5 and 4.0 support this parameter.","type":"string"},"url":{"description":"URL for image download (if response_format is \"url\")","format":"uri","type":"string"}},"type":"object"},"type":"array"},"error":{"description":"Error information (if any)","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message","type":"string"}},"type":"object"},"model":{"description":"The model ID used for the request","example":"seedream-3-0-t2i-250415","type":"string"},"usage":{"properties":{"generated_images":{"description":"Number of images generated by the model","type":"integer"},"output_tokens":{"description":"The number of tokens used for the picture generated by the model.","type":"integer"},"total_tokens":{"description":"The total number of tokens consumed by this request.","type":"integer"}},"type":"object"}},"type":"object"},"BytePlusVideoGenerationContent":{"properties":{"audio_url":{"description":"Input audio object. Only Seedance 2.0 \u0026 2.0 fast support audio input. Cannot be used alone - must include at least 1 image or video.","properties":{"url":{"description":"Audio URL, Base64 encoding, or Asset ID.\nAudio URL: Public URL of the audio (wav, mp3).\nBase64: Format data:audio/\u003cformat\u003e;base64,\u003ccontent\u003e\nAsset ID: Format asset://\u003cASSET_ID\u003e\n","type":"string"}},"type":"object"},"image_url":{"properties":{"url":{"description":"Image content for image-to-video generation (when type is \"image_url\")\nImage URL: Make sure that the image URL is accessible.\nBase64-encoded content: Format must be data:image/\u003cformat\u003e;base64,\u003ccontent\u003e\nAsset ID: Format asset://\u003cASSET_ID\u003e\n","type":"string"}},"type":"object"},"role":{"description":"The role/position of the content item.\nFor images: first_frame, last_frame, or reference_image.\nFor videos: reference_video (Seedance 2.0 \u0026 2.0 fast only).\nFor audio: reference_audio (Seedance 2.0 \u0026 2.0 fast only).\n","enum":["first_frame","last_frame","reference_image","reference_video","reference_audio"],"type":"string"},"text":{"description":"The input text information for the model. Includes text prompt and optional parameters.\n\nText prompt (required): Description of the video to be generated using Chinese and English characters.\n\nParameters (optional): Add --[parameters] after the text prompt to control video specifications:\n- --resolution (--rs): 480p, 720p, 1080p (default: 720p)\n- --ratio (--rt): 21:9, 16:9, 4:3, 1:1, 3:4, 9:16, 9:21, adaptive (default: 16:9 or adaptive)\n- --duration (--dur): 3-12 seconds (default: 5)\n- --framepersecond (--fps): 24 (default: 24)\n- --watermark (--wm): true/false (default: false)\n- --seed (--seed): -1 to 2^32-1 (default: -1)\n- --camerafixed (--cf): true/false (default: false)\n\nExample: \"A beautiful landscape --ratio 16:9 --resolution 720p --duration 5\"\n","maxLength":4096,"type":"string"},"type":{"description":"The type of the input content","enum":["text","image_url","video_url","audio_url"],"type":"string"},"video_url":{"description":"Input video object. Only Seedance 2.0 \u0026 2.0 fast support video input.","properties":{"url":{"description":"Video URL or Asset ID.\nVideo URL: Public URL of the video (mp4, mov).\nAsset ID: Format asset://\u003cASSET_ID\u003e\n","type":"string"}},"type":"object"}},"required":["type"],"type":"object"},"BytePlusVideoGenerationQueryResponse":{"properties":{"content":{"description":"The output after the video generation task is completed, which contains the download URL of the output video.","properties":{"video_url":{"description":"The URL of the output video. For security purposes, the output video is cleared after 24 hours.","type":"string"}},"type":"object"},"created_at":{"description":"The time when the task was created. The value is a UNIX timestamp in seconds.","type":"integer"},"error":{"description":"The error information. If the task succeeds, null is returned. If the task fails, the error information is returned.","nullable":true,"properties":{"code":{"description":"The error code","type":"string"},"message":{"description":"The error message","type":"string"}},"type":"object"},"id":{"description":"The ID of the video generation task","type":"string"},"model":{"description":"The name and version of the model used by the task","type":"string"},"status":{"description":"The state of the task","enum":["queued","running","cancelled","succeeded","failed","expired"],"type":"string"},"updated_at":{"description":"The time when the task was last updated. The value is a UNIX timestamp in seconds.","type":"integer"},"usage":{"description":"The token usage for the request","properties":{"completion_tokens":{"description":"The number of tokens generated by the model","type":"integer"},"total_tokens":{"description":"For the video generation model, the number of input tokens is not calculated and defaults to 0. Therefore, total_tokens = completion_tokens.","type":"integer"}},"type":"object"}},"type":"object"},"BytePlusVideoGenerationRequest":{"properties":{"callback_url":{"description":"Callback notification address for the result of this generation task","format":"uri","type":"string"},"content":{"description":"The input content for the model to generate a video","items":{"$ref":"#/components/schemas/BytePlusVideoGenerationContent"},"minItems":1,"type":"array"},"duration":{"description":"Video duration in seconds. Seedance 2.0 \u0026 2.0 fast: [4,15] or -1 (auto). Seedance 1.5 pro: [4,12] or -1. Seedance 1.0: [2,12].\n","type":"integer"},"execution_expires_after":{"description":"Task timeout threshold in seconds. Default 172800 (48h). Range: [3600, 259200].\n","type":"integer"},"generate_audio":{"default":true,"description":"Supported by Seedance 2.0, 2.0 fast, and 1.5 pro. Whether the generated video includes audio synchronized with the visuals.\ntrue: The model outputs a video with synchronized audio.\nfalse: The model outputs a silent video.\n","type":"boolean"},"model":{"description":"The ID of the model to call. Available models include seedance-1-5-pro-251215, seedance-1-0-pro-250528, seedance-1-0-pro-fast-251015, seedance-1-0-lite-t2v-250428, seedance-1-0-lite-i2v-250428","enum":["seedance-1-5-pro-251215","seedance-1-0-pro-250528","seedance-1-0-lite-t2v-250428","seedance-1-0-lite-i2v-250428","seedance-1-0-pro-fast-251015","dreamina-seedance-2-0-260128","dreamina-seedance-2-0-fast-260128"],"type":"string"},"ratio":{"description":"Aspect ratio of the generated video. Seedance 2.0 \u0026 2.0 fast, 1.5 pro default: adaptive.\n","enum":["16:9","4:3","1:1","3:4","9:16","21:9","adaptive"],"type":"string"},"resolution":{"description":"Video resolution. Seedance 2.0 \u0026 2.0 fast, 1.5 pro, 1.0 lite default: 720p. Seedance 1.0 pro \u0026 pro-fast default: 1080p.\nNote: Seedance 2.0 \u0026 2.0 fast do not support 1080p.\n","enum":["480p","720p","1080p"],"type":"string"},"return_last_frame":{"default":false,"description":"Whether to return the last frame image of the generated video.\ntrue: Returns the last frame image of the generated video. After setting this parameter to true, you can obtain the last frame image by calling the Querying the information about a video generation task. The last frame image is in PNG format, with its pixel width and height consistent with those of the generated video, and it contains no watermarks. Using this parameter allows the generation of multiple consecutive videos: the last frame of the previously generated video is used as the first frame of the next video task, enabling quick generation of multiple consecutive videos.\nfalse: Does not return the last frame image of the generated video.\n","type":"boolean"},"seed":{"description":"Seed integer for controlling randomness. Range: [-1, 2^32-1]. -1 uses a random seed.\n","type":"integer"},"service_tier":{"description":"Service tier for processing. Seedance 2.0 \u0026 2.0 fast do not support flex (offline inference).\n","enum":["default","flex"],"type":"string"},"watermark":{"default":false,"description":"Whether the generated video includes a watermark.","type":"boolean"}},"required":["model","content"],"type":"object"},"BytePlusVideoGenerationResponse":{"properties":{"id":{"description":"The ID of the video generation task","type":"string"}},"required":["id"],"type":"object"},"ClaimMyNodeRequest":{"properties":{"GH_TOKEN":{"description":"GitHub token to verify if the user owns the repo of the node","type":"string"}},"required":["GH_TOKEN"],"type":"object"},"ComfyNode":{"properties":{"category":{"description":"UI category where the node is listed, used for grouping nodes.","type":"string"},"comfy_node_name":{"description":"Unique identifier for the node","type":"string"},"deprecated":{"description":"Indicates if the node is deprecated. Deprecated nodes are hidden in the UI.","type":"boolean"},"description":{"description":"Brief description of the node's functionality or purpose.","type":"string"},"experimental":{"description":"Indicates if the node is experimental, subject to changes or removal.","type":"boolean"},"function":{"description":"Name of the entry-point function to execute the node.","type":"string"},"input_types":{"description":"Defines input parameters","type":"string"},"output_is_list":{"description":"Boolean values indicating if each output is a list.","items":{"type":"boolean"},"type":"array"},"policy":{"$ref":"#/components/schemas/ComfyNodePolicy"},"return_names":{"description":"Names of the outputs for clarity in workflows.","type":"string"},"return_types":{"description":"Specifies the types of outputs produced by the node.","type":"string"}},"type":"object"},"ComfyNodeCloudBuildInfo":{"properties":{"build_id":{"type":"string"},"location":{"type":"string"},"project_id":{"type":"string"},"project_number":{"type":"string"}},"type":"object"},"ComfyNodePolicy":{"enum":["ComfyNodePolicyActive","ComfyNodePolicyBanned","ComfyNodePolicyLocalOnly"],"type":"string"},"ComfyNodeUpdateRequest":{"properties":{"category":{"description":"UI category where the node is listed, used for grouping nodes.","type":"string"},"deprecated":{"description":"Indicates if the node is deprecated. Deprecated nodes are hidden in the UI.","type":"boolean"},"description":{"description":"Brief description of the node's functionality or purpose.","type":"string"},"experimental":{"description":"Indicates if the node is experimental, subject to changes or removal.","type":"boolean"},"function":{"description":"Name of the entry-point function to execute the node.","type":"string"},"input_types":{"description":"Defines input parameters","type":"string"},"output_is_list":{"description":"Boolean values indicating if each output is a list.","items":{"type":"boolean"},"type":"array"},"policy":{"$ref":"#/components/schemas/ComfyNodePolicy"},"return_names":{"description":"Names of the outputs for clarity in workflows.","type":"string"},"return_types":{"description":"Specifies the types of outputs produced by the node.","type":"string"}},"type":"object"},"ComputerToolCall":{"description":"A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.\n","properties":{"action":{"type":"object"},"call_id":{"description":"An identifier used when responding to the tool call with output.\n","type":"string"},"id":{"description":"The unique ID of the computer call.","type":"string"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"],"type":"string"},"type":{"default":"computer_call","description":"The type of the computer call. Always `computer_call`.","enum":["computer_call"],"type":"string"}},"required":["type","id","action","call_id","pending_safety_checks","status"],"title":"Computer tool call","type":"object"},"ComputerUsePreviewTool":{"description":"A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).","properties":{"display_height":{"description":"The height of the computer display.","type":"integer"},"display_width":{"description":"The width of the computer display.","type":"integer"},"environment":{"description":"The type of computer environment to control.","enum":["windows","mac","linux","ubuntu","browser"],"type":"string"},"type":{"default":"computer_use_preview","description":"The type of the computer use tool. Always `computer_use_preview`.","enum":["computer_use_preview"],"type":"string","x-stainless-const":true}},"required":["type","environment","display_width","display_height"],"title":"Computer use preview","type":"object"},"CouponResponse":{"properties":{"amount_off":{"description":"Amount off in cents","type":"integer"},"currency":{"description":"Currency for amount_off","type":"string"},"duration":{"description":"How long the coupon lasts","enum":["once","repeating","forever"],"type":"string"},"duration_in_months":{"description":"Number of months for repeating coupons","type":"integer"},"id":{"description":"The Stripe coupon ID","type":"string"},"max_redemptions":{"description":"Maximum number of times this coupon can be redeemed","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"description":"Set of key-value pairs for storing additional information","type":"object"},"name":{"description":"Name of the coupon displayed to customers","type":"string"},"percent_off":{"description":"Percent off discount (0-100)","format":"double","type":"number"},"redeem_by":{"description":"Unix timestamp specifying the last time at which the coupon can be redeemed","format":"int64","type":"integer"},"times_redeemed":{"description":"Number of times this coupon has been redeemed","type":"integer"},"valid":{"description":"Whether the coupon can still be redeemed","type":"boolean"}},"required":["id","duration","valid"],"type":"object"},"CreateAPIKeyRequest":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"CreateCouponRequest":{"properties":{"amount_off":{"description":"Amount off in cents","minimum":0,"type":"integer"},"currency":{"description":"Currency for amount_off (required if amount_off is set)","enum":["usd"],"type":"string"},"duration":{"default":"once","description":"How long the coupon lasts","enum":["once","repeating","forever"],"type":"string"},"duration_in_months":{"description":"Required if duration is repeating","minimum":1,"type":"integer"},"max_redemptions":{"description":"Maximum number of times this coupon can be redeemed","minimum":1,"type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"description":"Set of key-value pairs for storing additional information","type":"object"},"name":{"description":"Name of the coupon displayed to customers","type":"string"},"percent_off":{"description":"Percent off discount (0-100)","format":"double","maximum":100,"minimum":0,"type":"number"},"redeem_by":{"description":"Unix timestamp specifying the last time at which the coupon can be redeemed","format":"int64","type":"integer"}},"type":"object"},"CreateModelResponseProperties":{"allOf":[{"$ref":"#/components/schemas/ModelResponseProperties"}]},"CreatePromoCodeRequest":{"properties":{"coupon_id":{"description":"The Stripe coupon ID to create the promotional code for","type":"string"},"expire_days":{"default":30,"description":"Number of days until the promotion code expires","minimum":1,"type":"integer"},"max_redemptions":{"description":"Maximum number of times this code can be redeemed","minimum":1,"type":"integer"}},"required":["coupon_id"],"type":"object"},"Customer":{"properties":{"createdAt":{"description":"The date and time the user was created","format":"date-time","type":"string"},"email":{"description":"The email address for this user","type":"string"},"has_fund":{"description":"Whether the user has funds","type":"boolean"},"id":{"description":"The firebase UID of the user","type":"string"},"is_admin":{"description":"Whether the user is an admin","type":"boolean"},"metronome_id":{"description":"The Metronome customer ID","type":"string"},"name":{"description":"The name for this user","type":"string"},"stripe_id":{"description":"The Stripe customer ID","type":"string"},"subscription_tier":{"allOf":[{"$ref":"#/components/schemas/SubscriptionTier"}],"description":"The cached subscription tier level","nullable":true},"updatedAt":{"description":"The date and time the user was last updated","format":"date-time","type":"string"}},"required":["id"],"type":"object"},"CustomerAdmin":{"properties":{"cloud_subscription_end_date":{"description":"The date when the subscription is set to end (ISO 8601 format)","format":"date-time","nullable":true,"type":"string"},"cloud_subscription_is_active":{"description":"Whether the customer has an active cloud subscription","type":"boolean"},"cloud_subscription_renewal_date":{"description":"The next renewal date for the subscription (ISO 8601 format)","format":"date-time","nullable":true,"type":"string"},"cloud_subscription_subscription_id":{"description":"The active subscription ID if one exists","nullable":true,"type":"string"},"createdAt":{"description":"The date and time the user was created","format":"date-time","type":"string"},"email":{"description":"The email address for this user","type":"string"},"has_fund":{"description":"Whether the user has funds","type":"boolean"},"id":{"description":"The firebase UID of the user","type":"string"},"is_admin":{"description":"Whether the user is an admin","type":"boolean"},"metronome_id":{"description":"The Metronome customer ID","type":"string"},"name":{"description":"The name for this user","type":"string"},"stripe_id":{"description":"The Stripe customer ID","type":"string"},"subscription_tier":{"allOf":[{"$ref":"#/components/schemas/SubscriptionTier"}],"description":"The subscription tier level (e.g. FREE, STANDARD, CREATOR, PRO)","nullable":true},"updatedAt":{"description":"The date and time the user was last updated","format":"date-time","type":"string"}},"required":["id"],"type":"object"},"CustomerStorageResourceResponse":{"properties":{"download_url":{"description":"The signed URL to use for downloading the file from the specified path","type":"string"},"existing_file":{"description":"Whether an existing file with the same hash was found","type":"boolean"},"expires_at":{"description":"When the signed URL will expire","format":"date-time","type":"string"},"upload_url":{"description":"The signed URL to use for uploading the file to the specified path","type":"string"}},"type":"object"},"EasyInputMessage":{"description":"A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.\n","properties":{"content":{"description":"Text, image, or audio input to the model, used to generate a response.\nCan also contain previous assistant responses.\n","oneOf":[{"description":"A text input to the model.\n","title":"Text input","type":"string"},{"$ref":"#/components/schemas/InputMessageContentList"}]},"role":{"description":"The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.\n","enum":["user","assistant","system","developer"],"type":"string"},"type":{"description":"The type of the message input. Always `message`.\n","enum":["message"],"type":"string","x-stainless-const":true}},"required":["role","content"],"title":"Input message","type":"object"},"ElevenLabsAudioIsolationRequest":{"description":"Request body for audio isolation (removing background noise)","properties":{"audio":{"description":"The audio file from which vocals/speech will be isolated.","format":"binary","type":"string"},"file_format":{"default":"other","description":"The format of input audio. Options are 'pcm_s16le_16' or 'other'.\nFor pcm_s16le_16, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono).\nLatency will be lower than with passing an encoded waveform.\n","enum":["pcm_s16le_16","other"],"nullable":true,"type":"string"},"preview_b64":{"description":"Optional preview image base64 for tracking this generation.","nullable":true,"type":"string"}},"required":["audio"],"type":"object"},"ElevenLabsCreateVoiceRequest":{"description":"Request body for creating an instant voice clone","properties":{"description":{"description":"A description of the voice.","nullable":true,"type":"string"},"files":{"description":"Audio recordings for voice cloning.","items":{"format":"binary","type":"string"},"type":"array"},"labels":{"description":"JSON string of labels for the voice (language, accent, gender, age).","nullable":true,"type":"string"},"name":{"description":"The name that identifies this voice.","type":"string"},"remove_background_noise":{"default":false,"description":"If set, removes background noise from voice samples using audio isolation.","type":"boolean"}},"required":["name","files"],"type":"object"},"ElevenLabsDialogueInput":{"description":"A single dialogue input containing text and voice ID","properties":{"text":{"description":"The text to be converted into speech.","type":"string"},"voice_id":{"description":"The ID of the voice to be used for the generation.","type":"string"}},"required":["text","voice_id"],"type":"object"},"ElevenLabsDialogueSettings":{"description":"Settings controlling the dialogue generation","nullable":true,"properties":{"stability":{"default":0.5,"description":"Determines how stable the voice is and the randomness between each generation.\nLower values introduce broader emotional range for the voice.\nHigher values can result in a monotonous voice with limited emotion.\n","format":"double","nullable":true,"type":"number"}},"type":"object"},"ElevenLabsPronunciationDictionaryLocator":{"description":"Locator for a pronunciation dictionary","properties":{"pronunciation_dictionary_id":{"description":"The ID of the pronunciation dictionary","type":"string"},"version_id":{"description":"The version ID of the pronunciation dictionary","type":"string"}},"required":["pronunciation_dictionary_id","version_id"],"type":"object"},"ElevenLabsSTTAdditionalFormat":{"description":"Additional format response for transcript export","properties":{"content":{"description":"The content of the additional format.","type":"string"},"content_type":{"description":"The content type of the additional format.","type":"string"},"file_extension":{"description":"The file extension of the additional format.","type":"string"},"is_base64_encoded":{"description":"Whether the content is base64 encoded.","type":"boolean"},"requested_format":{"description":"The requested format.","type":"string"}},"required":["requested_format","file_extension","content_type","is_base64_encoded","content"],"type":"object"},"ElevenLabsSTTCharacter":{"description":"Character information with timing","properties":{"end":{"description":"The end time of the character in seconds.","format":"double","nullable":true,"type":"number"},"start":{"description":"The start time of the character in seconds.","format":"double","nullable":true,"type":"number"},"text":{"description":"The character that was transcribed.","type":"string"}},"required":["text"],"type":"object"},"ElevenLabsSTTDetectedEntity":{"description":"Detected entity in transcript","properties":{"end_char":{"description":"End character position in the transcript text.","type":"integer"},"entity_type":{"description":"The type of entity detected (e.g., 'credit_card', 'email_address', 'person_name').","type":"string"},"start_char":{"description":"Start character position in the transcript text.","type":"integer"},"text":{"description":"The text that was identified as an entity.","type":"string"}},"required":["text","entity_type","start_char","end_char"],"type":"object"},"ElevenLabsSTTExportOptions":{"description":"Export format options for speech-to-text transcripts","properties":{"format":{"description":"The output format for the transcript export.","enum":["segmented_json","docx","pdf","txt","html","srt"],"type":"string"},"include_speakers":{"default":true,"description":"Whether to include speaker labels in the export.","type":"boolean"},"include_timestamps":{"default":true,"description":"Whether to include timestamps in the export.","type":"boolean"},"max_characters_per_line":{"description":"Maximum characters per line (for txt and srt formats).","nullable":true,"type":"integer"},"max_segment_chars":{"description":"Maximum number of characters per segment.","nullable":true,"type":"integer"},"max_segment_duration_s":{"description":"Maximum duration of each segment in seconds.","format":"double","nullable":true,"type":"number"},"segment_on_silence_longer_than_s":{"description":"Segment the transcript when silence is longer than this value in seconds.","format":"double","nullable":true,"type":"number"}},"required":["format"],"type":"object"},"ElevenLabsSTTRequest":{"description":"Request body for ElevenLabs Speech-to-Text","properties":{"additional_formats":{"description":"A list of additional formats to export the transcript to.","items":{"$ref":"#/components/schemas/ElevenLabsSTTExportOptions"},"nullable":true,"type":"array"},"cloud_storage_url":{"description":"The HTTPS URL of the file to transcribe. Exactly one of file or cloud_storage_url parameters must be provided.\nThe file must be accessible via HTTPS and the file size must be less than 2GB.\n","nullable":true,"type":"string"},"diarization_threshold":{"description":"Diarization threshold to apply during speaker diarization.\nA higher value means there will be a lower chance of one speaker being diarized as two different speakers.\nCan only be set when diarize=True and num_speakers=None. Defaults to None.\n","format":"double","nullable":true,"type":"number"},"diarize":{"default":false,"description":"Whether to annotate which speaker is currently talking in the uploaded file.","type":"boolean"},"entity_detection":{"description":"Detect entities in the transcript. Can be 'all' to detect all entities,\na single entity type or category string, or a list of entity types/categories.\nCategories include 'pii', 'phi', 'pci', 'other', 'offensive_language'.\nWhen enabled, detected entities will be returned in the 'entities' field\nwith their text, type, and character positions. Usage of this parameter will incur additional costs.\n","nullable":true,"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"file":{"description":"The file to transcribe. All major audio and video formats are supported.\nExactly one of file or cloud_storage_url parameters must be provided.\nThe file size must be less than 3.0GB.\n","format":"binary","type":"string"},"file_format":{"default":"other","description":"The format of input audio. Options are 'pcm_s16le_16' or 'other'.\nFor pcm_s16le_16, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono).\n","enum":["pcm_s16le_16","other"],"type":"string"},"keyterms":{"description":"A list of keyterms to bias the transcription towards.\nThe number of keyterms cannot exceed 100 and each keyterm must be less than 50 characters.\n","items":{"type":"string"},"nullable":true,"type":"array"},"language_code":{"description":"An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file.\nCan sometimes improve transcription performance if known beforehand.\nDefaults to null, in this case the language is predicted automatically.\n","nullable":true,"type":"string"},"model_id":{"description":"The ID of the model to use for transcription.","enum":["scribe_v1","scribe_v2"],"type":"string"},"num_speakers":{"description":"The maximum amount of speakers talking in the uploaded file.\nCan help with predicting who speaks when. The maximum amount of speakers that can be predicted is 32.\nDefaults to null, in this case the amount of speakers is set to the maximum value the model supports.\n","nullable":true,"type":"integer"},"seed":{"description":"If specified, our system will make a best effort to sample deterministically.\nMust be an integer between 0 and 2147483647.\n","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"},"tag_audio_events":{"default":true,"description":"Whether to tag audio events like (laughter), (footsteps), etc. in the transcription.","type":"boolean"},"temperature":{"description":"Controls the randomness of the transcription output. Accepts values between 0.0 and 2.0.\nHigher values result in more diverse and less deterministic results.\n","format":"double","nullable":true,"type":"number"},"timestamps_granularity":{"default":"word","description":"The granularity of the timestamps in the transcription.\n'word' provides word-level timestamps and 'character' provides character-level timestamps per word.\n","enum":["none","word","character"],"type":"string"},"use_multi_channel":{"default":false,"description":"Whether the audio file contains multiple channels where each channel contains a single speaker.\nWhen enabled, each channel will be transcribed independently and the results will be combined.\nA maximum of 5 channels is supported.\n","type":"boolean"},"webhook":{"default":false,"description":"Whether to send the transcription result to configured speech-to-text webhooks.\nIf set the request will return early without the transcription, which will be delivered later via webhook.\n","type":"boolean"},"webhook_id":{"description":"Optional specific webhook ID to send the transcription result to.\nOnly valid when webhook is set to true.\n","nullable":true,"type":"string"},"webhook_metadata":{"description":"Optional metadata to be included in the webhook response.\nThis should be a JSON string representing an object with a maximum depth of 2 levels and maximum size of 16KB.\n","nullable":true,"type":"string"}},"required":["model_id"],"type":"object"},"ElevenLabsSTTResponse":{"description":"Response from ElevenLabs Speech-to-Text","properties":{"additional_formats":{"description":"Requested additional formats of the transcript.","items":{"$ref":"#/components/schemas/ElevenLabsSTTAdditionalFormat"},"nullable":true,"type":"array"},"channel_index":{"description":"The channel index this transcript belongs to (for multichannel audio).","nullable":true,"type":"integer"},"entities":{"description":"List of detected entities with their text, type, and character positions.","items":{"$ref":"#/components/schemas/ElevenLabsSTTDetectedEntity"},"nullable":true,"type":"array"},"language_code":{"description":"The detected language code (e.g. 'eng' for English).","type":"string"},"language_probability":{"description":"The confidence score of the language detection (0 to 1).","format":"double","type":"number"},"message":{"description":"Message for webhook responses.","nullable":true,"type":"string"},"request_id":{"description":"Request ID for webhook responses.","nullable":true,"type":"string"},"text":{"description":"The raw text of the transcription.","type":"string"},"transcription_id":{"description":"The transcription ID of the response.","nullable":true,"type":"string"},"transcripts":{"description":"List of transcripts for multichannel audio (when use_multi_channel is true).","items":{"$ref":"#/components/schemas/ElevenLabsSTTTranscript"},"nullable":true,"type":"array"},"words":{"description":"List of words with their timing information.","items":{"$ref":"#/components/schemas/ElevenLabsSTTWord"},"type":"array"}},"type":"object"},"ElevenLabsSTTTranscript":{"description":"Individual transcript for multichannel audio","properties":{"additional_formats":{"description":"Requested additional formats.","items":{"$ref":"#/components/schemas/ElevenLabsSTTAdditionalFormat"},"nullable":true,"type":"array"},"channel_index":{"description":"The channel index this transcript belongs to.","nullable":true,"type":"integer"},"entities":{"description":"List of detected entities.","items":{"$ref":"#/components/schemas/ElevenLabsSTTDetectedEntity"},"nullable":true,"type":"array"},"language_code":{"description":"The detected language code.","type":"string"},"language_probability":{"description":"The confidence score of the language detection.","format":"double","type":"number"},"text":{"description":"The raw text of the transcription.","type":"string"},"words":{"description":"List of words with their timing information.","items":{"$ref":"#/components/schemas/ElevenLabsSTTWord"},"type":"array"}},"type":"object"},"ElevenLabsSTTWord":{"description":"Word information from speech-to-text transcription","properties":{"characters":{"description":"The characters that make up the word and their timing information.","items":{"$ref":"#/components/schemas/ElevenLabsSTTCharacter"},"nullable":true,"type":"array"},"end":{"description":"The end time of the word or sound in seconds.","format":"double","nullable":true,"type":"number"},"logprob":{"description":"The log of the probability with which this word was predicted.\nLogprobs are in range [-infinity, 0], higher logprobs indicate higher confidence.\n","format":"double","type":"number"},"speaker_id":{"description":"Unique identifier for the speaker of this word.","nullable":true,"type":"string"},"start":{"description":"The start time of the word or sound in seconds.","format":"double","nullable":true,"type":"number"},"text":{"description":"The word or sound that was transcribed.","type":"string"},"type":{"description":"The type of the word or sound.\n'audio_event' is used for non-word sounds like laughter or footsteps.\n","enum":["word","spacing","audio_event"],"type":"string"}},"required":["text","type","logprob"],"type":"object"},"ElevenLabsSharedVoice":{"properties":{"accent":{"type":"string"},"age":{"type":"string"},"category":{"enum":["generated","cloned","premade","professional","famous","high_quality"],"type":"string"},"cloned_by_count":{"type":"integer"},"date_unix":{"type":"integer"},"description":{"nullable":true,"type":"string"},"descriptive":{"type":"string"},"featured":{"type":"boolean"},"fiat_rate":{"description":"The rate of the voice in USD per 1000 credits. null if default.","format":"double","nullable":true,"type":"number"},"free_users_allowed":{"type":"boolean"},"gender":{"type":"string"},"image_url":{"nullable":true,"type":"string"},"instagram_username":{"nullable":true,"type":"string"},"is_added_by_user":{"nullable":true,"type":"boolean"},"is_bookmarked":{"nullable":true,"type":"boolean"},"language":{"nullable":true,"type":"string"},"live_moderation_enabled":{"type":"boolean"},"locale":{"nullable":true,"type":"string"},"name":{"type":"string"},"notice_period":{"nullable":true,"type":"integer"},"play_api_usage_character_count_1y":{"type":"integer"},"preview_url":{"nullable":true,"type":"string"},"public_owner_id":{"type":"string"},"rate":{"format":"double","nullable":true,"type":"number"},"tiktok_username":{"nullable":true,"type":"string"},"twitter_username":{"nullable":true,"type":"string"},"usage_character_count_1y":{"type":"integer"},"usage_character_count_7d":{"type":"integer"},"use_case":{"type":"string"},"verified_languages":{"description":"The verified languages of the voice.","items":{"$ref":"#/components/schemas/ElevenLabsVerifiedVoiceLanguage"},"nullable":true,"type":"array"},"voice_id":{"type":"string"},"youtube_username":{"nullable":true,"type":"string"}},"required":["public_owner_id","voice_id","date_unix","name","accent","gender","age","descriptive","use_case","category","usage_character_count_1y","usage_character_count_7d","play_api_usage_character_count_1y","cloned_by_count","free_users_allowed","live_moderation_enabled","featured"],"type":"object"},"ElevenLabsSharedVoicesPaginatedResponse":{"description":"Paginated response shape returned by the shared-voices proxy to match the\nfrontend's `RichComboWidget` progressive-fetch contract.\n","properties":{"has_more":{"description":"Whether there are more shared voices in subsequent pages.","type":"boolean"},"items":{"description":"The list of shared voices on this page.","items":{"$ref":"#/components/schemas/ElevenLabsSharedVoice"},"type":"array"}},"required":["items","has_more"],"type":"object"},"ElevenLabsSoundGenerationRequest":{"description":"Request body for generating sound effects from text","properties":{"duration_seconds":{"description":"The duration of the sound which will be generated in seconds.\nMust be at least 0.5 and at most 30. If set to null, the optimal\nduration will be guessed using the prompt. Defaults to null.\n","format":"double","nullable":true,"type":"number"},"loop":{"default":false,"description":"Whether to create a sound effect that loops smoothly.\nOnly available for the 'eleven_text_to_sound_v2' model.\n","type":"boolean"},"model_id":{"default":"eleven_text_to_sound_v2","description":"The model ID to use for the sound generation.","type":"string"},"prompt_influence":{"description":"A higher prompt influence makes your generation follow the prompt\nmore closely while also making generations less variable.\nMust be a value between 0 and 1. Defaults to 0.3.\n","format":"double","type":"number"},"text":{"description":"The text that will get converted into a sound effect.","type":"string"}},"required":["text"],"type":"object"},"ElevenLabsSpeechToSpeechRequest":{"description":"Request body for ElevenLabs Speech-to-Speech (Voice Changer)","properties":{"audio":{"description":"The audio file which holds the content and emotion that will control the generated speech.","format":"binary","type":"string"},"file_format":{"default":"other","description":"The format of input audio. Options are 'pcm_s16le_16' or 'other'.\nFor pcm_s16le_16, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono).\n","enum":["pcm_s16le_16","other"],"nullable":true,"type":"string"},"model_id":{"default":"eleven_english_sts_v2","description":"Identifier of the model that will be used. Query GET /v1/models to list available models.\nThe model needs to have support for speech to speech (can_do_voice_conversion property).\n","type":"string"},"remove_background_noise":{"default":false,"description":"If set, will remove the background noise from your audio input using our audio isolation model.\nOnly applies to Voice Changer.\n","type":"boolean"},"seed":{"description":"If specified, our system will make a best effort to sample deterministically.\nRepeated requests with the same seed and parameters should return the same result.\nMust be integer between 0 and 4294967295.\n","maximum":4294967295,"minimum":0,"nullable":true,"type":"integer"},"voice_settings":{"description":"Voice settings overriding stored settings for the given voice.\nThey are applied only on the given request. Needs to be sent as a JSON encoded string.\n","nullable":true,"type":"string"}},"required":["audio"],"type":"object"},"ElevenLabsTTSRequest":{"description":"Request body for ElevenLabs Text to Speech","properties":{"apply_language_text_normalization":{"default":false,"description":"Controls language-specific text normalization. Can heavily increase latency. Currently only supported for Japanese.","type":"boolean"},"apply_text_normalization":{"default":"auto","description":"Controls text normalization. 'auto' lets the system decide, 'on' always applies normalization,\n'off' skips normalization.\n","enum":["auto","on","off"],"type":"string"},"language_code":{"description":"Language code (ISO 639-1) to enforce for the model. If unsupported, an error is returned.","nullable":true,"type":"string"},"model_id":{"default":"eleven_multilingual_v2","description":"Identifier of the model to use. Query /v1/models to list available models.","type":"string"},"next_request_ids":{"description":"Request IDs of next generations for continuity. Maximum 3.","items":{"type":"string"},"maxItems":3,"nullable":true,"type":"array"},"next_text":{"description":"Text that comes after this request, used to improve speech continuity.","nullable":true,"type":"string"},"previous_request_ids":{"description":"Request IDs of previous generations for continuity. Maximum 3.","items":{"type":"string"},"maxItems":3,"nullable":true,"type":"array"},"previous_text":{"description":"Text that came before this request, used to improve speech continuity.","nullable":true,"type":"string"},"pronunciation_dictionary_locators":{"description":"List of pronunciation dictionary locators (id, version_id). Maximum 3 per request.","items":{"$ref":"#/components/schemas/ElevenLabsPronunciationDictionaryLocator"},"maxItems":3,"nullable":true,"type":"array"},"seed":{"description":"Seed for deterministic generation. Must be between 0 and 4294967295.","maximum":4294967295,"minimum":0,"nullable":true,"type":"integer"},"text":{"description":"The text that will be converted into speech.","type":"string"},"use_pvc_as_ivc":{"default":false,"description":"Deprecated. If true, uses IVC version of voice instead of PVC.","type":"boolean"},"voice_settings":{"$ref":"#/components/schemas/ElevenLabsVoiceSettings"}},"required":["text"],"type":"object"},"ElevenLabsTextToDialogueRequest":{"description":"Request body for ElevenLabs Text-to-Dialogue (multi-voice TTS)","properties":{"apply_text_normalization":{"default":"auto","description":"Controls text normalization with three modes:\n'auto' - system automatically decides whether to apply text normalization\n'on' - text normalization will always be applied\n'off' - text normalization will be skipped\n","enum":["auto","on","off"],"type":"string"},"inputs":{"description":"A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.\nThe maximum number of unique voice IDs is 10.\n","items":{"$ref":"#/components/schemas/ElevenLabsDialogueInput"},"type":"array"},"language_code":{"description":"Language code (ISO 639-1) used to enforce a language for the model and text normalization.\nIf the model does not support provided language code, an error will be returned.\n","nullable":true,"type":"string"},"model_id":{"default":"eleven_v3","description":"Identifier of the model that will be used. Query GET /v1/models to list available models.\nThe model needs to have support for text to speech (can_do_text_to_speech property).\n","type":"string"},"pronunciation_dictionary_locators":{"description":"A list of pronunciation dictionary locators (id, version_id) to be applied to the text.\nThey will be applied in order. You may have up to 3 locators per request.\n","items":{"$ref":"#/components/schemas/ElevenLabsPronunciationDictionaryLocator"},"maxItems":3,"nullable":true,"type":"array"},"seed":{"description":"If specified, our system will make a best effort to sample deterministically.\nRepeated requests with the same seed and parameters should return the same result.\nMust be integer between 0 and 4294967295.\n","maximum":4294967295,"minimum":0,"nullable":true,"type":"integer"},"settings":{"$ref":"#/components/schemas/ElevenLabsDialogueSettings"}},"required":["inputs"],"type":"object"},"ElevenLabsValidationError":{"description":"Validation error response from ElevenLabs","properties":{"detail":{"description":"Details about the validation error","properties":{"message":{"description":"Error message","type":"string"},"status":{"description":"Error status","type":"string"}},"type":"object"}},"type":"object"},"ElevenLabsVerifiedVoiceLanguage":{"properties":{"accent":{"description":"The voice's accent, if applicable.","nullable":true,"type":"string"},"language":{"description":"The language of the voice.","type":"string"},"locale":{"description":"The voice's locale, if applicable.","nullable":true,"type":"string"},"model_id":{"description":"The voice's model ID.","type":"string"},"preview_url":{"description":"The voice's preview URL, if applicable.","nullable":true,"type":"string"}},"required":["language","model_id"],"type":"object"},"ElevenLabsVoice":{"description":"A voice from the authenticated account's voice library (e.g. a premade voice).","properties":{"category":{"description":"Voice category (e.g. \"premade\", \"cloned\", \"generated\", \"professional\").","type":"string"},"description":{"nullable":true,"type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Free-form string labels attached to the voice (e.g. accent, gender, age, use_case).","nullable":true,"type":"object"},"name":{"type":"string"},"preview_url":{"nullable":true,"type":"string"},"verified_languages":{"description":"The verified languages of the voice.","items":{"$ref":"#/components/schemas/ElevenLabsVerifiedVoiceLanguage"},"nullable":true,"type":"array"},"voice_id":{"type":"string"}},"required":["voice_id","name","category"],"type":"object"},"ElevenLabsVoiceSettings":{"description":"Voice settings configuration","nullable":true,"properties":{"similarity_boost":{"default":0.75,"description":"How closely the AI adheres to the original voice when replicating it.","format":"double","maximum":1,"minimum":0,"nullable":true,"type":"number"},"speed":{"default":1,"description":"Speed adjustment. 1.0 is default, values below slow down, values above speed up.","format":"double","maximum":1.2,"minimum":0.7,"nullable":true,"type":"number"},"stability":{"default":0.5,"description":"Stability of the voice. Lower values introduce broader emotional range.","format":"double","maximum":1,"minimum":0,"nullable":true,"type":"number"},"style":{"default":0,"description":"Style exaggeration. Amplifies the style of the original speaker.","format":"double","maximum":1,"minimum":0,"nullable":true,"type":"number"},"use_speaker_boost":{"default":true,"description":"Boosts similarity to the original speaker. Requires higher computational load.","nullable":true,"type":"boolean"}},"type":"object"},"ElevenLabsVoicesPaginatedResponse":{"description":"Paginated response shape returned by the premade-voices proxy.\nMirrors ElevenLabs `/v2/voices`, renaming `voices` to `items` to\nmatch the frontend's `RichComboWidget` progressive-fetch contract.\n","properties":{"has_more":{"description":"Whether there are more voices in subsequent pages.","type":"boolean"},"items":{"description":"The list of premade voices on this page.","items":{"$ref":"#/components/schemas/ElevenLabsVoice"},"type":"array"},"next_page_token":{"description":"Cursor to pass to the next request to fetch the next page.","nullable":true,"type":"string"}},"required":["items","has_more"],"type":"object"},"Error":{"properties":{"details":{"description":"Optional detailed information about the error or hints for resolving it.","items":{"type":"string"},"type":"array"},"message":{"description":"A clear and concise description of the error.","type":"string"}},"type":"object"},"ErrorResponse":{"properties":{"error":{"type":"string"},"message":{"type":"string"}},"required":["error","message"],"type":"object"},"FeaturesResponse":{"properties":{"partner_node_conversion_rate":{"description":"The conversion rate for partner nodes","example":0.5,"type":"number"}},"required":["partner_node_conversion_rate"],"type":"object"},"FileSearchTool":{"properties":{"type":{"description":"The type of tool","enum":["file_search"],"type":"string"},"vector_store_ids":{"description":"IDs of vector stores to search in","items":{"type":"string"},"type":"array"}},"required":["type","vector_store_ids"],"type":"object"},"FileSearchToolCall":{"description":"The results of a file search tool call. See the\n[file search guide](/docs/guides/tools-file-search) for more information.\n","properties":{"id":{"description":"The unique ID of the file search tool call.\n","type":"string"},"queries":{"description":"The queries used to search for files.\n","items":{"type":"string"},"type":"array"},"results":{"description":"The results of the file search tool call.\n","items":{"properties":{"file_id":{"description":"The unique ID of the file.\n","type":"string"},"filename":{"description":"The name of the file.\n","type":"string"},"score":{"description":"The relevance score of the file - a value between 0 and 1.\n","format":"float","type":"number"},"text":{"description":"The text that was retrieved from the file.\n","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of the file search tool call. One of `in_progress`,\n`searching`, `incomplete` or `failed`,\n","enum":["in_progress","searching","completed","incomplete","failed"],"type":"string"},"type":{"description":"The type of the file search tool call. Always `file_search_call`.\n","enum":["file_search_call"],"type":"string","x-stainless-const":true}},"required":["id","type","status","queries"],"title":"File search tool call","type":"object"},"FreepikErrorResponse":{"properties":{"error":{"type":"string"},"message":{"type":"string"}},"type":"object"},"FreepikMagnificRelightRequest":{"properties":{"advanced_settings":{"properties":{"blacks":{"default":50,"description":"Adjust the level of black color in the image.","maximum":100,"minimum":0,"type":"integer"},"brightness":{"default":50,"description":"Adjust the level of brightness in the image.","maximum":100,"minimum":0,"type":"integer"},"contrast":{"default":50,"description":"Adjust the level of contrast in the image.","maximum":100,"minimum":0,"type":"integer"},"engine":{"default":"automatic","description":"Engine preset for relighting:\n- balanced: Well-rounded, general-purpose option\n- cool: Brighter with cooler tones\n- real: Aims to enhance photographic quality (Experimental)\n- illusio: Optimized for illustrations and drawings\n- fairy: Suited for fantasy-themed images\n- colorful_anime: Ideal for anime, cartoons, and vibrant colors\n- hard_transform: Significantly alters the original image\n- softy: Slightly softer effect, suitable for graphic designs\n","enum":["automatic","balanced","cool","real","illusio","fairy","colorful_anime","hard_transform","softy"],"type":"string"},"fixed_generation":{"default":false,"description":"When enabled, using the same settings will consistently produce the same image.","type":"boolean"},"saturation":{"default":50,"description":"Adjust the level of saturation in the image.","maximum":100,"minimum":0,"type":"integer"},"transfer_light_a":{"default":"automatic","description":"Adjusts the intensity of light transfer.","enum":["automatic","low","medium","normal","high","high_on_faces"],"type":"string"},"transfer_light_b":{"default":"automatic","description":"Also modifies light transfer intensity. Can be combined with transfer_light_a for varied effects.","enum":["automatic","composition","straight","smooth_in","smooth_out","smooth_both","reverse_both","soft_in","soft_out","soft_mid","strong_mid","style_shift","strong_shift"],"type":"string"},"whites":{"default":50,"description":"Adjust the level of white color in the image.","maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"change_background":{"default":true,"description":"When enabled, changes the background based on prompt and/or reference image. Useful for product placement and portraits.","type":"boolean"},"image":{"description":"Base64 or URL of the image to do the relight","type":"string"},"interpolate_from_original":{"default":false,"description":"When enabled, makes the final image interpolate from the original using the light transfer strength slider.","type":"boolean"},"light_transfer_strength":{"default":100,"description":"Level of light transfer intensity. 0% keeps closest to original, 100% is maximum transfer.","maximum":100,"minimum":0,"type":"integer"},"preserve_details":{"default":true,"description":"Maintains texture and small details of the original image. Good for product photography, texts, etc.","type":"boolean"},"prompt":{"description":"You can guide the generation process and influence the light transfer with a descriptive prompt.\nIMPORTANT: You can emphasize specific aspects of the light in your prompt by using a number in parentheses, ranging from 1 to 1.4, like \"(dark scene:1.3)\".\n","type":"string"},"style":{"default":"standard","description":"Style preset for the relight operation.","enum":["standard","darker_but_realistic","clean","smooth","brighter","contrasted_n_hdr","just_composition"],"type":"string"},"transfer_light_from_lightmap":{"description":"Base64 or URL of the lightmap for light transfer. Incompatible with 'transfer_light_from_reference_image'","type":"string"},"transfer_light_from_reference_image":{"description":"Base64 or URL of the reference image for light transfer. Incompatible with 'transfer_light_from_lightmap'","type":"string"},"webhook_url":{"description":"Optional callback URL that will receive asynchronous notifications whenever the task changes status.","example":"https://www.example.com/webhook","format":"uri","type":"string"}},"required":["image"],"type":"object"},"FreepikMagnificStyleTransferRequest":{"properties":{"engine":{"default":"balanced","description":"Engine preset for style transfer","enum":["balanced","definio","illusio","3d_cartoon","colorful_anime","caricature","real","super_real","softy"],"type":"string"},"fixed_generation":{"default":false,"description":"When enabled, using the same settings will consistently produce the same image.","type":"boolean"},"flavor":{"default":"faithful","description":"Flavor of the transferring style","enum":["faithful","gen_z","psychedelia","detaily","clear","donotstyle","donotstyle_sharp"],"type":"string"},"image":{"description":"Base64 or URL of the image to do the style transfer","type":"string"},"is_portrait":{"default":false,"description":"Indicates whether the image should be processed as a portrait.","type":"boolean"},"portrait_beautifier":{"description":"Facial beautification on portrait images. Only used if is_portrait is true.","enum":["beautify_face","beautify_face_max"],"type":"string"},"portrait_style":{"default":"standard","description":"Visual style applied to portrait images. Only used if is_portrait is true.","enum":["standard","pop","super_pop"],"type":"string"},"prompt":{"description":"Prompt for the AI model","type":"string"},"reference_image":{"description":"Base64 or URL of the reference image for style transfer","type":"string"},"structure_strength":{"default":50,"description":"Allows to maintain the structure of the original image","maximum":100,"minimum":0,"type":"integer"},"style_strength":{"default":100,"description":"Percentage of style strength","maximum":100,"minimum":0,"type":"integer"},"webhook_url":{"description":"Optional callback URL for async notifications.","example":"https://www.example.com/webhook","format":"uri","type":"string"}},"required":["image","reference_image"],"type":"object"},"FreepikMagnificUpscalerCreativeRequest":{"properties":{"creativity":{"default":0,"description":"Increase or decrease AI's creativity. Valid values range [-10, 10].","maximum":10,"minimum":-10,"type":"integer"},"engine":{"default":"automatic","description":"Magnific model engines.","enum":["automatic","magnific_illusio","magnific_sharpy","magnific_sparkle"],"type":"string"},"fractality":{"default":0,"description":"Control the strength of the prompt and intricacy per square pixel. Valid values range [-10, 10].","maximum":10,"minimum":-10,"type":"integer"},"hdr":{"default":0,"description":"Increase or decrease the level of definition and detail. Valid values range [-10, 10].","maximum":10,"minimum":-10,"type":"integer"},"image":{"description":"Base64 image or URL to upscale. The resulted image can't exceed maximum allowed size of 25.3 million pixels.","type":"string"},"optimized_for":{"default":"standard","description":"Styles to optimize the upscale process.","enum":["standard","soft_portraits","hard_portraits","art_n_illustration","videogame_assets","nature_n_landscapes","films_n_photography","3d_renders","science_fiction_n_horror"],"type":"string"},"prompt":{"description":"Prompt to guide the upscale process. Reusing the same prompt for AI-generated images will improve the results.","type":"string"},"resemblance":{"default":0,"description":"Adjust the level of resemblance to the original image. Valid values range [-10, 10].","maximum":10,"minimum":-10,"type":"integer"},"scale_factor":{"default":"2x","description":"Configure scale factor of the image. For higher scales, the image will take longer to process.","enum":["2x","4x","8x","16x"],"type":"string"},"webhook_url":{"description":"Optional callback URL that will receive asynchronous notifications whenever the task changes status.","example":"https://www.example.com/webhook","format":"uri","type":"string"}},"required":["image"],"type":"object"},"FreepikMagnificUpscalerPrecisionV2Request":{"properties":{"flavor":{"description":"Image processing flavor:\n- sublime: Optimized for artistic and illustrated images\n- photo: Optimized for photographic images\n- photo_denoiser: Specialized for photos with noise reduction\n","enum":["sublime","photo","photo_denoiser"],"type":"string"},"image":{"description":"Source image to upscale. Accepts either:\n- A publicly accessible HTTPS URL pointing to the image\n- A base64-encoded image string\n","type":"string"},"scale_factor":{"description":"Image scaling factor. Determines how much larger the output will be compared to input.","maximum":16,"minimum":2,"type":"integer"},"sharpen":{"default":7,"description":"Image sharpness intensity control. Higher values increase edge definition and clarity.","maximum":100,"minimum":0,"type":"integer"},"smart_grain":{"default":7,"description":"Intelligent grain/texture enhancement. Higher values add more fine-grained texture.","maximum":100,"minimum":0,"type":"integer"},"ultra_detail":{"default":30,"description":"Ultra detail enhancement level. Higher values create more intricate details.","maximum":100,"minimum":0,"type":"integer"},"webhook_url":{"description":"Optional callback URL that will receive asynchronous notifications when the upscaling task completes.","format":"uri","type":"string"}},"required":["image"],"type":"object"},"FreepikSkinEnhancerCreativeRequest":{"properties":{"image":{"description":"Input image. Supports Base64 encoding or HTTPS URL (must be publicly accessible).","example":"https://example.com/portrait.jpg","type":"string"},"sharpen":{"default":0,"description":"Sharpening intensity","maximum":100,"minimum":0,"type":"integer"},"smart_grain":{"default":2,"description":"Smart grain intensity","maximum":100,"minimum":0,"type":"integer"},"webhook_url":{"description":"Optional callback URL for async notifications.","example":"https://www.example.com/webhook","format":"uri","type":"string"}},"required":["image"],"type":"object"},"FreepikSkinEnhancerFaithfulRequest":{"properties":{"image":{"description":"Input image. Supports Base64 encoding or HTTPS URL (must be publicly accessible).","example":"https://example.com/portrait.jpg","type":"string"},"sharpen":{"default":0,"description":"Sharpening intensity","maximum":100,"minimum":0,"type":"integer"},"skin_detail":{"default":80,"description":"Skin detail enhancement level","maximum":100,"minimum":0,"type":"integer"},"smart_grain":{"default":2,"description":"Smart grain intensity","maximum":100,"minimum":0,"type":"integer"},"webhook_url":{"description":"Optional callback URL for async notifications.","example":"https://www.example.com/webhook","format":"uri","type":"string"}},"required":["image"],"type":"object"},"FreepikSkinEnhancerFlexibleRequest":{"properties":{"image":{"description":"Input image. Supports Base64 encoding or HTTPS URL (must be publicly accessible).","example":"https://example.com/portrait.jpg","type":"string"},"optimized_for":{"default":"enhance_skin","description":"Optimization target for flexible skin enhancer","enum":["enhance_skin","improve_lighting","enhance_everything","transform_to_real","no_make_up"],"type":"string"},"sharpen":{"default":0,"description":"Sharpening intensity","maximum":100,"minimum":0,"type":"integer"},"smart_grain":{"default":2,"description":"Smart grain intensity","maximum":100,"minimum":0,"type":"integer"},"webhook_url":{"description":"Optional callback URL for async notifications.","example":"https://www.example.com/webhook","format":"uri","type":"string"}},"required":["image"],"type":"object"},"FreepikTaskData":{"properties":{"generated":{"description":"URLs to the generated images.","items":{"format":"uri","type":"string"},"type":"array"},"status":{"enum":["CREATED","IN_PROGRESS","COMPLETED","FAILED"],"type":"string"},"task_id":{"example":"046b6c7f-0b8a-43b9-b35d-6489e6daee91","format":"uuid","type":"string"}},"type":"object"},"FreepikTaskResponse":{"properties":{"data":{"$ref":"#/components/schemas/FreepikTaskData"}},"required":["data"],"type":"object"},"FunctionTool":{"properties":{"description":{"description":"Description of what the function does","type":"string"},"name":{"description":"Name of the function","type":"string"},"parameters":{"description":"JSON Schema object describing the function parameters","type":"object"},"type":{"description":"The type of tool","enum":["function"],"type":"string"}},"required":["type","name","parameters"],"type":"object"},"FunctionToolCall":{"description":"A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.\n","properties":{"arguments":{"description":"A JSON string of the arguments to pass to the function.\n","type":"string"},"call_id":{"description":"The unique ID of the function tool call generated by the model.\n","type":"string"},"id":{"description":"The unique ID of the function tool call.\n","type":"string"},"name":{"description":"The name of the function to run.\n","type":"string"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"],"type":"string"},"type":{"description":"The type of the function tool call. Always `function_call`.\n","enum":["function_call"],"type":"string","x-stainless-const":true}},"required":["type","call_id","name","arguments"],"title":"Function tool call","type":"object"},"GeminiCandidate":{"properties":{"citationMetadata":{"$ref":"#/components/schemas/GeminiCitationMetadata"},"content":{"$ref":"#/components/schemas/GeminiContent"},"finishReason":{"type":"string"},"safetyRatings":{"items":{"$ref":"#/components/schemas/GeminiSafetyRating"},"type":"array"}},"type":"object"},"GeminiCitation":{"properties":{"authors":{"items":{"type":"string"},"type":"array"},"endIndex":{"type":"integer"},"license":{"type":"string"},"publicationDate":{"format":"date","type":"string"},"startIndex":{"type":"integer"},"title":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"GeminiCitationMetadata":{"properties":{"citations":{"items":{"$ref":"#/components/schemas/GeminiCitation"},"type":"array"}},"type":"object"},"GeminiContent":{"description":"The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history and the latest request.\n","properties":{"parts":{"items":{"$ref":"#/components/schemas/GeminiPart"},"type":"array"},"role":{"enum":["user","model"],"example":"user","type":"string"}},"required":["role","parts"],"type":"object"},"GeminiFileData":{"description":"URI based data.","properties":{"fileUri":{"description":"URI","type":"string"},"mimeType":{"$ref":"#/components/schemas/GeminiMimeType"}},"type":"object"},"GeminiFunctionDeclaration":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"parameters":{"description":"JSON schema for the function parameters","type":"object"}},"required":["name","parameters"],"type":"object"},"GeminiGenerateContentRequest":{"properties":{"contents":{"items":{"$ref":"#/components/schemas/GeminiContent"},"type":"array"},"generationConfig":{"$ref":"#/components/schemas/GeminiGenerationConfig"},"safetySettings":{"items":{"$ref":"#/components/schemas/GeminiSafetySetting"},"type":"array"},"systemInstruction":{"$ref":"#/components/schemas/GeminiSystemInstructionContent"},"tools":{"items":{"$ref":"#/components/schemas/GeminiTool"},"type":"array"},"uploadImagesToStorage":{"description":"If true, generated images will be uploaded to cloud storage and returned as signed URLs instead of inline base64 data. The URLs expire after 24 hours.","type":"boolean"},"videoMetadata":{"$ref":"#/components/schemas/GeminiVideoMetadata"}},"required":["contents"],"type":"object"},"GeminiGenerateContentResponse":{"properties":{"candidates":{"items":{"$ref":"#/components/schemas/GeminiCandidate"},"type":"array"},"createTime":{"description":"Timestamp when the response was created.","type":"string"},"modelVersion":{"description":"The model version used to generate the response.","type":"string"},"promptFeedback":{"$ref":"#/components/schemas/GeminiPromptFeedback"},"responseId":{"description":"Unique identifier for the response.","type":"string"},"usageMetadata":{"$ref":"#/components/schemas/GeminiUsageMetadata"}},"type":"object"},"GeminiGenerationConfig":{"properties":{"imageConfig":{"description":"Configuration for image generation","properties":{"aspectRatio":{"description":"Aspect ratio for generated images","type":"string"},"imageOutputOptions":{"description":"Optional. The image output format for generated images.","properties":{"compressionQuality":{"description":"Optional. The compression quality of the output image.","type":"integer"},"mimeType":{"description":"Optional. The image format that the output should be saved as.","type":"string"}},"type":"object"},"imageSize":{"description":"Optional. Specifies the size of generated images. Supported values are 1K, 2K, 4K. If not specified, the model will use default value 1K.","type":"string"}},"type":"object"},"maxOutputTokens":{"description":"Maximum number of tokens that can be generated in the response. A token is approximately 4 characters. 100 tokens correspond to roughly 60-80 words.\n","example":2048,"maximum":8192,"minimum":16,"type":"integer"},"responseModalities":{"items":{"enum":["TEXT","IMAGE"],"type":"string"},"type":"array"},"seed":{"description":"When seed is fixed to a specific value, the model makes a best effort to provide the same response for repeated requests. Deterministic output isn't guaranteed. Also, changing the model or parameter settings, such as the temperature, can cause variations in the response even when you use the same seed value. By default, a random seed value is used. Available for the following models:, gemini-2.5-flash, gemini-2.5-pro, gemini-2.5-flash-preview-04-1, gemini-2.5-pro-preview-05-0, gemini-2.0-flash-lite-00, gemini-2.0-flash-001\n","example":343940597,"type":"integer"},"stopSequences":{"items":{"type":"string"},"type":"array"},"temperature":{"default":1,"description":"The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature\n","format":"float","maximum":2,"minimum":0,"type":"number"},"thinkingConfig":{"description":"Optional. Configuration for thinking features. Thinking is a process where the model breaks down a complex task into smaller steps to generate a higher-quality response.","properties":{"includeThoughts":{"description":"Optional. If true, the model will include its thoughts in the response.","type":"boolean"},"thinkingBudget":{"description":"Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget.","type":"integer"},"thinkingLevel":{"description":"Optional. The thinking level for the model.","enum":["THINKING_LEVEL_UNSPECIFIED","LOW","MEDIUM","HIGH","MINIMAL"],"type":"string"}},"type":"object"},"topK":{"default":40,"description":"Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary. A top-K of 3 means that the next token is selected from among the 3 most probable tokens by using temperature.\n","example":40,"minimum":1,"type":"integer"},"topP":{"default":0.95,"description":"If specified, nucleus sampling is used.\nTop-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate.\nSpecify a lower value for less random responses and a higher value for more random responses.\n","format":"float","maximum":1,"minimum":0,"type":"number"}},"type":"object"},"GeminiInlineData":{"description":"Inline data in raw bytes. For gemini-2.0-flash-lite and gemini-2.0-flash, you can specify up to 3000 images by using inlineData.\n","properties":{"data":{"description":"The base64 encoding of the image, PDF, or video to include inline in the prompt. When including media inline, you must also specify the media type (mimeType) of the data. Size limit: 20MB\n","format":"byte","type":"string"},"mimeType":{"$ref":"#/components/schemas/GeminiMimeType"}},"type":"object"},"GeminiMimeType":{"description":"The media type of the file specified in the data or fileUri fields. Acceptable values include the following. For gemini-2.0-flash-lite and gemini-2.0-flash, the maximum length of an audio file is 8.4 hours and the maximum length of a video file (without audio) is one hour. For more information, see Gemini audio and video requirements. Text files must be UTF-8 encoded. The contents of the text file count toward the token limit. There is no limit on image resolution.","enum":["application/pdf","audio/mpeg","audio/mp3","audio/wav","image/png","image/jpeg","image/webp","text/plain","video/mov","video/mpeg","video/mp4","video/mpg","video/avi","video/wmv","video/mpegps","video/flv"],"type":"string"},"GeminiOffset":{"description":"Represents a duration offset for video timeline positions.\n","properties":{"nanos":{"description":"Signed fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values.\n","example":0,"maximum":999999999,"minimum":0,"type":"integer"},"seconds":{"description":"Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.\n","example":60,"maximum":315576000000,"minimum":-315576000000,"type":"integer"}},"type":"object"},"GeminiPart":{"properties":{"fileData":{"$ref":"#/components/schemas/GeminiFileData"},"inlineData":{"$ref":"#/components/schemas/GeminiInlineData"},"text":{"description":"A text prompt or code snippet.","example":"Write a story about a robot learning to paint","type":"string"},"thought":{"description":"Indicates this part is a thinking/reasoning step from the model.","type":"boolean"}},"type":"object"},"GeminiPromptFeedback":{"properties":{"blockReason":{"type":"string"},"blockReasonMessage":{"type":"string"},"safetyRatings":{"items":{"$ref":"#/components/schemas/GeminiSafetyRating"},"type":"array"}},"type":"object"},"GeminiSafetyCategory":{"enum":["HARM_CATEGORY_SEXUALLY_EXPLICIT","HARM_CATEGORY_HATE_SPEECH","HARM_CATEGORY_HARASSMENT","HARM_CATEGORY_DANGEROUS_CONTENT"],"type":"string"},"GeminiSafetyRating":{"properties":{"category":{"$ref":"#/components/schemas/GeminiSafetyCategory"},"probability":{"description":"The probability that the content violates the specified safety category","enum":["NEGLIGIBLE","LOW","MEDIUM","HIGH","UNKNOWN"],"type":"string"}},"type":"object"},"GeminiSafetySetting":{"description":"Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.\n","properties":{"category":{"$ref":"#/components/schemas/GeminiSafetyCategory"},"threshold":{"$ref":"#/components/schemas/GeminiSafetyThreshold"}},"required":["category","threshold"],"type":"object"},"GeminiSafetyThreshold":{"enum":["OFF","BLOCK_NONE","BLOCK_LOW_AND_ABOVE","BLOCK_MEDIUM_AND_ABOVE","BLOCK_ONLY_HIGH"],"type":"string"},"GeminiSystemInstructionContent":{"description":"Available for gemini-2.0-flash and gemini-2.0-flash-lite. Instructions for the model to steer it toward better performance. For example, \"Answer as concisely as possible\" or \"Don't use technical terms in your response\". The text strings count toward the token limit. The role field of systemInstruction is ignored and doesn't affect the performance of the model. Note: Only text should be used in parts and content in each part should be in a separate paragraph.\n","properties":{"parts":{"description":"A list of ordered parts that make up a single message. Different parts may have different IANA MIME types. For limits on the inputs, such as the maximum number of tokens or the number of images, see the model specifications on the Google models page.\n","items":{"$ref":"#/components/schemas/GeminiTextPart"},"type":"array"},"role":{"description":"The identity of the entity that creates the message. The following values are supported: user: This indicates that the message is sent by a real person, typically a user-generated message. model: This indicates that the message is generated by the model. The model value is used to insert messages from the model into the conversation during multi-turn conversations. For non-multi-turn conversations, this field can be left blank or unset.\n","enum":["user","model"],"example":"user","type":"string"}},"required":["role","parts"],"type":"object"},"GeminiTextPart":{"properties":{"text":{"description":"A text prompt or code snippet.","example":"Answer as concisely as possible","type":"string"}},"type":"object"},"GeminiTool":{"description":"A piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. See Function calling.\n","properties":{"functionDeclarations":{"items":{"$ref":"#/components/schemas/GeminiFunctionDeclaration"},"type":"array"}},"type":"object"},"GeminiUsageMetadata":{"properties":{"cachedContentTokenCount":{"description":"Output only. Number of tokens in the cached part in the input (the cached content).","type":"integer"},"candidatesTokenCount":{"description":"Number of tokens in the response(s).","type":"integer"},"candidatesTokensDetails":{"description":"Breakdown of candidate tokens by modality.","items":{"$ref":"#/components/schemas/ModalityTokenCount"},"type":"array"},"promptTokenCount":{"description":"Number of tokens in the request. When cachedContent is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.","type":"integer"},"promptTokensDetails":{"description":"Breakdown of prompt tokens by modality.","items":{"$ref":"#/components/schemas/ModalityTokenCount"},"type":"array"},"thoughtsTokenCount":{"description":"Number of tokens present in thoughts output.","type":"integer"},"toolUsePromptTokenCount":{"description":"Number of tokens present in tool-use prompt(s).","type":"integer"},"totalTokenCount":{"description":"Total number of tokens (prompt + candidates).","type":"integer"},"trafficType":{"description":"Traffic type used for the request (e.g., PROVISIONED_THROUGHPUT).","type":"string"}},"type":"object"},"GeminiVideoMetadata":{"description":"For video input, the start and end offset of the video in Duration format. For example, to specify a 10 second clip starting at 1:00, set \"startOffset\": { \"seconds\": 60 } and \"endOffset\": { \"seconds\": 70 }. The metadata should only be specified while the video data is presented in inlineData or fileData.\n","properties":{"endOffset":{"$ref":"#/components/schemas/GeminiOffset"},"startOffset":{"$ref":"#/components/schemas/GeminiOffset"}},"type":"object"},"GitCommitSummary":{"properties":{"author":{"description":"The author of the commit","type":"string"},"branch_name":{"description":"The branch where the commit was made","type":"string"},"commit_hash":{"description":"The hash of the commit","type":"string"},"commit_name":{"description":"The name of the commit","type":"string"},"status_summary":{"additionalProperties":{"type":"string"},"description":"A map of operating system to status pairs","type":"object"},"timestamp":{"description":"The timestamp when the commit was made","format":"date-time","type":"string"}},"type":"object"},"GithubEnterprise":{"description":"A GitHub enterprise","properties":{"avatar_url":{"description":"URL to the enterprise avatar","type":"string"},"created_at":{"description":"When the enterprise was created","format":"date-time","type":"string"},"description":{"description":"The enterprise description","nullable":true,"type":"string"},"html_url":{"description":"The HTML URL of the enterprise","type":"string"},"id":{"description":"The enterprise ID","type":"integer"},"name":{"description":"The enterprise name","type":"string"},"node_id":{"description":"The enterprise node ID","type":"string"},"slug":{"description":"The enterprise slug","type":"string"},"updated_at":{"description":"When the enterprise was last updated","format":"date-time","type":"string"},"website_url":{"description":"The enterprise website URL","nullable":true,"type":"string"}},"required":["id","slug","name","node_id","avatar_url","html_url","created_at","updated_at"],"type":"object"},"GithubInstallation":{"description":"A GitHub App installation","properties":{"access_tokens_url":{"description":"The API URL for access tokens","type":"string"},"account":{"$ref":"#/components/schemas/GithubUser"},"app_id":{"description":"The GitHub App ID","type":"integer"},"created_at":{"description":"When the installation was created","format":"date-time","type":"string"},"events":{"description":"The events the installation subscribes to","items":{"type":"string"},"type":"array"},"html_url":{"description":"The HTML URL of the installation","type":"string"},"id":{"description":"The installation ID","type":"integer"},"permissions":{"description":"The installation permissions","type":"object"},"repositories_url":{"description":"The API URL for repositories","type":"string"},"repository_selection":{"description":"Repository selection for the installation","enum":["selected","all"],"type":"string"},"single_file_name":{"description":"The single file name if applicable","nullable":true,"type":"string"},"target_id":{"description":"The target ID","type":"integer"},"target_type":{"description":"The target type","type":"string"},"updated_at":{"description":"When the installation was last updated","format":"date-time","type":"string"}},"required":["id","account","repository_selection","access_tokens_url","repositories_url","html_url","app_id","target_id","target_type","permissions","events","created_at","updated_at"],"type":"object"},"GithubOrganization":{"description":"A GitHub organization","properties":{"avatar_url":{"description":"URL to the organization's avatar","type":"string"},"description":{"description":"The organization description","nullable":true,"type":"string"},"events_url":{"description":"The API URL of the organization's events","type":"string"},"hooks_url":{"description":"The API URL of the organization's hooks","type":"string"},"id":{"description":"The organization ID","type":"integer"},"issues_url":{"description":"The API URL of the organization's issues","type":"string"},"login":{"description":"The organization's login name","type":"string"},"members_url":{"description":"The API URL of the organization's members","type":"string"},"node_id":{"description":"The organization node ID","type":"string"},"public_members_url":{"description":"The API URL of the organization's public members","type":"string"},"repos_url":{"description":"The API URL of the organization's repositories","type":"string"},"url":{"description":"The API URL of the organization","type":"string"}},"required":["login","id","node_id","url","repos_url","events_url","hooks_url","issues_url","members_url","public_members_url","avatar_url"],"type":"object"},"GithubReleaseAsset":{"description":"A GitHub release asset","properties":{"browser_download_url":{"description":"The browser download URL","type":"string"},"content_type":{"description":"The content type of the asset","type":"string"},"created_at":{"description":"When the asset was created","format":"date-time","type":"string"},"download_count":{"description":"The number of downloads","type":"integer"},"id":{"description":"The asset ID","type":"integer"},"label":{"description":"The label of the asset","nullable":true,"type":"string"},"name":{"description":"The name of the asset","type":"string"},"node_id":{"description":"The asset node ID","type":"string"},"size":{"description":"The size of the asset in bytes","type":"integer"},"state":{"description":"The state of the asset","enum":["uploaded","open"],"type":"string"},"updated_at":{"description":"When the asset was last updated","format":"date-time","type":"string"},"uploader":{"$ref":"#/components/schemas/GithubUser"}},"required":["id","node_id","name","content_type","state","size","download_count","created_at","updated_at","browser_download_url","uploader"],"type":"object"},"GithubReleaseWebhook":{"description":"GitHub release webhook payload based on official webhook documentation","properties":{"action":{"description":"The action performed on the release","enum":["published","unpublished","created","edited","deleted","prereleased","released"],"type":"string"},"enterprise":{"$ref":"#/components/schemas/GithubEnterprise"},"installation":{"$ref":"#/components/schemas/GithubInstallation"},"organization":{"$ref":"#/components/schemas/GithubOrganization"},"release":{"description":"The release object","properties":{"assets":{"description":"Array of release assets","items":{"$ref":"#/components/schemas/GithubReleaseAsset"},"type":"array"},"assets_url":{"description":"The URL to the release assets","type":"string"},"author":{"$ref":"#/components/schemas/GithubUser"},"body":{"description":"The release notes/body","nullable":true,"type":"string"},"created_at":{"description":"When the release was created","format":"date-time","type":"string"},"draft":{"description":"Whether the release is a draft","type":"boolean"},"html_url":{"description":"The HTML URL of the release","type":"string"},"id":{"description":"The ID of the release","type":"integer"},"name":{"description":"The name of the release","nullable":true,"type":"string"},"node_id":{"description":"The node ID of the release","type":"string"},"prerelease":{"description":"Whether the release is a prerelease","type":"boolean"},"published_at":{"description":"When the release was published","format":"date-time","nullable":true,"type":"string"},"tag_name":{"description":"The tag name of the release","type":"string"},"tarball_url":{"description":"URL to the tarball","type":"string"},"target_commitish":{"description":"The branch or commit the release was created from","type":"string"},"upload_url":{"description":"The URL to upload release assets","type":"string"},"url":{"description":"The API URL of the release","type":"string"},"zipball_url":{"description":"URL to the zipball","type":"string"}},"required":["id","node_id","url","html_url","tag_name","target_commitish","draft","prerelease","created_at","author","tarball_url","zipball_url","assets"],"type":"object"},"repository":{"$ref":"#/components/schemas/GithubRepository"},"sender":{"$ref":"#/components/schemas/GithubUser"}},"required":["action","release","repository","sender"],"type":"object"},"GithubRepository":{"description":"A GitHub repository","properties":{"clone_url":{"description":"The clone URL of the repository","type":"string"},"created_at":{"description":"When the repository was created","format":"date-time","type":"string"},"default_branch":{"description":"The default branch of the repository","type":"string"},"description":{"description":"The repository description","nullable":true,"type":"string"},"fork":{"description":"Whether the repository is a fork","type":"boolean"},"full_name":{"description":"The full name of the repository (owner/repo)","type":"string"},"git_url":{"description":"The git URL of the repository","type":"string"},"html_url":{"description":"The HTML URL of the repository","type":"string"},"id":{"description":"The repository ID","type":"integer"},"name":{"description":"The name of the repository","type":"string"},"node_id":{"description":"The repository node ID","type":"string"},"owner":{"$ref":"#/components/schemas/GithubUser"},"private":{"description":"Whether the repository is private","type":"boolean"},"pushed_at":{"description":"When the repository was last pushed to","format":"date-time","type":"string"},"ssh_url":{"description":"The SSH URL of the repository","type":"string"},"updated_at":{"description":"When the repository was last updated","format":"date-time","type":"string"},"url":{"description":"The API URL of the repository","type":"string"}},"required":["id","node_id","name","full_name","private","owner","html_url","fork","url","clone_url","git_url","ssh_url","default_branch","created_at","updated_at","pushed_at"],"type":"object"},"GithubUser":{"description":"A GitHub user","properties":{"avatar_url":{"description":"URL to the user's avatar","type":"string"},"gravatar_id":{"description":"The user's gravatar ID","nullable":true,"type":"string"},"html_url":{"description":"The HTML URL of the user","type":"string"},"id":{"description":"The user's ID","type":"integer"},"login":{"description":"The user's login name","type":"string"},"node_id":{"description":"The user's node ID","type":"string"},"site_admin":{"description":"Whether the user is a site admin","type":"boolean"},"type":{"description":"The type of user","enum":["Bot","User","Organization"],"type":"string"},"url":{"description":"The API URL of the user","type":"string"}},"required":["login","id","node_id","avatar_url","url","html_url","type","site_admin"],"type":"object"},"HitPawErrorResponse":{"description":"Error response from HitPaw API","properties":{"error_code":{"description":"Error code","type":"integer"},"message":{"description":"Error message","type":"string"}},"type":"object"},"HitPawJobResponse":{"description":"Response from HitPaw Enhancement APIs (photo and video)","properties":{"code":{"description":"Status code, 200 indicates success","example":200,"type":"integer"},"data":{"properties":{"consume_coins":{"description":"Number of coins consumed for this task","example":75,"type":"integer"},"job_id":{"description":"Unique identifier for the enhancement job","example":"f5007c0b-e902-4070-8c75-f337d896168f","type":"string"}},"type":"object"},"message":{"description":"Response message","example":"OK","type":"string"}},"type":"object"},"HitPawPhotoEnhancerRequest":{"description":"Request body for HitPaw Photo Enhancement API","properties":{"DPI":{"description":"Target DPI for the output image","example":300,"format":"int64","type":"integer"},"exif":{"description":"Whether to preserve EXIF data (default false)","example":true,"type":"boolean"},"extension":{"description":"File extension of the image (e.g., \".jpg\", \".png\")","example":".jpg","type":"string"},"img_url":{"description":"URL of the image to be enhanced. Must be publicly accessible.","example":"https://example.com/image.jpg","format":"uri","type":"string"},"model_name":{"description":"The model name to use for enhancement.\n\n**Available Models:**\n- face_2x, face_4x: Face Clear Model (2x/4x upscaling)\n- face_v2_2x, face_v2_4x: Face Natural Model (2x/4x upscaling)\n- general_2x, general_4x: General Enhance Model (2x/4x upscaling)\n- high_fidelity_2x, high_fidelity_4x: High Fidelity Model (2x/4x upscaling)\n- sharpen_denoise: Sharp Denoise Model\n- detail_denoise: Detail Denoise Model\n- generative_portrait: Generative Portrait Model\n- generative: Generative Enhance Model\n","enum":["face_2x","face_4x","face_v2_2x","face_v2_4x","general_2x","general_4x","high_fidelity_2x","high_fidelity_4x","sharpen_denoise","detail_denoise","generative_portrait","generative"],"example":"generative_portrait","type":"string"}},"required":["model_name","img_url","extension"],"type":"object"},"HitPawTaskStatusRequest":{"description":"Request body for HitPaw Task Status Query API","properties":{"job_id":{"description":"Task ID obtained from Enhancement API response","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"}},"required":["job_id"],"type":"object"},"HitPawTaskStatusResponse":{"description":"Response from HitPaw Task Status Query API","properties":{"code":{"description":"Status code, 200 indicates success","example":200,"type":"integer"},"data":{"properties":{"job_id":{"description":"Task ID","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string"},"original_url":{"description":"Original Image URL (photo enhancement only)","example":"https://example.com/original.jpg","format":"uri","type":"string"},"res_url":{"description":"Result URL, only valid when status is COMPLETED","example":"https://example.com/result.jpg","format":"uri","type":"string"},"status":{"description":"Task status:\n- WAITING: The job is queued and waiting to be processed\n- CONVERTING: Processing task in progress\n- COMPLETED: Task completed successfully\n- ERROR: Task failed\n","enum":["WAITING","CONVERTING","COMPLETED","ERROR"],"type":"string"}},"type":"object"},"message":{"description":"Response message","example":"OK","type":"string"}},"type":"object"},"HitPawVideoEnhancerRequest":{"description":"Request body for HitPaw Video Enhancement API","properties":{"extension":{"default":".mp4","description":"File extension for the output video (default \".mp4\")","example":".mp4","type":"string"},"model_name":{"description":"Model name to use for enhancement.\n\n**Available Models:**\n- face_soft: Face Soft Model\n- portrait_restore_1x: Portrait Restore Model 1x\n- portrait_restore_2x: Portrait Restore Model 2x\n- general_restore_1x: General Restore Model 1x\n- general_restore_2x: General Restore Model 2x\n- general_restore_4x: General Restore Model 4x\n- ultrahd_restore: Ultra HD Model\n- generative: Generative Model (SD)\n","enum":["face_soft","portrait_restore_1x","portrait_restore_2x","general_restore_1x","general_restore_2x","general_restore_4x","ultrahd_restore","generative"],"example":"general_restore_2x","type":"string"},"original_resolution":{"description":"Original video resolution [width, height]","example":[1280,720],"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"resolution":{"description":"Target resolution [width, height]","example":[1920,1080],"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"video_url":{"description":"URL of the video to be enhanced","example":"https://example.com/video.mp4","format":"uri","type":"string"}},"required":["video_url","model_name","resolution"],"type":"object"},"IdeogramColorPalette":{"description":"A color palette specification that can either use a preset name or explicit color definitions with weights","oneOf":[{"properties":{"name":{"description":"Name of the preset color palette","type":"string"}},"required":["name"]},{"properties":{"members":{"description":"Array of color definitions with optional weights","items":{"properties":{"color":{"description":"Hexadecimal color code","pattern":"^#[0-9A-Fa-f]{6}$","type":"string"},"weight":{"description":"Optional weight for the color (0-1)","maximum":1,"minimum":0,"type":"number"}},"type":"object"},"type":"array"}},"required":["members"]}],"type":"object"},"IdeogramGenerateRequest":{"description":"Parameters for the Ideogram generation proxy request. Based on Ideogram's API.","properties":{"image_request":{"description":"The image generation request parameters.","properties":{"aspect_ratio":{"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.","type":"string"},"color_palette":{"additionalProperties":true,"description":"Optional. Color palette object. Only for V_2, V_2_TURBO.","type":"object"},"magic_prompt_option":{"description":"Optional. MagicPrompt usage ('AUTO', 'ON', 'OFF').","type":"string"},"model":{"description":"The model used (e.g., 'V_2', 'V_2A_TURBO')","type":"string"},"negative_prompt":{"description":"Optional. Description of what to exclude. Only for V_1, V_1_TURBO, V_2, V_2_TURBO.","type":"string"},"num_images":{"default":1,"description":"Optional. Number of images to generate (1-8). Defaults to 1.","maximum":8,"minimum":1,"type":"integer"},"prompt":{"description":"Required. The prompt to use to generate the image.","type":"string"},"resolution":{"description":"Optional. Resolution (e.g., 'RESOLUTION_1024_1024'). Only for model V_2. Cannot be used with aspect_ratio.","type":"string"},"seed":{"description":"Optional. A number between 0 and 2147483647.","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"style_type":{"description":"Optional. Style type ('AUTO', 'GENERAL', 'REALISTIC', 'DESIGN', 'RENDER_3D', 'ANIME'). Only for models V_2 and above.","type":"string"}},"required":["prompt","model"],"type":"object"}},"required":["image_request"],"type":"object"},"IdeogramGenerateResponse":{"description":"Response from the Ideogram image generation API.","properties":{"created":{"description":"Timestamp when the generation was created.","format":"date-time","type":"string"},"data":{"description":"Array of generated image information.","items":{"properties":{"is_image_safe":{"description":"Indicates whether the image is considered safe.","type":"boolean"},"prompt":{"description":"The prompt used to generate this image.","type":"string"},"resolution":{"description":"The resolution of the generated image (e.g., '1024x1024').","type":"string"},"seed":{"description":"The seed value used for this generation.","type":"integer"},"style_type":{"description":"The style type used for generation (e.g., 'REALISTIC', 'ANIME').","type":"string"},"url":{"description":"URL to the generated image.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"IdeogramStyleType":{"default":"GENERAL","enum":["AUTO","GENERAL","REALISTIC","DESIGN","FICTION"],"type":"string"},"IdeogramV3EditRequest":{"properties":{"character_reference_images":{"description":"Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"character_reference_images_mask":{"description":"Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"color_palette":{"$ref":"#/components/schemas/IdeogramColorPalette"},"image":{"description":"The image being edited (max size 10MB); only JPEG, WebP and PNG formats are supported at this time.","format":"binary","type":"string"},"magic_prompt":{"description":"Determine if MagicPrompt should be used in generating the request or not.","type":"string"},"mask":{"description":"A black and white image of the same size as the image being edited (max size 10MB). Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.","format":"binary","type":"string"},"num_images":{"description":"The number of images to generate.","type":"integer"},"prompt":{"description":"The prompt used to describe the edited result.","type":"string"},"rendering_speed":{"$ref":"#/components/schemas/RenderingSpeed"},"seed":{"description":"Random seed. Set for reproducible generation.","type":"integer"},"style_codes":{"description":"A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.","items":{"pattern":"^[0-9A-Fa-f]{8}$","type":"string"},"type":"array"},"style_reference_images":{"description":"A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"style_type":{"$ref":"#/components/schemas/IdeogramStyleType"}},"required":["prompt","rendering_speed"],"type":"object"},"IdeogramV3IdeogramResponse":{"properties":{"created":{"format":"date-time","type":"string"},"data":{"items":{"properties":{"is_image_safe":{"type":"boolean"},"prompt":{"type":"string"},"resolution":{"type":"string"},"seed":{"type":"integer"},"style_type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"IdeogramV3ReframeRequest":{"properties":{"color_palette":{"type":"object"},"image":{"format":"binary","type":"string"},"num_images":{"maximum":8,"minimum":1,"type":"integer"},"rendering_speed":{"$ref":"#/components/schemas/RenderingSpeed"},"resolution":{"type":"string"},"seed":{"maximum":2147483647,"minimum":0,"type":"integer"},"style_codes":{"items":{"type":"string"},"type":"array"},"style_reference_images":{"items":{"format":"binary","type":"string"},"type":"array"}},"required":["resolution"],"type":"object"},"IdeogramV3RemixRequest":{"properties":{"aspect_ratio":{"type":"string"},"character_reference_images":{"description":"Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"character_reference_images_mask":{"description":"Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"color_palette":{"type":"object"},"image":{"format":"binary","type":"string"},"image_weight":{"default":50,"maximum":100,"minimum":1,"type":"integer"},"magic_prompt":{"enum":["AUTO","ON","OFF"],"type":"string"},"negative_prompt":{"type":"string"},"num_images":{"maximum":8,"minimum":1,"type":"integer"},"prompt":{"type":"string"},"rendering_speed":{"$ref":"#/components/schemas/RenderingSpeed"},"resolution":{"type":"string"},"seed":{"maximum":2147483647,"minimum":0,"type":"integer"},"style_codes":{"items":{"type":"string"},"type":"array"},"style_reference_images":{"items":{"format":"binary","type":"string"},"type":"array"},"style_type":{"$ref":"#/components/schemas/IdeogramStyleType"}},"required":["prompt"],"type":"object"},"IdeogramV3ReplaceBackgroundRequest":{"properties":{"color_palette":{"type":"object"},"image":{"format":"binary","type":"string"},"magic_prompt":{"enum":["AUTO","ON","OFF"],"type":"string"},"num_images":{"maximum":8,"minimum":1,"type":"integer"},"prompt":{"type":"string"},"rendering_speed":{"$ref":"#/components/schemas/RenderingSpeed"},"seed":{"maximum":2147483647,"minimum":0,"type":"integer"},"style_codes":{"items":{"type":"string"},"type":"array"},"style_reference_images":{"items":{"format":"binary","type":"string"},"type":"array"}},"required":["prompt"],"type":"object"},"IdeogramV3Request":{"properties":{"aspect_ratio":{"description":"Aspect ratio in format WxH","example":"1x3","type":"string"},"character_reference_images":{"description":"Generations with character reference are subject to the character reference pricing. A set of images to use as character references (maximum total size 10MB across all character references), currently only supports 1 character reference image. The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"character_reference_images_mask":{"description":"Optional masks for character reference images. When provided, must match the number of character_reference_images. Each mask should be a grayscale image of the same dimensions as the corresponding character reference image. The images should be in JPEG, PNG or WebP format.","items":{"format":"binary","type":"string"},"type":"array"},"color_palette":{"properties":{"name":{"description":"Name of the color palette","example":"PASTEL","type":"string"}},"required":["name"],"type":"object"},"magic_prompt":{"description":"Whether to enable magic prompt enhancement","enum":["ON","OFF"],"type":"string"},"negative_prompt":{"description":"Text prompt specifying what to avoid in the generation","type":"string"},"num_images":{"description":"Number of images to generate","minimum":1,"type":"integer"},"prompt":{"description":"The text prompt for image generation","type":"string"},"rendering_speed":{"$ref":"#/components/schemas/RenderingSpeed"},"resolution":{"description":"Image resolution in format WxH","example":"1280x800","type":"string"},"seed":{"description":"Seed value for reproducible generation","type":"integer"},"style_codes":{"description":"Array of style codes in hexadecimal format","items":{"pattern":"^[0-9A-Fa-f]{8}$","type":"string"},"type":"array"},"style_reference_images":{"description":"Array of reference image URLs or identifiers","items":{"format":"binary","type":"string"},"type":"array"},"style_type":{"$ref":"#/components/schemas/IdeogramStyleType"}},"required":["prompt","rendering_speed"],"type":"object"},"ImagenGenerateImageRequest":{"properties":{"instances":{"items":{"$ref":"#/components/schemas/ImagenImageGenerationInstance"},"type":"array"},"parameters":{"$ref":"#/components/schemas/ImagenImageGenerationParameters"}},"required":["instances","parameters"],"type":"object"},"ImagenGenerateImageResponse":{"properties":{"predictions":{"items":{"$ref":"#/components/schemas/ImagenImagePrediction"},"type":"array"}},"type":"object"},"ImagenImageGenerationInstance":{"properties":{"prompt":{"description":"Text prompt for image generation","type":"string"}},"required":["prompt"],"type":"object"},"ImagenImageGenerationParameters":{"properties":{"addWatermark":{"type":"boolean"},"aspectRatio":{"enum":["1:1","9:16","16:9","3:4","4:3"],"type":"string"},"enhancePrompt":{"type":"boolean"},"includeRaiReason":{"type":"boolean"},"includeSafetyAttributes":{"type":"boolean"},"outputOptions":{"$ref":"#/components/schemas/ImagenOutputOptions"},"personGeneration":{"enum":["dont_allow","allow_adult","allow_all"],"type":"string"},"safetySetting":{"enum":["block_most","block_some","block_few","block_fewest"],"type":"string"},"sampleCount":{"maximum":4,"minimum":1,"type":"integer"},"seed":{"format":"uint32","type":"integer"},"storageUri":{"format":"uri","type":"string"}},"type":"object"},"ImagenImagePrediction":{"properties":{"bytesBase64Encoded":{"description":"Base64-encoded image content","format":"byte","type":"string"},"mimeType":{"description":"MIME type of the generated image","type":"string"},"prompt":{"description":"Enhanced or rewritten prompt used to generate this image","type":"string"}},"type":"object"},"ImagenOutputOptions":{"properties":{"compressionQuality":{"maximum":100,"minimum":0,"type":"integer"},"mimeType":{"enum":["image/png","image/jpeg"],"type":"string"}},"type":"object"},"Includable":{"description":"Specify additional output data to include in the model response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n  the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n","enum":["file_search_call.results","message.input_image.image_url","computer_call_output.output.image_url"],"type":"string"},"InputContent":{"oneOf":[{"$ref":"#/components/schemas/InputTextContent"},{"$ref":"#/components/schemas/InputImageContent"},{"$ref":"#/components/schemas/InputFileContent"}]},"InputFileContent":{"description":"A file input to the model.","properties":{"file_data":{"description":"The content of the file to be sent to the model.\n","type":"string"},"file_id":{"description":"The ID of the file to be sent to the model.","type":"string"},"filename":{"description":"The name of the file to be sent to the model.","type":"string"},"type":{"default":"input_file","description":"The type of the input item. Always `input_file`.","enum":["input_file"],"type":"string","x-stainless-const":true}},"required":["type"],"title":"Input file","type":"object"},"InputImageContent":{"description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","properties":{"detail":{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.","enum":["low","high","auto"],"type":"string"},"file_id":{"description":"The ID of the file to be sent to the model.","type":"string"},"image_url":{"description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.","type":"string"},"type":{"default":"input_image","description":"The type of the input item. Always `input_image`.","enum":["input_image"],"type":"string","x-stainless-const":true}},"required":["type","detail"],"title":"Input image","type":"object"},"InputItem":{"oneOf":[{"$ref":"#/components/schemas/EasyInputMessage"},{"$ref":"#/components/schemas/Item"}]},"InputMessage":{"properties":{"content":{"$ref":"#/components/schemas/InputMessageContentList"},"role":{"enum":["user","system","developer"],"type":"string"},"status":{"enum":["in_progress","completed","incomplete"],"type":"string"},"type":{"enum":["message"],"type":"string"}},"type":"object"},"InputMessageContentList":{"description":"A list of one or many input items to the model, containing different content\ntypes.\n","items":{"$ref":"#/components/schemas/InputContent"},"title":"Input item content list","type":"array"},"InputTextContent":{"description":"A text input to the model.","properties":{"text":{"description":"The text input to the model.","type":"string"},"type":{"default":"input_text","description":"The type of the input item. Always `input_text`.","enum":["input_text"],"type":"string","x-stainless-const":true}},"required":["type","text"],"title":"Input text","type":"object"},"Item":{"description":"Content item used to generate a response.\n","oneOf":[{"$ref":"#/components/schemas/InputMessage"},{"$ref":"#/components/schemas/OutputMessage"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/FunctionToolCall"},{"$ref":"#/components/schemas/ReasoningItem"}],"type":"object"},"KlingAudioUploadType":{"description":"Method of Transmitting Audio Files for Lip-Sync. Required when mode is audio2video.","enum":["file","url"],"type":"string"},"KlingAvatarMode":{"default":"std","description":"Video generation mode. std: Standard Mode (cost-effective), pro: Professional Mode (longer duration, higher quality).","enum":["std","pro"],"type":"string"},"KlingAvatarRequest":{"properties":{"audio_id":{"description":"Audio ID Generated via TTS API. Only supports 2-300 second audio generated within the last 30 days. Either audio_id or sound_file must be provided (mutually exclusive).","type":"string"},"callback_url":{"description":"The callback notification address for the result of this task.","format":"uri","type":"string"},"external_task_id":{"description":"Customized Task ID. Must be unique within a single user account.","type":"string"},"image":{"description":"Avatar Reference Image. Supports Base64 encoding or image URL. Supported formats: .jpg/.jpeg/.png. Max 10MB, min 300px width/height, aspect ratio between 1:2.5 and 2.5:1.","type":"string"},"mode":{"$ref":"#/components/schemas/KlingAvatarMode"},"prompt":{"description":"Positive text prompt. Can define avatar actions, emotions, and camera movements.","maxLength":2500,"type":"string"},"sound_file":{"description":"Sound File. Supports Base64-encoded audio or accessible audio URL. Accepted formats: .mp3/.wav/.m4a/.aac (max 5MB), 2-300 seconds. Either audio_id or sound_file must be provided (mutually exclusive).","type":"string"},"watermark_info":{"properties":{"enabled":{"description":"Whether to generate watermarked results simultaneously.","type":"boolean"}},"type":"object"}},"required":["image"],"type":"object"},"KlingAvatarResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time","type":"integer"},"final_unit_deduction":{"description":"The deduction units of task","type":"string"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"type":"string"}},"type":"object"},"task_result":{"properties":{"videos":{"items":{"$ref":"#/components/schemas/KlingVideoResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"task_status_msg":{"description":"Task status information","type":"string"},"updated_at":{"description":"Task update time","type":"integer"},"watermark_info":{"properties":{"enabled":{"type":"boolean"}},"type":"object"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingCameraConfig":{"properties":{"horizontal":{"description":"Controls camera's movement along horizontal axis (x-axis). Negative indicates left, positive indicates right.","maximum":10,"minimum":-10,"type":"number"},"pan":{"description":"Controls camera's rotation in vertical plane (x-axis). Negative indicates downward rotation, positive indicates upward rotation.","maximum":10,"minimum":-10,"type":"number"},"roll":{"description":"Controls camera's rolling amount (z-axis). Negative indicates counterclockwise, positive indicates clockwise.","maximum":10,"minimum":-10,"type":"number"},"tilt":{"description":"Controls camera's rotation in horizontal plane (y-axis). Negative indicates left rotation, positive indicates right rotation.","maximum":10,"minimum":-10,"type":"number"},"vertical":{"description":"Controls camera's movement along vertical axis (y-axis). Negative indicates downward, positive indicates upward.","maximum":10,"minimum":-10,"type":"number"},"zoom":{"description":"Controls change in camera's focal length. Negative indicates narrower field of view, positive indicates wider field of view.","maximum":10,"minimum":-10,"type":"number"}},"type":"object"},"KlingCameraControl":{"properties":{"config":{"$ref":"#/components/schemas/KlingCameraConfig"},"type":{"$ref":"#/components/schemas/KlingCameraControlType"}},"type":"object"},"KlingCameraControlType":{"description":"Predefined camera movements type. simple: Customizable camera movement. down_back: Camera descends and moves backward. forward_up: Camera moves forward and tilts up. right_turn_forward: Rotate right and move forward. left_turn_forward: Rotate left and move forward.","enum":["simple","down_back","forward_up","right_turn_forward","left_turn_forward"],"type":"string"},"KlingCharacterEffectModelName":{"default":"kling-v1","description":"Model Name. Can be kling-v1, kling-v1-5, or kling-v1-6.","enum":["kling-v1","kling-v1-5","kling-v1-6"],"type":"string"},"KlingDualCharacterEffectInput":{"properties":{"duration":{"$ref":"#/components/schemas/KlingVideoGenDuration"},"images":{"$ref":"#/components/schemas/KlingDualCharacterImages"},"mode":{"$ref":"#/components/schemas/KlingVideoGenMode"},"model_name":{"$ref":"#/components/schemas/KlingCharacterEffectModelName"}},"required":["images","duration"],"type":"object"},"KlingDualCharacterEffectsScene":{"description":"Scene Name. Dual-character Effects (hug, kiss, heart_gesture).","enum":["hug","kiss","heart_gesture"],"type":"string"},"KlingDualCharacterImages":{"items":{"description":"Reference Image Group. Must contain exactly 2 images. First image will be positioned on left side, second on right side of the composite. Each image follows the same requirements as single image effects.","type":"string"},"maxItems":2,"minItems":2,"type":"array"},"KlingErrorResponse":{"properties":{"code":{"description":"- 1000: Authentication failed\n- 1001: Authorization is empty\n- 1002: Authorization is invalid\n- 1003: Authorization is not yet valid\n- 1004: Authorization has expired\n- 1100: Account exception\n- 1101: Account in arrears (postpaid scenario)\n- 1102: Resource pack depleted or expired (prepaid scenario)\n- 1103: Unauthorized access to requested resource\n- 1200: Invalid request parameters\n- 1201: Invalid parameters\n- 1202: Invalid request method\n- 1203: Requested resource does not exist\n- 1300: Trigger platform strategy\n- 1301: Trigger content security policy\n- 1302: API request too frequent\n- 1303: Concurrency/QPS exceeds limit\n- 1304: Trigger IP whitelist policy\n- 5000: Internal server error\n- 5001: Service temporarily unavailable\n- 5002: Server internal timeout\n","type":"integer"},"message":{"description":"Human-readable error message","type":"string"},"request_id":{"description":"Request ID for tracking and troubleshooting","type":"string"}},"required":["code","message","request_id"],"type":"object"},"KlingImage2VideoRequest":{"properties":{"callback_url":{"description":"The callback notification address. Server will notify when the task status changes.","format":"uri","type":"string"},"camera_control":{"$ref":"#/components/schemas/KlingCameraControl"},"cfg_scale":{"$ref":"#/components/schemas/KlingVideoGenCfgScale"},"duration":{"$ref":"#/components/schemas/KlingVideoGenDuration"},"dynamic_masks":{"description":"Dynamic Brush Configuration List (up to 6 groups). For 5-second videos, trajectory length must not exceed 77 coordinates.","items":{"properties":{"mask":{"description":"Dynamic Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image.","format":"uri","type":"string"},"trajectories":{"items":{"properties":{"x":{"description":"The horizontal coordinate of trajectory point. Based on bottom-left corner of image as origin (0,0).","type":"integer"},"y":{"description":"The vertical coordinate of trajectory point. Based on bottom-left corner of image as origin (0,0).","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"element_list":{"description":"Reference Element List based on element ID configuration. Supports up to 3 reference elements. The element_list and voice_list parameters are mutually exclusive.","items":{"properties":{"element_id":{"description":"Element ID","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"external_task_id":{"description":"Customized Task ID. Must be unique within a single user account.","type":"string"},"image":{"description":"Reference Image - URL or Base64 encoded string, cannot exceed 10MB, resolution not less than 300*300px, aspect ratio between 1:2.5 ~ 2.5:1. Base64 should not include data:image prefix.","type":"string"},"image_tail":{"description":"Reference Image - End frame control. URL or Base64 encoded string, cannot exceed 10MB, resolution not less than 300*300px. Base64 should not include data:image prefix. Cannot be used simultaneously with dynamic_masks/static_mask or camera_control.","type":"string"},"mode":{"$ref":"#/components/schemas/KlingVideoGenMode"},"model_name":{"$ref":"#/components/schemas/KlingVideoGenModelName"},"multi_prompt":{"description":"Information about each storyboard, such as prompts and duration. Supports up to 6 storyboards, with a minimum of 1. Required when multi_shot is true and shot_type is customize.","items":{"properties":{"duration":{"description":"Duration of this storyboard in seconds. Must not exceed total task duration and must not be less than 1. Sum of all storyboard durations equals total task duration.","type":"string"},"index":{"description":"Shot sequence number","type":"integer"},"prompt":{"description":"Prompt word for this storyboard. Maximum length 512 characters.","maxLength":512,"type":"string"}},"type":"object"},"type":"array"},"multi_shot":{"default":false,"description":"Whether to generate multi-shot video. When true, the prompt parameter is invalid. When false, the shot_type and multi_prompt parameters are invalid.","type":"boolean"},"negative_prompt":{"description":"Negative text prompt. It is recommended to supplement negative prompt information through negative sentences directly within positive prompts.","maxLength":2500,"type":"string"},"prompt":{"description":"Positive text prompt. Use \u003c\u003c\u003cvoice_1\u003e\u003e\u003e to specify a voice matching the voice_list parameter order. A task can reference up to 2 tones. When specifying a tone, the sound parameter value must be on.","maxLength":2500,"type":"string"},"shot_type":{"description":"Storyboard method. Required when the multi_shot parameter is set to true.","enum":["customize","intelligence"],"type":"string"},"sound":{"default":"off","description":"Whether to generate sound simultaneously when generating videos. Only V2.6 and subsequent versions of the model support this parameter.","enum":["on","off"],"type":"string"},"static_mask":{"description":"Static Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image.","type":"string"},"voice_list":{"description":"List of voices referenced when generating videos. Supports up to 2 voices. The element_list and voice_list parameters are mutually exclusive.","items":{"properties":{"voice_id":{"description":"Voice ID returned through the voice customization API or a system preset voice ID.","type":"string"}},"type":"object"},"type":"array"},"watermark_info":{"description":"Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.","properties":{"enabled":{"description":"true means generate watermark, false means do not generate.","type":"boolean"}},"type":"object"}},"type":"object"},"KlingImageGenAspectRatio":{"default":"16:9","description":"Aspect ratio of the generated images","enum":["16:9","9:16","1:1","4:3","3:4","3:2","2:3","21:9"],"type":"string"},"KlingImageGenImageReferenceType":{"description":"Image reference type","enum":["subject","face"],"type":"string"},"KlingImageGenModelName":{"default":"kling-v1","description":"Model Name","enum":["kling-v1","kling-v1-5","kling-v2","kling-v3"],"type":"string"},"KlingImageGenerationsRequest":{"properties":{"aspect_ratio":{"$ref":"#/components/schemas/KlingImageGenAspectRatio"},"callback_url":{"description":"The callback notification address","format":"uri","type":"string"},"element_list":{"description":"Reference Element List based on element ID configuration. The sum of reference elements and reference images shall not exceed 10.","items":{"properties":{"element_id":{"description":"Element ID","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"external_task_id":{"description":"Customized Task ID. Must be unique within a single user account.","type":"string"},"human_fidelity":{"default":0.45,"description":"Subject reference similarity","maximum":1,"minimum":0,"type":"number"},"image":{"description":"Reference Image - Base64 encoded string or image URL. Supported formats include .jpg/.jpeg/.png. File size cannot exceed 10MB. Width and height dimensions shall not be less than 300px, aspect ratio between 1:2.5 ~ 2.5:1. Required when image_reference is not empty.","type":"string"},"image_fidelity":{"default":0.5,"description":"Reference intensity for user-uploaded images","maximum":1,"minimum":0,"type":"number"},"image_reference":{"$ref":"#/components/schemas/KlingImageGenImageReferenceType"},"model_name":{"$ref":"#/components/schemas/KlingImageGenModelName"},"n":{"default":1,"description":"Number of generated images. Value range [1,9].","maximum":9,"minimum":1,"type":"integer"},"negative_prompt":{"description":"Negative text prompt. Cannot exceed 2500 characters. It is recommended to supplement negative prompt information through negative sentences directly within positive prompts. Not supported in Image-to-Image scenario (when image field is not empty).","maxLength":2500,"type":"string"},"prompt":{"description":"Positive text prompt. Must not exceed 2,500 characters.","maxLength":2500,"type":"string"},"resolution":{"default":"1k","description":"Image generation resolution. 1k is 1K standard, 2k is 2K high-res.","enum":["1k","2k"],"type":"string"}},"required":["prompt"],"type":"object"},"KlingImageGenerationsResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time, Unix timestamp in milliseconds","type":"integer"},"final_unit_deduction":{"description":"The deduction units of task","type":"string"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"description":"Customer-defined task ID","type":"string"}},"type":"object"},"task_result":{"properties":{"images":{"items":{"$ref":"#/components/schemas/KlingImageResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"task_status_msg":{"description":"Task status information, displaying the failure reason when the task fails","type":"string"},"updated_at":{"description":"Task update time, Unix timestamp in milliseconds","type":"integer"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingImageResult":{"properties":{"index":{"description":"Image Number (0-9)","type":"integer"},"url":{"description":"URL for generated image","format":"uri","type":"string"}},"type":"object"},"KlingLipSyncInputObject":{"properties":{"audio_file":{"description":"Local Path of Audio File. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. Base64 code.","type":"string"},"audio_type":{"$ref":"#/components/schemas/KlingAudioUploadType"},"audio_url":{"description":"Audio File Download URL. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB.","type":"string"},"mode":{"$ref":"#/components/schemas/KlingLipSyncMode"},"text":{"description":"Text Content for Lip-Sync Video Generation. Required when mode is text2video. Maximum length is 120 characters.","type":"string"},"video_id":{"description":"The ID of the video generated by Kling AI. Only supports 5-second and 10-second videos generated within the last 30 days.","type":"string"},"video_url":{"description":"Get link for uploaded video. Video files support .mp4/.mov, file size does not exceed 100MB, video length between 2-10s.","type":"string"},"voice_id":{"description":"Voice ID. Required when mode is text2video. The system offers a variety of voice options to choose from.","type":"string"},"voice_language":{"$ref":"#/components/schemas/KlingLipSyncVoiceLanguage"},"voice_speed":{"default":1,"description":"Speech Rate. Valid range: 0.8~2.0, accurate to one decimal place.","maximum":2,"minimum":0.8,"type":"number"}},"required":["mode"],"type":"object"},"KlingLipSyncMode":{"description":"Video Generation Mode. text2video: Text-to-video generation mode; audio2video: Audio-to-video generation mode","enum":["text2video","audio2video"],"type":"string"},"KlingLipSyncRequest":{"properties":{"callback_url":{"description":"The callback notification address. Server will notify when the task status changes.","format":"uri","type":"string"},"input":{"$ref":"#/components/schemas/KlingLipSyncInputObject"}},"required":["input"],"type":"object"},"KlingLipSyncResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time","type":"integer"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"type":"string"}},"type":"object"},"task_result":{"properties":{"videos":{"items":{"$ref":"#/components/schemas/KlingVideoResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"updated_at":{"description":"Task update time","type":"integer"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingLipSyncVoiceLanguage":{"default":"en","description":"The voice language corresponds to the Voice ID.","enum":["zh","en"],"type":"string"},"KlingMotionControlRequest":{"properties":{"callback_url":{"description":"The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes.","format":"uri","type":"string"},"character_orientation":{"description":"Generate the orientation of the characters in the video. image - same orientation as the person in the picture (reference video duration should not exceed 10 seconds). video - consistent with the orientation of the characters in the video (reference video duration should not exceed 30 seconds).","enum":["image","video"],"type":"string"},"element_list":{"description":"Reference Element List based on element ID configuration. Currently only one element can be introduced.","items":{"properties":{"element_id":{"description":"Element ID","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"external_task_id":{"description":"Customized Task ID. Users can provide a customized task ID, which will not overwrite the system-generated task ID but can be used for task queries. Must be unique within a single user account.","type":"string"},"image_url":{"description":"Reference Image. The characters, backgrounds, and other elements in the generated video are based on the reference image. Supports inputting image Base64 encoding or image URL (ensure accessibility). Supported image formats include .jpg / .jpeg / .png. The image file size cannot exceed 10MB, and the width and height dimensions of the image range from 300px to 65536px, and the aspect ratio of the image should be between 1:2.5 ~ 2.5:1.","type":"string"},"keep_original_sound":{"default":"yes","description":"Whether to keep the original sound of the video. Enumeration values - yes (Keep the original sound), no (do not retain the original video sound).","enum":["yes","no"],"type":"string"},"mode":{"description":"Video generation mode. std - Standard Mode (cost-effective). pro - Professional Mode (longer duration but higher quality video output).","enum":["std","pro"],"type":"string"},"model_name":{"default":"kling-v2-6","description":"Model name for motion control. Enum values - kling-v2-6, kling-v3.","enum":["kling-v2-6","kling-v3"],"type":"string"},"prompt":{"description":"Text prompt words, which can include positive and negative descriptions. Cannot exceed 2500 characters.","maxLength":2500,"type":"string"},"video_url":{"description":"The URL of the reference video. The character actions in the generated video are consistent with the reference video. The video file supports .mp4/.mov, with a file size not exceeding 100MB, and only supports side lengths between 340px and 3850px. The lower limit of video duration should not be less than 3 seconds, and the upper limit depends on character_orientation.","type":"string"},"watermark_info":{"description":"Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.","properties":{"enabled":{"description":"true means generate watermark, false means do not generate.","type":"boolean"}},"type":"object"}},"required":["image_url","video_url","character_orientation","mode"],"type":"object"},"KlingMotionControlResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time, Unix timestamp, unit ms","type":"integer"},"final_unit_deduction":{"description":"The deduction units of task","type":"string"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"description":"Customer-defined task ID","type":"string"}},"type":"object"},"task_result":{"properties":{"videos":{"items":{"$ref":"#/components/schemas/KlingMotionControlVideoResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"task_status_msg":{"description":"Task status information, displaying the failure reason when the task fails","type":"string"},"updated_at":{"description":"Task update time, Unix timestamp, unit ms","type":"integer"},"watermark_info":{"properties":{"enabled":{"type":"boolean"}},"type":"object"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingMotionControlVideoResult":{"properties":{"duration":{"description":"Total video duration, unit - s (seconds)","type":"string"},"id":{"description":"Generated video ID; globally unique","type":"string"},"url":{"description":"URL for generating videos","type":"string"},"watermark_url":{"description":"URL for generating videos with watermark, hotlink protection format","type":"string"}},"type":"object"},"KlingOmniImageRequest":{"properties":{"aspect_ratio":{"default":"auto","description":"Aspect ratio of the generated images (width:height). auto is to intelligently generate images based on incoming content.","enum":["16:9","9:16","1:1","4:3","3:4","3:2","2:3","21:9","auto"],"type":"string"},"callback_url":{"description":"The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes.","format":"uri","type":"string"},"element_list":{"description":"Reference Element List based on element ID configuration. The sum of reference elements and reference images shall not exceed 10.","items":{"properties":{"element_id":{"description":"Element ID","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"external_task_id":{"description":"Customized Task ID. Must be unique within a single user account.","type":"string"},"image_list":{"description":"Reference Image List. Supports inputting image Base64 encoding or image URL (ensure accessibility). Supported formats include .jpg/.jpeg/.png. File size cannot exceed 10MB. Width and height dimensions shall not be less than 300px, aspect ratio between 1:2.5 ~ 2.5:1. The sum of reference elements and reference images shall not exceed 10.","items":{"properties":{"image":{"description":"Image Base64 encoding or image URL (ensure accessibility)","type":"string"}},"type":"object"},"type":"array"},"model_name":{"default":"kling-image-o1","description":"Model Name","enum":["kling-image-o1","kling-v3-omni"],"type":"string"},"n":{"default":1,"description":"Number of generated images. Value range [1,9].","maximum":9,"minimum":1,"type":"integer"},"prompt":{"description":"Text prompt words, which can include positive and negative descriptions. Must not exceed 2,500 characters. The Omni model can achieve various capabilities through Prompt with elements and images. Specify an image in the format of \u003c\u003c\u003c\u003e\u003e\u003e, such as \u003c\u003c\u003cimage_1\u003e\u003e\u003e.","maxLength":2500,"type":"string"},"resolution":{"default":"1k","description":"Image generation resolution. 1k is 1K standard, 2k is 2K high-res, 4k is 4K high-res.","enum":["1k","2k","4k"],"type":"string"},"result_type":{"default":"single","description":"Control whether to generate a single image or a series of images.","enum":["single","series"],"type":"string"},"series_amount":{"default":4,"description":"Number of images in a series. Value range [2,9].","maximum":9,"minimum":2,"type":"integer"}},"required":["prompt"],"type":"object"},"KlingOmniImageResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time, Unix timestamp in milliseconds","type":"integer"},"final_unit_deduction":{"description":"The deduction units of task","type":"string"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"description":"Customer-defined task ID","type":"string"}},"type":"object"},"task_result":{"properties":{"images":{"items":{"$ref":"#/components/schemas/KlingImageResult"},"type":"array"},"result_type":{"description":"Whether the result is a single image or a series of images","enum":["single","series"],"type":"string"},"series_images":{"description":"Series images result list","items":{"properties":{"index":{"description":"Series-image sequence number","type":"integer"},"url":{"description":"URL for generated image","format":"uri","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"task_status_msg":{"description":"Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)","type":"string"},"updated_at":{"description":"Task update time, Unix timestamp in milliseconds","type":"integer"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingOmniVideoRequest":{"properties":{"aspect_ratio":{"description":"The aspect ratio of the generated video frame (width:height). Required when first-frame reference or video editing features are not used.","enum":["16:9","9:16","1:1"],"type":"string"},"callback_url":{"description":"The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes.","format":"uri","type":"string"},"duration":{"default":"5","description":"Video Length in seconds. When using video editing function (refer_type: base), output duration is the same as input video and this parameter is invalid.","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"type":"string"},"element_list":{"description":"Reference Element List based on element ID configuration.","items":{"properties":{"element_id":{"description":"Element ID","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"external_task_id":{"description":"Customized Task ID. Must be unique within a single user account.","type":"string"},"image_list":{"description":"Reference Image List. Can include reference images of the element, scene, style, etc., or be used as the first or last frame to generate videos.","items":{"properties":{"image_url":{"description":"Image Base64 encoding or image URL (ensure accessibility). Supported formats include .jpg/.jpeg/.png. File size cannot exceed 10MB. Width and height dimensions shall not be less than 300px, aspect ratio between 1:2.5 ~ 2.5:1.","type":"string"},"type":{"description":"Whether the image is in the first or last frame. first_frame is the first frame, end_frame is the last frame. Currently does not support only the end frame.","enum":["first_frame","end_frame"],"type":"string"}},"type":"object"},"type":"array"},"mode":{"default":"pro","description":"Video generation mode. std: Standard Mode, generating 720P videos, cost-effective. pro: Professional Mode, generating 1080P videos, higher quality video output.","enum":["pro","std"],"type":"string"},"model_name":{"default":"kling-video-o1","description":"Model Name","enum":["kling-video-o1","kling-v3-omni"],"type":"string"},"multi_prompt":{"description":"Information about each storyboard, such as prompts and duration. Supports up to 6 storyboards, with a minimum of 1. Required when multi_shot is true and shot_type is customize.","items":{"properties":{"duration":{"description":"Duration of this storyboard in seconds. Must not exceed total task duration and must not be less than 1. Sum of all storyboard durations equals total task duration.","type":"string"},"index":{"description":"Shot sequence number","type":"integer"},"prompt":{"description":"Prompt word for this storyboard. Maximum length 512 characters.","maxLength":512,"type":"string"}},"type":"object"},"type":"array"},"multi_shot":{"default":false,"description":"Whether to generate multi-shot video. When true, the prompt parameter is invalid. When false, the shot_type and multi_prompt parameters are invalid.","type":"boolean"},"prompt":{"description":"Text prompt words, which can include positive and negative descriptions. Must not exceed 2,500 characters. Can specify elements, images, or videos in the format \u003c\u003c\u003c\u003e\u003e\u003e such as \u003c\u003celement_1\u003e\u003e, \u003c\u003c\u003cimage_1\u003e\u003e\u003e, \u003c\u003c\u003cvideo_1\u003e\u003e\u003e.","maxLength":2500,"type":"string"},"shot_type":{"description":"Storyboard method. Required when the multi_shot parameter is set to true.","enum":["customize","intelligence"],"type":"string"},"sound":{"default":"off","description":"Whether sound is generated simultaneously when generating videos.","enum":["on","off"],"type":"string"},"video_list":{"description":"Reference Video list. Can be used as a reference video for feature or as a video to be edited, with the default being the video to be edited.","items":{"properties":{"keep_original_sound":{"description":"Whether to keep the video original sound. yes indicates retention, no indicates non retention.","enum":["yes","no"],"type":"string"},"refer_type":{"description":"Reference video type. feature is the feature reference video, base is the video to be edited.","enum":["feature","base"],"type":"string"},"video_url":{"description":"URL of uploaded video. Only .mp4/.mov formats are supported. Duration between 3-10 seconds. Resolution must be between 720px and 2160px. Frame rates of 24-60 fps supported. Only 1 video can be uploaded, with size not exceeding 200MB.","type":"string"}},"type":"object"},"type":"array"},"watermark_info":{"description":"Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.","properties":{"enabled":{"description":"true means generate watermark, false means do not generate.","type":"boolean"}},"type":"object"}},"type":"object"},"KlingPresetsElement":{"properties":{"element_description":{"type":"string"},"element_id":{"format":"int64","type":"integer"},"element_image_list":{"properties":{"frontal_image":{"type":"string"},"refer_images":{"items":{"properties":{"image_url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"element_name":{"type":"string"},"element_video_list":{"properties":{"refer_videos":{"items":{"properties":{"video_url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"element_voice_info":{"properties":{"owned_by":{"type":"string"},"trial_url":{"type":"string"},"voice_id":{"type":"string"},"voice_name":{"type":"string"}},"type":"object"},"owned_by":{"type":"string"},"reference_type":{"type":"string"},"tag_list":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"KlingPresetsElementTask":{"properties":{"created_at":{"description":"Task creation time, Unix timestamp in ms","type":"integer"},"final_unit_deduction":{"type":"string"},"task_id":{"type":"string"},"task_info":{"properties":{"external_task_id":{"type":"string"}},"type":"object"},"task_result":{"properties":{"elements":{"items":{"$ref":"#/components/schemas/KlingPresetsElement"},"type":"array"}},"type":"object"},"task_status":{"enum":["submitted","processing","succeed","failed"],"type":"string"},"task_status_msg":{"type":"string"},"updated_at":{"description":"Task update time, Unix timestamp in ms","type":"integer"}},"type":"object"},"KlingPresetsElementsResponse":{"properties":{"code":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/KlingPresetsElementTask"},"type":"array"},"message":{"type":"string"},"request_id":{"type":"string"}},"type":"object"},"KlingQueryTaskResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time, Unix timestamp in milliseconds","type":"integer"},"final_unit_deduction":{"description":"The deduction units of task","type":"string"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"type":"string"}},"type":"object"},"task_result":{"properties":{"videos":{"items":{"$ref":"#/components/schemas/KlingVideoResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"task_status_msg":{"description":"Task status information, displaying the failure reason when the task fails","type":"string"},"updated_at":{"description":"Task update time, Unix timestamp in milliseconds","type":"integer"},"watermark_info":{"properties":{"enabled":{"type":"boolean"}},"type":"object"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingResourcePackageResponse":{"properties":{"code":{"description":"Error code; 0 indicates success","type":"integer"},"data":{"properties":{"code":{"description":"Error code; 0 indicates success","type":"integer"},"msg":{"description":"Error information","type":"string"},"resource_pack_subscribe_infos":{"description":"Resource package list","items":{"properties":{"effective_time":{"description":"Effective time, Unix timestamp in ms","format":"int64","type":"integer"},"invalid_time":{"description":"Expiration time, Unix timestamp in ms","format":"int64","type":"integer"},"purchase_time":{"description":"Purchase time, Unix timestamp in ms","format":"int64","type":"integer"},"remaining_quantity":{"description":"Remaining quantity (updated with a 12-hour delay)","format":"float","type":"number"},"resource_pack_id":{"description":"Resource package ID","type":"string"},"resource_pack_name":{"description":"Resource package name","type":"string"},"resource_pack_type":{"description":"Resource package type (decreasing_total=decreasing total, constant_period=constant periodicity)","enum":["decreasing_total","constant_period"],"type":"string"},"status":{"description":"Resource Package Status","enum":["toBeOnline","online","expired","runOut"],"type":"string"},"total_quantity":{"description":"Total quantity","format":"float","type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"message":{"description":"Error information","type":"string"},"request_id":{"description":"Request ID, generated by the system, used to track requests and troubleshoot problems","type":"string"}},"type":"object"},"KlingSingleImageEffectDuration":{"description":"Video Length in seconds. Only 5-second videos are supported.","enum":["5"],"type":"string"},"KlingSingleImageEffectInput":{"properties":{"duration":{"$ref":"#/components/schemas/KlingSingleImageEffectDuration"},"image":{"description":"Reference Image. URL or Base64 encoded string (without data:image prefix). File size cannot exceed 10MB, resolution not less than 300*300px, aspect ratio between 1:2.5 ~ 2.5:1.","type":"string"},"model_name":{"$ref":"#/components/schemas/KlingSingleImageEffectModelName"}},"required":["model_name","image","duration"],"type":"object"},"KlingSingleImageEffectModelName":{"description":"Model Name. Only kling-v1-6 is supported for single image effects.","enum":["kling-v1-6"],"type":"string"},"KlingSingleImageEffectsScene":{"description":"Scene Name. Single Image Effects (bloombloom, dizzydizzy, fuzzyfuzzy, squish, expansion).","enum":["bloombloom","dizzydizzy","fuzzyfuzzy","squish","expansion"],"type":"string"},"KlingTaskStatus":{"description":"Task Status","enum":["submitted","processing","succeed","failed"],"type":"string"},"KlingText2VideoRequest":{"properties":{"aspect_ratio":{"$ref":"#/components/schemas/KlingVideoGenAspectRatio"},"callback_url":{"description":"The callback notification address","format":"uri","type":"string"},"camera_control":{"$ref":"#/components/schemas/KlingCameraControl"},"cfg_scale":{"$ref":"#/components/schemas/KlingVideoGenCfgScale"},"duration":{"$ref":"#/components/schemas/KlingVideoGenDuration"},"external_task_id":{"description":"Customized Task ID","type":"string"},"mode":{"$ref":"#/components/schemas/KlingVideoGenMode"},"model_name":{"$ref":"#/components/schemas/KlingTextToVideoModelName"},"multi_prompt":{"description":"Information about each storyboard, such as prompts and duration. Supports up to 6 storyboards, with a minimum of 1. Required when multi_shot is true and shot_type is customize.","items":{"properties":{"duration":{"description":"Duration of this storyboard in seconds. Must not exceed total task duration and must not be less than 1. Sum of all storyboard durations equals total task duration.","type":"string"},"index":{"description":"Shot sequence number","type":"integer"},"prompt":{"description":"Prompt word for this storyboard. Maximum length 512 characters.","maxLength":512,"type":"string"}},"type":"object"},"type":"array"},"multi_shot":{"default":false,"description":"Whether to generate multi-shot video. When true, the prompt parameter is invalid. When false, the shot_type and multi_prompt parameters are invalid.","type":"boolean"},"negative_prompt":{"description":"Negative text prompt. It is recommended to supplement negative prompt information through negative sentences directly within positive prompts.","maxLength":2500,"type":"string"},"prompt":{"description":"Positive text prompt. Use \u003c\u003c\u003cvoice_1\u003e\u003e\u003e to specify a voice matching the voice_list parameter order. A task can reference up to 2 tones. When specifying a tone, the sound parameter value must be on.","maxLength":2500,"type":"string"},"shot_type":{"description":"Storyboard method. Required when the multi_shot parameter is set to true.","enum":["customize","intelligence"],"type":"string"},"sound":{"default":"off","description":"Whether to generate sound simultaneously when generating videos. Only V2.6 and subsequent versions of the model support this parameter.","enum":["on","off"],"type":"string"},"watermark_info":{"description":"Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.","properties":{"enabled":{"description":"true means generate watermark, false means do not generate.","type":"boolean"}},"type":"object"}},"type":"object"},"KlingTextToVideoModelName":{"default":"kling-v1","description":"Model Name","enum":["kling-v1","kling-v1-5","kling-v1-6","kling-v2-master","kling-v2-1-master","kling-v2-5-turbo","kling-v2-6","kling-v3"],"type":"string"},"KlingVideoEffectsInput":{"oneOf":[{"$ref":"#/components/schemas/KlingSingleImageEffectInput"},{"$ref":"#/components/schemas/KlingDualCharacterEffectInput"}]},"KlingVideoEffectsRequest":{"properties":{"callback_url":{"description":"The callback notification address for the result of this task.","format":"uri","type":"string"},"effect_scene":{"oneOf":[{"$ref":"#/components/schemas/KlingDualCharacterEffectsScene"},{"$ref":"#/components/schemas/KlingSingleImageEffectsScene"}]},"external_task_id":{"description":"Customized Task ID. Must be unique within a single user account.","type":"string"},"input":{"$ref":"#/components/schemas/KlingVideoEffectsInput"}},"required":["effect_scene","input"],"type":"object"},"KlingVideoEffectsResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time","type":"integer"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"type":"string"}},"type":"object"},"task_result":{"properties":{"videos":{"items":{"$ref":"#/components/schemas/KlingVideoResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"updated_at":{"description":"Task update time","type":"integer"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingVideoExtendRequest":{"properties":{"callback_url":{"description":"The callback notification address. Server will notify when the task status changes.","format":"uri","type":"string"},"cfg_scale":{"$ref":"#/components/schemas/KlingVideoGenCfgScale"},"negative_prompt":{"description":"Negative text prompt for elements to avoid in the extended video","maxLength":2500,"type":"string"},"prompt":{"description":"Positive text prompt for guiding the video extension","maxLength":2500,"type":"string"},"video_id":{"description":"The ID of the video to be extended. Supports videos generated by text-to-video, image-to-video, and previous video extension operations. Cannot exceed 3 minutes total duration after extension.","type":"string"}},"type":"object"},"KlingVideoExtendResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time","type":"integer"},"task_id":{"description":"Task ID","type":"string"},"task_info":{"properties":{"external_task_id":{"type":"string"}},"type":"object"},"task_result":{"properties":{"videos":{"items":{"$ref":"#/components/schemas/KlingVideoResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"updated_at":{"description":"Task update time","type":"integer"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"KlingVideoGenAspectRatio":{"default":"16:9","description":"Video aspect ratio","enum":["16:9","9:16","1:1"],"type":"string"},"KlingVideoGenCfgScale":{"default":0.5,"description":"Flexibility in video generation. The higher the value, the lower the model's degree of flexibility, and the stronger the relevance to the user's prompt.","format":"float","maximum":1,"minimum":0,"type":"number"},"KlingVideoGenDuration":{"default":"5","description":"Video length in seconds","enum":["3","4","5","6","7","8","9","10","11","12","13","14","15"],"type":"string"},"KlingVideoGenMode":{"default":"std","description":"Video generation mode. std: Standard Mode, which is cost-effective. pro: Professional Mode, generates videos with longer duration but higher quality output.","enum":["std","pro"],"type":"string"},"KlingVideoGenModelName":{"default":"kling-v1","description":"Model Name","enum":["kling-v1","kling-v1-5","kling-v1-6","kling-v2-master","kling-v2-1","kling-v2-1-master","kling-v2-5-turbo","kling-v2-6","kling-v3"],"type":"string"},"KlingVideoResult":{"properties":{"duration":{"description":"Total video duration in seconds","type":"string"},"id":{"description":"Generated video ID","type":"string"},"url":{"description":"URL for generated video","format":"uri","type":"string"},"watermark_url":{"description":"URL for generated video with watermark, hotlink protection format","format":"uri","type":"string"}},"type":"object"},"KlingVirtualTryOnModelName":{"default":"kolors-virtual-try-on-v1","description":"Model Name","enum":["kolors-virtual-try-on-v1","kolors-virtual-try-on-v1-5"],"type":"string"},"KlingVirtualTryOnRequest":{"properties":{"callback_url":{"description":"The callback notification address","format":"uri","type":"string"},"cloth_image":{"description":"Reference clothing image - Base64 encoded string or image URL","type":"string"},"human_image":{"description":"Reference human image - Base64 encoded string or image URL","type":"string"},"model_name":{"$ref":"#/components/schemas/KlingVirtualTryOnModelName"}},"required":["human_image"],"type":"object"},"KlingVirtualTryOnResponse":{"properties":{"code":{"description":"Error code","type":"integer"},"data":{"properties":{"created_at":{"description":"Task creation time","type":"integer"},"task_id":{"description":"Task ID","type":"string"},"task_result":{"properties":{"images":{"items":{"$ref":"#/components/schemas/KlingImageResult"},"type":"array"}},"type":"object"},"task_status":{"$ref":"#/components/schemas/KlingTaskStatus"},"task_status_msg":{"description":"Task status information","type":"string"},"updated_at":{"description":"Task update time","type":"integer"}},"type":"object"},"message":{"description":"Error message","type":"string"},"request_id":{"description":"Request ID","type":"string"}},"type":"object"},"LTXImage2VideoRequest":{"properties":{"duration":{"description":"Video duration in seconds","enum":[6,8,10],"type":"integer"},"fps":{"default":25,"description":"Frame rate in frames per second","enum":[25,50],"type":"integer"},"generate_audio":{"default":true,"description":"Generate audio for the video","type":"boolean"},"image_uri":{"description":"Image to be used as the first frame of the video (HTTPS URL or base64 data URI)","type":"string"},"model":{"description":"Model to use for generation","enum":["ltx-2-fast","ltx-2-pro"],"type":"string"},"prompt":{"description":"Text description of how the image should be animated","maxLength":10000,"type":"string"},"resolution":{"description":"Output video resolution","enum":["1920x1080","2560x1440","3840x2160"],"type":"string"}},"required":["image_uri","prompt","model","duration","resolution"],"type":"object"},"LTXText2VideoRequest":{"properties":{"duration":{"description":"Video duration in seconds","enum":[6,8,10],"type":"integer"},"fps":{"default":25,"description":"Frame rate in frames per second","enum":[25,50],"type":"integer"},"generate_audio":{"default":true,"description":"Generate audio for the video","type":"boolean"},"model":{"description":"Model to use for generation","enum":["ltx-2-fast","ltx-2-pro"],"type":"string"},"prompt":{"description":"Text prompt describing the desired video content","maxLength":10000,"type":"string"},"resolution":{"description":"Output video resolution","enum":["1920x1080","2560x1440","3840x2160"],"type":"string"}},"required":["prompt","model","duration","resolution"],"type":"object"},"LumaAgentsAspectRatio":{"description":"Output aspect ratio","enum":["3:1","2:1","16:9","3:2","1:1","2:3","9:16","1:2","1:3"],"type":"string"},"LumaAgentsError":{"description":"The error object","properties":{"detail":{"description":"The error message","type":"string"}},"type":"object"},"LumaAgentsFailureCode":{"description":"Machine-readable failure code for programmatic handling","enum":["content_moderated","generation_failed","budget_exhausted","output_not_found"],"type":"string"},"LumaAgentsGeneration":{"description":"Generation status and output","properties":{"created_at":{"description":"Creation timestamp","type":"string"},"failure_code":{"$ref":"#/components/schemas/LumaAgentsFailureCode"},"failure_reason":{"description":"Human-readable failure description","type":"string"},"id":{"description":"Generation identifier","type":"string"},"model":{"description":"Model used","type":"string"},"output":{"items":{"$ref":"#/components/schemas/LumaAgentsGenerationOutput"},"type":"array"},"state":{"$ref":"#/components/schemas/LumaAgentsState"},"type":{"$ref":"#/components/schemas/LumaAgentsGenerationType"}},"type":"object"},"LumaAgentsGenerationOutput":{"description":"A generated output entry","properties":{"type":{"description":"Media type (e.g. image)","type":"string"},"url":{"description":"Presigned URL (1hr expiry)","type":"string"}},"type":"object"},"LumaAgentsGenerationRequest":{"description":"The Luma Agents generation request object","properties":{"aspect_ratio":{"$ref":"#/components/schemas/LumaAgentsAspectRatio"},"image_ref":{"description":"Reference images for style/content guidance. Up to 9 for type 'image', up to 8 for type 'image_edit'.","items":{"$ref":"#/components/schemas/LumaAgentsImageRef"},"type":"array"},"model":{"description":"Model to use","type":"string"},"output_format":{"$ref":"#/components/schemas/LumaAgentsOutputFormat"},"prompt":{"description":"Text prompt","type":"string"},"source":{"$ref":"#/components/schemas/LumaAgentsImageRef"},"style":{"$ref":"#/components/schemas/LumaAgentsStyle"},"type":{"$ref":"#/components/schemas/LumaAgentsGenerationType"},"web_search":{"description":"Enable web search grounding","type":"boolean"}},"required":["prompt"],"type":"object"},"LumaAgentsGenerationType":{"description":"The kind of generation to perform","enum":["image","image_edit"],"type":"string"},"LumaAgentsImageRef":{"description":"Reference image for style/content guidance or guided generation","properties":{"data":{"description":"Base64-encoded image data","type":"string"},"media_type":{"description":"MIME type (e.g. image/jpeg). Required with data.","type":"string"},"url":{"description":"Publicly accessible image URL","type":"string"}},"type":"object"},"LumaAgentsOutputFormat":{"description":"Output image format","enum":["png","jpeg"],"type":"string"},"LumaAgentsState":{"description":"Current state of the generation","enum":["queued","processing","completed","failed"],"type":"string"},"LumaAgentsStyle":{"description":"Style preset","enum":["auto","manga"],"type":"string"},"LumaAspectRatio":{"default":"16:9","description":"The aspect ratio of the generation","enum":["1:1","16:9","9:16","4:3","3:4","21:9","9:21"],"example":"16:9","type":"string"},"LumaAssets":{"description":"The assets of the generation","properties":{"image":{"description":"The URL of the image","format":"uri","type":"string"},"progress_video":{"description":"The URL of the progress video","format":"uri","type":"string"},"video":{"description":"The URL of the video","format":"uri","type":"string"}},"type":"object"},"LumaAudioGenerationRequest":{"description":"The audio generation request object","properties":{"callback_url":{"description":"The callback URL for the audio","format":"uri","type":"string"},"generation_type":{"default":"add_audio","enum":["add_audio"],"type":"string"},"negative_prompt":{"description":"The negative prompt of the audio","type":"string"},"prompt":{"description":"The prompt of the audio","type":"string"}},"type":"object"},"LumaError":{"description":"The error object","example":{"detail":"Invalid API key is provided"},"properties":{"detail":{"description":"The error message","type":"string"}},"type":"object"},"LumaGeneration":{"description":"The generation response object","example":{"assets":{"video":"https://example.com/video.mp4"},"created_at":"2023-06-01T12:00:00Z","failure_reason":null,"id":"123e4567-e89b-12d3-a456-426614174000","model":"ray-2","request":{"aspect_ratio":"16:9","keyframes":{"frame0":{"type":"image","url":"https://example.com/image.jpg"},"frame1":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"generation"}},"loop":true,"prompt":"A serene lake surrounded by mountains at sunset"},"state":"completed"},"properties":{"assets":{"$ref":"#/components/schemas/LumaAssets"},"created_at":{"description":"The date and time when the generation was created","format":"date-time","type":"string"},"failure_reason":{"description":"The reason for the state of the generation","type":"string"},"generation_type":{"$ref":"#/components/schemas/LumaGenerationType"},"id":{"description":"The ID of the generation","format":"uuid","type":"string"},"model":{"description":"The model used for the generation","type":"string"},"request":{"description":"The request of the generation","oneOf":[{"$ref":"#/components/schemas/LumaGenerationRequest"},{"$ref":"#/components/schemas/LumaImageGenerationRequest"},{"$ref":"#/components/schemas/LumaUpscaleVideoGenerationRequest"},{"$ref":"#/components/schemas/LumaAudioGenerationRequest"}]},"state":{"$ref":"#/components/schemas/LumaState"}},"type":"object"},"LumaGenerationReference":{"description":"The generation reference object","example":{"id":"123e4567-e89b-12d3-a456-426614174003","type":"generation"},"properties":{"id":{"description":"The ID of the generation","format":"uuid","type":"string"},"type":{"default":"generation","enum":["generation"],"type":"string"}},"required":["type","id"],"type":"object"},"LumaGenerationRequest":{"description":"The generation request object","properties":{"aspect_ratio":{"$ref":"#/components/schemas/LumaAspectRatio"},"callback_url":{"description":"The callback URL of the generation, a POST request with Generation object will be sent to the callback URL when the generation is dreaming, completed, or failed","format":"uri","type":"string"},"duration":{"$ref":"#/components/schemas/LumaVideoModelOutputDuration"},"generation_type":{"default":"video","enum":["video"],"type":"string"},"keyframes":{"$ref":"#/components/schemas/LumaKeyframes"},"loop":{"description":"Whether to loop the video","type":"boolean"},"model":{"$ref":"#/components/schemas/LumaVideoModel"},"prompt":{"description":"The prompt of the generation","type":"string"},"resolution":{"$ref":"#/components/schemas/LumaVideoModelOutputResolution"}},"required":["duration","resolution","prompt","aspect_ratio","model"],"type":"object"},"LumaGenerationType":{"enum":["video","image"],"type":"string"},"LumaImageGenerationRequest":{"description":"The image generation request object","properties":{"aspect_ratio":{"$ref":"#/components/schemas/LumaAspectRatio"},"callback_url":{"description":"The callback URL for the generation","format":"uri","type":"string"},"character_ref":{"properties":{"identity0":{"$ref":"#/components/schemas/LumaImageIdentity"}},"type":"object"},"generation_type":{"default":"image","enum":["image"],"type":"string"},"image_ref":{"items":{"$ref":"#/components/schemas/LumaImageRef"},"type":"array"},"model":{"$ref":"#/components/schemas/LumaImageModel"},"modify_image_ref":{"$ref":"#/components/schemas/LumaModifyImageRef"},"prompt":{"description":"The prompt of the generation","type":"string"},"style_ref":{"items":{"$ref":"#/components/schemas/LumaImageRef"},"type":"array"}},"type":"object"},"LumaImageIdentity":{"description":"The image identity object","properties":{"images":{"description":"The URLs of the image identity","items":{"format":"uri","type":"string"},"type":"array"}},"type":"object"},"LumaImageModel":{"default":"photon-1","description":"The image model used for the generation","enum":["photon-1","photon-flash-1"],"type":"string"},"LumaImageRef":{"description":"The image reference object","properties":{"url":{"description":"The URL of the image reference","format":"uri","type":"string"},"weight":{"description":"The weight of the image reference","type":"number"}},"type":"object"},"LumaImageReference":{"description":"The image object","example":{"type":"image","url":"https://example.com/image.jpg"},"properties":{"type":{"default":"image","enum":["image"],"type":"string"},"url":{"description":"The URL of the image","format":"uri","type":"string"}},"required":["type","url"],"type":"object"},"LumaKeyframe":{"description":"A keyframe can be either a Generation reference, an Image, or a Video","discriminator":{"mapping":{"generation":"#/components/schemas/LumaGenerationReference","image":"#/components/schemas/LumaImageReference"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/LumaGenerationReference"},{"$ref":"#/components/schemas/LumaImageReference"}]},"LumaKeyframes":{"description":"The keyframes of the generation","example":{"frame0":{"type":"image","url":"https://example.com/image.jpg"},"frame1":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"generation"}},"properties":{"frame0":{"$ref":"#/components/schemas/LumaKeyframe"},"frame1":{"$ref":"#/components/schemas/LumaKeyframe"}},"type":"object"},"LumaModifyImageRef":{"description":"The modify image reference object","properties":{"url":{"description":"The URL of the image reference","format":"uri","type":"string"},"weight":{"description":"The weight of the modify image reference","type":"number"}},"type":"object"},"LumaState":{"description":"The state of the generation","enum":["queued","dreaming","completed","failed"],"example":"completed","type":"string"},"LumaUpscaleVideoGenerationRequest":{"description":"The upscale generation request object","properties":{"callback_url":{"description":"The callback URL for the upscale","format":"uri","type":"string"},"generation_type":{"default":"upscale_video","enum":["upscale_video"],"type":"string"},"resolution":{"$ref":"#/components/schemas/LumaVideoModelOutputResolution"}},"type":"object"},"LumaVideoModel":{"default":"ray-2","description":"The video model used for the generation","enum":["ray-2","ray-flash-2","ray-1-6"],"example":"ray-2","type":"string"},"LumaVideoModelOutputDuration":{"anyOf":[{"enum":["5s","9s"],"type":"string"},{"type":"string"}]},"LumaVideoModelOutputResolution":{"anyOf":[{"enum":["540p","720p","1080p","4k"],"type":"string"},{"type":"string"}]},"MachineStats":{"properties":{"cpu_capacity":{"description":"Total CPU on the machine.","type":"string"},"disk_capacity":{"description":"Total disk capacity on the machine.","type":"string"},"gpu_type":{"description":"The GPU type. eg. NVIDIA Tesla K80","type":"string"},"initial_cpu":{"description":"Initial CPU available before the job starts.","type":"string"},"initial_disk":{"description":"Initial disk available before the job starts.","type":"string"},"initial_ram":{"description":"Initial RAM available before the job starts.","type":"string"},"machine_name":{"description":"Name of the machine.","type":"string"},"memory_capacity":{"description":"Total memory on the machine.","type":"string"},"os_version":{"description":"The operating system version. eg. Ubuntu Linux 20.04","type":"string"},"pip_freeze":{"description":"The pip freeze output","type":"string"},"vram_time_series":{"description":"Time series of VRAM usage.","type":"object"}},"type":"object"},"MeshyAiModel":{"default":"latest","description":"ID of the model to use.","enum":["meshy-5","latest"],"type":"string"},"MeshyAnimationCreateResponse":{"properties":{"result":{"description":"The task id of the newly created animation task.","type":"string"}},"required":["result"],"type":"object"},"MeshyAnimationPostProcess":{"description":"Parameters for post-processing animation files.","properties":{"fps":{"default":30,"description":"The target frame rate. Default is 30. Applicable only when operation_type is change_fps.","enum":[24,25,30,60],"type":"integer"},"operation_type":{"description":"The type of operation to perform.","enum":["change_fps","fbx2usdz","extract_armature"],"type":"string"}},"required":["operation_type"],"type":"object"},"MeshyAnimationRequest":{"properties":{"action_id":{"description":"The identifier of the animation action to apply.","type":"integer"},"post_process":{"$ref":"#/components/schemas/MeshyAnimationPostProcess"},"rig_task_id":{"description":"The id of a successfully completed rigging task (from POST /openapi/v1/rigging). The character from this task will be animated.","type":"string"}},"required":["rig_task_id","action_id"],"type":"object"},"MeshyAnimationResult":{"description":"Contains the output animation URLs if the task SUCCEEDED.","properties":{"animation_fbx_url":{"description":"Downloadable URL for the animation in FBX format.","type":"string"},"animation_glb_url":{"description":"Downloadable URL for the animation in GLB format.","type":"string"},"processed_animation_fps_fbx_url":{"description":"Downloadable URL for the animation with changed FPS in FBX format.","type":"string"},"processed_armature_fbx_url":{"description":"Downloadable URL for the processed armature in FBX format.","type":"string"},"processed_usdz_url":{"description":"Downloadable URL for the processed animation in USDZ format.","type":"string"}},"type":"object"},"MeshyAnimationTask":{"properties":{"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"expires_at":{"description":"Timestamp of when the task result expires, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task (0-100).","maximum":100,"minimum":0,"type":"integer"},"result":{"$ref":"#/components/schemas/MeshyAnimationResult"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"type":{"description":"Type of the Animation task.","enum":["animate"],"type":"string"}},"required":["id","status"],"type":"object"},"MeshyArtStyle":{"default":"realistic","description":"Describe your desired art style of the object.","enum":["realistic","sculpture"],"type":"string"},"MeshyImageTo3DCreateResponse":{"properties":{"result":{"description":"The task id of the newly created Image to 3D task.","type":"string"}},"required":["result"],"type":"object"},"MeshyImageTo3DModelUrls":{"description":"Downloadable URLs to the 3D model files generated by Meshy.","properties":{"fbx":{"description":"Downloadable URL to the FBX file.","type":"string"},"glb":{"description":"Downloadable URL to the GLB file.","type":"string"},"mtl":{"description":"Downloadable URL to the MTL file.","type":"string"},"obj":{"description":"Downloadable URL to the OBJ file.","type":"string"},"pre_remeshed_glb":{"description":"Downloadable URL to the original GLB output before remeshing. Available only when should_remesh and save_pre_remeshed_model are both true.","type":"string"},"usdz":{"description":"Downloadable URL to the USDZ file.","type":"string"}},"type":"object"},"MeshyImageTo3DRequest":{"properties":{"ai_model":{"$ref":"#/components/schemas/MeshyAiModel"},"enable_pbr":{"default":false,"description":"Generate PBR Maps (metallic, roughness, normal) in addition to the base color.","type":"boolean"},"image_url":{"description":"Provide an image for Meshy to use in model creation. Supports .jpg, .jpeg, .png formats or base64-encoded data URI.","type":"string"},"is_a_t_pose":{"default":false,"description":"Deprecated. Use pose_mode instead. Whether to generate the model in an A/T pose.","type":"boolean"},"model_type":{"default":"standard","description":"Specify the type of 3D mesh generation.\n- standard: Regular high-detail 3D mesh generation.\n- lowpoly: Generates low-poly mesh optimized for cleaner polygons.\nWhen lowpoly is selected, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model are ignored.\n","enum":["standard","lowpoly"],"type":"string"},"moderation":{"default":false,"description":"When true, input content will be screened for potentially harmful content.","type":"boolean"},"pose_mode":{"$ref":"#/components/schemas/MeshyPoseMode"},"save_pre_remeshed_model":{"default":false,"description":"When true, stores an extra GLB file before the remesh phase completes. Only takes effect when should_remesh is true.","type":"boolean"},"should_remesh":{"default":true,"description":"Controls whether to enable the remesh phase. When false, returns highest-precision triangular mesh.","type":"boolean"},"should_texture":{"default":true,"description":"Determines if textures are generated. When false, provides a mesh without textures.","type":"boolean"},"symmetry_mode":{"$ref":"#/components/schemas/MeshySymmetryMode"},"target_polycount":{"default":30000,"description":"Specify the target number of polygons in the generated model. Valid range is 100 to 300,000.","maximum":300000,"minimum":100,"type":"integer"},"texture_image_url":{"description":"Provide a 2d image to guide the texturing process. Supports .jpg, .jpeg, .png formats or base64-encoded data URI.","type":"string"},"texture_prompt":{"description":"Provide a text prompt to guide the texturing process. Maximum 600 characters.","maxLength":600,"type":"string"},"topology":{"$ref":"#/components/schemas/MeshyTopology"}},"required":["image_url"],"type":"object"},"MeshyImageTo3DTask":{"properties":{"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"expires_at":{"description":"Timestamp of when the task result expires, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"model_urls":{"$ref":"#/components/schemas/MeshyImageTo3DModelUrls"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task. 0 if not started, 100 when succeeded.","maximum":100,"minimum":0,"type":"integer"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"texture_image_url":{"description":"Downloadable URL to the texture image that was used to guide the texturing process.","type":"string"},"texture_prompt":{"description":"The text prompt that was used to guide the texturing process.","type":"string"},"texture_urls":{"description":"An array of texture URL objects that are generated from the task.","items":{"$ref":"#/components/schemas/MeshyTextureUrls"},"type":"array"},"thumbnail_url":{"description":"Downloadable URL to the thumbnail image of the model file.","type":"string"},"type":{"description":"Type of the Image to 3D task.","enum":["image-to-3d"],"type":"string"}},"required":["id","status"],"type":"object"},"MeshyModelUrls":{"description":"Downloadable URLs to the textured 3D model files generated by Meshy.","properties":{"fbx":{"description":"Downloadable URL to the FBX file.","type":"string"},"glb":{"description":"Downloadable URL to the GLB file.","type":"string"},"mtl":{"description":"Downloadable URL to the MTL file.","type":"string"},"obj":{"description":"Downloadable URL to the OBJ file.","type":"string"},"usdz":{"description":"Downloadable URL to the USDZ file.","type":"string"}},"type":"object"},"MeshyMultiImageTo3DCreateResponse":{"properties":{"result":{"description":"The task id of the newly created Multi-Image to 3D task.","type":"string"}},"required":["result"],"type":"object"},"MeshyMultiImageTo3DRequest":{"properties":{"ai_model":{"default":"latest","description":"ID of the model to use.","enum":["meshy-5","latest"],"type":"string"},"enable_pbr":{"default":false,"description":"Generate PBR Maps (metallic, roughness, normal) in addition to the base color.","type":"boolean"},"image_urls":{"description":"Provide 1 to 4 images for Meshy to use in model creation. All images should depict the same object from different angles.","items":{"type":"string"},"maxItems":4,"minItems":1,"type":"array"},"is_a_t_pose":{"default":false,"description":"Deprecated. Use pose_mode instead. Whether to generate the model in an A/T pose.","type":"boolean"},"moderation":{"default":false,"description":"When true, input content will be screened for potentially harmful content.","type":"boolean"},"pose_mode":{"$ref":"#/components/schemas/MeshyPoseMode"},"save_pre_remeshed_model":{"default":false,"description":"When true, stores an extra GLB file before the remesh phase completes. Only takes effect when should_remesh is true.","type":"boolean"},"should_remesh":{"default":true,"description":"Controls whether to enable the remesh phase. When false, returns highest-precision triangular mesh.","type":"boolean"},"should_texture":{"default":true,"description":"Determines if textures are generated. When false, provides a mesh without textures for 5 credits.","type":"boolean"},"symmetry_mode":{"$ref":"#/components/schemas/MeshySymmetryMode"},"target_polycount":{"default":30000,"description":"Specify the target number of polygons in the generated model. Valid range is 100 to 300,000.","maximum":300000,"minimum":100,"type":"integer"},"texture_image_url":{"description":"Provide a 2d image to guide the texturing process. Supports .jpg, .jpeg, .png formats or base64-encoded data URI.","type":"string"},"texture_prompt":{"description":"Provide a text prompt to guide the texturing process. Maximum 600 characters.","maxLength":600,"type":"string"},"topology":{"$ref":"#/components/schemas/MeshyTopology"}},"required":["image_urls"],"type":"object"},"MeshyMultiImageTo3DTask":{"properties":{"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"expires_at":{"description":"Timestamp of when the task result expires, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"model_urls":{"$ref":"#/components/schemas/MeshyImageTo3DModelUrls"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task. 0 if not started, 100 when succeeded.","maximum":100,"minimum":0,"type":"integer"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"texture_prompt":{"description":"The text prompt that was used to guide the texturing process.","type":"string"},"texture_urls":{"description":"An array of texture URL objects that are generated from the task.","items":{"$ref":"#/components/schemas/MeshyTextureUrls"},"type":"array"},"thumbnail_url":{"description":"Downloadable URL to the thumbnail image of the model file.","type":"string"},"type":{"description":"Type of the Multi-Image to 3D task.","enum":["multi-image-to-3d"],"type":"string"}},"required":["id","status"],"type":"object"},"MeshyPoseMode":{"description":"Specify the pose mode for the generated model.","enum":["a-pose","t-pose",""],"type":"string"},"MeshyRemeshCreateResponse":{"properties":{"result":{"description":"The id of the newly created remesh task.","type":"string"}},"required":["result"],"type":"object"},"MeshyRemeshModelUrls":{"description":"Downloadable URLs to the remeshed 3D model files.","properties":{"blend":{"description":"Downloadable URL to the Blender file.","type":"string"},"fbx":{"description":"Downloadable URL to the FBX file.","type":"string"},"glb":{"description":"Downloadable URL to the GLB file.","type":"string"},"obj":{"description":"Downloadable URL to the OBJ file.","type":"string"},"stl":{"description":"Downloadable URL to the STL file.","type":"string"},"usdz":{"description":"Downloadable URL to the USDZ file.","type":"string"}},"type":"object"},"MeshyRemeshRequest":{"properties":{"convert_format_only":{"default":false,"description":"If true, only changes the format of the input model file, ignoring other inputs like topology, resize_height, and target_polycount.","type":"boolean"},"input_task_id":{"description":"The ID of the completed Image to 3D or Text to 3D task you wish to remesh. Required if model_url is not provided.","type":"string"},"model_url":{"description":"A publicly accessible URL or data URI to a 3D model. Supported formats glb, gltf, obj, fbx, stl. Required if input_task_id is not provided.","type":"string"},"origin_at":{"description":"Position of the origin.","enum":["bottom","center",""],"type":"string"},"resize_height":{"default":0,"description":"Resize the model to a certain height measured in meters. 0 means no resizing.","type":"number"},"target_formats":{"default":["glb"],"description":"A list of target formats for the remeshed model.","items":{"enum":["glb","fbx","obj","usdz","blend","stl"],"type":"string"},"type":"array"},"target_polycount":{"default":30000,"description":"Specify the target number of polygons in the generated model. Valid range is 100 to 300,000.","maximum":300000,"minimum":100,"type":"integer"},"topology":{"$ref":"#/components/schemas/MeshyTopology"}},"type":"object"},"MeshyRemeshTask":{"properties":{"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"model_urls":{"$ref":"#/components/schemas/MeshyRemeshModelUrls"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task. 0 if not started, 100 when succeeded.","maximum":100,"minimum":0,"type":"integer"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyRemeshTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"type":{"description":"Type of the Remesh task.","enum":["remesh"],"type":"string"}},"required":["id","status"],"type":"object"},"MeshyRemeshTaskStatus":{"description":"Status of the remesh task.","enum":["PENDING","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"MeshyRetextureCreateResponse":{"properties":{"result":{"description":"The task id of the newly created Retexture task.","type":"string"}},"required":["result"],"type":"object"},"MeshyRetextureModelUrls":{"description":"Downloadable URLs to the textured 3D model files.","properties":{"fbx":{"description":"Downloadable URL to the FBX file.","type":"string"},"glb":{"description":"Downloadable URL to the GLB file.","type":"string"},"usdz":{"description":"Downloadable URL to the USDZ file.","type":"string"}},"type":"object"},"MeshyRetextureRequest":{"properties":{"ai_model":{"$ref":"#/components/schemas/MeshyAiModel"},"enable_original_uv":{"default":true,"description":"Use the original UV of the model instead of generating new UVs.","type":"boolean"},"enable_pbr":{"default":false,"description":"Generate PBR Maps (metallic, roughness, normal) in addition to the base color.","type":"boolean"},"image_style_url":{"description":"A 2d image to guide the texturing process. Supports jpg, jpeg, png formats or base64-encoded data URI. Required if text_style_prompt is not provided.","type":"string"},"input_task_id":{"description":"The ID of the completed Image to 3D or Text to 3D task you wish to retexture. Required if model_url is not provided.","type":"string"},"model_url":{"description":"A publicly accessible URL or Data URI to a 3D model. Supported formats glb, gltf, obj, fbx, stl. Required if input_task_id is not provided.","type":"string"},"text_style_prompt":{"description":"Describe your desired texture style of the object using text. Maximum 600 characters. Required if image_style_url is not provided.","maxLength":600,"type":"string"}},"type":"object"},"MeshyRetextureTask":{"properties":{"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"expires_at":{"description":"Timestamp of when the task result expires, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"image_style_url":{"description":"The image input that was used to create the texturing task.","type":"string"},"model_urls":{"$ref":"#/components/schemas/MeshyRetextureModelUrls"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task. 0 if not started, 100 when succeeded.","maximum":100,"minimum":0,"type":"integer"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"text_style_prompt":{"description":"The text prompt that was used to create the texturing task.","type":"string"},"texture_urls":{"description":"An array of texture URL objects that are generated from the task.","items":{"$ref":"#/components/schemas/MeshyTextureUrls"},"type":"array"},"thumbnail_url":{"description":"Downloadable URL to the thumbnail image of the model file.","type":"string"},"type":{"description":"Type of the Retexture task.","enum":["retexture"],"type":"string"}},"required":["id","status"],"type":"object"},"MeshyRiggingBasicAnimations":{"description":"Contains URLs for default animations.","properties":{"running_armature_glb_url":{"description":"Downloadable URL for running animation armature in GLB format.","type":"string"},"running_fbx_url":{"description":"Downloadable URL for running animation in FBX format (with skin).","type":"string"},"running_glb_url":{"description":"Downloadable URL for running animation in GLB format (with skin).","type":"string"},"walking_armature_glb_url":{"description":"Downloadable URL for walking animation armature in GLB format.","type":"string"},"walking_fbx_url":{"description":"Downloadable URL for walking animation in FBX format (with skin).","type":"string"},"walking_glb_url":{"description":"Downloadable URL for walking animation in GLB format (with skin).","type":"string"}},"type":"object"},"MeshyRiggingCreateResponse":{"properties":{"result":{"description":"The task id of the newly created rigging task.","type":"string"}},"required":["result"],"type":"object"},"MeshyRiggingRequest":{"properties":{"height_meters":{"default":1.7,"description":"The approximate height of the character model in meters. Must be a positive number.","type":"number"},"input_task_id":{"description":"The input task that needs to be rigged. Required if model_url is not provided.","type":"string"},"model_url":{"description":"A publicly accessible URL or Data URI to a textured humanoid GLB file. Required if input_task_id is not provided.","type":"string"},"texture_image_url":{"description":"The model's UV-unwrapped base color texture image. Publicly accessible URL or Data URI. Supports .png format.","type":"string"}},"type":"object"},"MeshyRiggingResult":{"description":"Contains the output asset URLs if the task SUCCEEDED.","properties":{"basic_animations":{"$ref":"#/components/schemas/MeshyRiggingBasicAnimations"},"rigged_character_fbx_url":{"description":"Downloadable URL for the rigged character in FBX format.","type":"string"},"rigged_character_glb_url":{"description":"Downloadable URL for the rigged character in GLB format.","type":"string"}},"type":"object"},"MeshyRiggingTask":{"properties":{"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"expires_at":{"description":"Timestamp of when the task result expires, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task (0-100). 0 if not started, 100 if succeeded.","maximum":100,"minimum":0,"type":"integer"},"result":{"$ref":"#/components/schemas/MeshyRiggingResult"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"type":{"description":"Type of the Rigging task.","enum":["rig"],"type":"string"}},"required":["id","status"],"type":"object"},"MeshySymmetryMode":{"default":"auto","description":"Controls symmetry behavior during model generation.","enum":["off","auto","on"],"type":"string"},"MeshyTaskError":{"description":"Error object that contains the error message if the task failed.","properties":{"message":{"description":"Detailed error message.","type":"string"}},"type":"object"},"MeshyTaskStatus":{"description":"Status of the task.","enum":["PENDING","IN_PROGRESS","SUCCEEDED","FAILED","CANCELED"],"type":"string"},"MeshyTextTo3DCreateResponse":{"properties":{"result":{"description":"The task id of the newly created Text to 3D task.","type":"string"}},"required":["result"],"type":"object"},"MeshyTextTo3DPreviewRequest":{"properties":{"ai_model":{"$ref":"#/components/schemas/MeshyAiModel"},"art_style":{"$ref":"#/components/schemas/MeshyArtStyle"},"is_a_t_pose":{"default":false,"description":"Deprecated. Use pose_mode instead. Whether to generate the model in an A/T pose.","type":"boolean"},"mode":{"description":"This field should be set to \"preview\" when creating a preview task.","enum":["preview"],"type":"string"},"moderation":{"default":false,"description":"When true, input content will be screened for potentially harmful content.","type":"boolean"},"pose_mode":{"$ref":"#/components/schemas/MeshyPoseMode"},"prompt":{"description":"Describe what kind of object the 3D model is. Maximum 600 characters.","maxLength":600,"type":"string"},"should_remesh":{"default":true,"description":"Controls whether to enable the remesh phase. When false, returns highest-precision triangular mesh.","type":"boolean"},"symmetry_mode":{"$ref":"#/components/schemas/MeshySymmetryMode"},"target_polycount":{"default":30000,"description":"Specify the target number of polygons in the generated model. Valid range is 100 to 300,000.","maximum":300000,"minimum":100,"type":"integer"},"topology":{"$ref":"#/components/schemas/MeshyTopology"}},"required":["mode","prompt"],"type":"object"},"MeshyTextTo3DRefineRequest":{"properties":{"ai_model":{"$ref":"#/components/schemas/MeshyAiModel"},"enable_pbr":{"default":false,"description":"Generate PBR Maps (metallic, roughness, normal) in addition to the base color. Note that enable_pbr should be set to false when using Sculpture style.","type":"boolean"},"mode":{"description":"This field should be set to \"refine\" when creating a refine task.","enum":["refine"],"type":"string"},"moderation":{"default":false,"description":"When true, input content will be screened for potentially harmful content.","type":"boolean"},"preview_task_id":{"description":"The corresponding preview task id. The status of the given preview task must be SUCCEEDED.","type":"string"},"texture_image_url":{"description":"Provide a 2d image to guide the texturing process. Supports .jpg, .jpeg, .png formats or base64-encoded data URI.","type":"string"},"texture_prompt":{"description":"Provide an additional text prompt to guide the texturing process. Maximum 600 characters.","maxLength":600,"type":"string"}},"required":["mode","preview_task_id"],"type":"object"},"MeshyTextTo3DRequest":{"discriminator":{"mapping":{"preview":"#/components/schemas/MeshyTextTo3DPreviewRequest","refine":"#/components/schemas/MeshyTextTo3DRefineRequest"},"propertyName":"mode"},"oneOf":[{"$ref":"#/components/schemas/MeshyTextTo3DPreviewRequest"},{"$ref":"#/components/schemas/MeshyTextTo3DRefineRequest"}]},"MeshyTextTo3DTask":{"properties":{"art_style":{"description":"The unmodified art_style that was used to create the preview task.","type":"string"},"created_at":{"description":"Timestamp of when the task was created, in milliseconds.","type":"integer"},"finished_at":{"description":"Timestamp of when the task was finished, in milliseconds. 0 if not finished.","type":"integer"},"id":{"description":"Unique identifier for the task.","type":"string"},"model_urls":{"$ref":"#/components/schemas/MeshyModelUrls"},"negative_prompt":{"description":"Deprecated field maintained for backward compatibility.","type":"string"},"preceding_tasks":{"description":"The count of preceding tasks. Only meaningful when status is PENDING.","type":"integer"},"progress":{"description":"Progress of the task. 0 if not started, 100 when succeeded.","maximum":100,"minimum":0,"type":"integer"},"prompt":{"description":"The unmodified prompt that was used to create the task.","type":"string"},"started_at":{"description":"Timestamp of when the task was started, in milliseconds. 0 if not started.","type":"integer"},"status":{"$ref":"#/components/schemas/MeshyTaskStatus"},"task_error":{"$ref":"#/components/schemas/MeshyTaskError"},"texture_image_url":{"description":"Downloadable URL to the texture image that was used to guide the texturing process.","type":"string"},"texture_prompt":{"description":"Additional text prompt provided to guide the texturing process during the refine stage.","type":"string"},"texture_richness":{"description":"Deprecated field maintained for backward compatibility.","type":"string"},"texture_urls":{"description":"An array of texture URL objects that are generated from the task.","items":{"$ref":"#/components/schemas/MeshyTextureUrls"},"type":"array"},"thumbnail_url":{"description":"Downloadable URL to the thumbnail image of the model file.","type":"string"},"type":{"description":"Type of the Text to 3D task.","enum":["text-to-3d-preview","text-to-3d-refine"],"type":"string"},"video_url":{"description":"Deprecated field returning the downloadable URL to the preview video.","type":"string"}},"required":["id","status"],"type":"object"},"MeshyTextureUrls":{"description":"Texture URL object containing PBR maps.","properties":{"base_color":{"description":"Downloadable URL to the base color map image.","type":"string"},"metallic":{"description":"Downloadable URL to the metallic map image.","type":"string"},"normal":{"description":"Downloadable URL to the normal map image.","type":"string"},"roughness":{"description":"Downloadable URL to the roughness map image.","type":"string"}},"type":"object"},"MeshyTopology":{"default":"triangle","description":"Specify the topology of the generated model.","enum":["quad","triangle"],"type":"string"},"MinimaxBaseResponse":{"description":"Common response structure used by Minimax APIs","properties":{"status_code":{"description":"Status code. 0 indicates success, other values indicate errors.","type":"integer"},"status_msg":{"description":"Specific error details or success message.","type":"string"}},"required":["status_code","status_msg"],"type":"object"},"MinimaxFileRetrieveResponse":{"description":"Response from retrieving a Minimax file download URL.","properties":{"base_resp":{"$ref":"#/components/schemas/MinimaxBaseResponse"},"file":{"properties":{"bytes":{"description":"File size in bytes","type":"integer"},"created_at":{"description":"Unix timestamp when the file was created, in seconds","type":"integer"},"download_url":{"description":"The URL to download the video","type":"string"},"file_id":{"description":"Unique identifier for the file","type":"integer"},"filename":{"description":"The name of the file","type":"string"},"purpose":{"description":"The purpose of using the file","type":"string"}},"type":"object"}},"required":["file","base_resp"],"type":"object"},"MinimaxTaskResultResponse":{"description":"Response from querying a Minimax video generation task status.","properties":{"base_resp":{"$ref":"#/components/schemas/MinimaxBaseResponse"},"file_id":{"description":"After the task status changes to Success, this field returns the file ID corresponding to the generated video.","type":"string"},"status":{"description":"Task status: 'Queueing' (in queue), 'Preparing' (task is preparing), 'Processing' (generating), 'Success' (task completed successfully), or 'Fail' (task failed).","enum":["Queueing","Preparing","Processing","Success","Fail"],"type":"string"},"task_id":{"description":"The task ID being queried.","type":"string"}},"required":["task_id","status","base_resp"],"type":"object"},"MinimaxVideoGenerationRequest":{"description":"Parameters for the Minimax video generation proxy request.","properties":{"callback_url":{"description":"Optional. URL to receive real-time status updates about the video generation task.","type":"string"},"duration":{"default":6,"description":"Video length in seconds. Only available for MiniMax-Hailuo-02","enum":[6,10],"type":"integer"},"first_frame_image":{"description":"URL or base64 encoding of the first frame image. Required when model is I2V-01, I2V-01-Director, or I2V-01-live.","type":"string"},"model":{"description":"Required. ID of model. Options: MiniMax-Hailuo-02, T2V-01-Director, I2V-01-Director, S2V-01, I2V-01, I2V-01-live, T2V-01","enum":["MiniMax-Hailuo-02","T2V-01-Director","I2V-01-Director","S2V-01","I2V-01","I2V-01-live","T2V-01"],"type":"string"},"prompt":{"description":"Description of the video. Should be less than 2000 characters. Supports camera movement instructions in [brackets].","maxLength":2000,"type":"string"},"prompt_optimizer":{"default":true,"description":"If true (default), the model will automatically optimize the prompt. Set to false for more precise control.","type":"boolean"},"resolution":{"default":"768P","description":"Video resolution. Only available for MiniMax-Hailuo-02.","enum":["768P","1080P"],"type":"string"},"subject_reference":{"description":"Only available when model is S2V-01. The model will generate a video based on the subject uploaded through this parameter.","items":{"properties":{"image":{"description":"URL or base64 encoding of the subject reference image.","type":"string"},"mask":{"description":"URL or base64 encoding of the mask for the subject reference image.","type":"string"}},"type":"object"},"type":"array"}},"required":["model"],"type":"object"},"MinimaxVideoGenerationResponse":{"description":"Response from the Minimax video generation API.","properties":{"base_resp":{"$ref":"#/components/schemas/MinimaxBaseResponse"},"task_id":{"description":"The task ID for the asynchronous video generation task.","type":"string"}},"required":["task_id","base_resp"],"type":"object"},"Modality":{"description":"Type of input or output content modality.","enum":["MODALITY_UNSPECIFIED","TEXT","IMAGE","VIDEO","AUDIO","DOCUMENT"],"type":"string"},"ModalityTokenCount":{"properties":{"modality":{"$ref":"#/components/schemas/Modality"},"tokenCount":{"description":"Number of tokens for the given modality.","type":"integer"}},"type":"object"},"ModelResponseProperties":{"description":"Common properties for model responses","properties":{"instructions":{"description":"Instructions for the model on how to generate the response","type":"string"},"max_output_tokens":{"description":"Maximum number of tokens to generate","type":"integer"},"model":{"description":"The model used to generate the response","type":"string"},"temperature":{"default":1,"description":"Controls randomness in the response","maximum":2,"minimum":0,"type":"number"},"top_p":{"default":1,"description":"Controls diversity of the response via nucleus sampling","maximum":1,"minimum":0,"type":"number"},"truncation":{"default":"disabled","description":"How to handle truncation of the response","enum":["disabled","auto"],"type":"string"}},"type":"object"},"MoonvalleyImageToVideoRequest":{"allOf":[{"$ref":"#/components/schemas/MoonvalleyTextToVideoRequest"},{"properties":{"keyframes":{"additionalProperties":{"properties":{"image_url":{"type":"string"}},"type":"object"},"type":"object"}},"type":"object"}]},"MoonvalleyPromptResponse":{"properties":{"error":{"type":"object"},"frame_conditioning":{"type":"object"},"id":{"type":"string"},"inference_params":{"type":"object"},"meta":{"type":"object"},"model_params":{"type":"object"},"output_url":{"type":"string"},"prompt_text":{"type":"string"},"status":{"type":"string"}},"type":"object"},"MoonvalleyResizeVideoRequest":{"allOf":[{"$ref":"#/components/schemas/MoonvalleyVideoToVideoRequest"},{"properties":{"frame_position":{"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"frame_resolution":{"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"scale":{"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}]},"MoonvalleyTextToImageRequest":{"properties":{"image_url":{"type":"string"},"inference_params":{"$ref":"#/components/schemas/MoonvalleyTextToVideoInferenceParams"},"prompt_text":{"type":"string"},"webhook_url":{"type":"string"}},"type":"object"},"MoonvalleyTextToVideoInferenceParams":{"properties":{"guidance_scale":{"default":10,"description":"Guidance scale for generation control","format":"float","type":"number"},"height":{"default":1080,"description":"Height of the generated video in pixels","type":"integer"},"negative_prompt":{"description":"Negative prompt text","type":"string"},"seed":{"default":9,"description":"Random seed for generation (default: random)","type":"integer"},"steps":{"default":80,"description":"Number of denoising steps","type":"integer"},"use_negative_prompts":{"default":true,"description":"Whether to use negative prompts","type":"boolean"},"width":{"default":1920,"description":"Width of the generated video in pixels","type":"integer"}},"type":"object"},"MoonvalleyTextToVideoRequest":{"properties":{"image_url":{"type":"string"},"inference_params":{"$ref":"#/components/schemas/MoonvalleyTextToVideoInferenceParams"},"prompt_text":{"type":"string"},"webhook_url":{"type":"string"}},"type":"object"},"MoonvalleyUploadFileRequest":{"properties":{"file":{"format":"binary","type":"string"}},"type":"object"},"MoonvalleyUploadFileResponse":{"properties":{"access_url":{"type":"string"}},"type":"object"},"MoonvalleyVideoToVideoInferenceParams":{"properties":{"control_params":{"properties":{"motion_intensity":{"default":6,"description":"Intensity of motion control","format":"int32","type":"integer"}},"type":"object"},"guidance_scale":{"default":10,"description":"Guidance scale for generation control","format":"float","type":"number"},"negative_prompt":{"description":"Negative prompt text","type":"string"},"seed":{"default":9,"description":"Random seed for generation (default: random)","type":"integer"},"steps":{"default":80,"description":"Number of denoising steps","type":"integer"},"use_negative_prompts":{"default":true,"description":"Whether to use negative prompts","type":"boolean"}},"type":"object"},"MoonvalleyVideoToVideoRequest":{"properties":{"control_type":{"description":"Supported types for video control","enum":["motion_control","pose_control"],"type":"string"},"image_url":{"description":"Url to control image","type":"string"},"inference_params":{"$ref":"#/components/schemas/MoonvalleyVideoToVideoInferenceParams"},"prompt_text":{"description":"Describes the video to generate","type":"string"},"video_url":{"description":"Url to control video","type":"string"},"webhook_url":{"description":"Optional webhook URL for notifications","type":"string"}},"required":["prompt_text","video_url","control_type"],"type":"object"},"Node":{"properties":{"author":{"type":"string"},"banner_url":{"description":"URL to the node's banner.","type":"string"},"category":{"deprecated":true,"description":"DEPRECATED: The category of the node. Use 'tags' field instead. This field will be removed in a future version.","type":"string"},"created_at":{"description":"The date and time when the node was created","format":"date-time","type":"string"},"description":{"type":"string"},"downloads":{"description":"The number of downloads of the node.","type":"integer"},"github_stars":{"description":"Number of stars on the GitHub repository.","type":"integer"},"icon":{"description":"URL to the node's icon.","type":"string"},"id":{"description":"The unique identifier of the node.","type":"string"},"latest_version":{"$ref":"#/components/schemas/NodeVersion"},"license":{"description":"The path to the LICENSE file in the node's repository.","type":"string"},"name":{"description":"The display name of the node.","type":"string"},"preempted_comfy_node_names":{"description":"A list of Comfy node names that are preempted by this node.","items":{"type":"string"},"type":"array"},"publisher":{"$ref":"#/components/schemas/Publisher"},"rating":{"description":"The average rating of the node.","type":"number"},"repository":{"description":"URL to the node's repository.","type":"string"},"search_ranking":{"description":"A numerical value representing the node's search ranking, used for sorting search results.","type":"integer"},"status":{"$ref":"#/components/schemas/NodeStatus"},"status_detail":{"description":"The status detail of the node.","type":"string"},"supported_accelerators":{"description":"List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports","items":{"type":"string"},"type":"array"},"supported_comfyui_frontend_version":{"description":"Supported versions of ComfyUI frontend","type":"string"},"supported_comfyui_version":{"description":"Supported versions of ComfyUI","type":"string"},"supported_os":{"description":"List of operating systems that this node supports","items":{"type":"string"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"tags_admin":{"description":"Admin-only tags for security warnings and admin metadata","items":{"type":"string"},"type":"array"},"translations":{"additionalProperties":{"additionalProperties":true,"type":"object"},"description":"Translations of node metadata in different languages.","type":"object"}},"type":"object"},"NodeStatus":{"enum":["NodeStatusActive","NodeStatusDeleted","NodeStatusBanned"],"type":"string"},"NodeVersion":{"properties":{"changelog":{"description":"Summary of changes made in this version","type":"string"},"comfy_node_extract_status":{"description":"The status of comfy node extraction process.","type":"string"},"createdAt":{"description":"The date and time the version was created.","format":"date-time","type":"string"},"dependencies":{"description":"A list of pip dependencies required by the node.","items":{"type":"string"},"type":"array"},"deprecated":{"description":"Indicates if this version is deprecated.","type":"boolean"},"downloadUrl":{"description":"[Output Only] URL to download this version of the node","type":"string"},"id":{"type":"string"},"node_id":{"description":"The unique identifier of the node.","type":"string"},"status":{"$ref":"#/components/schemas/NodeVersionStatus"},"status_reason":{"type":"string"},"supported_accelerators":{"description":"List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports","items":{"type":"string"},"type":"array"},"supported_comfyui_frontend_version":{"description":"Supported versions of ComfyUI frontend","type":"string"},"supported_comfyui_version":{"description":"Supported versions of ComfyUI","type":"string"},"supported_os":{"description":"List of operating systems that this node supports","items":{"type":"string"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"tags_admin":{"description":"Admin-only tags for security warnings and admin metadata","items":{"type":"string"},"type":"array"},"version":{"description":"The version identifier, following semantic versioning. Must be unique for the node.","type":"string"}},"type":"object"},"NodeVersionIdentifier":{"properties":{"node_id":{"description":"The unique identifier of the node","type":"string"},"version":{"description":"The version of the node","type":"string"}},"required":["node_id","version"],"type":"object"},"NodeVersionStatus":{"enum":["NodeVersionStatusActive","NodeVersionStatusDeleted","NodeVersionStatusBanned","NodeVersionStatusPending","NodeVersionStatusFlagged"],"type":"string"},"NodeVersionUpdateRequest":{"properties":{"changelog":{"description":"The changelog describing the version changes.","type":"string"},"deprecated":{"description":"Whether the version is deprecated.","type":"boolean"}},"type":"object"},"OpenAICreateResponse":{"allOf":[{"$ref":"#/components/schemas/CreateModelResponseProperties"},{"$ref":"#/components/schemas/ResponseProperties"},{"properties":{"include":{"description":"Specify additional output data to include in the model response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n  the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n","items":{"$ref":"#/components/schemas/Includable"},"nullable":true,"type":"array"},"input":{"description":"Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Image inputs](/docs/guides/images)\n- [File inputs](/docs/guides/pdf-files)\n- [Conversation state](/docs/guides/conversation-state)\n- [Function calling](/docs/guides/function-calling)\n","oneOf":[{"description":"A text input to the model, equivalent to a text input with the\n`user` role.\n","title":"Text input","type":"string"},{"description":"A list of one or many input items to the model, containing\ndifferent content types.\n","items":{"$ref":"#/components/schemas/InputItem"},"title":"Input item list","type":"array"}]},"parallel_tool_calls":{"default":true,"description":"Whether to allow the model to run tool calls in parallel.\n","nullable":true,"type":"boolean"},"store":{"default":true,"description":"Whether to store the generated model response for later retrieval via\nAPI.\n","nullable":true,"type":"boolean"},"stream":{"default":false,"description":"If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/responses-streaming)\nfor more information.\n","nullable":true,"type":"boolean"},"usage":{"$ref":"#/components/schemas/ResponseUsage"}},"required":["model","input"],"type":"object"}]},"OpenAIImageEditRequest":{"properties":{"background":{"description":"Background transparency","example":"opaque","type":"string"},"model":{"description":"The model to use for image editing (e.g., dall-e-2, gpt-image-1, gpt-image-1.5, gpt-image-2)","example":"gpt-image-2","type":"string"},"moderation":{"description":"Content moderation setting","enum":["low","auto"],"example":"auto","type":"string"},"n":{"description":"The number of images to generate","example":1,"type":"integer"},"output_compression":{"description":"Compression level for JPEG or WebP (0-100)","example":100,"type":"integer"},"output_format":{"description":"Format of the output image","enum":["png","webp","jpeg"],"example":"png","type":"string"},"prompt":{"description":"A text description of the desired edit","example":"Give the rocketship rainbow coloring","type":"string"},"quality":{"description":"The quality of the edited image","example":"low","type":"string"},"size":{"description":"Size of the output image","example":"1024x1024","type":"string"},"user":{"description":"A unique identifier for end-user monitoring","example":"user-1234","type":"string"}},"required":["model","prompt"],"type":"object"},"OpenAIImageGenerationRequest":{"properties":{"background":{"description":"Background transparency","enum":["transparent","opaque"],"example":"opaque","type":"string"},"model":{"description":"The model to use for image generation (e.g., dall-e-2, dall-e-3, gpt-image-1, gpt-image-1.5, gpt-image-2)","example":"gpt-image-2","type":"string"},"moderation":{"description":"Content moderation setting","enum":["low","auto"],"example":"auto","type":"string"},"n":{"description":"The number of images to generate (1-10). Only 1 supported for dall-e-3.","example":1,"type":"integer"},"output_compression":{"description":"Compression level for JPEG or WebP (0-100)","example":100,"type":"integer"},"output_format":{"description":"Format of the output image","enum":["png","webp","jpeg"],"example":"png","type":"string"},"prompt":{"description":"A text description of the desired image","example":"Draw a rocket in front of a blackhole in deep space","type":"string"},"quality":{"description":"The quality of the generated image","enum":["low","medium","high","standard","hd"],"example":"high","type":"string"},"response_format":{"description":"Response format of image data","enum":["url","b64_json"],"example":"b64_json","type":"string"},"size":{"description":"Size of the image (e.g., 1024x1024, 1536x1024, auto)","example":"1024x1536","type":"string"},"style":{"description":"Style of the image (only for dall-e-3)","enum":["vivid","natural"],"example":"vivid","type":"string"},"user":{"description":"A unique identifier for end-user monitoring","example":"user-1234","type":"string"}},"required":["prompt"],"type":"object"},"OpenAIImageGenerationResponse":{"properties":{"data":{"items":{"properties":{"b64_json":{"description":"Base64 encoded image data","type":"string"},"revised_prompt":{"description":"Revised prompt","type":"string"},"url":{"description":"URL of the image","type":"string"}},"type":"object"},"type":"array"},"usage":{"properties":{"input_tokens":{"type":"integer"},"input_tokens_details":{"properties":{"image_tokens":{"type":"integer"},"text_tokens":{"type":"integer"}},"type":"object"},"output_tokens":{"type":"integer"},"output_tokens_details":{"properties":{"image_tokens":{"type":"integer"},"text_tokens":{"type":"integer"}},"type":"object"},"total_tokens":{"type":"integer"}},"type":"object"}},"type":"object"},"OpenAIModels":{"enum":["gpt-4","gpt-4-0314","gpt-4-0613","gpt-4-32k","gpt-4-32k-0314","gpt-4-32k-0613","gpt-4-0125-preview","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-turbo-preview","gpt-4-1106-preview","gpt-4-vision-preview","gpt-3.5-turbo","gpt-3.5-turbo-16k","gpt-3.5-turbo-0301","gpt-3.5-turbo-0613","gpt-3.5-turbo-1106","gpt-3.5-turbo-0125","gpt-3.5-turbo-16k-0613","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","o1","o1-mini","o1-preview","o1-pro","o1-2024-12-17","o1-preview-2024-09-12","o1-mini-2024-09-12","o1-pro-2025-03-19","o3","o3-mini","o3-2025-04-16","o3-mini-2025-01-31","o4-mini","o4-mini-2025-04-16","gpt-4o","gpt-4o-mini","gpt-4o-2024-11-20","gpt-4o-2024-08-06","gpt-4o-2024-05-13","gpt-4o-mini-2024-07-18","gpt-4o-audio-preview","gpt-4o-audio-preview-2024-10-01","gpt-4o-audio-preview-2024-12-17","gpt-4o-mini-audio-preview","gpt-4o-mini-audio-preview-2024-12-17","gpt-4o-search-preview","gpt-4o-mini-search-preview","gpt-4o-search-preview-2025-03-11","gpt-4o-mini-search-preview-2025-03-11","computer-use-preview","computer-use-preview-2025-03-11","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5.5","gpt-5.5-pro","chatgpt-4o-latest"],"type":"string"},"OpenAIResponse":{"allOf":[{"$ref":"#/components/schemas/ModelResponseProperties"},{"$ref":"#/components/schemas/ResponseProperties"},{"properties":{"created_at":{"description":"Unix timestamp (in seconds) of when this Response was created.","type":"number"},"error":{"$ref":"#/components/schemas/ResponseError"},"id":{"description":"Unique identifier for this Response.","type":"string"},"incomplete_details":{"description":"Details about why the response is incomplete.\n","nullable":true,"properties":{"reason":{"description":"The reason why the response is incomplete.","enum":["max_output_tokens","content_filter"],"type":"string"}},"type":"object"},"object":{"description":"The object type of this resource - always set to `response`.","enum":["response"],"type":"string","x-stainless-const":true},"output":{"description":"An array of content items generated by the model.\n\n- The length and order of items in the `output` array is dependent\n  on the model's response.\n- Rather than accessing the first item in the `output` array and\n  assuming it's an `assistant` message with the content generated by\n  the model, you might consider using the `output_text` property where\n  supported in SDKs.\n","items":{"$ref":"#/components/schemas/OutputItem"},"type":"array"},"output_text":{"description":"SDK-only convenience property that contains the aggregated text output\nfrom all `output_text` items in the `output` array, if any are present.\nSupported in the Python and JavaScript SDKs.\n","nullable":true,"type":"string","x-oaiSupportedSDKs":["python","javascript"]},"parallel_tool_calls":{"default":true,"description":"Whether to allow the model to run tool calls in parallel.\n","type":"boolean"},"status":{"description":"The status of the response generation. One of `completed`, `failed`, `in_progress`, or `incomplete`.","enum":["completed","failed","in_progress","incomplete"],"type":"string"},"usage":{"$ref":"#/components/schemas/ResponseUsage"}},"type":"object"}],"description":"A response from the model","type":"object"},"OpenAIResponseStreamEvent":{"anyOf":[{"$ref":"#/components/schemas/ResponseCreatedEvent"},{"$ref":"#/components/schemas/ResponseInProgressEvent"},{"$ref":"#/components/schemas/ResponseCompletedEvent"},{"$ref":"#/components/schemas/ResponseFailedEvent"},{"$ref":"#/components/schemas/ResponseIncompleteEvent"},{"$ref":"#/components/schemas/ResponseOutputItemAddedEvent"},{"$ref":"#/components/schemas/ResponseOutputItemDoneEvent"},{"$ref":"#/components/schemas/ResponseContentPartAddedEvent"},{"$ref":"#/components/schemas/ResponseContentPartDoneEvent"},{"$ref":"#/components/schemas/ResponseErrorEvent"}],"description":"Events that can be emitted during response streaming","type":"object"},"OpenAIVideoCreateRequest":{"properties":{"input_reference":{"description":"Optional image or video reference that guides generation","format":"binary","type":"string"},"model":{"default":"sora-2","description":"The video generation model to use","enum":["sora-2","sora-2-pro"],"type":"string"},"prompt":{"description":"Text prompt that describes the video to generate","example":"A calico cat playing a piano on stage","type":"string"},"seconds":{"default":"4","description":"Clip duration in seconds","enum":["4","8","12"],"type":"string"},"size":{"default":"720x1280","description":"Output resolution formatted as width x height","enum":["720x1280","1280x720","1024x1792","1792x1024"],"type":"string"}},"required":["prompt"],"type":"object"},"OpenAIVideoJob":{"properties":{"completed_at":{"description":"Unix timestamp (seconds) for when the job completed, if finished","example":1712698600,"type":"integer"},"created_at":{"description":"Unix timestamp (seconds) for when the job was created","example":1712697600,"type":"integer"},"error":{"description":"Error payload that explains why generation failed, if applicable","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Human-readable error message","type":"string"}},"type":"object"},"expires_at":{"description":"Unix timestamp (seconds) for when the downloadable assets expire, if set","example":1712784000,"type":"integer"},"id":{"description":"Unique identifier for the video job","example":"video_123","type":"string"},"model":{"description":"The video generation model that produced the job","example":"sora-2","type":"string"},"object":{"description":"The object type, which is always video","enum":["video"],"example":"video","type":"string"},"progress":{"description":"Approximate completion percentage for the generation task","example":0,"type":"integer"},"quality":{"description":"Quality of the generated video","example":"standard","type":"string"},"remixed_from_video_id":{"description":"Identifier of the source video if this video is a remix","example":"video_456","type":"string"},"seconds":{"description":"Duration of the generated clip in seconds","example":"8","type":"string"},"size":{"description":"The resolution of the generated video","example":"1024x1808","type":"string"},"status":{"description":"Current lifecycle status of the video job","enum":["queued","in_progress","completed","failed"],"example":"queued","type":"string"}},"type":"object"},"OutputAudioContent":{"properties":{"data":{"description":"Base64-encoded audio data","type":"string"},"transcript":{"description":"Transcript of the audio","type":"string"},"type":{"description":"The type of output content","enum":["output_audio"],"type":"string"}},"required":["type","data","transcript"],"type":"object"},"OutputContent":{"oneOf":[{"$ref":"#/components/schemas/OutputTextContent"},{"$ref":"#/components/schemas/OutputAudioContent"}]},"OutputItem":{"oneOf":[{"$ref":"#/components/schemas/OutputMessage"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/FunctionToolCall"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/ReasoningItem"}]},"OutputMessage":{"properties":{"content":{"description":"The content of the message","items":{"$ref":"#/components/schemas/OutputContent"},"type":"array"},"role":{"description":"The role of the message","enum":["assistant"],"type":"string"},"type":{"description":"The type of output item","enum":["message"],"type":"string"}},"required":["type","role","content"],"type":"object"},"OutputTextContent":{"properties":{"text":{"description":"The text content","type":"string"},"type":{"description":"The type of output content","enum":["output_text"],"type":"string"}},"required":["type","text"],"type":"object"},"PersonalAccessToken":{"properties":{"createdAt":{"description":"[Output Only]The date and time the token was created.","format":"date-time","type":"string"},"description":{"description":"Optional. A more detailed description of the token's intended use.","type":"string"},"id":{"description":"Unique identifier for the GitCommit","format":"uuid","type":"string"},"name":{"description":"Required. The name of the token. Can be a simple description.","type":"string"},"token":{"description":"[Output Only]. The personal access token. Only returned during creation.","type":"string"}},"type":"object"},"PikaBody_generate_2_2_c2v_generate_2_2_pikascenes_post":{"properties":{"aspectRatio":{"anyOf":[{"maximum":2.5,"minimum":0.4,"type":"number"}],"description":"Aspect ratio (width / height)","title":"Aspectratio"},"duration":{"default":5,"title":"Duration","type":"integer"},"images":{"items":{"format":"binary","type":"string"},"title":"Images","type":"array"},"ingredientsMode":{"enum":["creative","precise"],"title":"Ingredientsmode","type":"string"},"negativePrompt":{"anyOf":[{"type":"string"}],"title":"Negativeprompt"},"promptText":{"anyOf":[{"type":"string"}],"title":"Prompttext"},"resolution":{"default":"1080p","title":"Resolution","type":"string"},"seed":{"anyOf":[{"type":"integer"}],"title":"Seed"}},"required":["ingredientsMode"],"title":"Body_generate_2_2_c2v_generate_2_2_pikascenes_post","type":"object"},"PikaBody_generate_2_2_i2v_generate_2_2_i2v_post":{"properties":{"duration":{"$ref":"#/components/schemas/PikaDurationEnum"},"image":{"format":"binary","nullable":true,"title":"Image","type":"string"},"negativePrompt":{"nullable":true,"title":"Negativeprompt","type":"string"},"promptText":{"nullable":true,"title":"Prompttext","type":"string"},"resolution":{"$ref":"#/components/schemas/PikaResolutionEnum"},"seed":{"nullable":true,"title":"Seed","type":"integer"}},"title":"Body_generate_2_2_i2v_generate_2_2_i2v_post","type":"object"},"PikaBody_generate_2_2_keyframe_generate_2_2_pikaframes_post":{"properties":{"duration":{"maximum":10,"minimum":5,"title":"Duration","type":"integer"},"keyFrames":{"description":"Array of keyframe images","items":{"format":"binary","type":"string"},"title":"Keyframes","type":"array"},"negativePrompt":{"anyOf":[{"type":"string"}],"title":"Negativeprompt"},"promptText":{"title":"Prompttext","type":"string"},"resolution":{"$ref":"#/components/schemas/PikaResolutionEnum"},"seed":{"anyOf":[{"type":"integer"}],"title":"Seed"}},"required":["promptText"],"title":"Body_generate_2_2_keyframe_generate_2_2_pikaframes_post","type":"object"},"PikaBody_generate_2_2_t2v_generate_2_2_t2v_post":{"properties":{"aspectRatio":{"default":1.7777777777777777,"description":"Aspect ratio (width / height)","format":"float","maximum":2.5,"minimum":0.4,"title":"Aspectratio","type":"number"},"duration":{"$ref":"#/components/schemas/PikaDurationEnum"},"negativePrompt":{"nullable":true,"title":"Negativeprompt","type":"string"},"promptText":{"title":"Prompttext","type":"string"},"resolution":{"$ref":"#/components/schemas/PikaResolutionEnum"},"seed":{"nullable":true,"title":"Seed","type":"integer"}},"required":["promptText"],"title":"Body_generate_2_2_t2v_generate_2_2_t2v_post","type":"object"},"PikaBody_generate_pikadditions_generate_pikadditions_post":{"properties":{"image":{"format":"binary","title":"Image","type":"string"},"negativePrompt":{"anyOf":[{"type":"string"}],"title":"Negativeprompt"},"promptText":{"anyOf":[{"type":"string"}],"title":"Prompttext"},"seed":{"anyOf":[{"type":"integer"}],"title":"Seed"},"video":{"format":"binary","title":"Video","type":"string"}},"title":"Body_generate_pikadditions_generate_pikadditions_post","type":"object"},"PikaBody_generate_pikaffects_generate_pikaffects_post":{"properties":{"image":{"format":"binary","title":"Image","type":"string"},"negativePrompt":{"anyOf":[{"type":"string"}],"title":"Negativeprompt"},"pikaffect":{"$ref":"#/components/schemas/Pikaffect"},"promptText":{"anyOf":[{"type":"string"}],"title":"Prompttext"},"seed":{"anyOf":[{"type":"integer"}],"title":"Seed"}},"title":"Body_generate_pikaffects_generate_pikaffects_post","type":"object"},"PikaBody_generate_pikaswaps_generate_pikaswaps_post":{"properties":{"image":{"anyOf":[{"format":"binary","type":"string"}],"title":"Image"},"modifyRegionMask":{"anyOf":[{"format":"binary","type":"string"}],"description":"A mask image that specifies the region to modify, where the mask is white and the background is black","title":"Modifyregionmask"},"modifyRegionRoi":{"anyOf":[{"type":"string"}],"description":"Plaintext description of the object / region to modify","title":"Modifyregionroi"},"negativePrompt":{"anyOf":[{"type":"string"}],"title":"Negativeprompt"},"promptText":{"anyOf":[{"type":"string"}],"title":"Prompttext"},"seed":{"anyOf":[{"type":"integer"}],"title":"Seed"},"video":{"format":"binary","title":"Video","type":"string"}},"title":"Body_generate_pikaswaps_generate_pikaswaps_post","type":"object"},"PikaDurationEnum":{"default":5,"enum":[5,10],"type":"integer"},"PikaGenerateResponse":{"properties":{"video_id":{"title":"Video Id","type":"string"}},"required":["video_id"],"title":"GenerateResponse","type":"object"},"PikaHTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/PikaValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"PikaResolutionEnum":{"default":"1080p","enum":["1080p","720p"],"type":"string"},"PikaStatusEnum":{"enum":["queued","started","finished"],"type":"string"},"PikaValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"PikaVideoResponse":{"properties":{"id":{"title":"Id","type":"string"},"progress":{"nullable":true,"title":"Progress","type":"integer"},"status":{"$ref":"#/components/schemas/PikaStatusEnum"},"url":{"nullable":true,"title":"Url","type":"string"}},"required":["id","status"],"title":"VideoResponse","type":"object"},"Pikaffect":{"enum":["Cake-ify","Crumble","Crush","Decapitate","Deflate","Dissolve","Explode","Eye-pop","Inflate","Levitate","Melt","Peel","Poke","Squish","Ta-da","Tear"],"type":"string"},"PixverseImageUploadResponse":{"properties":{"ErrCode":{"type":"integer"},"ErrMsg":{"type":"string"},"Resp":{"properties":{"img_id":{"type":"integer"}},"type":"object"}},"type":"object"},"PixverseImageVideoRequest":{"properties":{"duration":{"enum":[5,8],"type":"integer"},"img_id":{"type":"integer"},"model":{"enum":["v3.5"],"type":"string"},"motion_mode":{"enum":["normal","fast"],"type":"string"},"prompt":{"type":"string"},"quality":{"enum":["360p","540p","720p","1080p"],"type":"string"},"seed":{"type":"integer"},"style":{"enum":["anime","3d_animation","clay","comic","cyberpunk"],"type":"string"},"template_id":{"type":"integer"},"water_mark":{"type":"boolean"}},"required":["img_id","model","duration","quality","prompt"],"type":"object"},"PixverseTextVideoRequest":{"properties":{"aspect_ratio":{"enum":["16:9","4:3","1:1","3:4","9:16"],"type":"string"},"duration":{"enum":[5,8],"type":"integer"},"model":{"enum":["v3.5"],"type":"string"},"motion_mode":{"enum":["normal","fast"],"type":"string"},"negative_prompt":{"type":"string"},"prompt":{"type":"string"},"quality":{"enum":["360p","540p","720p","1080p"],"type":"string"},"seed":{"type":"integer"},"style":{"enum":["anime","3d_animation","clay","comic","cyberpunk"],"type":"string"},"template_id":{"type":"integer"},"water_mark":{"type":"boolean"}},"required":["aspect_ratio","duration","model","prompt","quality"],"type":"object"},"PixverseTransitionVideoRequest":{"properties":{"duration":{"enum":[5,8],"type":"integer"},"first_frame_img":{"type":"integer"},"last_frame_img":{"type":"integer"},"model":{"enum":["v3.5"],"type":"string"},"motion_mode":{"enum":["normal","fast"],"type":"string"},"prompt":{"type":"string"},"quality":{"enum":["360p","540p","720p","1080p"],"type":"string"},"seed":{"type":"integer"},"style":{"enum":["anime","3d_animation","clay","comic","cyberpunk"],"type":"string"},"template_id":{"type":"integer"},"water_mark":{"type":"boolean"}},"required":["first_frame_img","last_frame_img","model","duration","quality","prompt","motion_mode","seed"],"type":"object"},"PixverseVideoResponse":{"properties":{"ErrCode":{"type":"integer"},"ErrMsg":{"type":"string"},"Resp":{"properties":{"video_id":{"type":"integer"}},"type":"object"}},"type":"object"},"PixverseVideoResultResponse":{"properties":{"ErrCode":{"type":"integer"},"ErrMsg":{"type":"string"},"Resp":{"properties":{"create_time":{"type":"string"},"id":{"type":"integer"},"modify_time":{"type":"string"},"negative_prompt":{"type":"string"},"outputHeight":{"type":"integer"},"outputWidth":{"type":"integer"},"prompt":{"type":"string"},"resolution_ratio":{"type":"integer"},"seed":{"type":"integer"},"size":{"type":"integer"},"status":{"description":"Video generation status codes:\n* 1 - Generation successful\n* 5 - Generating\n* 6 - Deleted\n* 7 - Contents moderation failed\n* 8 - Generation failed\n","enum":[1,5,6,7,8],"type":"integer"},"style":{"type":"string"},"url":{"type":"string"}},"type":"object"}},"type":"object"},"PromoCodeResponse":{"properties":{"active":{"description":"Whether the promo code is currently active","type":"boolean"},"code":{"description":"The generated promotional code","type":"string"},"coupon_id":{"description":"The Stripe coupon ID associated with this promo code","type":"string"},"expires_at":{"description":"Unix timestamp when the promo code expires","format":"int64","type":"integer"},"id":{"description":"The Stripe promotion code ID","type":"string"},"max_redemptions":{"description":"Maximum number of times this code can be redeemed","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"description":"Set of key-value pairs for storing additional information","type":"object"},"times_redeemed":{"description":"Number of times this code has been redeemed","type":"integer"}},"required":["id","code","coupon_id","active"],"type":"object"},"Publisher":{"properties":{"createdAt":{"description":"The date and time the publisher was created.","format":"date-time","type":"string"},"description":{"type":"string"},"id":{"description":"The unique identifier for the publisher. It's akin to a username. Should be lowercase.","type":"string"},"logo":{"description":"URL to the publisher's logo.","type":"string"},"members":{"description":"A list of members in the publisher.","items":{"$ref":"#/components/schemas/PublisherMember"},"type":"array"},"name":{"type":"string"},"source_code_repo":{"type":"string"},"status":{"$ref":"#/components/schemas/PublisherStatus"},"support":{"type":"string"},"website":{"type":"string"}},"type":"object"},"PublisherMember":{"properties":{"id":{"description":"The unique identifier for the publisher member.","type":"string"},"role":{"description":"The role of the user in the publisher.","type":"string"},"user":{"$ref":"#/components/schemas/PublisherUser"}},"type":"object"},"PublisherStatus":{"enum":["PublisherStatusActive","PublisherStatusBanned"],"type":"string"},"PublisherUser":{"properties":{"email":{"description":"The email address for this user.","type":"string"},"id":{"description":"The unique id for this user.","type":"string"},"name":{"description":"The name for this user.","type":"string"}},"type":"object"},"QuiverImageObject":{"description":"Image input for Quiver AI (URL or base64)","properties":{"base64":{"description":"Base64-encoded image payload","maxLength":16777216,"type":"string"},"url":{"description":"Network image URL. Only http/https URLs allowed.","format":"uri","type":"string"}},"type":"object"},"QuiverImageToSVGRequest":{"description":"Request body for Quiver AI image-to-SVG vectorization","properties":{"auto_crop":{"default":false,"description":"Auto-crop image to the dominant subject before vectorization","type":"boolean"},"image":{"$ref":"#/components/schemas/QuiverImageObject"},"max_output_tokens":{"description":"Maximum number of output tokens","maximum":131072,"minimum":1,"type":"integer"},"model":{"description":"Model identifier for SVG vectorization","example":"arrow-1.1","type":"string"},"presence_penalty":{"default":0,"description":"Penalty for tokens already present in prior output","maximum":2,"minimum":-2,"nullable":true,"type":"number"},"stream":{"default":false,"description":"Enable Server-Sent Events streaming","type":"boolean"},"target_size":{"description":"Square resize target in pixels","maximum":4096,"minimum":128,"type":"integer"},"temperature":{"default":1,"description":"Sampling temperature","maximum":2,"minimum":0,"type":"number"},"top_p":{"default":1,"description":"Nucleus sampling probability","maximum":1,"minimum":0,"type":"number"}},"required":["model","image"],"type":"object"},"QuiverSVGResponse":{"description":"Response from Quiver AI SVG generation/vectorization","properties":{"created":{"description":"Unix timestamp of creation","type":"integer"},"credits":{"description":"Credit cost for this request. Use this for billing instead of usage tokens.","minimum":0,"type":"integer"},"data":{"items":{"properties":{"mime_type":{"description":"MIME type of the output","enum":["image/svg+xml"],"type":"string"},"svg":{"description":"Raw SVG markup","type":"string"}},"required":["svg","mime_type"],"type":"object"},"minItems":1,"type":"array"},"id":{"description":"Unique identifier for the generation","type":"string"},"usage":{"deprecated":true,"description":"Deprecated. Use credits for billing values.","properties":{"input_tokens":{"deprecated":true,"description":"Deprecated. Token counts are retained for compatibility and may be zeroed.","minimum":0,"type":"integer"},"output_tokens":{"deprecated":true,"description":"Deprecated. Token counts are retained for compatibility and may be zeroed.","minimum":0,"type":"integer"},"total_tokens":{"deprecated":true,"description":"Deprecated. Token counts are retained for compatibility and may be zeroed.","minimum":0,"type":"integer"}},"type":"object"}},"required":["id","created","data"],"type":"object"},"QuiverTextToSVGRequest":{"description":"Request body for Quiver AI text-to-SVG generation","properties":{"instructions":{"description":"Additional style or formatting guidance","type":"string"},"max_output_tokens":{"description":"Maximum number of output tokens","maximum":131072,"minimum":1,"type":"integer"},"model":{"description":"Model identifier for SVG generation","example":"arrow-1.1","type":"string"},"n":{"default":1,"description":"Number of SVGs to generate","maximum":16,"minimum":1,"type":"integer"},"presence_penalty":{"default":0,"description":"Penalty for tokens already present in prior output","maximum":2,"minimum":-2,"nullable":true,"type":"number"},"prompt":{"description":"Text description of the desired SVG output","type":"string"},"references":{"description":"Optional reference images to guide style/composition. Accepts URL object, base64 object, or URL string shorthand. Runtime limits are model-specific.","items":{"oneOf":[{"$ref":"#/components/schemas/QuiverImageObject"},{"description":"URL string shorthand for a reference image","format":"uri","type":"string"}]},"maxItems":16,"type":"array"},"temperature":{"default":1,"description":"Sampling temperature","maximum":2,"minimum":0,"type":"number"},"top_p":{"default":1,"description":"Nucleus sampling probability","maximum":1,"minimum":0,"type":"number"}},"required":["model","prompt"],"type":"object"},"RGBColor":{"description":"RGB color values","example":{"rgb":[255,0,0]},"properties":{"rgb":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":3,"minItems":3,"type":"array"}},"required":["rgb"],"type":"object"},"Reasoning":{"description":"**o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n","properties":{"effort":{"$ref":"#/components/schemas/ReasoningEffort"},"generate_summary":{"deprecated":true,"description":"**Deprecated:** use `summary` instead.\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.\n","enum":["auto","concise","detailed"],"type":"string"},"summary":{"description":"A summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.\n","enum":["auto","concise","detailed"],"type":"string"}},"title":"Reasoning","type":"object"},"ReasoningEffort":{"default":"medium","description":"**o-series models only**\n\nConstrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n","enum":["low","medium","high"],"type":"string"},"ReasoningItem":{"description":"A description of the chain of thought used by a reasoning model while generating\na response.\n","properties":{"id":{"description":"The unique identifier of the reasoning content.\n","type":"string"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"],"type":"string"},"summary":{"description":"Reasoning text contents.\n","items":{"properties":{"text":{"description":"A short summary of the reasoning used by the model when generating\nthe response.\n","type":"string"},"type":{"description":"The type of the object. Always `summary_text`.\n","enum":["summary_text"],"type":"string","x-stainless-const":true}},"required":["type","text"],"type":"object"},"type":"array"},"type":{"description":"The type of the object. Always `reasoning`.\n","enum":["reasoning"],"type":"string","x-stainless-const":true}},"required":["id","summary","type"],"title":"Reasoning","type":"object"},"RecraftCreateStyleRequest":{"description":"Request body for creating a Recraft style reference","properties":{"file1":{"description":"First image file (PNG, JPG, or WEBP)","format":"binary","type":"string"},"file2":{"description":"Second image file (PNG, JPG, or WEBP)","format":"binary","type":"string"},"file3":{"description":"Third image file (PNG, JPG, or WEBP)","format":"binary","type":"string"},"file4":{"description":"Fourth image file (PNG, JPG, or WEBP)","format":"binary","type":"string"},"file5":{"description":"Fifth image file (PNG, JPG, or WEBP)","format":"binary","type":"string"},"style":{"description":"The base style of the generated images","enum":["realistic_image","digital_illustration","vector_illustration","icon"],"type":"string"}},"required":["style","file1"],"type":"object"},"RecraftCreateStyleResponse":{"description":"Response containing the created style ID","properties":{"id":{"description":"The unique identifier of the created style","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"RecraftGenerateImageResponse":{"properties":{"created":{"type":"integer"},"credits":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/RecraftImage"},"type":"array"}},"required":["created","data","credits"],"type":"object"},"RecraftImage":{"properties":{"b64_json":{"type":"string"},"features":{"$ref":"#/components/schemas/RecraftImageFeatures"},"image_id":{"format":"uuid","type":"string"},"revised_prompt":{"type":"string"},"url":{"type":"string"}},"required":["image_id"],"type":"object"},"RecraftImageColor":{"properties":{"rgb":{"items":{"type":"integer"},"type":"array"},"std":{"items":{"type":"number"},"type":"array"},"weight":{"type":"number"}},"type":"object"},"RecraftImageFeatures":{"properties":{"nsfw_score":{"type":"number"}},"type":"object"},"RecraftImageFormat":{"enum":["webp","png"],"type":"string"},"RecraftImageGenerationRequest":{"description":"Parameters for the Recraft image generation proxy request.","properties":{"controls":{"description":"The controls for the generated image","properties":{"artistic_level":{"description":"Defines artistic tone of your image. At a simple level, the person looks straight at the camera in a static and clean style. Dynamic and eccentric levels introduce movement and creativity.","maximum":5,"minimum":0,"nullable":true,"type":"integer"},"background_color":{"$ref":"#/components/schemas/RGBColor"},"colors":{"description":"An array of preferable colors","items":{"$ref":"#/components/schemas/RGBColor"},"type":"array"},"no_text":{"description":"Do not embed text layouts","type":"boolean"}},"type":"object"},"model":{"description":"The model to use for generation (e.g., \"recraftv3\")","type":"string"},"n":{"description":"The number of images to generate","maximum":4,"minimum":1,"type":"integer"},"prompt":{"description":"The text prompt describing the image to generate","type":"string"},"size":{"description":"The size of the generated image (e.g., \"1024x1024\")","type":"string"},"style":{"description":"The style to apply to the generated image (e.g., \"digital_illustration\")","type":"string"},"style_id":{"description":"The style ID to apply to the generated image (e.g., \"123e4567-e89b-12d3-a456-426614174000\"). If style_id is provided, style should not be provided.","type":"string"}},"required":["prompt","model","size","n"],"type":"object"},"RecraftImageGenerationResponse":{"description":"Response from the Recraft image generation API.","properties":{"created":{"description":"Unix timestamp when the generation was created","type":"integer"},"credits":{"description":"Number of credits used for the generation","type":"integer"},"data":{"description":"Array of generated image information","items":{"properties":{"image_id":{"description":"Unique identifier for the generated image","type":"string"},"url":{"description":"URL to access the generated image","type":"string"}},"type":"object"},"type":"array"}},"required":["created","credits","data"],"type":"object"},"RecraftImageStyle":{"enum":["digital_illustration","icon","realistic_image","vector_illustration"],"type":"string"},"RecraftImageSubStyle":{"enum":["2d_art_poster","3d","80s","glow","grain","hand_drawn","infantile_sketch","kawaii","pixel_art","psychedelic","seamless","voxel","watercolor","broken_line","colored_outline","colored_shapes","colored_shapes_gradient","doodle_fill","doodle_offset_fill","offset_fill","outline","outline_gradient","uneven_fill","70s","cartoon","doodle_line_art","engraving","flat_2","kawaii","line_art","linocut","seamless","b_and_w","enterprise","hard_flash","hdr","motion_blur","natural_light","studio_portrait","line_circuit","2d_art_poster_2","engraving_color","flat_air_art","hand_drawn_outline","handmade_3d","stickers_drawings","plastic","pictogram"],"type":"string"},"RecraftImageToImageRequest":{"properties":{"block_nsfw":{"type":"boolean"},"calculate_features":{"type":"boolean"},"controls":{"$ref":"#/components/schemas/RecraftUserControls"},"image":{"format":"binary","type":"string"},"image_format":{"$ref":"#/components/schemas/RecraftImageFormat"},"model":{"$ref":"#/components/schemas/RecraftTransformModel"},"n":{"type":"integer"},"negative_prompt":{"type":"string"},"prompt":{"type":"string"},"response_format":{"$ref":"#/components/schemas/RecraftResponseFormat"},"strength":{"type":"number"},"style":{"$ref":"#/components/schemas/RecraftImageStyle"},"style_id":{"format":"uuid","type":"string"},"substyle":{"$ref":"#/components/schemas/RecraftImageSubStyle"},"text_layout":{"$ref":"#/components/schemas/RecraftTextLayout"}},"required":["prompt","image","strength"],"type":"object"},"RecraftProcessImageRequest":{"properties":{"image":{"format":"binary","type":"string"},"image_format":{"$ref":"#/components/schemas/RecraftImageFormat"},"response_format":{"$ref":"#/components/schemas/RecraftResponseFormat"}},"required":["image"],"type":"object"},"RecraftProcessImageResponse":{"properties":{"created":{"type":"integer"},"credits":{"type":"integer"},"image":{"$ref":"#/components/schemas/RecraftImage"}},"required":["created","image","credits"],"type":"object"},"RecraftResponseFormat":{"enum":["url","b64_json"],"type":"string"},"RecraftTextLayout":{"items":{"$ref":"#/components/schemas/RecraftTextLayoutItem"},"type":"array"},"RecraftTextLayoutItem":{"properties":{"bbox":{"items":{"items":{"type":"number","x-go-type":"float32"},"type":"array"},"type":"array"},"text":{"type":"string"}},"required":["text","bbox"],"type":"object"},"RecraftTransformImageWithMaskRequest":{"properties":{"block_nsfw":{"type":"boolean"},"calculate_features":{"type":"boolean"},"image":{"format":"binary","type":"string"},"image_format":{"$ref":"#/components/schemas/RecraftImageFormat"},"mask":{"format":"binary","type":"string"},"model":{"$ref":"#/components/schemas/RecraftTransformModel"},"n":{"type":"integer"},"negative_prompt":{"type":"string"},"prompt":{"type":"string"},"response_format":{"$ref":"#/components/schemas/RecraftResponseFormat"},"style":{"$ref":"#/components/schemas/RecraftImageStyle"},"style_id":{"format":"uuid","type":"string"},"substyle":{"$ref":"#/components/schemas/RecraftImageSubStyle"},"text_layout":{"$ref":"#/components/schemas/RecraftTextLayout"}},"required":["image","mask","prompt"],"type":"object"},"RecraftTransformModel":{"enum":["refm1","recraft20b","recraftv2","recraftv3","recraftv4","recraftv4_pro","flux1_1pro","flux1dev","imagen3","hidream_i1_dev"],"type":"string"},"RecraftUserControls":{"properties":{"artistic_level":{"type":"integer"},"background_color":{"$ref":"#/components/schemas/RecraftImageColor"},"colors":{"items":{"$ref":"#/components/schemas/RecraftImageColor"},"type":"array"},"no_text":{"type":"boolean"}},"type":"object"},"ReleaseNote":{"properties":{"attention":{"description":"The attention level for this release","enum":["low","medium","high"],"type":"string"},"content":{"description":"The content of the release note in markdown format","type":"string"},"id":{"description":"Unique identifier for the release note","type":"integer"},"project":{"description":"The project this release note belongs to","enum":["comfyui","comfyui_frontend","desktop","cloud"],"type":"string"},"published_at":{"description":"When the release note was published","format":"date-time","type":"string"},"version":{"description":"The version of the release","type":"string"}},"required":["id","project","version","attention","content","published_at"],"type":"object"},"RenderingSpeed":{"default":"DEFAULT","description":"The rendering speed setting that controls the trade-off between generation speed and quality","enum":["DEFAULT","TURBO","QUALITY"],"type":"string"},"ResponseCompletedEvent":{"description":"Emitted when the model response is complete.","properties":{"response":{"$ref":"#/components/schemas/OpenAIResponse"},"type":{"description":"The type of the event. Always `response.completed`.","enum":["response.completed"],"type":"string","x-stainless-const":true}},"required":["type","response"],"type":"object"},"ResponseContentPartAddedEvent":{"description":"Emitted when a new content part is added.","properties":{"content_index":{"description":"The index of the content part that was added.","type":"integer"},"item_id":{"description":"The ID of the output item that the content part was added to.","type":"string"},"output_index":{"description":"The index of the output item that the content part was added to.","type":"integer"},"part":{"$ref":"#/components/schemas/OutputContent"},"type":{"description":"The type of the event. Always `response.content_part.added`.","enum":["response.content_part.added"],"type":"string","x-stainless-const":true}},"required":["type","item_id","output_index","content_index","part"],"type":"object"},"ResponseContentPartDoneEvent":{"description":"Emitted when a content part is done.","properties":{"content_index":{"description":"The index of the content part that is done.","type":"integer"},"item_id":{"description":"The ID of the output item that the content part was added to.","type":"string"},"output_index":{"description":"The index of the output item that the content part was added to.","type":"integer"},"part":{"$ref":"#/components/schemas/OutputContent"},"type":{"description":"The type of the event. Always `response.content_part.done`.","enum":["response.content_part.done"],"type":"string","x-stainless-const":true}},"required":["type","item_id","output_index","content_index","part"],"type":"object"},"ResponseCreatedEvent":{"description":"An event that is emitted when a response is created.","properties":{"response":{"$ref":"#/components/schemas/OpenAIResponse"},"type":{"description":"The type of the event. Always `response.created`.","enum":["response.created"],"type":"string","x-stainless-const":true}},"required":["type","response"],"type":"object"},"ResponseError":{"description":"An error object returned when the model fails to generate a Response.","properties":{"code":{"$ref":"#/components/schemas/ResponseErrorCode"},"message":{"description":"A human-readable description of the error.","type":"string"}},"required":["code","message"],"type":"object"},"ResponseErrorCode":{"description":"The error code for the response.","enum":["server_error","rate_limit_exceeded","invalid_prompt","vector_store_timeout","invalid_image","invalid_image_format","invalid_base64_image","invalid_image_url","image_too_large","image_too_small","image_parse_error","image_content_policy_violation","invalid_image_mode","image_file_too_large","unsupported_image_media_type","empty_image_file","failed_to_download_image","image_file_not_found"],"type":"string"},"ResponseErrorEvent":{"description":"Emitted when an error occurs.","properties":{"code":{"description":"The error code.\n","type":"string"},"message":{"description":"The error message.\n","type":"string"},"param":{"description":"The error parameter.\n","type":"string"},"type":{"description":"The type of the event. Always `error`.\n","enum":["error"],"type":"string","x-stainless-const":true}},"required":["type","code","message","param"],"type":"object"},"ResponseFailedEvent":{"description":"An event that is emitted when a response fails.\n","properties":{"response":{"$ref":"#/components/schemas/OpenAIResponse"},"type":{"description":"The type of the event. Always `response.failed`.\n","enum":["response.failed"],"type":"string","x-stainless-const":true}},"required":["type","response"],"type":"object"},"ResponseFormatJsonObject":{"description":"JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n","properties":{"type":{"description":"The type of response format being defined. Always `json_object`.","enum":["json_object"],"type":"string","x-stainless-const":true}},"required":["type"],"title":"JSON object","type":"object"},"ResponseFormatJsonSchemaSchema":{"additionalProperties":true,"description":"The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n","title":"JSON schema","type":"object"},"ResponseFormatText":{"description":"Default response format. Used to generate text responses.\n","properties":{"type":{"description":"The type of response format being defined. Always `text`.","enum":["text"],"type":"string","x-stainless-const":true}},"required":["type"],"title":"Text","type":"object"},"ResponseInProgressEvent":{"description":"Emitted when the response is in progress.","properties":{"response":{"$ref":"#/components/schemas/OpenAIResponse"},"type":{"description":"The type of the event. Always `response.in_progress`.\n","enum":["response.in_progress"],"type":"string","x-stainless-const":true}},"required":["type","response"],"type":"object"},"ResponseIncompleteEvent":{"description":"An event that is emitted when a response finishes as incomplete.\n","properties":{"response":{"$ref":"#/components/schemas/OpenAIResponse"},"type":{"description":"The type of the event. Always `response.incomplete`.\n","enum":["response.incomplete"],"type":"string","x-stainless-const":true}},"required":["type","response"],"type":"object"},"ResponseOutputItemAddedEvent":{"description":"Emitted when a new output item is added.","properties":{"item":{"$ref":"#/components/schemas/OutputItem"},"output_index":{"description":"The index of the output item that was added.\n","type":"integer"},"type":{"description":"The type of the event. Always `response.output_item.added`.\n","enum":["response.output_item.added"],"type":"string","x-stainless-const":true}},"required":["type","output_index","item"],"type":"object"},"ResponseOutputItemDoneEvent":{"description":"Emitted when an output item is marked done.","properties":{"item":{"$ref":"#/components/schemas/OutputItem"},"output_index":{"description":"The index of the output item that was marked done.\n","type":"integer"},"type":{"description":"The type of the event. Always `response.output_item.done`.\n","enum":["response.output_item.done"],"type":"string","x-stainless-const":true}},"required":["type","output_index","item"],"type":"object"},"ResponseProperties":{"properties":{"instructions":{"description":"Inserts a system (or developer) message as the first item in the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n","type":"string"},"max_output_tokens":{"description":"An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"integer"},"model":{"$ref":"#/components/schemas/OpenAIModels"},"previous_response_id":{"description":"The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](/docs/guides/conversation-state).\n","type":"string"},"reasoning":{"$ref":"#/components/schemas/Reasoning"},"text":{"properties":{"format":{"$ref":"#/components/schemas/TextResponseFormatConfiguration"}},"type":"object"},"tool_choice":{"description":"How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n","oneOf":[{"$ref":"#/components/schemas/ToolChoiceOptions"},{"$ref":"#/components/schemas/ToolChoiceTypes"},{"$ref":"#/components/schemas/ToolChoiceFunction"}]},"tools":{"items":{"$ref":"#/components/schemas/Tool"},"type":"array"},"truncation":{"default":"disabled","description":"The truncation strategy to use for the model response.\n- `auto`: If the context of this response and previous ones exceeds\n  the model's context window size, the model will truncate the\n  response to fit the context window by dropping input items in the\n  middle of the conversation.\n- `disabled` (default): If a model response will exceed the context window\n  size for a model, the request will fail with a 400 error.\n","enum":["auto","disabled"],"type":"string"}},"type":"object"},"ResponseUsage":{"description":"Represents token usage details including input tokens, output tokens,\na breakdown of output tokens, and the total tokens used.\n","properties":{"input_tokens":{"description":"The number of input tokens.","type":"integer"},"input_tokens_details":{"description":"A detailed breakdown of the input tokens.","properties":{"cached_tokens":{"description":"The number of tokens that were retrieved from the cache.\n[More on prompt caching](/docs/guides/prompt-caching).\n","type":"integer"}},"required":["cached_tokens"],"type":"object"},"output_tokens":{"description":"The number of output tokens.","type":"integer"},"output_tokens_details":{"description":"A detailed breakdown of the output tokens.","properties":{"reasoning_tokens":{"description":"The number of reasoning tokens.","type":"integer"}},"required":["reasoning_tokens"],"type":"object"},"total_tokens":{"description":"The total number of tokens used.","type":"integer"}},"required":["input_tokens","input_tokens_details","output_tokens","output_tokens_details","total_tokens"],"type":"object"},"ReveImageCreateRequest":{"description":"Request body for Reve image creation.","properties":{"aspect_ratio":{"default":"3:2","description":"The desired aspect ratio of the generated image.","enum":["16:9","9:16","3:2","2:3","4:3","3:4","1:1"],"type":"string"},"postprocessing":{"description":"Optional postprocessing operations to apply after generation. May add additional cost.","items":{"$ref":"#/components/schemas/RevePostprocessingOperation"},"type":"array"},"prompt":{"description":"The text description of the desired image. Maximum length is 2560 characters.","maxLength":2560,"type":"string"},"test_time_scaling":{"description":"If included, the model will spend more effort making better images. Values between 1 and 15 are accepted. Adds additional credits cost.","maximum":15,"minimum":1,"type":"number"},"version":{"default":"latest","description":"Model version to use. Supported: latest, reve-create@20250915.","type":"string"}},"required":["prompt"],"type":"object"},"ReveImageEditRequest":{"description":"Request body for Reve image editing.","properties":{"aspect_ratio":{"description":"The desired aspect ratio. Defaults to the aspect ratio of the reference image if not provided.","enum":["16:9","9:16","3:2","2:3","4:3","3:4","1:1"],"type":"string"},"edit_instruction":{"description":"The text description of how to edit the provided image. Maximum length is 2560 characters.","maxLength":2560,"type":"string"},"postprocessing":{"description":"Optional postprocessing operations to apply after generation. May add additional cost.","items":{"$ref":"#/components/schemas/RevePostprocessingOperation"},"type":"array"},"reference_image":{"description":"A base64 encoded image to use as reference for the edit.","type":"string"},"test_time_scaling":{"description":"If included, the model will spend more effort making better images. Values between 1 and 15 are accepted. Adds additional credits cost.","maximum":15,"minimum":1,"type":"number"},"version":{"default":"latest","description":"Model version to use. Supported: latest-fast, latest, reve-edit-fast@20251030, reve-edit@20250915.","type":"string"}},"required":["edit_instruction","reference_image"],"type":"object"},"ReveImageRemixRequest":{"description":"Request body for Reve image remixing.","properties":{"aspect_ratio":{"description":"The desired aspect ratio. If not provided, smartly chosen by the model.","enum":["16:9","9:16","3:2","2:3","4:3","3:4","1:1"],"type":"string"},"postprocessing":{"description":"Optional postprocessing operations to apply after generation. May add additional cost.","items":{"$ref":"#/components/schemas/RevePostprocessingOperation"},"type":"array"},"prompt":{"description":"The text description of the desired image. May include xml img tags to refer to specific reference images by index. Maximum length is 2560 characters.","maxLength":2560,"type":"string"},"reference_images":{"description":"A list of 1-6 base64 encoded reference images. Each must be less than 10 MB. Total pixel count must be no more than 32 million pixels.","items":{"type":"string"},"maxItems":6,"minItems":1,"type":"array"},"test_time_scaling":{"description":"If included, the model will spend more effort making better images. Values between 1 and 15 are accepted. Adds additional credits cost.","maximum":15,"minimum":1,"type":"number"},"version":{"default":"latest","description":"Model version to use. Supported: latest-fast, latest, reve-remix-fast@20251030, reve-remix@20250915.","type":"string"}},"required":["prompt","reference_images"],"type":"object"},"ReveImageResponse":{"description":"Response from the Reve image API.","properties":{"content_violation":{"description":"Indicates whether the generated image violates the content policy.","type":"boolean"},"credits_remaining":{"description":"The number of credits remaining in your budget.","type":"number"},"credits_used":{"description":"The number of credits used for this request.","type":"number"},"image":{"description":"The base64 encoded image data. Empty if the request was not successful.","type":"string"},"request_id":{"description":"A unique id for the request.","type":"string"},"version":{"description":"The specific model version used in the generation process.","type":"string"}},"type":"object"},"RevePostprocessingOperation":{"description":"A postprocessing operation to apply after image generation.","properties":{"effect_name":{"description":"Name of the effect to apply. Only used when process is effect.","type":"string"},"effect_parameters":{"description":"Optional parameters to override default effect settings.","type":"object"},"max_dim":{"description":"Maximum dimension for fit_image. At least one of max_dim, max_width, or max_height must be set.","maximum":1024,"type":"integer"},"max_height":{"description":"Maximum height for fit_image.","maximum":1024,"type":"integer"},"max_width":{"description":"Maximum width for fit_image.","maximum":1024,"type":"integer"},"process":{"description":"The postprocessing operation: upscale, remove_background, fit_image, or effect.","enum":["upscale","remove_background","fit_image","effect"],"type":"string"},"upscale_factor":{"description":"Upscale factor (2, 3, or 4). Only used when process is upscale.","maximum":4,"minimum":2,"type":"integer"}},"required":["process"],"type":"object"},"Rodin3DCheckStatusRequest":{"properties":{"subscription_key":{"description":"subscription from generate endpoint","type":"string"}},"required":["subscription_key"],"type":"object"},"Rodin3DCheckStatusResponse":{"properties":{"jobs":{"description":"Details for the generation status.","items":{"$ref":"#/components/schemas/RodinCheckStatusJobItem"},"type":"array"}},"type":"object"},"Rodin3DDownloadRequest":{"properties":{"task_uuid":{"description":"Task UUID","type":"string"}},"required":["task_uuid"],"type":"object"},"Rodin3DDownloadResponse":{"properties":{"list":{"items":{"$ref":"#/components/schemas/RodinResourceItem"},"type":"array"}},"type":"object"},"Rodin3DGenerateRequest":{"properties":{"addons":{"description":"Optional list of upstream addon flags (e.g. \"HighPack\").","items":{"type":"string"},"type":"array"},"images":{"description":"The reference images to generate 3D Assets.","type":"string"},"material":{"$ref":"#/components/schemas/RodinMaterialType"},"mesh_mode":{"$ref":"#/components/schemas/RodinMeshModeType"},"prompt":{"description":"Text prompt used by the upstream Rodin API. Required by upstream for text-to-3D requests (no images uploaded); optional for image-to-3D requests where it acts as additional guidance.\n","type":"string"},"quality":{"$ref":"#/components/schemas/RodinQualityType"},"seed":{"description":"Seed.","type":"integer"},"tier":{"$ref":"#/components/schemas/RodinTierType"}},"required":["images"],"type":"object"},"Rodin3DGenerateResponse":{"properties":{"jobs":{"$ref":"#/components/schemas/RodinGenerateJobsData"},"message":{"description":"message","type":"string"},"prompt":{"description":"prompt","type":"string"},"submit_time":{"description":"Time","type":"string"},"uuid":{"description":"Task UUID","type":"string"}},"type":"object"},"RodinCheckStatusJobItem":{"properties":{"status":{"$ref":"#/components/schemas/RodinStatusOptions"},"uuid":{"description":"sub uuid","type":"string"}},"type":"object"},"RodinGenerateJobsData":{"properties":{"subscription_key":{"description":"Subscription Key.","type":"string"},"uuids":{"description":"subjobs uuid.","items":{"type":"string"},"type":"array"}},"type":"object"},"RodinMaterialType":{"description":"Rodin Material para options","enum":["PBR","Shaded"],"type":"string"},"RodinMeshModeType":{"description":"Rodin Mesh_Mode para options","enum":["Quad","Raw"],"type":"string"},"RodinQualityType":{"description":"Rodin Quality para options","enum":["extra-low","low","medium","high"],"type":"string"},"RodinResourceItem":{"properties":{"name":{"description":"File name","type":"string"},"url":{"description":"Download url","type":"string"}},"type":"object"},"RodinStatusOptions":{"enum":["Done","Failed","Generating","Waiting"],"type":"string"},"RodinTierType":{"description":"Rodin Tier para options","enum":["Regular","Sketch","Detail","Smooth"],"type":"string"},"RunwayAspectRatioEnum":{"enum":["1280:720","720:1280","1104:832","832:1104","960:960","1584:672","1280:768","768:1280"],"type":"string"},"RunwayDurationEnum":{"enum":[5,10],"type":"integer"},"RunwayImageToVideoRequest":{"properties":{"duration":{"$ref":"#/components/schemas/RunwayDurationEnum"},"model":{"$ref":"#/components/schemas/RunwayModelEnum"},"promptImage":{"$ref":"#/components/schemas/RunwayPromptImageObject"},"promptText":{"description":"Text prompt for the generation","maxLength":1000,"type":"string"},"ratio":{"$ref":"#/components/schemas/RunwayAspectRatioEnum"},"seed":{"description":"Random seed for generation","format":"int64","maximum":4294967295,"minimum":0,"type":"integer"}},"required":["promptImage","seed","model","duration","ratio"],"type":"object"},"RunwayImageToVideoResponse":{"properties":{"id":{"description":"Task ID","type":"string"}},"type":"object"},"RunwayModelEnum":{"description":"Available Runway models for generation.","enum":["gen4_turbo","gen3a_turbo"],"type":"string"},"RunwayPromptImageDetailedObject":{"description":"Represents an image with its position in the video sequence.","properties":{"position":{"description":"The position of the image in the output video. 'last' is currently supported for gen3a_turbo only.","enum":["first","last"],"type":"string"},"uri":{"description":"A HTTPS URL or data URI containing an encoded image.","type":"string"}},"required":["uri","position"],"type":"object"},"RunwayPromptImageObject":{"description":"Image(s) to use for the video generation. Can be a single URI or an array of image objects with positions.","oneOf":[{"description":"A single HTTPS URL or data URI for the first frame image.","type":"string"},{"description":"An array of image objects with positions. No two images can have the same position.","items":{"$ref":"#/components/schemas/RunwayPromptImageDetailedObject"},"type":"array"}]},"RunwayTaskStatusEnum":{"description":"Possible statuses for a Runway task.","enum":["SUCCEEDED","RUNNING","FAILED","PENDING","CANCELLED","THROTTLED"],"type":"string"},"RunwayTaskStatusResponse":{"properties":{"createdAt":{"description":"Task creation timestamp","format":"date-time","type":"string"},"id":{"description":"Task ID","type":"string"},"output":{"description":"Array of output video URLs","items":{"type":"string"},"type":"array"},"progress":{"description":"Float value between 0 and 1 representing the progress of the task. Only available if status is RUNNING.","format":"float","maximum":1,"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RunwayTaskStatusEnum"}},"required":["id","status","createdAt"],"type":"object"},"RunwayTextToImageAspectRatioEnum":{"enum":["1920:1080","1080:1920","1024:1024","1360:768","1080:1080","1168:880","1440:1080","1080:1440","1808:768","2112:912"],"type":"string"},"RunwayTextToImageRequest":{"properties":{"model":{"description":"Model to use for generation","enum":["gen4_image"],"type":"string"},"promptText":{"description":"Text prompt for the image generation","maxLength":1000,"type":"string"},"ratio":{"$ref":"#/components/schemas/RunwayTextToImageAspectRatioEnum"},"referenceImages":{"description":"Array of reference images to guide the generation","items":{"properties":{"uri":{"description":"A HTTPS URL or data URI containing an encoded image","type":"string"}},"type":"object"},"type":"array"}},"required":["promptText","model","ratio"],"type":"object"},"RunwayTextToImageResponse":{"properties":{"id":{"description":"Task ID","type":"string"}},"type":"object"},"SeedanceAssetError":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SeedanceAssetModeration":{"properties":{"strategy":{"description":"Content Pre-filter review strategy. \"Skip\" bypasses most non-baseline policies (requires Secure Mode off on the account).","enum":["Default","Skip"],"type":"string"}},"required":["strategy"],"type":"object"},"SeedanceCreateAssetRequest":{"properties":{"asset_type":{"enum":["Image","Video","Audio"],"type":"string"},"group_id":{"description":"BytePlus Asset Group ID the asset will belong to. Caller must own this group.","type":"string"},"moderation":{"$ref":"#/components/schemas/SeedanceAssetModeration"},"name":{"description":"Optional asset name, up to 64 characters.","type":"string"},"project_name":{"description":"BytePlus project name. Defaults to \"default\". Must match the Asset Group's project.","type":"string"},"url":{"description":"Publicly accessible URL of the asset.","type":"string"}},"required":["group_id","url","asset_type"],"type":"object"},"SeedanceCreateAssetResponse":{"properties":{"asset_id":{"description":"BytePlus-issued asset id. Clients poll seedanceGetAsset with this until status == Active.","type":"string"}},"required":["asset_id"],"type":"object"},"SeedanceCreateVisualValidateSessionRequest":{"properties":{"name":{"description":"Optional human-readable label for the asset group that will be created by this verification. Stored locally and returned by seedanceListVisualValidationGroups so users can identify their groups in selectors.\n","maxLength":64,"type":"string"}},"type":"object"},"SeedanceCreateVisualValidateSessionResponse":{"properties":{"h5_link":{"description":"BytePlus-issued H5 liveness link. Open in a browser with camera access. Valid for ~120 seconds.","type":"string"},"session_id":{"description":"Session identifier. Clients poll seedanceGetVisualValidateSession with this.","format":"uuid","type":"string"}},"required":["session_id","h5_link"],"type":"object"},"SeedanceGetAssetResponse":{"properties":{"asset_type":{"enum":["Image","Video","Audio"],"type":"string"},"create_time":{"format":"date-time","nullable":true,"type":"string"},"error":{"$ref":"#/components/schemas/SeedanceAssetError"},"group_id":{"type":"string"},"id":{"type":"string"},"name":{"nullable":true,"type":"string"},"project_name":{"nullable":true,"type":"string"},"status":{"enum":["Active","Processing","Failed"],"type":"string"},"update_time":{"format":"date-time","nullable":true,"type":"string"},"url":{"description":"Access URL valid for ~12 hours.","nullable":true,"type":"string"}},"required":["id","asset_type","group_id","status"],"type":"object"},"SeedanceGetVisualValidateSessionResponse":{"properties":{"error_code":{"nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"group_id":{"description":"Populated only when status == completed. This is the BytePlus Asset Group ID the user will upload assets into.","nullable":true,"type":"string"},"name":{"description":"Optional human-readable label provided when the session was created.","nullable":true,"type":"string"},"session_id":{"format":"uuid","type":"string"},"status":{"enum":["pending","completed","failed"],"type":"string"}},"required":["session_id","status"],"type":"object"},"SeedanceListUserAssetsResponse":{"properties":{"assets":{"items":{"$ref":"#/components/schemas/SeedanceUserAsset"},"type":"array"},"truncated":{"description":"True if the global per-request asset cap was hit and older results were dropped.","type":"boolean"}},"required":["assets","truncated"],"type":"object"},"SeedanceListVisualValidationGroupsResponse":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/SeedanceVisualValidationGroup"},"type":"array"}},"required":["groups"],"type":"object"},"SeedanceUserAsset":{"properties":{"asset_id":{"type":"string"},"asset_type":{"enum":["Image","Video","Audio"],"type":"string"},"create_time":{"format":"date-time","type":"string"},"group_id":{"type":"string"},"group_name":{"description":"Display label of the source group, denormalized for client-side search.","type":"string"},"name":{"nullable":true,"type":"string"},"status":{"enum":["Active","Processing","Failed"],"type":"string"},"url":{"description":"BytePlus access URL (~12h validity). Refreshed on each list call.","nullable":true,"type":"string"}},"required":["asset_id","group_id","group_name","asset_type","status","create_time"],"type":"object"},"SeedanceVirtualLibraryCreateAssetRequest":{"properties":{"hash":{"description":"Client-supplied content hash used as the per-customer dedup key. Re-submitting the same hash returns the existing asset id without re-uploading to BytePlus.","type":"string"},"url":{"description":"Publicly accessible URL of the image asset to upload to the caller's virtual portrait library.","type":"string"}},"required":["url","hash"],"type":"object"},"SeedanceVirtualLibraryCreateAssetResponse":{"properties":{"asset_id":{"description":"BytePlus-issued asset id. Clients poll seedanceGetAsset with this until status == Active.","type":"string"}},"required":["asset_id"],"type":"object"},"SeedanceVisualValidationGroup":{"properties":{"created_at":{"format":"date-time","type":"string"},"group_id":{"description":"BytePlus-issued asset group id.","type":"string"},"name":{"description":"Display label. Caller-supplied at creation time when available; otherwise a server-generated fallback derived from the creation date.\n","type":"string"}},"required":["group_id","name","created_at"],"type":"object"},"SoniloErrorResponse":{"properties":{"detail":{"properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Human-readable error message","type":"string"}},"type":"object"}},"type":"object"},"SoniloStreamEvent":{"description":"A single NDJSON event from the Sonilo streaming response.","oneOf":[{"properties":{"copy_index":{"minimum":0,"type":"integer"},"display_tags":{"items":{"type":"string"},"type":"array"},"prompt_index":{"minimum":0,"type":"integer"},"stream_index":{"minimum":0,"type":"integer"},"title":{"type":"string"},"type":{"enum":["title"],"type":"string"}},"required":["type","stream_index","prompt_index","copy_index","title","display_tags"],"type":"object"},{"properties":{"channels":{"type":"integer"},"data":{"description":"Base64-encoded AAC in fMP4 fragments; concatenate per stream_index.","type":"string"},"num_streams":{"minimum":1,"type":"integer"},"sample_rate":{"type":"integer"},"stream_index":{"minimum":0,"type":"integer"},"type":{"enum":["audio_chunk"],"type":"string"}},"required":["type","sample_rate","channels","stream_index","num_streams","data"],"type":"object"},{"properties":{"billing":{"type":"number"},"billing_rate_per_sec":{"type":"number"},"channels":{"type":"integer"},"duration_sec_by_stream":{"items":{"type":"number"},"type":"array"},"sample_rate":{"type":"integer"},"type":{"enum":["generated_audio"],"type":"string"}},"required":["type","sample_rate","channels","duration_sec_by_stream","billing_rate_per_sec","billing"],"type":"object"},{"properties":{"type":{"enum":["complete"],"type":"string"}},"required":["type"],"type":"object"},{"properties":{"code":{"type":"string"},"message":{"type":"string"},"type":{"enum":["error"],"type":"string"}},"required":["type","message"],"type":"object"}]},"SoniloTextToMusicRequest":{"properties":{"duration":{"description":"Target duration in seconds. Will be inferred if not provided.","exclusiveMinimum":true,"maximum":360,"minimum":0,"type":"number"},"prompt":{"description":"Text prompt describing the desired music.","minLength":1,"type":"string"}},"required":["prompt"],"type":"object"},"SoniloVideoToMusicRequest":{"oneOf":[{"properties":{"prompt":{"description":"Optional text prompt to guide music generation.","type":"string"},"video":{"description":"Multipart file part; e.g. video/mp4.","format":"binary","type":"string"}},"required":["video"],"type":"object"},{"properties":{"prompt":{"description":"Optional text prompt to guide music generation.","type":"string"},"video_url":{"description":"Public http(s) URL of the video.","format":"uri","type":"string"}},"required":["video_url"],"type":"object"}]},"StabilityContentModerationResponse":{"description":"Your request was flagged by our content moderation system.","example":{"errors":["Your request was flagged by our content moderation system, as a result your request was denied and you were not charged."],"id":"ed14db44362126aab3cbd25cca51ffe3","name":"content_moderation"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Our content moderation system has flagged some part of your request and subsequently denied it.  You were not charged for this request.  While this may at times be frustrating, it is necessary to maintain the integrity of our platform and ensure a safe experience for all users. If you would like to provide feedback, please use the [Support Form](https://kb.stability.ai/knowledge-base/kb-tickets/new).","enum":["content_moderation"],"minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityCreativity":{"default":0.35,"description":"Controls the likelihood of creating additional details not heavily conditioned by the init image.","maximum":0.5,"minimum":0.2,"type":"number"},"StabilityError":{"example":{"errors":["An unexpected server error has occurred, please try again later."],"id":"2a1b2d4eafe2bc6ab4cd4d5c6133f513","name":"internal_error"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":[{"some-field":"is required"}],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.\n","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityGenerationID":{"description":"The `id` of a generation, typically used for async generations, that can be used to check the status of the generation or retrieve the result.","example":"a6dc6c6e20acda010fe14d71f180658f2896ed9b4ec25aa99a6ff06c796987c4","maxLength":64,"minLength":64,"type":"string"},"StabilityGetResultResponse_202":{"properties":{"id":{"description":"The ID of the generation result.","example":1234567890,"type":"string"},"status":{"enum":["in-progress"],"type":"string"}},"type":"object"},"StabilityImageGenerationSD3_Request":{"properties":{"aspect_ratio":{"default":"1:1","description":"Controls the aspect ratio of the generated image. Defaults to 1:1.\n\n\u003e **Important:** This parameter is only valid for **text-to-image** requests.","enum":["21:9","16:9","3:2","5:4","1:1","4:5","2:3","9:16","9:21"],"type":"string"},"cfg_scale":{"description":"How strictly the diffusion process adheres to the prompt text (higher values keep your image closer to your prompt). The _Large_ and _Medium_ models use a default of `4`. The _Turbo_ model uses a default of `1`.","maximum":10,"minimum":1,"type":"number"},"image":{"description":"The image to use as the starting point for the generation.\n\nSupported formats:\n\n\n\n  - jpeg\n  - png\n  - webp\n\nSupported dimensions:\n\n\n\n  - Every side must be at least 64 pixels\n\n\u003e **Important:** This parameter is only valid for **image-to-image** requests.","format":"binary","type":"string"},"mode":{"default":"text-to-image","description":"Controls whether this is a text-to-image or image-to-image generation, which affects which parameters are required:\n- **text-to-image** requires only the `prompt` parameter\n- **image-to-image** requires the `prompt`, `image`, and `strength` parameters","enum":["text-to-image","image-to-image"],"title":"GenerationMode","type":"string"},"model":{"default":"sd3.5-large","description":"The model to use for generation.\n\n- `sd3.5-large` requires 6.5 credits per generation\n- `sd3.5-large-turbo` requires 4 credits per generation\n- `sd3.5-medium` requires 3.5 credits per generation\n- As of the April 17, 2025, `sd3-large`, `sd3-large-turbo` and `sd3-medium`\n\n\n\n  are re-routed to their `sd3.5-[model version]` equivalent, at the same price.","enum":["sd3.5-large","sd3.5-large-turbo","sd3.5-medium"],"type":"string"},"negative_prompt":{"description":"Keywords of what you **do not** wish to see in the output image.\nThis is an advanced feature.","maxLength":10000,"type":"string"},"output_format":{"default":"png","description":"Dictates the `content-type` of the generated image.","enum":["png","jpeg"],"type":"string"},"prompt":{"description":"What you wish to see in the output image. A strong, descriptive prompt that clearly defines\nelements, colors, and subjects will lead to better results.","maxLength":10000,"minLength":1,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"},"strength":{"description":"Sometimes referred to as _denoising_, this parameter controls how much influence the\n`image` parameter has on the generated image.  A value of 0 would yield an image that\nis identical to the input.  A value of 1 would be as if you passed in no image at all.\n\n\u003e **Important:** This parameter is only valid for **image-to-image** requests.","maximum":1,"minimum":0,"type":"number"},"style_preset":{"description":"Guides the image model towards a particular style.","enum":["enhance","anime","photographic","digital-art","comic-book","fantasy-art","line-art","analog-film","neon-punk","isometric","low-poly","origami","modeling-compound","cinematic","3d-model","pixel-art","tile-texture"],"type":"string"}},"required":["prompt"],"type":"object"},"StabilityImageGenrationSD3_Response_200":{"properties":{"finish_reason":{"description":"The reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\npolicy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"},"StabilityImageGenrationSD3_Response_400":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationSD3_Response_413":{"example":{"errors":["body: payloads cannot be larger than 10MiB in size"],"id":"4212a4b66fbe1cedca4bf2133d35dca5","name":"payload_too_large"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationSD3_Response_422":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationSD3_Response_429":{"example":{"errors":["You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."],"id":"rate_limit_exceeded","name":"rate_limit_exceeded"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationSD3_Response_500":{"example":{"errors":["An unexpected server error has occurred, please try again later."],"id":"2a1b2d4eafe2bc6ab4cd4d5c6133f513","name":"internal_error"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Request":{"properties":{"creativity":{"$ref":"#/components/schemas/StabilityCreativity"},"image":{"description":"The image you wish to upscale.\n\nSupported Formats:\n- jpeg\n- png\n- webp\n\nValidation Rules:\n- Every side must be at least 64 pixels\n- Total pixel count must be between 4,096 and 9,437,184 pixels\n- The aspect ratio must be between 1:2.5 and 2.5:1","example":"./some/image.png","format":"binary","type":"string"},"negative_prompt":{"description":"A blurb of text describing what you **do not** wish to see in the output image.\nThis is an advanced feature.","maxLength":10000,"type":"string"},"output_format":{"default":"png","description":"Dictates the `content-type` of the generated image.","enum":["jpeg","png","webp"],"type":"string"},"prompt":{"description":"What you wish to see in the output image. A strong, descriptive prompt that clearly defines\nelements, colors, and subjects will lead to better results.\n\nTo control the weight of a given word use the format `(word:weight)`,\nwhere `word` is the word you'd like to control the weight of and `weight`\nis a value between 0 and 1. For example: `The sky was a crisp (blue:0.3) and (green:0.8)`\nwould convey a sky that was blue and green, but more green than blue.","maxLength":10000,"minLength":1,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","prompt"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Response_200":{"properties":{"finish_reason":{"description":"The reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\npolicy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Response_400":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Response_413":{"example":{"errors":["body: payloads cannot be larger than 10MiB in size"],"id":"4212a4b66fbe1cedca4bf2133d35dca5","name":"payload_too_large"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Response_422":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Response_429":{"example":{"errors":["You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."],"id":"rate_limit_exceeded","name":"rate_limit_exceeded"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleConservative_Response_500":{"example":{"errors":["An unexpected server error has occurred, please try again later."],"id":"2a1b2d4eafe2bc6ab4cd4d5c6133f513","name":"internal_error"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Request":{"properties":{"creativity":{"default":0.3,"description":"Indicates how creative the model should be when upscaling an image.\nHigher values will result in more details being added to the image during upscaling.","maximum":0.5,"minimum":0.1,"type":"number"},"image":{"description":"The image you wish to upscale.\n\nSupported Formats:\n- jpeg\n- png\n- webp\n\nValidation Rules:\n- Every side must be at least 64 pixels\n- Total pixel count must be between 4,096 and 1,048,576 pixels","example":"./some/image.png","format":"binary","type":"string"},"negative_prompt":{"description":"A blurb of text describing what you **do not** wish to see in the output image.\nThis is an advanced feature.","maxLength":10000,"type":"string"},"output_format":{"default":"png","description":"Dictates the `content-type` of the generated image.","enum":["jpeg","png","webp"],"type":"string"},"prompt":{"description":"What you wish to see in the output image. A strong, descriptive prompt that clearly defines\nelements, colors, and subjects will lead to better results.\n\nTo control the weight of a given word use the format `(word:weight)`,\nwhere `word` is the word you'd like to control the weight of and `weight`\nis a value between 0 and 1. For example: `The sky was a crisp (blue:0.3) and (green:0.8)`\nwould convey a sky that was blue and green, but more green than blue.","maxLength":10000,"minLength":1,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"},"style_preset":{"description":"Guides the image model towards a particular style.","enum":["enhance","anime","photographic","digital-art","comic-book","fantasy-art","line-art","analog-film","neon-punk","isometric","low-poly","origami","modeling-compound","cinematic","3d-model","pixel-art","tile-texture"],"type":"string"}},"required":["image","prompt"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Response_200":{"properties":{"id":{"$ref":"#/components/schemas/StabilityGenerationID"}},"required":["id"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Response_400":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Response_413":{"example":{"errors":["body: payloads cannot be larger than 10MiB in size"],"id":"4212a4b66fbe1cedca4bf2133d35dca5","name":"payload_too_large"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Response_422":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Response_429":{"example":{"errors":["You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."],"id":"rate_limit_exceeded","name":"rate_limit_exceeded"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleCreative_Response_500":{"example":{"errors":["An unexpected server error has occurred, please try again later."],"id":"2a1b2d4eafe2bc6ab4cd4d5c6133f513","name":"internal_error"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleFast_Request":{"properties":{"image":{"description":"The image you wish to upscale.\n\nSupported Formats:\n- jpeg\n- png\n- webp\n\nValidation Rules:\n- Width must be between 32 and 1,536 pixels\n- Height must be between 32 and 1,536 pixels\n- Total pixel count must be between 1,024 and 1,048,576 pixels","example":"./some/image.png","format":"binary","type":"string"},"output_format":{"default":"png","description":"Dictates the `content-type` of the generated image.","enum":["jpeg","png","webp"],"type":"string"}},"required":["image"],"type":"object"},"StabilityImageGenrationUpscaleFast_Response_200":{"properties":{"finish_reason":{"description":"The reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\npolicy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"},"StabilityImageGenrationUpscaleFast_Response_400":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleFast_Response_413":{"example":{"errors":["body: payloads cannot be larger than 10MiB in size"],"id":"4212a4b66fbe1cedca4bf2133d35dca5","name":"payload_too_large"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleFast_Response_422":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleFast_Response_429":{"example":{"errors":["You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."],"id":"rate_limit_exceeded","name":"rate_limit_exceeded"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityImageGenrationUpscaleFast_Response_500":{"example":{"errors":["An unexpected server error has occurred, please try again later."],"id":"2a1b2d4eafe2bc6ab4cd4d5c6133f513","name":"internal_error"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new)\nyou file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"},"StabilityStabilityClientID":{"description":"The name of your application, used to help us communicate app-specific debugging or moderation issues to you.","example":"my-awesome-app","maxLength":256,"type":"string"},"StabilityStabilityClientUserID":{"description":"A unique identifier for your end user. Used to help us communicate user-specific debugging or moderation issues to you. Feel free to obfuscate this value to protect user privacy.","example":"DiscordUser#9999","maxLength":256,"type":"string"},"StabilityStabilityClientVersion":{"description":"The version of your application, used to help us communicate version-specific debugging or moderation issues to you.","example":"1.2.1","maxLength":256,"type":"string"},"StableAudio25AudioResponse":{"description":"Response from Stable Audio 2.5 audio generation","properties":{"audio":{"description":"Base64-encoded audio data","format":"byte","type":"string"},"finish_reason":{"description":"Reason for completion","enum":["SUCCESS","ERROR","CONTENT_FILTERED"],"type":"string"},"id":{"description":"Unique identifier for the generation request","type":"string"}},"type":"object"},"StableAudio25AudioToAudioRequest":{"description":"Request parameters for Stable Audio audio-to-audio transformation","properties":{"audio":{"description":"The audio to be used as the starting point for the generation. Supported formats - mp3, wav. Audio must be between 6 and 190 seconds long.","format":"binary","type":"string"},"cfg_scale":{"description":"How strictly the diffusion process adheres to the prompt text (higher values make your audio closer to your prompt). Defaults to 7 for stable-audio-2 and 1 for stable-audio-2.5.","maximum":25,"minimum":1,"type":"number"},"duration":{"default":190,"description":"Controls the duration in seconds of the generated audio.","maximum":190,"minimum":1,"type":"number"},"model":{"$ref":"#/components/schemas/StableAudio25Model"},"output_format":{"$ref":"#/components/schemas/StableAudio25OutputFormat"},"prompt":{"description":"What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.","maxLength":10000,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"},"steps":{"default":8,"description":"Controls the number of sampling steps. For stable-audio-2.5 accepts steps between 4 and 8 (defaults to 8).","maximum":8,"minimum":4,"type":"integer"},"strength":{"default":1,"description":"Controls how much influence the audio parameter has on the generated audio. A value of 0 would yield audio that is identical to the input. A value of 1 would be as if you passed in no audio at all. Minimum value for stable-audio-2.5 is 0.01.","maximum":1,"minimum":0,"type":"number"}},"required":["prompt","audio","model"],"type":"object"},"StableAudio25InpaintRequest":{"description":"Request parameters for Stable Audio 2.5 audio inpainting","properties":{"audio":{"description":"The audio to be used as the starting point for the generation. Supported formats - mp3, wav. Audio must be between 6 and 190 seconds long.","format":"binary","type":"string"},"duration":{"default":190,"description":"Controls the duration in seconds of the generated audio.","maximum":190,"minimum":1,"type":"number"},"mask_end":{"default":190,"description":"End time in seconds for the audio segment to be inpainted.","maximum":190,"minimum":0,"type":"number"},"mask_start":{"default":30,"description":"Start time in seconds for the audio segment to be inpainted.","maximum":190,"minimum":0,"type":"number"},"output_format":{"$ref":"#/components/schemas/StableAudio25OutputFormat"},"prompt":{"description":"What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.","maxLength":10000,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"},"steps":{"default":8,"description":"Controls the number of sampling steps.","maximum":8,"minimum":4,"type":"integer"}},"required":["prompt","audio"],"type":"object"},"StableAudio25Model":{"description":"The model to use for generation","enum":["stable-audio-2.5"],"type":"string"},"StableAudio25OutputFormat":{"description":"Dictates the content-type of the generated audio","enum":["mp3","wav"],"type":"string"},"StableAudio25TextToAudioRequest":{"description":"Request parameters for Stable Audio 2.5 text-to-audio generation","properties":{"cfg_scale":{"default":1,"description":"How strictly the diffusion process adheres to the prompt text (higher values make your audio closer to your prompt). Defaults to 1 for stable-audio-2.5.","maximum":25,"minimum":1,"type":"number"},"duration":{"default":190,"description":"Controls the duration in seconds of the generated audio.","maximum":190,"minimum":1,"type":"number"},"model":{"$ref":"#/components/schemas/StableAudio25Model"},"output_format":{"$ref":"#/components/schemas/StableAudio25OutputFormat"},"prompt":{"description":"What you wish the output audio to be. A strong, descriptive prompt that clearly defines instruments, moods, styles, and genre will lead to better results.","maxLength":10000,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"},"steps":{"default":8,"description":"Controls the number of sampling steps. For stable-audio-2.5 accepts steps between 4 and 8 (defaults to 8).","maximum":8,"minimum":4,"type":"integer"}},"required":["prompt","model"],"type":"object"},"StorageFile":{"properties":{"file_path":{"description":"Path to the file in storage","type":"string"},"id":{"description":"Unique identifier for the storage file","format":"uuid","type":"string"},"public_url":{"description":"Public URL","type":"string"}},"type":"object"},"StripeEvent":{"properties":{"data":{"properties":{"object":{"type":"object"}},"type":"object"},"id":{"type":"string"},"object":{"enum":["event"],"type":"string"},"type":{"enum":["invoice.paid"],"type":"string"}},"required":["id","object","type","data"],"type":"object"},"SubscriptionDuration":{"description":"The subscription billing duration","enum":["MONTHLY","ANNUAL"],"type":"string"},"SubscriptionTier":{"description":"The subscription tier level","enum":["FREE","STANDARD","CREATOR","PRO","FOUNDERS_EDITION"],"type":"string"},"TencentErrorResponse":{"description":"Error response from Tencent API","properties":{"Response":{"properties":{"Error":{"properties":{"Code":{"description":"Error code","type":"string"},"Message":{"description":"Error message","type":"string"}},"type":"object"},"RequestId":{"description":"Unique request ID for troubleshooting","type":"string"}},"type":"object"}},"type":"object"},"TencentFile3D":{"description":"3D file information","properties":{"PreviewImageUrl":{"description":"Preview image URL","format":"uri","type":"string"},"Type":{"description":"3D file format","enum":["GLB","OBJ"],"type":"string"},"Url":{"description":"File URL (valid for 24 hours)","format":"uri","type":"string"}},"type":"object"},"TencentHunyuan3DProRequest":{"description":"Request body for Tencent Hunyuan 3D Pro generation","properties":{"EnablePBR":{"default":false,"description":"Whether to enable PBR material generation.","type":"boolean"},"FaceCount":{"default":500000,"description":"Face count for 3D model generation.","maximum":1500000,"minimum":40000,"type":"integer"},"GenerateType":{"default":"Normal","description":"Generation task type:\n- Normal: generates a geometric model with textures (default)\n- LowPoly: model generated after intelligent polygon reduction\n- Geometry: generate model without textures (white model)\n- Sketch: generative model from sketch or line drawing\n","enum":["Normal","LowPoly","Geometry","Sketch"],"type":"string"},"ImageBase64":{"description":"Base64 encoded image for image-to-3D generation.\nResolution: min 128px, max 5000px per side.\nMax size: 8MB (recommend 6MB before encoding).\nSupported formats: jpg, png, jpeg, webp.\nEither ImageBase64/ImageUrl or Prompt is required.\n","type":"string"},"ImageUrl":{"description":"URL of input image for image-to-3D generation.\nResolution: min 128px, max 5000px per side.\nMax size: 8MB.\nSupported formats: jpg, png, jpeg, webp.\nEither ImageBase64/ImageUrl or Prompt is required.\n","format":"uri","type":"string"},"Model":{"default":"3.0","description":"Tencent HY 3D Global model version.\nDefaults to 3.0, with optional choices: 3.0, 3.1.\nWhen selecting version 3.1, the LowPoly parameter is unavailable.\n","enum":["3.0","3.1"],"example":"3.0","type":"string"},"MultiViewImages":{"description":"Multi-perspective model images for 3D generation.\nEach perspective is limited to one image.\nImage size limit: max 8MB after encoding.\nImage resolution: min 128px, max 5000px per side.\nSupported formats: JPG, PNG.\n","items":{"$ref":"#/components/schemas/TencentViewImage"},"type":"array"},"PolygonType":{"default":"triangle","description":"Polygon type (only effective when GenerateType is LowPoly).\n- triangle: triangular faces (default)\n- quadrilateral: mix of quadrangle and triangle faces\n","enum":["triangle","quadrilateral"],"type":"string"},"Prompt":{"description":"Text description for 3D content generation.\nSupports up to 1024 utf-8 characters.\nEither Prompt or ImageBase64/ImageUrl is required, but not both.\n","example":"A cat","maxLength":1024,"type":"string"}},"type":"object"},"TencentHunyuan3DProResponse":{"description":"Response from Tencent Hunyuan 3D Pro submit endpoint","properties":{"Response":{"properties":{"Error":{"description":"Error object (present when request fails)","properties":{"Code":{"description":"Error code","type":"string"},"Message":{"description":"Error message","type":"string"}},"type":"object"},"JobId":{"description":"Task ID (valid for 24 hours)","example":"1375367755519696896","type":"string"},"RequestId":{"description":"Unique request ID for troubleshooting","example":"13f47dd0-1af9-4383-b401-dae18d6e99fc","type":"string"}},"type":"object"}},"type":"object"},"TencentHunyuan3DQueryRequest":{"properties":{"JobId":{"description":"The JobId returned from the submit endpoint","example":"1375367755519696896","type":"string"}},"required":["JobId"],"type":"object"},"TencentHunyuan3DQueryResponse":{"description":"Response from Tencent Hunyuan 3D query endpoint","properties":{"Response":{"properties":{"ErrorCode":{"description":"Error code (empty string if no error)","type":"string"},"ErrorMessage":{"description":"Error message if task failed (empty string if no error)","type":"string"},"RequestId":{"description":"Unique request ID for troubleshooting","type":"string"},"ResultFile3Ds":{"description":"Array of generated 3D files","items":{"$ref":"#/components/schemas/TencentFile3D"},"type":"array"},"Status":{"description":"Task status:\n- WAIT: waiting\n- RUN: running\n- FAIL: failed\n- DONE: successful\n","enum":["WAIT","RUN","FAIL","DONE"],"type":"string"}},"type":"object"}},"type":"object"},"TencentHunyuan3DSmartTopologyRequest":{"description":"Request body for Tencent Hunyuan 3D Smart Topology (retopology/polygon reduction)","properties":{"FaceLevel":{"description":"Polygon reduction level.","enum":["high","medium","low"],"example":"medium","type":"string"},"File3D":{"$ref":"#/components/schemas/TencentInputFile3D"},"PolygonType":{"description":"Polygon type for the output mesh. Defaults to triangle.","enum":["triangle","quadrilateral"],"example":"triangle","type":"string"}},"required":["File3D"],"type":"object"},"TencentHunyuan3DTextureEditRequest":{"description":"Request body for Tencent Hunyuan 3D texture edit","properties":{"EnablePBR":{"description":"Whether to enable the PBR texture parameter; only supported when using Prompt.","example":true,"type":"boolean"},"File3D":{"$ref":"#/components/schemas/TencentInputFile3D"},"Image":{"$ref":"#/components/schemas/TencentImageInfo"},"Prompt":{"description":"Describes texture editing. Either Image or Prompt is required; they cannot coexist.","example":"a kitten","maxLength":1024,"type":"string"}},"required":["File3D"],"type":"object"},"TencentHunyuan3DUVRequest":{"description":"Request body for Tencent Hunyuan 3D UV unfolding","properties":{"File":{"$ref":"#/components/schemas/TencentInputFile3D"}},"type":"object"},"TencentHunyuan3DUVResponse":{"description":"Response from Tencent Hunyuan 3D UV submit endpoint","properties":{"Response":{"properties":{"Error":{"description":"Error object (present when request fails)","properties":{"Code":{"description":"Error code","type":"string"},"Message":{"description":"Error message","type":"string"}},"type":"object"},"JobId":{"description":"Task ID for the UV unwrapping job","example":"1384898587778465792","type":"string"},"RequestId":{"description":"Unique request ID for troubleshooting","example":"5265eb4a-0f4f-4cb1-9b3d-d9f1fb9347d2","type":"string"}},"type":"object"}},"type":"object"},"TencentImageInfo":{"description":"Reference image - Base64 data or image URL","properties":{"ImageBase64":{"description":"Base64 encoded image. Resolution 128-4096 per side, converted Base64 less than 10MB. Formats jpg, jpeg, png.","type":"string"},"ImageUrl":{"description":"Image URL. If both Base64 and Url provided, Url prevails.","format":"uri","type":"string"}},"type":"object"},"TencentInputFile3D":{"description":"3D file input for UV unwrapping","properties":{"Type":{"description":"3D file format type","enum":["FBX","OBJ","GLB"],"example":"GLB","type":"string"},"Url":{"description":"URL of the 3D file that needs UV unwrapping","example":"https://example.com/model.glb","format":"uri","type":"string"}},"required":["Type","Url"],"type":"object"},"TencentViewImage":{"description":"A view image for multi-perspective 3D generation","properties":{"ViewImageBase64":{"description":"Base64 encoded image for this view.\nResolution: min 128px, max 5000px per side.\nMax size: 8MB.\nSupported formats: JPG, PNG.\n","type":"string"},"ViewImageUrl":{"description":"URL of the image for this view.\nResolution: min 128px, max 5000px per side.\nMax size: 8MB.\nSupported formats: JPG, PNG.\n","format":"uri","type":"string"},"ViewType":{"description":"The viewing angle type for this image.\n- left: Left view\n- right: Right view\n- back: Rear view\n- top: Top view (only supported in Model 3.1)\n- bottom: Bottom view (only supported in Model 3.1)\n- left_front: Left front 45 degree view (only supported in Model 3.1)\n- right_front: Right front 45 degree view (only supported in Model 3.1)\n","enum":["left","right","back","top","bottom","left_front","right_front"],"type":"string"}},"type":"object"},"TextResponseFormatConfiguration":{"description":"An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","oneOf":[{"$ref":"#/components/schemas/ResponseFormatText"},{"$ref":"#/components/schemas/TextResponseFormatJsonSchema"},{"$ref":"#/components/schemas/ResponseFormatJsonObject"}]},"TextResponseFormatJsonSchema":{"description":"JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n","properties":{"description":{"description":"A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n","type":"string"},"name":{"description":"The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n","type":"string"},"schema":{"$ref":"#/components/schemas/ResponseFormatJsonSchemaSchema"},"strict":{"default":false,"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n","type":"boolean"},"type":{"description":"The type of response format being defined. Always `json_schema`.","enum":["json_schema"],"type":"string","x-stainless-const":true}},"required":["type","schema","name"],"title":"JSON schema","type":"object"},"Tool":{"discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/FileSearchTool"},{"$ref":"#/components/schemas/FunctionTool"},{"$ref":"#/components/schemas/WebSearchPreviewTool"},{"$ref":"#/components/schemas/ComputerUsePreviewTool"}]},"ToolChoiceFunction":{"description":"Use this option to force the model to call a specific function.\n","properties":{"name":{"description":"The name of the function to call.","type":"string"},"type":{"description":"For function calling, the type is always `function`.","enum":["function"],"type":"string","x-stainless-const":true}},"required":["type","name"],"title":"Function tool","type":"object"},"ToolChoiceOptions":{"description":"Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n","enum":["none","auto","required"],"title":"Tool choice mode","type":"string"},"ToolChoiceTypes":{"description":"Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](/docs/guides/tools).\n","properties":{"type":{"description":"The type of hosted tool the model should to use. Learn more about\n[built-in tools](/docs/guides/tools).\n\nAllowed values are:\n- `file_search`\n- `web_search_preview`\n- `computer_use_preview`\n","enum":["file_search","web_search_preview","computer_use_preview","web_search_preview_2025_03_11"],"type":"string"}},"required":["type"],"title":"Hosted tool","type":"object"},"TopazCombinedCreateRequest":{"oneOf":[{"$ref":"#/components/schemas/TopazCreateRequestVideoSchema"},{"$ref":"#/components/schemas/TopazCreateRequestImageSequenceSchema"}]},"TopazCreateRequestImageSequenceSchema":{"properties":{"destination":{"properties":{"external":{"$ref":"#/components/schemas/TopazExternalStorage"}},"type":"object"},"filters":{"$ref":"#/components/schemas/TopazInputFilters"},"output":{"$ref":"#/components/schemas/TopazOutputInformationImageSequence"},"source":{"description":"Source details for the video","properties":{"container":{"description":"The container format of the image files","enum":["DPX","EXR","JPEG","PNG","TIFF"],"example":"TIFF","type":"string"},"endNumber":{"description":"Optional ending frame number for image sequences","example":120,"type":"integer"},"external":{"$ref":"#/components/schemas/TopazExternalStorage"},"frameCount":{"description":"Total number of frames in the video, in this case, equal to the number of image files.","example":18000,"type":"number"},"frameRate":{"description":"Frame rate of the video","example":30,"type":"number"},"resolution":{"description":"Resolution details of the image","properties":{"height":{"description":"Height of the image in pixels","example":1080,"type":"integer"},"width":{"description":"Width of the image in pixels","example":1920,"type":"integer"}},"required":["width","height"],"type":"object"},"startNumber":{"description":"Optional starting frame number for image sequences","example":120,"type":"integer"}},"required":["container","frameCount","frameRate","resolution","external"],"type":"object"}},"required":["source","filters","output","destination"],"title":"Image Sequence","type":"object"},"TopazCreateRequestVideoSchema":{"properties":{"destination":{"properties":{"external":{"$ref":"#/components/schemas/TopazExternalStorage"}},"type":"object"},"filters":{"$ref":"#/components/schemas/TopazInputFilters"},"output":{"$ref":"#/components/schemas/TopazOutputInformationVideo"},"overrides":{"properties":{"isPaidDiffusion":{"type":"boolean"}},"type":"object"},"source":{"description":"Source details for the video","properties":{"container":{"description":"The container format of the video file","enum":["mp4","mov","mkv"],"example":"mp4","type":"string"},"duration":{"description":"Duration of the video file in seconds","example":600,"type":"number"},"external":{"$ref":"#/components/schemas/TopazExternalStorage"},"frameCount":{"description":"Total number of frames in the video","example":18000,"type":"number"},"frameRate":{"description":"Frame rate of the video","example":30,"type":"number"},"resolution":{"description":"Resolution details of the video","properties":{"height":{"description":"Height of the video in pixels","example":1080,"type":"integer"},"width":{"description":"Width of the video in pixels","example":1920,"type":"integer"}},"required":["width","height"],"type":"object"},"size":{"description":"Size of the video file in bytes","example":123456000,"type":"integer"}},"required":["container","size","duration","frameCount","frameRate","resolution"],"type":"object"}},"required":["source","filters","output"],"title":"Video AI","type":"object"},"TopazCredentialsS3":{"properties":{"externalId":{"description":"Kind of like a secret string for extra layer of security","example":"MSTnuGztXtTU25XKjVfMJCsujv6VtAGtv1TGSjtOL6M=","type":"string"},"roleArn":{"description":"AWS ARN of the role to assume","example":"arn:aws:iam::123456789:role/topazlabs","type":"string"}},"required":["roleArn","externalId"],"type":"object"},"TopazDownloadResponse":{"properties":{"download_url":{"description":"Presigned URL to download the image","example":"https://example.com/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?presigned_headers","type":"string"},"expiry":{"description":"Expiration time of the presigned URLs in Unix timestamp","example":1617220000,"type":"integer"},"head_url":{"description":"Presigned URL to get image metadata","example":"https://example.com/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?presigned_headers","type":"string"}},"required":["download_url","expiry"],"type":"object"},"TopazEnhanceGenRequest":{"properties":{"color_preservation":{"default":"true","description":"To preserve the original color - available for Reimagine only (must be string \"true\" or \"false\" due to Topaz API requirement)","enum":["true","false"],"type":"string"},"creativity":{"default":3,"description":"Creativity settings range from 1 to 9 -  - available for Reimagine only","maximum":9,"minimum":1,"type":"integer"},"crop_to_fill":{"default":false,"description":"Default behavior is to letterbox the image if a differing aspect ratio is chosen. Enable crop_to_fill by setting this to true if you instead want to crop the image to fill the dimensions","type":"boolean"},"face_enhancement":{"default":true,"description":"By default, faces (if any) are enhanced during image processing as well. Set face_enhancement to false if you don't want this","type":"boolean"},"face_enhancement_creativity":{"default":0,"description":"Choose the level of creativity for face enhancement from 0 to 1. Defaults to 0, and is ignored if face_enhancement is false","maximum":1,"minimum":0,"type":"number"},"face_enhancement_strength":{"default":0.8,"description":"Control how sharp the enhanced faces are relative to the background from 0 to 1. Defaults to 0.8, and is ignored if face_enhancement is false","maximum":1,"minimum":0,"type":"number"},"face_preservation":{"default":"true","description":"To preserve the identity of characters - available for Reimagine only (must be string \"true\" or \"false\" due to Topaz API requirement)","enum":["true","false"],"type":"string"},"image":{"description":"The image file to be processed. Supported formats - jpeg (or jpg), png, tiff (or tif)","format":"binary","type":"string"},"model":{"default":"Reimagine","description":"The model to use for processing the image (Bloom - Creative Upscale)","enum":["Reimagine"],"type":"string"},"output_format":{"default":"jpeg","description":"The desired format of the output image","enum":["jpeg","jpg","png","tiff","tif"],"type":"string"},"output_height":{"description":"The desired height of the output image in pixels","maximum":32000,"minimum":1,"type":"integer"},"output_width":{"description":"The desired width of the output image in pixels","maximum":32000,"minimum":1,"type":"integer"},"prompt":{"description":"Text prompt for creative upscaling guidance - available for Reimagine only","example":"enter-your-prompt-here","type":"string"},"source_id":{"description":"Unique identifier of the source image","example":"d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b","type":"string"},"source_url":{"description":"The URL of the source image","example":"https://example.com/image.jpg","type":"string"},"subject_detection":{"default":"All","description":"Specifies whether you want to detect all subjects in the image, only the foreground subject, or only the background for the AI model to run on","enum":["All","Foreground","Background"],"type":"string"}},"required":["model"],"type":"object"},"TopazEnhanceGenResponse":{"properties":{"eta":{"description":"Expected completion time in Unix timestamp","example":1617220000,"type":"integer"},"process_id":{"description":"Unique identifier for the processing job","example":"d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b","type":"string"},"source_id":{"description":"Unique identifier of the source image","example":"d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b","type":"string"}},"required":["process_id","eta"],"type":"object"},"TopazExternalStorage":{"properties":{"bucketName":{"example":"galaxies","type":"string"},"credentials":{"$ref":"#/components/schemas/TopazCredentialsS3"},"key":{"description":"The example includes the standard specifier for image sequence requests, with optional directory path. It must begin with \"%\" and end with the integer specifier \"d\". The \"0\" in the example indicates left-padding with zeroes, and \"6\" indicates the number of digits in the file name.\nKeys for video requests must be valid characters supported by S3.\n","example":"milky_way/%06d.tiff","type":"string"},"provider":{"enum":["s3"],"example":"s3","type":"string"}},"required":["provider","credentials","bucketName","key"],"type":"object"},"TopazInputFilters":{"description":"Array of EnhancementFilter or FrameInterpolationFilter objects","example":[{"auto":"Auto","blur":0.6,"compression":0.1,"details":0.2,"fieldOrder":"Auto","focusFixLevel":"Normal","grain":0.02,"grainSize":1,"halo":0.4,"model":"prob-4","noise":0.3,"preblur":0.5,"prenoise":0.01,"recoverOriginalDetailValue":0.7,"videoType":"Progressive"},{"duplicate":true,"duplicateThreshold":0.01,"fps":60,"model":"apo-8","slowmo":2}],"items":{"anyOf":[{"$ref":"#/components/schemas/TopazVideoEnhancementFilter"},{"$ref":"#/components/schemas/TopazVideoFrameInterpolationFilter"}]},"type":"array"},"TopazOutputInformationImageSequence":{"properties":{"codecId":{"description":"Video codec ID, if known. Defaults to videoEncoder.","example":"h265-main-win-nvidia","type":"string"},"container":{"description":"Desired output container, defaults to the input container","enum":["DPX","EXR","JPEG","PNG","TIFF"],"example":"TIFF","type":"string"},"cropToFit":{"description":"Center cropping to fit the output dimensions","example":true,"type":"boolean"},"frameRate":{"description":"Frame rate","example":30,"type":"number"},"resolution":{"description":"Desired output resolution","properties":{"height":{"description":"Height in pixels. The maximum size depends on the encoder and can be referenced using the table below \u003ctable\u003e \u003ctr\u003e \u003ctd\u003eH264\u003c/td\u003e \u003ctd\u003eH265\u003c/td\u003e \u003ctd\u003eProRes \u003ctd\u003eAV1 \u003ctd\u003eVP9 \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e4096\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003ctd\u003e16386\u003c/td\u003e \u003ctd\u003e8704\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e","example":4320,"type":"integer"},"width":{"description":"Width in pixels. The maximum size depends on the encoder and can be referenced using the table below \u003ctable\u003e \u003ctr\u003e \u003ctd\u003eH264\u003c/td\u003e \u003ctd\u003eH265\u003c/td\u003e \u003ctd\u003eProRes \u003ctd\u003eAV1 \u003ctd\u003eVP9 \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e4096\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003ctd\u003e16386\u003c/td\u003e \u003ctd\u003e16384\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e","example":7680,"type":"integer"}},"required":["width","height"],"type":"object"},"videoEncoder":{"enum":["DPX","EXR","JPEG","PNG","TIFF"],"example":"TIFF","type":"string"},"videoProfile":{"description":"Codec profile specific to videoEncoder","example":"Main","type":"string"}},"required":["resolution","frameRate"],"type":"object"},"TopazOutputInformationVideo":{"properties":{"audioBitrate":{"description":"Audio bitrate, if audioTransfer is Copy or Convert. Default values for the codec are used if not provided.","example":"320","type":"string"},"audioCodec":{"description":"__Required if audioTransfer is Copy or Convert.__","enum":["AAC","AC3","PCM"],"example":"AAC","type":"string"},"audioTransfer":{"enum":["Copy","Convert","None"],"example":"Copy","type":"string"},"codecId":{"description":"Video codec ID, if known. Defaults to videoEncoder.","example":"h265-main-win-nvidia","type":"string"},"container":{"description":"Desired output container","enum":["mp4","mov","mkv"],"example":"mp4","type":"string"},"cropToFit":{"description":"Center cropping to fit the output dimensions","example":true,"type":"boolean"},"dynamicCompressionLevel":{"description":"__Required if videoBitrate is not provided.__ Automatic CQP selection.","enum":["Low","Mid","High"],"example":"Mid","type":"string"},"frameRate":{"description":"Frame rate","example":30,"type":"number"},"resolution":{"description":"Desired output resolution","properties":{"height":{"description":"Height in pixels. The maximum size depends on the encoder and can be referenced using the table below \u003ctable\u003e \u003ctr\u003e \u003ctd\u003eH264\u003c/td\u003e \u003ctd\u003eH265\u003c/td\u003e \u003ctd\u003eProRes \u003ctd\u003eAV1 \u003ctd\u003eVP9 \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e4096\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003ctd\u003e16386\u003c/td\u003e \u003ctd\u003e8704\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e","example":4320,"type":"integer"},"width":{"description":"Width in pixels. The maximum size depends on the encoder and can be referenced using the table below \u003ctable\u003e \u003ctr\u003e \u003ctd\u003eH264\u003c/td\u003e \u003ctd\u003eH265\u003c/td\u003e \u003ctd\u003eProRes \u003ctd\u003eAV1 \u003ctd\u003eVP9 \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e4096\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003ctd\u003e16386\u003c/td\u003e \u003ctd\u003e16384\u003c/td\u003e \u003ctd\u003e8192\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e","example":7680,"type":"integer"}},"required":["width","height"],"type":"object"},"videoBitrate":{"description":"__Required if dynamicCompressionLevel is not provided.__ Constant bitrate, suffixed with \"k\" for kilobits or \"m\" for megabits per second.","example":"1k","type":"string"},"videoEncoder":{"enum":["AV1","FFV1","H264","H265","ProRes","QuickTime Animation","QuickTime R210","QuickTime V210","VP9"],"example":"H265","type":"string"},"videoProfile":{"description":"Codec profile specific to videoEncoder. The following are some combinations of available profiles based on the 'videoEncoder' selection \u003ctable\u003e \u003ctr\u003e \u003ctd\u003eH264\u003c/td\u003e \u003ctd\u003eH265\u003c/td\u003e \u003ctd\u003eProRes \u003ctd\u003eAV1 \u003ctd\u003eVP9 \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eHigh\u003c/td\u003e \u003ctd\u003eMain, Main10\u003c/td\u003e \u003ctd\u003e422 Proxy, 422 LT, 422 Std, 422 HQ\u003c/td\u003e \u003ctd\u003e8-bit, 10-bit\u003c/td\u003e \u003ctd\u003eGood, Best\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e","example":"Main","type":"string"}},"required":["resolution","frameRate","audioCodec","audioTransfer"],"type":"object"},"TopazStatusResponse":{"properties":{"category":{"description":"Processing category (e.g., \"Enhance\")","type":"string"},"creation_time":{"description":"Creation time in Unix timestamp","type":"integer"},"credits":{"description":"Credits consumed for this job","type":"integer"},"crop_to_fill":{"description":"Whether crop to fill is enabled","type":"boolean"},"eta":{"description":"Expected completion time in Unix timestamp","type":"integer"},"face_enhancement":{"description":"Whether face enhancement is enabled","type":"boolean"},"face_enhancement_creativity":{"description":"Face enhancement creativity level","type":"number"},"face_enhancement_strength":{"description":"Face enhancement strength level","type":"number"},"filename":{"description":"Original filename without extension","type":"string"},"input_format":{"description":"Format of the input image","type":"string"},"input_height":{"description":"Height of the input image in pixels","type":"integer"},"input_width":{"description":"Width of the input image in pixels","type":"integer"},"model":{"description":"Specific model used (e.g., \"Reimagine\")","type":"string"},"model_type":{"description":"Type of model used (e.g., \"Generative\")","type":"string"},"modification_time":{"description":"Last modification time in Unix timestamp","type":"integer"},"options_json":{"description":"JSON string containing additional options","type":"string"},"output_format":{"description":"Format of the output image","type":"string"},"output_height":{"description":"Height of the output image in pixels","type":"integer"},"output_width":{"description":"Width of the output image in pixels","type":"integer"},"process_id":{"description":"Unique identifier for the processing job","type":"string"},"progress":{"description":"Progress percentage (0-100)","maximum":100,"minimum":0,"type":"number"},"source_id":{"description":"Unique identifier of the source image","type":"string"},"status":{"description":"Current status of the processing job","enum":["Pending","Processing","Completed","Failed","Cancelled"],"type":"string"},"subject_detection":{"description":"Subject detection setting","type":"string"},"sync":{"description":"Whether this was a synchronous request","type":"boolean"}},"required":["process_id","status","credits"],"type":"object"},"TopazVideoAcceptResponse":{"properties":{"message":{"description":"Response message","example":"Accepted","type":"string"},"uploadId":{"description":"Upload ID for completing multi-part upload","example":"GDlWC7qIaE6okS41Xf/ktpuS5XzTRabg","type":"string"},"urls":{"description":"URLs to PUT the parts to","example":["https://videocloud.s3.amazonaws.com/source.mp4?uploadPart1","https://videocloud.s3.amazonaws.com/source.mp4?uploadPart2"],"items":{"type":"string"},"type":"array"}},"required":["uploadId","urls"],"type":"object"},"TopazVideoCompleteUploadRequest":{"properties":{"md5Hash":{"description":"MD5 hash of the source video file in hex","example":"4d186321c1a7f0f354b297e8914ab240","type":"string"},"uploadResults":{"description":"An array of part number and ETag pairs of the uploaded parts. ETags are returned by S3 upon upload of the part.","items":{"properties":{"eTag":{"description":"eTag value returned by S3 upon upload of the part","example":"d41d8cd98f00b204e9800998ecf8427e","type":"string"},"partNum":{"description":"Part number of the uploaded part, starting from 1","example":1,"type":"integer"}},"required":["partNum","eTag"],"type":"object"},"type":"array"}},"required":["uploadResults"],"type":"object"},"TopazVideoCompleteUploadResponse":{"properties":{"message":{"description":"Confirmation message","example":"Processing has been queued","type":"string"}},"required":["message"],"type":"object"},"TopazVideoCreateRequest":{"oneOf":[{"$ref":"#/components/schemas/TopazCreateRequestVideoSchema"},{"$ref":"#/components/schemas/TopazCreateRequestImageSequenceSchema"}]},"TopazVideoCreateResponse":{"properties":{"estimates":{"$ref":"#/components/schemas/TopazVideoRequestEstimates"},"requestId":{"description":"Unique identifier for the video processing request","example":"c1f96dc2-c448-00e6-82ed-14ecb6403c62","format":"uuid","type":"string"}},"required":["requestId","estimates"],"type":"object"},"TopazVideoEnhancedDownload":{"description":"Signed download URL to the enhanced video file","properties":{"expiresAt":{"description":"Time in milliseconds since UTC epoch","example":1727213400000,"type":"integer"},"expiresIn":{"description":"TTL in milliseconds","example":86400000,"type":"integer"},"url":{"example":"https://videocloud.r2.cloudflarestorage.com/enhanced.mp4","type":"string"}},"type":"object"},"TopazVideoEnhancementFilter":{"properties":{"auto":{"description":"Parameter mode of the selected model","enum":["Auto","Manual","Relative"],"example":"Auto","type":"string"},"blur":{"description":"Amount of sharpness applied","example":0.6,"maximum":1,"minimum":-1,"type":"number"},"compression":{"description":"Adjust strength of compression recovery","example":0.1,"maximum":1,"minimum":-1,"type":"number"},"creativity":{"description":"Creativity level for Starlight Creative (slc-1) only","enum":["low","high"],"type":"string"},"details":{"description":"Amount of detail reconstruction","example":0.2,"maximum":1,"minimum":-1,"type":"number"},"fieldOrder":{"description":"Optional specification of field order for interlaced input videos","enum":["TopFirst","BottomFirst","Auto"],"example":"Auto","type":"string"},"focusFixLevel":{"description":"Downscales video input for stronger correction of blurred subjects","enum":["None","Normal","Strong"],"example":"Normal","type":"string"},"grain":{"description":"Adds grain after AI model processing","example":0.02,"maximum":0.1,"minimum":0,"type":"number"},"grainSize":{"description":"Size of generated grain","example":1,"maximum":5,"minimum":0,"type":"number"},"halo":{"description":"Amount of halo reduction","example":0.4,"maximum":1,"minimum":-1,"type":"number"},"isOptimizedMode":{"description":"Set to true for Starlight Creative (slc-1) only","type":"boolean"},"model":{"description":"Short code name for AI model","enum":["aaa-9","ahq-12","alq-13","alqs-2","amq-13","amqs-2","ddv-3","dtd-4","dtds-2","dtv-4","dtvs-2","gcg-5","ghq-5","iris-2","iris-3","nxf-1","nyx-3","prob-4","rhea-1","rxl-1","thd-3","thf-4","thm-2","slf-1","slc-1"],"example":"prob-4","type":"string"},"noise":{"description":"Amount of noise reduction","example":0.3,"maximum":1,"minimum":-1,"type":"number"},"preblur":{"description":"Adjust anti-aliasing and deblurring strength","example":0.5,"maximum":1,"minimum":-1,"type":"number"},"prenoise":{"description":"Adds noise to input to reduce over-smoothing","example":0.01,"maximum":0.1,"minimum":0,"type":"number"},"recoverOriginalDetailValue":{"description":"Reintroduce source details into the output video","example":0.7,"maximum":1,"minimum":0,"type":"number"},"videoType":{"description":"Frame/field type of the video","enum":["Progressive","Interlaced","ProgressiveInterlaced"],"example":"Progressive","type":"string"}},"required":["model"],"type":"object"},"TopazVideoFrameInterpolationFilter":{"properties":{"duplicate":{"description":"Analyze input for duplicate frames and remove them","example":true,"type":"boolean"},"duplicateThreshold":{"description":"Sensitivity of detection for duplicate frames","example":0.01,"maximum":0.1,"minimum":0.001,"type":"number"},"fps":{"description":"Output frame rate, does not increase duration","example":60,"maximum":240,"minimum":15,"type":"number"},"model":{"description":"Short code name for AI model","enum":["aion-1","apf-2","apo-8","chf-3","chr-2"],"example":"apo-8","type":"string"},"slowmo":{"description":"Slow motion factor applied to input video","example":2,"maximum":16,"minimum":1,"type":"number"}},"required":["model"],"type":"object"},"TopazVideoRequestEstimates":{"description":"Lower and upper bound estimates","properties":{"cost":{"description":"Cost range in credits","example":[10,12],"items":{"type":"integer"},"type":"array"},"time":{"description":"Time range in seconds","example":[600,700],"items":{"type":"integer"},"type":"array"}},"type":"object"},"TopazVideoStatusResponse":{"properties":{"averageFps":{"description":"Average processing speed of each node","example":1.23,"type":"number"},"combinedFps":{"description":"Combined processing speed of all nodes","example":12.34,"type":"number"},"download":{"$ref":"#/components/schemas/TopazVideoEnhancedDownload"},"estimates":{"$ref":"#/components/schemas/TopazVideoRequestEstimates"},"message":{"example":"Processing","type":"string"},"outputSize":{"description":"Size of output video","example":"10 GB","type":"string"},"progress":{"description":"Total progress percentage","example":82,"maximum":100,"minimum":0,"type":"number"},"status":{"description":"Current status of the video processing","enum":["requested","accepted","initializing","preprocessing","processing","postprocessing","complete","canceling","canceled","failed"],"example":"processing","type":"string"}},"required":["status"],"type":"object"},"TripoAnimation":{"enum":["preset:idle","preset:walk","preset:climb","preset:jump","preset:run","preset:slash","preset:shoot","preset:hurt","preset:fall","preset:turn"],"type":"string"},"TripoBalance":{"properties":{"balance":{"type":"number"},"frozen":{"type":"number"}},"required":["balance","frozen"],"type":"object"},"TripoConvertFormat":{"enum":["GLTF","USDZ","FBX","OBJ","STL","3MF"],"type":"string"},"TripoErrorResponse":{"properties":{"code":{"enum":[1001,2000,2001,2002,2003,2004,2006,2007,2008,2010],"type":"integer"},"message":{"type":"string"},"suggestion":{"type":"string"}},"required":["code","message","suggestion"],"type":"object"},"TripoGeometryQuality":{"enum":["standard","detailed"],"type":"string"},"TripoImageToModel":{"description":"Task type for Tripo image-to-model generation.","enum":["image_to_model"],"example":"image_to_model","type":"string"},"TripoModelStyle":{"description":"Style for the Tripo model generation.","enum":["person:person2cartoon","animal:venom","object:clay","object:steampunk","object:christmas","object:barbie","gold","ancient_bronze"],"example":"object:clay","type":"string"},"TripoModelVersion":{"description":"Version of the Tripo model.","enum":["v2.5-20250123","v2.0-20240919","v1.4-20240625"],"example":"v2.5-20250123","type":"string"},"TripoMultiviewMode":{"description":"Mode for multiview generation, specifying view orientation.","enum":["LEFT","RIGHT"],"example":"LEFT","type":"string"},"TripoMultiviewToModel":{"description":"Task type for Tripo multiview-to-model generation.","enum":["multiview_to_model"],"example":"multiview_to_model","type":"string"},"TripoOrientation":{"default":"default","enum":["align_image","default"],"type":"string"},"TripoResponseSuccessCode":{"description":"Standard success code for Tripo API responses. Typically 0 for success.","example":0,"type":"integer"},"TripoSpec":{"enum":["mixamo","tripo"],"type":"string"},"TripoStandardFormat":{"enum":["glb","fbx"],"type":"string"},"TripoStylizeOptions":{"enum":["lego","voxel","voronoi","minecraft"],"type":"string"},"TripoSuccessTask":{"properties":{"code":{"enum":[0],"type":"integer"},"data":{"properties":{"task_id":{"description":"used for getTask","type":"string"}},"required":["task_id"],"type":"object"}},"required":["code","data"],"type":"object"},"TripoTask":{"properties":{"consumed_credit":{"description":"Actual credits consumed by the task. Present once status is finalized; 0 for failed tasks.","type":"integer"},"create_time":{"type":"integer"},"input":{"type":"object"},"output":{"properties":{"base_model":{"type":"string"},"model":{"type":"string"},"pbr_model":{"type":"string"},"rendered_image":{"type":"string"},"riggable":{"type":"boolean"},"topology":{"enum":["bip","quad"],"type":"string"}},"type":"object"},"progress":{"maximum":100,"minimum":0,"type":"integer"},"status":{"enum":["queued","running","success","failed","cancelled","unknown","banned","expired"],"type":"string"},"task_id":{"type":"string"},"type":{"type":"string"}},"required":["task_id","type","status","input","output","progress","create_time"],"type":"object"},"TripoTextToModel":{"description":"The type of the Tripo task, specifically for text-to-model operations.","enum":["text_to_model"],"example":"text_to_model","type":"string"},"TripoTextureAlignment":{"enum":["original_image","geometry"],"type":"string"},"TripoTextureFormat":{"enum":["BMP","DPX","HDR","JPEG","OPEN_EXR","PNG","TARGA","TIFF","WEBP"],"type":"string"},"TripoTextureQuality":{"enum":["standard","detailed"],"type":"string"},"TripoTopology":{"enum":["bip","quad"],"type":"string"},"TripoTypeAnimatePrerigcheck":{"enum":["animate_prerigcheck"],"type":"string"},"TripoTypeAnimateRetarget":{"enum":["animate_retarget"],"type":"string"},"TripoTypeAnimateRig":{"enum":["animate_rig"],"type":"string"},"TripoTypeConvertModel":{"enum":["convert_model"],"type":"string"},"TripoTypeRefineModel":{"enum":["refine_model"],"type":"string"},"TripoTypeStylizeModel":{"enum":["stylize_model"],"type":"string"},"TripoTypeTextureModel":{"enum":["texture_model"],"type":"string"},"UpdateCouponRequest":{"properties":{"metadata":{"additionalProperties":{"type":"string"},"description":"Set of key-value pairs for storing additional information","type":"object"},"name":{"description":"Name of the coupon displayed to customers","type":"string"}},"type":"object"},"UpdatePromoCodeRequest":{"properties":{"active":{"description":"Whether the promo code is active","type":"boolean"},"metadata":{"additionalProperties":{"type":"string"},"description":"Set of key-value pairs for storing additional information","type":"object"}},"type":"object"},"User":{"properties":{"email":{"description":"The email address for this user.","type":"string"},"id":{"description":"The unique id for this user.","type":"string"},"isAdmin":{"description":"Indicates if the user has admin privileges.","type":"boolean"},"isApproved":{"description":"Indicates if the user is approved.","type":"boolean"},"name":{"description":"The name for this user.","type":"string"}},"type":"object"},"Veo2GenVidPollRequest":{"properties":{"operationName":{"description":"Full operation name (from predict response)","example":"projects/PROJECT_ID/locations/us-central1/publishers/google/models/MODEL_ID/operations/OPERATION_ID","type":"string"}},"required":["operationName"],"type":"object"},"Veo2GenVidPollResponse":{"properties":{"done":{"type":"boolean"},"error":{"description":"Error details if operation failed","properties":{"code":{"description":"Error code","type":"integer"},"message":{"description":"Error message","type":"string"}},"type":"object"},"name":{"type":"string"},"response":{"description":"The actual prediction response if done is true","properties":{"@type":{"example":"type.googleapis.com/cloud.ai.large_models.vision.GenerateVideoResponse","type":"string"},"raiMediaFilteredCount":{"description":"Count of media filtered by responsible AI policies","type":"integer"},"raiMediaFilteredReasons":{"description":"Reasons why media was filtered by responsible AI policies","items":{"type":"string"},"type":"array"},"videos":{"items":{"properties":{"bytesBase64Encoded":{"description":"Base64-encoded video content","type":"string"},"gcsUri":{"description":"Cloud Storage URI of the video","type":"string"},"mimeType":{"description":"Video MIME type","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"Veo2GenVidRequest":{"properties":{"instances":{"items":{"properties":{"image":{"description":"Optional image to guide video generation","oneOf":[{"required":["bytesBase64Encoded"]},{"required":["gcsUri"]}],"properties":{"bytesBase64Encoded":{"format":"byte","type":"string"},"gcsUri":{"type":"string"},"mimeType":{"type":"string"}},"type":"object"},"prompt":{"description":"Text description of the video","type":"string"}},"required":["prompt"],"type":"object"},"type":"array"},"parameters":{"properties":{"aspectRatio":{"example":"16:9","type":"string"},"durationSeconds":{"type":"integer"},"enhancePrompt":{"type":"boolean"},"negativePrompt":{"type":"string"},"personGeneration":{"enum":["ALLOW","BLOCK"],"type":"string"},"sampleCount":{"type":"integer"},"seed":{"format":"uint32","type":"integer"},"storageUri":{"description":"Optional Cloud Storage URI to upload the video","type":"string"}},"type":"object"}},"type":"object"},"Veo2GenVidResponse":{"properties":{"name":{"description":"Operation resource name","example":"projects/PROJECT_ID/locations/us-central1/publishers/google/models/MODEL_ID/operations/a1b07c8e-7b5a-4aba-bb34-3e1ccb8afcc8","type":"string"}},"required":["name"],"type":"object"},"VeoGenVidPollRequest":{"properties":{"operationName":{"description":"Full operation name returned from the generate response","example":"projects/PROJECT_ID/locations/us-central1/publishers/google/models/MODEL_ID/operations/OPERATION_ID","type":"string"}},"required":["operationName"],"type":"object"},"VeoGenVidPollResponse":{"description":"Response from polling a Veo video generation operation","properties":{"done":{"description":"Whether the operation has completed","type":"boolean"},"error":{"description":"Error details, present if the operation failed","properties":{"code":{"description":"gRPC error code","type":"integer"},"message":{"description":"Error message","type":"string"}},"type":"object"},"name":{"description":"Operation resource name","type":"string"},"response":{"description":"The prediction response, present when done is true","properties":{"@type":{"example":"type.googleapis.com/cloud.ai.large_models.vision.GenerateVideoResponse","type":"string"},"raiMediaFilteredCount":{"description":"Number of videos filtered by responsible AI policies","type":"integer"},"raiMediaFilteredReasons":{"description":"Reasons why videos were filtered by responsible AI policies","items":{"type":"string"},"type":"array"},"videos":{"items":{"properties":{"bytesBase64Encoded":{"description":"Base64-encoded video content","type":"string"},"gcsUri":{"description":"Cloud Storage URI of the generated video","type":"string"},"mimeType":{"description":"Video MIME type (video/mp4)","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"VeoGenVidRequest":{"properties":{"instances":{"items":{"properties":{"cameraControl":{"description":"Camera motion type. Requires image to be provided.","enum":["fixed","pan_left","pan_right","tilt_up","tilt_down","truck_left","truck_right","pedestal_up","pedestal_down","push_in","pull_out"],"type":"string"},"image":{"description":"Optional first frame image to guide video generation","oneOf":[{"required":["bytesBase64Encoded"]},{"required":["gcsUri"]}],"properties":{"bytesBase64Encoded":{"description":"Base64-encoded image data","format":"byte","type":"string"},"gcsUri":{"description":"Cloud Storage URI of the image","type":"string"},"mimeType":{"description":"MIME type of the image (image/jpeg or image/png)","enum":["image/jpeg","image/png"],"type":"string"}},"type":"object"},"lastFrame":{"description":"Optional last frame image. Used with image to generate video between first and last frames. Supported by Veo 3.0+ models.","oneOf":[{"required":["bytesBase64Encoded"]},{"required":["gcsUri"]}],"properties":{"bytesBase64Encoded":{"description":"Base64-encoded image data","format":"byte","type":"string"},"gcsUri":{"description":"Cloud Storage URI of the image","type":"string"},"mimeType":{"description":"MIME type of the image (image/jpeg or image/png)","enum":["image/jpeg","image/png"],"type":"string"}},"type":"object"},"mask":{"description":"Optional mask for video editing. Applies to input video.","oneOf":[{"required":["bytesBase64Encoded"]},{"required":["gcsUri"]}],"properties":{"bytesBase64Encoded":{"description":"Base64-encoded mask bytes","format":"byte","type":"string"},"gcsUri":{"description":"Cloud Storage URI to mask file","type":"string"},"maskMode":{"description":"How the mask is applied","enum":["insert","remove","remove_static","outpaint"],"type":"string"},"mimeType":{"description":"MIME type of the mask (image/png, image/jpeg, image/webp, or video formats)","type":"string"}},"type":"object"},"prompt":{"description":"Text description of the video to generate","type":"string"},"referenceImages":{"description":"Optional reference images to guide video generation. Supports up to 3 asset images or 1 style image. Supported by Veo 3.1 models (preview).","items":{"properties":{"image":{"oneOf":[{"required":["bytesBase64Encoded"]},{"required":["gcsUri"]}],"properties":{"bytesBase64Encoded":{"description":"Base64-encoded image data","format":"byte","type":"string"},"gcsUri":{"description":"Cloud Storage URI of the image","type":"string"},"mimeType":{"description":"MIME type of the image (image/jpeg or image/png)","enum":["image/jpeg","image/png"],"type":"string"}},"type":"object"},"referenceId":{"description":"Optional identifier for the reference image","type":"string"},"referenceType":{"description":"Type of reference image","enum":["asset","style"],"type":"string"}},"required":["image","referenceType"],"type":"object"},"type":"array"},"video":{"description":"Optional input video for video extension or editing. Incompatible with image and referenceImages.","oneOf":[{"required":["bytesBase64Encoded"]},{"required":["gcsUri"]}],"properties":{"bytesBase64Encoded":{"description":"Base64-encoded video bytes","format":"byte","type":"string"},"gcsUri":{"description":"Cloud Storage URI of the input video","type":"string"},"mimeType":{"description":"MIME type of the video","enum":["video/mov","video/mpeg","video/mp4","video/mpg","video/avi","video/wmv","video/mpegps","video/x-flv"],"type":"string"}},"type":"object"}},"required":["prompt"],"type":"object"},"type":"array"},"parameters":{"properties":{"aspectRatio":{"description":"Aspect ratio of the generated video. Default: 16:9","enum":["16:9","9:16"],"example":"16:9","type":"string"},"compressionQuality":{"description":"Video compression quality. Default: optimized","enum":["optimized","lossless"],"type":"string"},"durationSeconds":{"description":"Target duration of the generated video in seconds. Veo 2: 5-8. Veo 3/3.1: 4, 6, or 8. Default: 8","type":"number"},"enhancePrompt":{"description":"Automatically improve prompt for higher quality. Defaults to true.","type":"boolean"},"fps":{"description":"Frame rate of generated videos in frames per second","type":"integer"},"generateAudio":{"description":"Whether to generate audio along with the video. Defaults to true. Supported by Veo 3.0+ models.","type":"boolean"},"negativePrompt":{"description":"Text describing what to avoid in the generated video","type":"string"},"personGeneration":{"description":"Controls people in generated videos. Default: allow_adult","enum":["dont_allow","allow_adult","allowAll"],"type":"string"},"pubsubTopic":{"description":"Cloud Pub/Sub topic for progress updates (projects/{project}/topics/{topic})","type":"string"},"resizeMode":{"description":"Resize approach for input image. Default: pad","enum":["pad","crop"],"type":"string"},"resolution":{"description":"Output video resolution. Supported by Veo 3.0+ models. Default: 720p","enum":["720p","1080p","4k"],"type":"string"},"sampleCount":{"description":"Number of videos to generate. If not specified, 1 video is generated.","maximum":4,"minimum":1,"type":"integer"},"seed":{"description":"Random seed for deterministic output. Different seeds used per video if sampleCount \u003e 1.","format":"uint32","type":"integer"},"storageUri":{"description":"Cloud Storage URI (gs://) for saving generated videos","type":"string"},"task":{"description":"Operation type for the video generation request","enum":["textToVideo","imageToVideo","referenceToVideo","edit","extend","upscale"],"type":"string"}},"type":"object"}},"type":"object"},"VeoGenVidResponse":{"description":"Response from a Veo video generation request. Contains the operation name for polling.","properties":{"name":{"description":"Operation resource name used to poll for results via fetchPredictOperation","example":"projects/PROJECT_ID/locations/us-central1/publishers/google/models/MODEL_ID/operations/a1b07c8e-7b5a-4aba-bb34-3e1ccb8afcc8","type":"string"}},"required":["name"],"type":"object"},"ViduCreation":{"properties":{"cover_url":{"type":"string"},"id":{"type":"string"},"moderation_url":{"items":{"type":"string"},"type":"array"},"url":{"type":"string"},"watermarked_url":{"type":"string"}},"type":"object"},"ViduExtendReply":{"properties":{"created_at":{"format":"date-time","type":"string"},"credits":{"format":"int32","type":"integer"},"duration":{"format":"int32","type":"integer"},"images":{"items":{"type":"string"},"type":"array"},"model":{"type":"string"},"payload":{"type":"string"},"prompt":{"type":"string"},"resolution":{"type":"string"},"state":{"$ref":"#/components/schemas/ViduState"},"task_id":{"type":"string"},"video_creation_id":{"type":"string"},"video_url":{"type":"string"}},"required":["task_id","state","credits"],"type":"object"},"ViduExtendRequest":{"properties":{"callback_url":{"description":"Callback URL for task status updates","type":"string"},"duration":{"description":"Extended duration in seconds (1-7, default 5)","format":"int32","type":"integer"},"images":{"description":"Extended reference image to the end frame (only accepts 1 image)","items":{"type":"string"},"type":"array"},"model":{"description":"Model name (viduq2-pro or viduq2-turbo)","type":"string"},"payload":{"description":"Transparent transmission parameters (max 1048576 characters)","type":"string"},"prompt":{"description":"Text prompt for video generation (max 2000 characters)","type":"string"},"resolution":{"description":"Resolution (540p, 720p, 1080p)","type":"string"},"video_creation_id":{"description":"Vidu video_creation_id, required with video_url","type":"string"},"video_url":{"description":"Any video URL, required with video_creation_id","type":"string"}},"required":["model"],"type":"object"},"ViduGetCreationsReply":{"properties":{"creations":{"items":{"$ref":"#/components/schemas/ViduCreation"},"type":"array"},"err_code":{"type":"string"},"id":{"type":"string"},"state":{"$ref":"#/components/schemas/ViduState"}},"type":"object"},"ViduImageSetting":{"properties":{"duration":{"description":"Duration between key frames in seconds (2-7, default 5)","format":"int32","type":"integer"},"key_image":{"description":"Reference image for each key frame","type":"string"},"prompt":{"description":"Prompt for extending the previous frame","type":"string"}},"required":["key_image"],"type":"object"},"ViduMultiframeReply":{"properties":{"created_at":{"format":"date-time","type":"string"},"credits":{"format":"int32","type":"integer"},"image_settings":{"items":{"$ref":"#/components/schemas/ViduImageSetting"},"type":"array"},"model":{"type":"string"},"payload":{"type":"string"},"resolution":{"type":"string"},"start_image":{"type":"string"},"state":{"$ref":"#/components/schemas/ViduState"},"task_id":{"type":"string"}},"required":["task_id","state","credits"],"type":"object"},"ViduMultiframeRequest":{"properties":{"callback_url":{"description":"Callback URL for task status updates","type":"string"},"image_settings":{"description":"Configuration for intelligent multi-frame generation (2-9 frames)","items":{"$ref":"#/components/schemas/ViduImageSetting"},"type":"array"},"model":{"description":"Model name (viduq2-pro or viduq2-turbo)","type":"string"},"payload":{"description":"Transparent transmission parameters (max 1048576 characters)","type":"string"},"resolution":{"description":"Video resolution (540p, 720p, 1080p)","type":"string"},"start_image":{"description":"The first frame image (Base64 or URL)","type":"string"}},"required":["model","start_image","image_settings"],"type":"object"},"ViduState":{"enum":["created","processing","queueing","success","failed"],"type":"string"},"ViduTaskReply":{"properties":{"aspect_ratio":{"type":"string"},"bgm":{"description":"Whether background music was added","type":"boolean"},"created_at":{"format":"date-time","type":"string"},"credits":{"format":"int32","type":"integer"},"duration":{"format":"int32","type":"integer"},"images":{"items":{"type":"string"},"type":"array"},"model":{"type":"string"},"movement_amplitude":{"enum":["auto","small","medium","large"],"type":"string"},"off_peak":{"description":"Off peak mode status","type":"boolean"},"payload":{"description":"Transparent transmission parameters","type":"string"},"prompt":{"type":"string"},"resolution":{"type":"string"},"seed":{"format":"int32","type":"integer"},"state":{"$ref":"#/components/schemas/ViduState"},"style":{"enum":["general","anime"],"type":"string"},"task_id":{"type":"string"},"watermark":{"description":"Whether watermark was added","type":"boolean"}},"required":["task_id","state","credits"],"type":"object"},"ViduTaskRequest":{"properties":{"aspect_ratio":{"type":"string"},"audio":{"description":"Enable direct audio-video generation capability (default true for q3 model)","type":"boolean"},"audio_type":{"description":"Audio type when audio is true: all (sound effects + vocals), speech_only, sound_effect_only. Ineffective for q3 model","enum":["all","speech_only","sound_effect_only"],"type":"string"},"bgm":{"description":"Add background music to generated video (ineffective for q3 model)","type":"boolean"},"callback_url":{"description":"Callback URL for task status updates","type":"string"},"duration":{"description":"Video duration in seconds. viduq3-pro: 1-16, viduq2-pro-fast: 1-10, viduq2-pro/turbo: 1-8","format":"int32","type":"integer"},"enhance":{"type":"boolean"},"images":{"description":"Images for img2video (accepts 1 image as start frame)","items":{"type":"string"},"type":"array"},"is_rec":{"description":"Use recommended prompt (consumes additional 10 credits)","type":"boolean"},"meta_data":{"description":"Metadata identification, JSON format string for custom metadata","type":"string"},"model":{"description":"Model name: viduq3-pro, viduq2-pro-fast, viduq2-pro, viduq2-turbo, viduq1, viduq1-classic, vidu2.0","type":"string"},"movement_amplitude":{"description":"Movement amplitude of objects in frame (ineffective for q2, q3 models)","enum":["auto","small","medium","large"],"type":"string"},"off_peak":{"description":"Off peak mode (lower cost, tasks generated within 48 hours)","type":"boolean"},"payload":{"description":"Transparent transmission parameters (max 1048576 characters)","type":"string"},"priority":{"format":"int32","type":"integer"},"prompt":{"description":"Text prompt for video generation (max 2000 characters)","type":"string"},"resolution":{"description":"Resolution: 360p, 540p, 720p, 1080p, 2K (availability depends on model and duration)","type":"string"},"seed":{"description":"Random seed (defaults to random if not specified)","format":"int32","type":"integer"},"style":{"enum":["general","anime"],"type":"string"},"voice_id":{"description":"Voice ID for audio (ineffective for q3 model)","type":"string"},"watermark":{"description":"Add watermark to video (default false)","type":"boolean"},"wm_position":{"description":"Watermark position: 1 (top left), 2 (top right), 3 (bottom right, default), 4 (bottom left)","format":"int32","type":"integer"},"wm_url":{"description":"Watermark image URL (uses default watermark if not provided)","type":"string"}},"type":"object"},"WanImage2ImageGenerationRequest":{"properties":{"input":{"description":"Enter basic information, such as prompt words, images, etc.","properties":{"images":{"description":"Array of image URLs for image-to-image generation","items":{"description":"Image URL. Supported formats JPEG, JPG, PNG, BMP, WEBP. Resolution width and height must be between 384 and 5000 pixels. File size no larger than 10MB.","type":"string"},"maxItems":2,"minItems":1,"type":"array"},"negative_prompt":{"description":"Reverse prompt words to describe content that you do not want to see in the image","maxLength":500,"type":"string"},"prompt":{"description":"Positive prompt words to describe expected image elements and visual features. Support Chinese and English, length not exceeding 2000 characters","maxLength":2000,"type":"string"}},"required":["prompt","images"],"type":"object"},"model":{"description":"The ID of the model to call for image-to-image generation","enum":["wan2.5-i2i-preview"],"type":"string"},"parameters":{"description":"Image processing parameters","properties":{"n":{"default":1,"description":"Number of generated images. Range 1-4, default is 1","maximum":4,"minimum":1,"type":"integer"},"seed":{"description":"Random number seed to control randomness. Range [0, 2147483647]","maximum":2147483647,"minimum":0,"type":"integer"},"size":{"default":"1280*1280","description":"Output image resolution. Default is 1280*1280. Width and height must be between 384 and 5000 pixels.","type":"string"},"watermark":{"default":false,"description":"Whether to add watermark logo in lower right corner","type":"boolean"}},"type":"object"}},"required":["model","input"],"type":"object"},"WanImage2ImageGenerationResponse":{"properties":{"code":{"description":"The error code for the failed request (not returned if request is successful)","type":"string"},"message":{"description":"Detailed information about the failed request (not returned if request is successful)","type":"string"},"output":{"properties":{"task_id":{"description":"Task ID","type":"string"},"task_status":{"description":"Task status","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","UNKNOWN"],"type":"string"}},"required":["task_id","task_status"],"type":"object"},"request_id":{"description":"Unique request identifier","type":"string"}},"required":["request_id","output"],"type":"object"},"WanImageGenerationRequest":{"properties":{"input":{"description":"Enter basic information, such as prompt words, etc.","properties":{"negative_prompt":{"description":"Reverse prompt words to describe content that you do not want to see in the image","type":"string"},"prompt":{"description":"Positive prompt words to describe expected image elements and visual features. Support Chinese and English, length not exceeding 800 characters","type":"string"}},"required":["prompt"],"type":"object"},"model":{"description":"The ID of the model to call for text-to-image generation","enum":["wan2.5-t2i-preview"],"type":"string"},"parameters":{"description":"Image processing parameters","properties":{"n":{"default":4,"description":"Number of generated images. Range 1-4, default is 4","maximum":4,"minimum":1,"type":"integer"},"prompt_extend":{"default":true,"description":"Enable prompt intelligent rewriting. Default is true","type":"boolean"},"seed":{"description":"Random number seed to control randomness. Range [0, 2147483647]","maximum":2147483647,"minimum":0,"type":"integer"},"size":{"default":"1024*1024","description":"Output image resolution. Default is 1024*1024. Pixel range [512, 1440], up to 200 megapixels","type":"string"},"watermark":{"default":false,"description":"Whether to add watermark logo in lower right corner","type":"boolean"}},"type":"object"}},"required":["model","input"],"type":"object"},"WanImageGenerationResponse":{"properties":{"code":{"description":"The error code for the failed request (not returned if request is successful)","type":"string"},"message":{"description":"Detailed information about the failed request (not returned if request is successful)","type":"string"},"output":{"properties":{"task_id":{"description":"Task ID","type":"string"},"task_status":{"description":"Task status","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","UNKNOWN"],"type":"string"}},"required":["task_id","task_status"],"type":"object"},"request_id":{"description":"Unique request identifier","type":"string"}},"required":["request_id","output"],"type":"object"},"WanTaskQueryResponse":{"properties":{"output":{"properties":{"actual_prompt":{"description":"Actual prompt after intelligent rewriting (for video tasks)","type":"string"},"check_audio":{"description":"Audio URL for I2V tasks with audio generation","type":"string"},"code":{"description":"The error code for the failed request (not returned if request is successful)","type":"string"},"end_time":{"description":"Task completion time","type":"string"},"message":{"description":"Detailed information about the failed request (not returned if request is successful)","type":"string"},"orig_prompt":{"description":"Original input prompt (for video tasks)","type":"string"},"results":{"description":"List of task results for image generation tasks","items":{"properties":{"actual_prompt":{"description":"Actual prompt after intelligent rewriting (if enabled)","type":"string"},"code":{"description":"Image error code (returned when some tasks fail)","type":"string"},"message":{"description":"Image error information (returned when some tasks fail)","type":"string"},"orig_prompt":{"description":"Original input prompt","type":"string"},"url":{"description":"Generated image URL address","type":"string"}},"type":"object"},"type":"array"},"scheduled_time":{"description":"Task execution time","type":"string"},"submit_time":{"description":"Task submission time","type":"string"},"task_id":{"description":"Task ID","type":"string"},"task_metrics":{"description":"Task result statistics for image generation tasks","properties":{"FAILED":{"description":"Number of failed tasks","type":"integer"},"SUCCEEDED":{"description":"Number of successful tasks","type":"integer"},"TOTAL":{"description":"Total number of tasks","type":"integer"}},"type":"object"},"task_status":{"description":"Task status","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","UNKNOWN"],"type":"string"},"video_url":{"description":"Video URL for completed video generation tasks. Link validity period 24 hours","type":"string"}},"required":["task_id","task_status"],"type":"object"},"request_id":{"description":"Unique request identifier","type":"string"},"usage":{"description":"Output information statistics. Only successful results are counted","properties":{"SR":{"description":"Video resolution level (I2V tasks)","type":"integer"},"duration":{"description":"Duration of generated video in seconds (I2V tasks)","type":"number"},"image_count":{"description":"Number of generated images (T2I tasks)","type":"integer"},"size":{"description":"Image resolution (T2I tasks)","type":"string"},"video_count":{"description":"Number of generated videos (T2V tasks)","type":"integer"},"video_duration":{"description":"Duration of generated video in seconds (T2V tasks)","type":"number"},"video_ratio":{"description":"Video resolution ratio (T2V tasks)","type":"string"}},"type":"object"}},"required":["request_id","output"],"type":"object"},"WanVideoGenerationRequest":{"properties":{"input":{"description":"Enter basic information, such as prompt words, etc.","properties":{"audio_url":{"description":"Audio file download URL. Supported formats: mp3 and wav. Cannot be used with reference_video_urls.","type":"string"},"img_url":{"description":"First frame image URL or Base64 encoded data. Required for I2V models. Image formats: JPEG, JPG, PNG, BMP, WEBP. Resolution: 360-2000 pixels. File size: max 10MB.","type":"string"},"media":{"description":"Media asset list for wan2.7 models. Specifies reference materials (image, audio, video)\nfor video generation. Each element contains a type and url field.\nSupported type values vary by model:\n- wan2.7-i2v: first_frame, last_frame, driving_audio, first_clip\n- wan2.7-r2v: reference_image, reference_video\n- wan2.7-videoedit: video, reference_image\n","items":{"properties":{"type":{"description":"Media asset type","enum":["first_frame","last_frame","driving_audio","first_clip","reference_image","reference_video","video"],"type":"string"},"url":{"description":"URL of the media file (public HTTP/HTTPS URL or OSS temporary URL)","type":"string"}},"required":["type","url"],"type":"object"},"type":"array"},"negative_prompt":{"description":"Reverse prompt words are used to describe content that you do not want to see in the video screen","maxLength":500,"type":"string"},"prompt":{"description":"Text prompt words. Support Chinese and English, length not exceeding 800 characters.\nFor wan2.6-r2v with multiple reference videos, use 'character1', 'character2', etc. to refer to subjects\nin the order of reference videos. Example: \"Character1 sings on the roadside, Character2 dances beside it\"\n","maxLength":800,"type":"string"},"reference_video_urls":{"description":"Reference video URLs for wan2.6-r2v model only. Array of 1-3 video URLs.\nInput restrictions:\n- Format: mp4, mov\n- Quantity: 1-3 videos\n- Single video length: 2-30 seconds\n- Single file size: max 30MB\n- Cannot be used with audio_url\nReference duration: Single video max 5s, two videos max 2.5s each, three videos proportionally less.\nBilling: Based on actual reference duration used.\n","items":{"type":"string"},"maxItems":3,"minItems":1,"type":"array"},"template":{"description":"Video effect template name. Optional. Currently supported: squish, flying, carousel. When used, prompt parameter is ignored.","type":"string"}},"type":"object"},"model":{"description":"The ID of the model to call","enum":["wan2.5-t2v-preview","wan2.5-i2v-preview","wan2.6-t2v","wan2.6-i2v","wan2.6-r2v","wan2.7-i2v","wan2.7-t2v","wan2.7-r2v","wan2.7-videoedit","happyhorse-1.0-t2v","happyhorse-1.0-i2v","happyhorse-1.0-r2v","happyhorse-1.0-video-edit"],"type":"string"},"parameters":{"description":"Video processing parameters","properties":{"audio":{"default":true,"description":"Whether to add audio to the video","type":"boolean"},"audio_setting":{"default":"auto","description":"Video audio setting for wan2.7-videoedit model.\n- auto (default): Model intelligently judges based on prompt content\n- origin: Forcefully preserve the original audio from the input video\n","enum":["auto","origin"],"type":"string"},"duration":{"default":5,"description":"The duration of the video generated, in seconds:\n- wan2.5 models: 5 or 10 seconds\n- wan2.6-t2v, wan2.6-i2v: 5, 10, or 15 seconds\n- wan2.6-r2v: 5 or 10 seconds only (no 15s support)\n- wan2.7-i2v, wan2.7-t2v: integer in [2, 15]\n- wan2.7-r2v, wan2.7-videoedit: integer in [2, 10]\n","maximum":15,"minimum":2,"type":"integer"},"prompt_extend":{"default":true,"description":"Is it enabled prompt intelligent rewriting. Default is true","type":"boolean"},"ratio":{"description":"Aspect ratio of the generated video. For wan2.7 models only.\nIf not provided, defaults based on the resolution tier.\n","enum":["16:9","9:16","1:1","4:3","3:4"],"type":"string"},"resolution":{"description":"Resolution level. Supported values vary by model:\n- wan2.5-i2v-preview: 480P, 720P, 1080P\n- wan2.6-i2v: 720P, 1080P only (no 480P support)\n- wan2.7 models (i2v, t2v, r2v, videoedit): 720P, 1080P (default 1080P)\n","enum":["480P","720P","1080P"],"type":"string"},"seed":{"description":"Random number seed, used to control the randomness of the model generated content","maximum":2147483647,"minimum":0,"type":"integer"},"shot_type":{"default":"single","description":"Intelligent multi-lens control. Only active when prompt_extend is enabled.\nFor wan2.6 and wan2.7-r2v models.\n- single: Single-shot video (default)\n- multi: Multi-shot video\n","enum":["multi","single"],"type":"string"},"size":{"description":"Video resolution in format width*height. Supported resolutions vary by model:\nFor wan2.5 T2V: 480P (480*832, 832*480, 624*624), 720P, 1080P sizes\nFor wan2.6 T2V/R2V (no 480P):\n  720P: 1280*720, 720*1280, 960*960, 1088*832, 832*1088\n  1080P: 1920*1080, 1080*1920, 1440*1440, 1632*1248, 1248*1632\n","type":"string"},"watermark":{"default":false,"description":"Whether to add a watermark logo, the watermark is located in the lower right corner","type":"boolean"}},"type":"object"}},"required":["model","input"],"type":"object"},"WanVideoGenerationResponse":{"properties":{"code":{"description":"The error code for the failed request (not returned if request is successful)","type":"string"},"message":{"description":"Detailed information about the failed request (not returned if request is successful)","type":"string"},"output":{"properties":{"task_id":{"description":"Task ID","type":"string"},"task_status":{"description":"Task status","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","UNKNOWN"],"type":"string"}},"required":["task_id","task_status"],"type":"object"},"request_id":{"description":"Unique request identifier","type":"string"}},"required":["output","request_id"],"type":"object"},"WavespeedFlashVSRRequest":{"description":"Request body for WavespeedAI FlashVSR video upscaling","properties":{"duration":{"description":"Duration of the video in seconds\n","type":"number"},"target_resolution":{"default":"1080p","description":"Target resolution to upscale to.","enum":["720p","1080p","2k","4k"],"type":"string"},"video":{"description":"The video to upscale. Can be a URL to the video file or a base64-encoded video.\n","type":"string"}},"required":["video","duration"],"type":"object"},"WavespeedSeedVR2ImageRequest":{"description":"Request body for WavespeedAI SeedVR2 image upscaling","properties":{"enable_base64_output":{"default":false,"description":"If enabled, the output will be encoded into a BASE64 string instead of a URL.","type":"boolean"},"image":{"description":"The URL of the image to upscale.","type":"string"},"output_format":{"default":"jpeg","description":"The format of the output image.","enum":["jpeg","png","webp"],"type":"string"},"target_resolution":{"default":"4k","description":"The target resolution of the output image.","enum":["2k","4k","8k"],"type":"string"}},"required":["image"],"type":"object"},"WavespeedTaskResponse":{"description":"Response from WavespeedAI task submission","properties":{"code":{"description":"HTTP status code (e.g., 200 for success)","type":"integer"},"data":{"properties":{"created_at":{"description":"ISO timestamp of when the request was created","type":"string"},"error":{"description":"Error message (empty if no error occurred)","type":"string"},"has_nsfw_contents":{"description":"Array of boolean values indicating NSFW detection for each output","items":{"type":"boolean"},"type":"array"},"id":{"description":"Unique identifier for the prediction/task","type":"string"},"model":{"description":"Model ID used for the prediction","type":"string"},"outputs":{"description":"Array of URLs to the generated content (empty when status is not completed)","items":{"type":"string"},"type":"array"},"status":{"description":"Status of the task","enum":["created","processing","completed","failed"],"type":"string"},"timings":{"properties":{"inference":{"description":"Inference time in milliseconds","type":"integer"}},"type":"object"},"urls":{"properties":{"get":{"description":"URL to retrieve the prediction result","type":"string"}},"type":"object"}},"type":"object"},"message":{"description":"Status message (e.g., \"success\")","type":"string"}},"type":"object"},"WavespeedTaskResultResponse":{"description":"Response from WavespeedAI task result query","properties":{"code":{"description":"HTTP status code (e.g., 200 for success)","type":"integer"},"data":{"properties":{"created_at":{"description":"ISO timestamp of when the request was created","type":"string"},"error":{"description":"Error message (empty if no error occurred)","type":"string"},"id":{"description":"Unique identifier for the prediction/task","type":"string"},"model":{"description":"Model ID used for the prediction","type":"string"},"outputs":{"description":"Array of URLs to the generated content (empty when status is not completed)","items":{"type":"string"},"type":"array"},"status":{"description":"Status of the task","enum":["created","processing","completed","failed"],"type":"string"},"timings":{"properties":{"inference":{"description":"Inference time in milliseconds","type":"integer"}},"type":"object"},"urls":{"properties":{"get":{"description":"URL to retrieve the prediction result","type":"string"}},"type":"object"}},"type":"object"},"message":{"description":"Status message (e.g., \"success\")","type":"string"}},"type":"object"},"WebSearchPreviewTool":{"description":"This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).","properties":{"search_context_size":{"description":"High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.","enum":["low","medium","high"],"type":"string"},"type":{"default":"web_search_preview","description":"The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.","enum":["web_search_preview","web_search_preview_2025_03_11"],"type":"string","x-stainless-const":true}},"required":["type"],"title":"Web search preview","type":"object"},"WebSearchToolCall":{"description":"The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.\n","properties":{"id":{"description":"The unique ID of the web search tool call.\n","type":"string"},"status":{"description":"The status of the web search tool call.\n","enum":["in_progress","searching","completed","failed"],"type":"string"},"type":{"description":"The type of the web search tool call. Always `web_search_call`.\n","enum":["web_search_call"],"type":"string","x-stainless-const":true}},"required":["id","type","status"],"title":"Web search tool call","type":"object"},"WorkflowRunStatus":{"enum":["WorkflowRunStatusStarted","WorkflowRunStatusFailed","WorkflowRunStatusCompleted"],"type":"string"},"XAIGeneratedImage":{"description":"A generated image from xAI","properties":{"b64_json":{"description":"A base64-encoded string representation of the generated image in jpeg encoding (if response_format is b64_json)","type":"string"},"mime_type":{"description":"The MIME type of the generated image (e.g. image/png, image/jpeg, image/webp).","type":"string"},"url":{"description":"A url to the generated image (if response_format is url)","type":"string"}},"type":"object"},"XAIGeneratedVideo":{"description":"A generated video from xAI","properties":{"duration":{"description":"Duration of the generated video in seconds","type":"integer"},"respect_moderation":{"description":"Whether the video generated by the model respects moderation rules","type":"boolean"},"url":{"description":"A url to the generated video","nullable":true,"type":"string"}},"type":"object"},"XAIImageEditRequest":{"description":"Request body for xAI Grok Imagine image editing","properties":{"aspect_ratio":{"description":"Aspect ratio of the output image for image editing with multiple images. For single image editing, do not set this.","enum":["1:1","3:4","4:3","9:16","16:9","2:3","3:2","9:19.5","19.5:9","9:20","20:9","1:2","2:1","auto"],"type":"string"},"image":{"$ref":"#/components/schemas/XAIImageObject"},"images":{"description":"List of input images for multi-reference editing. Mutually exclusive with image. When multiple images are provided, refer to them as \u003cIMAGE_0\u003e, \u003cIMAGE_1\u003e, etc. in the prompt.","items":{"$ref":"#/components/schemas/XAIImageObject"},"type":"array"},"mask":{"$ref":"#/components/schemas/XAIImageObject"},"model":{"default":"grok-imagine-image","description":"Model to be used","type":"string"},"n":{"description":"Number of image edits to be generated","type":"integer"},"prompt":{"description":"Prompt for image editing","type":"string"},"quality":{"description":"Quality of the output image. Currently a no-op, reserved for future use.","enum":["low","medium","high"],"type":"string"},"resolution":{"default":"1k","description":"Resolution of the generated image. Defaults to 1k.","enum":["1k","2k"],"type":"string"},"response_format":{"default":"url","description":"Response format to return the image in. Can be url or b64_json.","enum":["url","b64_json"],"type":"string"},"size":{"description":"Size of the image (not supported)","type":"string"},"style":{"description":"Style of the image (not supported)","type":"string"},"user":{"description":"A unique identifier representing your end-user, which can help xAI to monitor and detect abuse","type":"string"}},"required":["prompt"],"type":"object"},"XAIImageGenerationRequest":{"description":"Request body for xAI Grok Imagine image generation","properties":{"aspect_ratio":{"default":"auto","description":"Aspect ratio of the generated image. Defaults to auto for automatically selecting the best ratio for the prompt.","enum":["1:1","3:4","4:3","9:16","16:9","2:3","3:2","9:19.5","19.5:9","9:20","20:9","1:2","2:1","auto"],"type":"string"},"model":{"default":"grok-imagine-image","description":"Model to be used","type":"string"},"n":{"default":1,"description":"Number of images to be generated","maximum":10,"minimum":1,"type":"integer"},"prompt":{"description":"Prompt for image generation","type":"string"},"quality":{"description":"Quality of the output image. Currently a no-op, reserved for future use.","enum":["low","medium","high"],"type":"string"},"resolution":{"default":"1k","description":"Resolution of the generated image. Defaults to 1k.","enum":["1k","2k"],"type":"string"},"response_format":{"default":"url","description":"Response format to return the image in. Can be url or b64_json.","enum":["url","b64_json"],"type":"string"},"size":{"description":"Size of the image (not supported)","type":"string"},"style":{"description":"Style of the image (not supported)","type":"string"},"user":{"description":"A unique identifier representing your end-user, which can help xAI to monitor and detect abuse","type":"string"}},"required":["prompt"],"type":"object"},"XAIImageGenerationResponse":{"description":"Response from xAI image generation or editing","properties":{"block_reason":{"description":"If the request was blocked by input moderation, contains the block reason","type":"string"},"data":{"description":"A list of generated image objects","items":{"$ref":"#/components/schemas/XAIGeneratedImage"},"type":"array"},"usage":{"$ref":"#/components/schemas/XAIImageUsage"}},"type":"object"},"XAIImageObject":{"description":"Input image object for xAI endpoints","properties":{"type":{"description":"Type of the image input","enum":["image_url"],"type":"string"},"url":{"description":"URL of the input image (public URL or base64-encoded data URI)","type":"string"}},"required":["url"],"type":"object"},"XAIImageUsage":{"description":"Usage information for the image generation request","properties":{"cost_in_usd_ticks":{"description":"Accurate cost of this request in USD ticks (10,000,000,000 ticks = 1 USD)","type":"integer"}},"type":"object"},"XAIReferenceImageObject":{"description":"A reference image used to guide video generation in R2V mode","properties":{"url":{"description":"URL of the reference image. Supports HTTPS URLs (public) or base64-encoded data URLs (e.g., data:image/jpeg;base64,...).","type":"string"}},"required":["url"],"type":"object"},"XAIVideoAsyncResponse":{"description":"Response from xAI video generation or editing (async operation)","properties":{"request_id":{"description":"Unique identifier to poll for the completed video","type":"string"}},"type":"object"},"XAIVideoEditRequest":{"description":"Request body for xAI Grok Imagine video editing","properties":{"model":{"description":"Model to be used","nullable":true,"type":"string"},"output":{"description":"Optional output destination for generated video","nullable":true,"type":"object"},"prompt":{"description":"Prompt for video editing","type":"string"},"user":{"description":"A unique identifier representing your end-user","nullable":true,"type":"string"},"video":{"$ref":"#/components/schemas/XAIVideoObject"}},"required":["prompt","video"],"type":"object"},"XAIVideoExtensionRequest":{"description":"Request body for xAI Grok Imagine video extension","properties":{"duration":{"default":6,"description":"Length of the extension in seconds. Range [2, 10]. Default 6.","maximum":10,"minimum":2,"nullable":true,"type":"integer"},"model":{"description":"Model to use","nullable":true,"type":"string"},"prompt":{"description":"Text description of what should happen next in the video","type":"string"},"video":{"$ref":"#/components/schemas/XAIVideoObject"}},"required":["prompt","video"],"type":"object"},"XAIVideoGenerationRequest":{"description":"Request body for xAI Grok Imagine video generation.\nSupports three modes: text-to-video (prompt only), image-to-video (prompt + image),\nand reference-to-video (prompt + reference_images).\nThe fields image, reference_images, and video are mutually exclusive.\n","properties":{"aspect_ratio":{"default":"16:9","description":"Aspect ratio of the generated video","enum":["1:1","16:9","9:16","4:3","3:4","3:2","2:3"],"type":"string"},"duration":{"default":8,"description":"Video duration in seconds. Range [1, 15]. Default 8.","maximum":15,"minimum":1,"nullable":true,"type":"integer"},"image":{"$ref":"#/components/schemas/XAIImageObject"},"model":{"description":"Model to be used","type":"string"},"output":{"description":"Optional output destination for generated video","nullable":true,"type":"object"},"prompt":{"description":"Prompt for video generation. Maximum 4,096 characters.","type":"string"},"reference_images":{"description":"One or more reference images to guide the video generation (reference-to-video mode). Mutually exclusive with image and video.","items":{"$ref":"#/components/schemas/XAIReferenceImageObject"},"type":"array"},"resolution":{"description":"Resolution of the output video","nullable":true,"type":"string"},"size":{"description":"Size of the output video","nullable":true,"type":"string"},"user":{"description":"A unique identifier representing your end-user","nullable":true,"type":"string"}},"required":["prompt"],"type":"object"},"XAIVideoObject":{"description":"Input video object for xAI endpoints","properties":{"url":{"description":"URL of the video (public URL or base64-encoded data URL). The video must have the .mp4 file extension and be encoded with .mp4 supported codecs such as H.265, H.264, AV1, etc.","type":"string"}},"required":["url"],"type":"object"},"XAIVideoResultResponse":{"description":"Response from getting video generation result","properties":{"block_reason":{"description":"If the request was blocked by input moderation, contains the block reason","nullable":true,"type":"string"},"model":{"description":"The model used to generate the video","type":"string"},"status":{"description":"Status of the deferred request: \"pending\" or \"done\"","enum":["pending","done"],"type":"string"},"usage":{"$ref":"#/components/schemas/XAIVideoUsage"},"video":{"$ref":"#/components/schemas/XAIGeneratedVideo"}},"type":"object"},"XAIVideoUsage":{"description":"Usage information for the video generation request","properties":{"cost_in_usd_ticks":{"description":"The cost of this request expressed in USD ticks. One USD cent equals 100,000,000 ticks, so one US dollar equals 10,000,000,000 ticks.\n","type":"integer"}},"type":"object"}},"securitySchemes":{"BearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"info":{"title":"Comfy API","version":"1.0"},"openapi":"3.0.2","paths":{"/admin/customers/{customer_id}/archive-metronome-data":{"post":{"description":"Archives metronome data. See https://docs.metronome.com/api-reference/customers/archive-a-customer","operationId":"PostAdminArchiveMetronomeData","parameters":[{"description":"The ID of the customer whose Metronome data to archive","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Admin API secret used to authorize this request","in":"header","name":"X-Comfy-Admin-Secret","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"Success message","type":"string"}},"type":"object"}}},"description":"Metronome data archived successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request - missing required parameter"},"401":{"description":"Unauthorized or missing admin API secret"},"404":{"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Archive customer Metronome data","tags":["Admin"],"x-excluded":true}},"/admin/customers/{customer_id}/balance":{"get":{"description":"Returns the specified customer's current remaining balance in microamount and its currency.","operationId":"GetAdminCustomerBalance","parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"in":"header","name":"X-Comfy-Admin-Secret","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"amount_micros":{"format":"double","type":"number"},"cloud_credit_balance_micros":{"format":"double","type":"number"},"currency":{"type":"string"},"effective_balance_micros":{"format":"double","type":"number"},"pending_charges_micros":{"format":"double","type":"number"},"prepaid_balance_micros":{"format":"double","type":"number"}},"required":["amount_micros","currency"],"type":"object"}}},"description":"Customer balance retrieved successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Admin get customer's remaining balance","tags":["Admin"],"x-excluded":true}},"/admin/customers/{customer_id}/cloud-subscription-status":{"get":{"description":"Allows an admin to inspect a specific customer's cloud subscription status.","operationId":"GetAdminCustomerCloudSubscriptionStatus","parameters":[{"description":"The ID of the customer whose subscription status to retrieve","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Admin API secret used to authorize this request","in":"header","name":"X-Comfy-Admin-Secret","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"end_date":{"description":"The date when the subscription is set to end (ISO 8601 format)","format":"date-time","nullable":true,"type":"string"},"has_fund":{"description":"Whether the customer has funds/credits available","type":"boolean"},"is_active":{"description":"Whether the customer has an active cloud subscription","type":"boolean"},"renewal_date":{"description":"The next renewal date for the subscription (ISO 8601 format)","format":"date-time","nullable":true,"type":"string"},"subscription_duration":{"allOf":[{"$ref":"#/components/schemas/SubscriptionDuration"}],"nullable":true},"subscription_id":{"description":"The active subscription ID if one exists","nullable":true,"type":"string"},"subscription_tier":{"allOf":[{"$ref":"#/components/schemas/SubscriptionTier"}],"nullable":true}},"type":"object"}}},"description":"Cloud subscription status retrieved successfully"},"401":{"description":"Unauthorized or missing admin API secret"},"404":{"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Admin check cloud subscription status","tags":["Admin"],"x-excluded":true}},"/admin/customers/{customer_id}/stripe-data":{"delete":{"description":"Deletes the Stripe customer data associated with the given customer ID.","operationId":"DeleteAdminCustomerStripeData","parameters":[{"description":"The ID of the customer whose Stripe data to delete","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Admin API secret used to authorize this request","in":"header","name":"X-Comfy-Admin-Secret","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"Success message","type":"string"}},"type":"object"}}},"description":"Stripe data deleted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request - missing required parameter"},"401":{"description":"Unauthorized or missing admin API secret"},"404":{"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete customer Stripe data","tags":["Admin"],"x-excluded":true}},"/admin/generate-token":{"post":{"description":"Generates a short-lived JWT admin token for browser-based admin operations.\nThe user must already be authenticated with Firebase and have admin privileges.\nThe generated token expires after 1 hour.\n","operationId":"GenerateAdminToken","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"expires_at":{"description":"When the token expires","format":"date-time","type":"string"},"token":{"description":"The JWT admin token","type":"string"}},"required":["token","expires_at"],"type":"object"}}},"description":"JWT token generated successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized or user is not an admin"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Generate a short-lived JWT admin token","tags":["Admin"]}},"/admin/nodes":{"post":{"operationId":"AdminCreateNode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Node created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Duplicate error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a new custom node using admin priviledge","tags":["Registry"],"x-excluded":true}},"/admin/nodes/{nodeId}":{"put":{"description":"Only admins can update a node with admin privileges.","operationId":"AdminUpdateNode","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Node updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Admin Update Node","tags":["Registry"],"x-excluded":true}},"/admin/nodes/{nodeId}/versions/{versionNumber}":{"put":{"description":"Only admins can approve a node version.","operationId":"AdminUpdateNodeVersion","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"path","name":"versionNumber","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/components/schemas/NodeVersionStatus"},"status_reason":{"description":"The reason for the status change.","type":"string"},"supported_accelerators":{"description":"List of accelerators (e.g. CUDA, DirectML, ROCm) that this node supports","items":{"type":"string"},"type":"array"},"supported_comfyui_frontend_version":{"description":"Supported versions of ComfyUI frontend","type":"string"},"supported_comfyui_version":{"description":"Supported versions of ComfyUI","type":"string"},"supported_os":{"description":"List of operating systems that this node supports","items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeVersion"}}},"description":"Version updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Admin Update Node Version Status","tags":["Registry"],"x-excluded":true}},"/admin/nodeversions":{"get":{"description":"Admin-only endpoint to list all node versions with support for including deleted versions. Only admins can access this endpoint.","operationId":"AdminListAllNodeVersions","parameters":[{"in":"query","name":"nodeId","schema":{"type":"string"}},{"explode":true,"in":"query","name":"statuses","schema":{"items":{"$ref":"#/components/schemas/NodeVersionStatus"},"type":"array"},"style":"form"},{"in":"query","name":"include_status_reason","schema":{"default":false,"type":"boolean"}},{"description":"The page number to retrieve.","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"The number of items to include per page.","in":"query","name":"pageSize","schema":{"default":10,"type":"integer"}},{"description":"search for status_reason, case insensitive","in":"query","name":"status_reason","schema":{"type":"string"}},{"description":"Include soft-deleted node versions in the results","in":"query","name":"include_deleted","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"page":{"description":"Current page number","type":"integer"},"pageSize":{"description":"Maximum number of node versions per page. Maximum is 100.","type":"integer"},"total":{"description":"Total number of node versions available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"},"versions":{"items":{"$ref":"#/components/schemas/NodeVersion"},"type":"array"}},"type":"object"}}},"description":"List of all node versions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid input, object invalid"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Admin list all node versions with optional filters","tags":["Registry"],"x-excluded":true}},"/admin/verify-api-key":{"post":{"description":"Validates a ComfyUI API key and returns the associated customer information.\nThis endpoint is used by cloud.comfy.org to authenticate users via API keys\ninstead of Firebase tokens.\n","operationId":"VerifyApiKey","parameters":[{"description":"Admin API secret used to authorize this request","in":"header","name":"X-Comfy-Admin-Secret","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"api_key":{"description":"The ComfyUI API key to verify (e.g., comfy_xxx...)","type":"string"}},"required":["api_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"email":{"description":"The customer's email address","type":"string"},"firebase_uid":{"description":"The Firebase UID of the user","type":"string"},"is_admin":{"description":"Whether the customer is an admin","type":"boolean"},"name":{"description":"The customer's name","type":"string"},"valid":{"description":"Whether the API key is valid","type":"boolean"}},"required":["valid","firebase_uid"],"type":"object"}}},"description":"API key is valid"},"401":{"description":"Unauthorized or missing admin API secret"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"API key auth not allowed for this account (e.g., free tier)"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"API key not found or invalid"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Verify a ComfyUI API key and return customer details","tags":["Admin"],"x-excluded":true}},"/branch":{"get":{"description":"Returns all branches for a given repo.","operationId":"GetBranch","parameters":[{"description":"The repo to filter by.","in":"query","name":"repo_name","required":true,"schema":{"default":"comfyanonymous/ComfyUI","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"branches":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"An array of branches"},"404":{"description":"Repo not found"},"500":{"description":"Internal server error"}},"summary":"Retrieve all distinct branches for a given repo","tags":["ComfyUI CI"],"x-excluded":true}},"/bulk/nodes/versions":{"post":{"operationId":"GetBulkNodeVersions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkNodeVersionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkNodeVersionsResponse"}}},"description":"Successfully retrieved node versions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve multiple node versions in a single request","tags":["Registry"]}},"/comfy-nodes":{"get":{"operationId":"ListAllComfyNodes","parameters":[{"in":"query","name":"pageSize","schema":{"default":100,"type":"integer"}},{"description":"Page number (1-based indexing)","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Filter by node ID","in":"query","name":"node_id","schema":{"type":"string"}},{"description":"Filter by node version","in":"query","name":"node_version","schema":{"type":"string"}},{"description":"Filter by ComfyUI node name","in":"query","name":"comfy_node_name","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"comfy_nodes":{"items":{"$ref":"#/components/schemas/ComfyNode"},"type":"array"},"total":{"description":"Total number of comfy nodes","type":"integer"}},"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"list all comfy-nodes","tags":["Registry"]}},"/comfy-nodes/backfill":{"post":{"operationId":"ComfyNodesBackfill","parameters":[{"in":"query","name":"max_node","schema":{"default":10,"type":"integer"}}],"responses":{"204":{"description":"Backfill triggered"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"trigger comfy nodes backfill","tags":["Registry"],"x-excluded":true}},"/comfy-nodes/{comfyNodeName}/node":{"get":{"description":"Returns the node that contains a ComfyUI node with the specified name","operationId":"GetNodeByComfyNodeName","parameters":[{"description":"The name of the ComfyUI node","in":"path","name":"comfyNodeName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Node details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No node found containing the specified ComfyUI node name"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve a node by ComfyUI node name","tags":["Registry"]}},"/customers":{"get":{"description":"Search for customers by email, name, Stripe ID, or Metronome ID.","operationId":"SearchCustomers","parameters":[{"description":"Email address to search for","in":"query","name":"email","schema":{"type":"string"}},{"description":"Customer name to search for","in":"query","name":"name","schema":{"type":"string"}},{"description":"Stripe customer ID to search for","in":"query","name":"stripe_id","schema":{"type":"string"}},{"description":"Metronome customer ID to search for\\","in":"query","name":"metronome_id","schema":{"type":"string"}},{"description":"Page number to retrieve","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Number of customers to return per page","in":"query","name":"limit","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"customers":{"items":{"$ref":"#/components/schemas/Customer"},"type":"array"},"limit":{"description":"Number of customers per page","type":"integer"},"page":{"description":"Current page number","type":"integer"},"total":{"description":"Total number of matching customers","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"}},"type":"object"}}},"description":"Customers matching the search criteria"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid request parameters"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - insufficient permissions"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Search for customers","tags":["API Nodes","Admin"],"x-excluded":true},"post":{"description":"Creates a new customer using the provided token. No request body is needed as user information is extracted from the token.","operationId":"CreateCustomer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"Customer already exists"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"Customer created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a new customer","tags":["API Nodes"],"x-excluded":true}},"/customers/admin/coupons":{"get":{"description":"Retrieves a list of all coupons from Stripe. Only admins can list coupons.","operationId":"ListCoupons","parameters":[{"description":"Number of coupons to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"coupons":{"items":{"$ref":"#/components/schemas/CouponResponse"},"type":"array"},"has_more":{"description":"Whether there are more results available","type":"boolean"}},"required":["coupons"],"type":"object"}}},"description":"List of coupons retrieved successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"List all coupons","tags":["Admin","API Nodes"],"x-excluded":true},"post":{"description":"Creates a new coupon in Stripe. Only admins can create coupons.","operationId":"CreateCoupon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCouponRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponResponse"}}},"description":"Coupon created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a new Stripe coupon","tags":["Admin","API Nodes"],"x-excluded":true}},"/customers/admin/coupons/{coupon_id}":{"delete":{"description":"Deletes a coupon in Stripe. Only admins can delete coupons.","operationId":"DeleteCoupon","parameters":[{"description":"The Stripe coupon ID","in":"path","name":"coupon_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"coupon_id":{"description":"The deleted coupon ID","type":"string"},"message":{"description":"Success message","type":"string"}},"required":["message","coupon_id"],"type":"object"}}},"description":"Coupon deleted successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Coupon not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Delete a coupon","tags":["Admin","API Nodes"],"x-excluded":true},"get":{"description":"Retrieves details of a specific coupon from Stripe. Only admins can view coupons.","operationId":"GetCoupon","parameters":[{"description":"The Stripe coupon ID","in":"path","name":"coupon_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponResponse"}}},"description":"Coupon retrieved successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Coupon not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get a specific coupon","tags":["Admin","API Nodes"],"x-excluded":true},"patch":{"description":"Updates a coupon in Stripe. Only admins can update coupons.","operationId":"UpdateCoupon","parameters":[{"description":"The Stripe coupon ID","in":"path","name":"coupon_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCouponRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponResponse"}}},"description":"Coupon updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Coupon not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Update a coupon","tags":["Admin","API Nodes"],"x-excluded":true}},"/customers/admin/promo-codes":{"get":{"description":"Retrieves a list of all promotional codes from Stripe. Only admins can list promo codes.","operationId":"ListPromoCodes","parameters":[{"description":"Filter by active status","in":"query","name":"active","schema":{"type":"boolean"}},{"description":"Number of promo codes to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"has_more":{"description":"Whether there are more results available","type":"boolean"},"promo_codes":{"items":{"$ref":"#/components/schemas/PromoCodeResponse"},"type":"array"}},"required":["promo_codes"],"type":"object"}}},"description":"List of promo codes retrieved successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"List all promotional codes","tags":["Admin","API Nodes"],"x-excluded":true},"post":{"description":"Creates a new unique promotional code in Stripe for the specified coupon. Only admins can generate promo codes.","operationId":"CreatePromoCode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePromoCodeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromoCodeResponse"}}},"description":"Promo code created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Generate a new Stripe promotional code","tags":["Admin","API Nodes"],"x-excluded":true}},"/customers/admin/promo-codes/{promo_code_id}":{"delete":{"description":"Deactivates a promotional code in Stripe. Only admins can deactivate promo codes.","operationId":"DeletePromoCode","parameters":[{"description":"The Stripe promotion code ID","in":"path","name":"promo_code_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"Success message","type":"string"},"promo_code_id":{"description":"The deactivated promo code ID","type":"string"}},"required":["message","promo_code_id"],"type":"object"}}},"description":"Promo code deactivated successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Promo code not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Deactivate a promotional code","tags":["Admin","API Nodes"],"x-excluded":true},"get":{"description":"Retrieves details of a specific promotional code from Stripe. Only admins can view promo codes.","operationId":"GetPromoCode","parameters":[{"description":"The Stripe promotion code ID","in":"path","name":"promo_code_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromoCodeResponse"}}},"description":"Promo code retrieved successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Promo code not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get a specific promotional code","tags":["Admin","API Nodes"],"x-excluded":true},"patch":{"description":"Updates a promotional code in Stripe. Only admins can update promo codes.","operationId":"UpdatePromoCode","parameters":[{"description":"The Stripe promotion code ID","in":"path","name":"promo_code_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePromoCodeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromoCodeResponse"}}},"description":"Promo code updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - Admin access required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Promo code not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Update a promotional code","tags":["Admin","API Nodes"],"x-excluded":true}},"/customers/api-keys":{"get":{"operationId":"ListCustomerAPIKeys","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"api_keys":{"items":{"$ref":"#/components/schemas/APIKey"},"type":"array"}},"type":"object"}}},"description":"List of API keys"},"401":{"description":"Unauthorized"},"404":{"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List all API keys for a customer","x-excluded":true},"post":{"operationId":"CreateCustomerAPIKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIKeyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"api_key":{"$ref":"#/components/schemas/APIKeyWithPlaintext"}},"type":"object"}}},"description":"API key created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Customer or API key not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Create a new API key for a customer","x-excluded":true}},"/customers/api-keys/{api_key_id}":{"delete":{"operationId":"DeleteCustomerAPIKey","parameters":[{"in":"path","name":"api_key_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"API key deleted"},"401":{"description":"Unauthorized"},"404":{"description":"Customer or API key not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete an API key for a customer","x-excluded":true}},"/customers/balance":{"get":{"description":"Returns the customer's current remaining balance in microamount and its currency, with separate breakdowns for prepaid commits and cloud credits.","operationId":"GetCustomerBalance","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"amount_micros":{"description":"The total remaining balance in microamount (1/1,000,000 of the currency unit)","format":"double","type":"number"},"cloud_credit_balance_micros":{"description":"The remaining balance from cloud credits in microamount","format":"double","type":"number"},"currency":{"description":"The currency code (e.g., \"usd\")","type":"string"},"effective_balance_micros":{"description":"The effective balance (total balance minus pending charges). Can be negative if pending charges exceed the balance. Only included when the show_negative_balances feature flag is enabled.","format":"double","type":"number"},"pending_charges_micros":{"description":"The total amount of pending/unbilled charges from draft invoices in microamount. Only included when the show_negative_balances feature flag is enabled.","format":"double","type":"number"},"prepaid_balance_micros":{"description":"The remaining balance from prepaid commits in microamount","format":"double","type":"number"}},"required":["amount_micros","currency"],"type":"object"}}},"description":"Customer balance retrieved successfully"},"401":{"description":"Unauthorized or invalid token"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get customer's remaining balance","tags":["API Nodes"],"x-excluded":true}},"/customers/billing":{"post":{"description":"Creates a session for the customer to access their billing portal where they can manage subscriptions, payment methods, and view invoices.","operationId":"AccessBillingPortal","requestBody":{"content":{"application/json":{"schema":{"properties":{"return_url":{"description":"Optional URL to redirect the customer after they're done with the billing portal","type":"string"},"target_tier":{"description":"Optional target subscription tier. When provided, creates a deep link directly to the subscription update confirmation screen with this tier pre-selected.","enum":["standard","creator","pro","standard-yearly","creator-yearly","pro-yearly"],"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"billing_portal_url":{"description":"The URL to redirect the customer to the billing portal","type":"string"}},"type":"object"}}},"description":"Billing portal session created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input"},"401":{"description":"Unauthorized or invalid token"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Access customer billing portal","tags":["API Nodes","Released"],"x-excluded":true}},"/customers/cloud-subscription-checkout":{"post":{"description":"Creates a cloud subscription checkout session for $20/month with automatic billing","operationId":"CreateCloudSubscriptionCheckout","requestBody":{"content":{"application/json":{"schema":{"properties":{"ga_client_id":{"description":"Google Analytics client ID from _ga cookie","type":"string"},"ga_session_id":{"description":"Google Analytics session ID","type":"string"},"ga_session_number":{"description":"Google Analytics session number","type":"string"},"gbraid":{"description":"Google Ads iOS attribution parameter","type":"string"},"gclid":{"description":"Google Ads click ID","type":"string"},"im_ref":{"description":"Impact.com click ID for affiliate conversion tracking","type":"string"},"utm_campaign":{"description":"UTM campaign parameter","type":"string"},"utm_content":{"description":"UTM content parameter","type":"string"},"utm_medium":{"description":"UTM medium parameter","type":"string"},"utm_source":{"description":"UTM source parameter","type":"string"},"utm_term":{"description":"UTM term parameter","type":"string"},"wbraid":{"description":"Google Ads web-to-app attribution parameter","type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"checkout_url":{"description":"The URL to redirect the customer to complete subscription","type":"string"}},"type":"object"}}},"description":"Subscription checkout session created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input"},"401":{"description":"Unauthorized or invalid token"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create cloud subscription checkout session","tags":["API Nodes","Released"],"x-excluded":true}},"/customers/cloud-subscription-checkout/{tier}":{"post":{"description":"Creates a cloud subscription checkout session for a specific subscription tier (standard, creator, or pro) with automatic billing","operationId":"CreateCloudSubscriptionCheckoutTier","parameters":[{"description":"The subscription tier (standard, creator, or pro) with optional yearly billing (standard-yearly, creator-yearly, pro-yearly)","in":"path","name":"tier","required":true,"schema":{"enum":["standard","creator","pro","standard-yearly","creator-yearly","pro-yearly"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ga_client_id":{"description":"Google Analytics client ID from _ga cookie","type":"string"},"ga_session_id":{"description":"Google Analytics session ID","type":"string"},"ga_session_number":{"description":"Google Analytics session number","type":"string"},"gbraid":{"description":"Google Ads iOS attribution parameter","type":"string"},"gclid":{"description":"Google Ads click ID","type":"string"},"im_ref":{"description":"Impact.com click ID for affiliate conversion tracking","type":"string"},"utm_campaign":{"description":"UTM campaign parameter","type":"string"},"utm_content":{"description":"UTM content parameter","type":"string"},"utm_medium":{"description":"UTM medium parameter","type":"string"},"utm_source":{"description":"UTM source parameter","type":"string"},"utm_term":{"description":"UTM term parameter","type":"string"},"wbraid":{"description":"Google Ads web-to-app attribution parameter","type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"checkout_url":{"description":"The URL to redirect the customer to complete subscription","type":"string"}},"type":"object"}}},"description":"Subscription checkout session created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input or tier"},"401":{"description":"Unauthorized or invalid token"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create cloud subscription checkout session for a specific tier","tags":["API Nodes","Released"],"x-excluded":true}},"/customers/cloud-subscription-status":{"get":{"description":"Check if the customer has an active cloud subscription","operationId":"GetCloudSubscriptionStatus","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"end_date":{"description":"The date when the subscription is set to end (ISO 8601 format)","format":"date-time","nullable":true,"type":"string"},"has_fund":{"description":"Whether the customer has funds/credits available","type":"boolean"},"is_active":{"description":"Whether the customer has an active cloud subscription","type":"boolean"},"renewal_date":{"description":"The next renewal date for the subscription (ISO 8601 format)","format":"date-time","nullable":true,"type":"string"},"subscription_duration":{"allOf":[{"$ref":"#/components/schemas/SubscriptionDuration"}],"nullable":true},"subscription_id":{"description":"The active subscription ID if one exists","nullable":true,"type":"string"},"subscription_tier":{"allOf":[{"$ref":"#/components/schemas/SubscriptionTier"}],"nullable":true}},"type":"object"}}},"description":"Cloud subscription status retrieved successfully"},"401":{"description":"Unauthorized or invalid token"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Check cloud subscription status","tags":["API Nodes","Released"],"x-excluded":true}},"/customers/credit":{"post":{"operationId":"InitiateCreditPurchase","requestBody":{"content":{"application/json":{"schema":{"properties":{"amount_micros":{"description":"the amount of the checkout transaction in micro value","format":"int64","type":"integer"},"currency":{"description":"the currency used in the checkout transaction","type":"string"}},"required":["amount_micros","currency"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"checkout_url":{"description":"the url to redirect the customer","type":"string"}},"type":"object"}}},"description":"Customer Checkout created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid token or user already exists"},"401":{"description":"Unauthorized or invalid token"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Initiates a Credit Purchase.","tags":["API Nodes","Released"],"x-excluded":true}},"/customers/events":{"get":{"operationId":"GetCustomerEvents","parameters":[{"description":"Page number of the nodes list","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Number of nodes to return per page","in":"query","name":"limit","schema":{"default":10,"type":"integer"}},{"description":"Event type to filter","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Start date for filtering events (RFC3339 format, e.g., 2025-01-01T00:00:00Z)","in":"query","name":"start_date","schema":{"format":"date-time","type":"string"}},{"description":"End date for filtering events (RFC3339 format, e.g., 2025-01-31T23:59:59Z)","in":"query","name":"end_date","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"events":{"items":{"$ref":"#/components/schemas/AuditLog"},"type":"array"},"limit":{"description":"Maximum number of nodes per page","type":"integer"},"page":{"description":"Current page number","type":"integer"},"total":{"description":"Total number of events available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"}},"type":"object"}}},"description":"A paginated list of nodes"},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get events related to customer","tags":["API Nodes"],"x-excluded":true}},"/customers/me":{"get":{"description":"Returns details about the currently authenticated customer based on their JWT token.","operationId":"GetAuthenticatedCustomer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"Customer details retrieved successfully"},"401":{"description":"Unauthorized or invalid token"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get authenticated customer details","tags":["API Nodes"],"x-excluded":true}},"/customers/storage":{"post":{"description":"Store a resource for a customer. Resource will have a 24 hour expiry. The signed URL will be generated for the specified file path.","operationId":"CreateCustomerStorageResource","requestBody":{"content":{"application/json":{"schema":{"properties":{"content_type":{"description":"The content type of the file (e.g., 'image/png')","type":"string"},"file_hash":{"description":"The hash of the file. If provided, an existing file with the same hash may be returned.","type":"string"},"file_name":{"description":"The desired name of the file (e.g., 'profile.jpg')","type":"string"}},"required":["file_name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerStorageResourceResponse"}}},"description":"Signed URL generated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Store a resource for a customer","tags":["API Nodes"],"x-excluded":true}},"/customers/usage":{"post":{"description":"Returns the customer's as a dashboard URL.","operationId":"GetCustomerUsage","requestBody":{"content":{"application/json":{"schema":{"properties":{"color_overrides":{"description":"Optional list of colors to override for branding","items":{"properties":{"name":{"description":"The color property to override","enum":["Gray_dark","Gray_medium","Gray_light","Gray_extralight","White","Primary_medium","Primary_light","UsageLine_0","UsageLine_1","UsageLine_2","UsageLine_3","UsageLine_4","UsageLine_5","UsageLine_6","UsageLine_7","UsageLine_8","UsageLine_9","Primary_green","Primary_red","Progress_bar","Progress_bar_background"],"type":"string"},"value":{"description":"Hex color code (e.g., \"#FF5733\")","pattern":"^#[0-9A-Fa-f]{6}$","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"dashboard_type":{"default":"usage","description":"The type of dashboard to retrieve","enum":["invoices","usage","credits","commits_and_credits"],"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"url":{"description":"The dashboard URL for the customer's usage","type":"string"}},"type":"object"}}},"description":"Successful response"},"401":{"description":"Unauthorized or invalid token"},"404":{"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get customer's usage","tags":["API Nodes"],"x-excluded":true}},"/customers/{customer_id}":{"get":{"description":"Returns details about a customer by their ID.","operationId":"GetCustomerById","parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"customer":{"$ref":"#/components/schemas/CustomerAdmin"}},"type":"object"}}},"description":"Customer details retrieved successfully"},"401":{"description":"Unauthorized or invalid token"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get a customer by ID","tags":["API Nodes","Admin"],"x-excluded":true}},"/customers/{customer_id}/balance":{"get":{"description":"Returns the specified customer's current remaining balance in microamount and its currency, with separate breakdowns for prepaid commits and cloud credits.","operationId":"GetCustomerBalanceById","parameters":[{"description":"The ID of the customer whose balance to retrieve","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"amount_micros":{"description":"The total remaining balance in microamount (1/1,000,000 of the currency unit)","format":"double","type":"number"},"cloud_credit_balance_micros":{"description":"The remaining balance from cloud credits in microamount","format":"double","type":"number"},"currency":{"description":"The currency code (e.g., \"usd\")","type":"string"},"effective_balance_micros":{"description":"The effective balance (total balance minus pending charges). Can be negative if pending charges exceed the balance. Only included when the show_negative_balances feature flag is enabled.","format":"double","type":"number"},"pending_charges_micros":{"description":"The total amount of pending/unbilled charges from draft invoices in microamount. Only included when the show_negative_balances feature flag is enabled.","format":"double","type":"number"},"prepaid_balance_micros":{"description":"The remaining balance from prepaid commits in microamount","format":"double","type":"number"}},"required":["amount_micros","currency"],"type":"object"}}},"description":"Customer balance retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized or invalid token"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get customer's remaining balance by ID","tags":["API Nodes","Admin"],"x-excluded":true}},"/customers/{customer_id}/events":{"get":{"operationId":"GetCustomerEventsById","parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Page number of the nodes list","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Number of nodes to return per page","in":"query","name":"limit","schema":{"default":10,"type":"integer"}},{"description":"Event type to filter","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Start date for filtering events (RFC3339 format, e.g., 2025-01-01T00:00:00Z)","in":"query","name":"start_date","schema":{"format":"date-time","type":"string"}},{"description":"End date for filtering events (RFC3339 format, e.g., 2025-01-31T23:59:59Z)","in":"query","name":"end_date","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"events":{"items":{"$ref":"#/components/schemas/AuditLog"},"type":"array"},"limit":{"description":"Maximum number of nodes per page","type":"integer"},"page":{"description":"Current page number","type":"integer"},"total":{"description":"Total number of events available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"}},"type":"object"}}},"description":"A paginated list of nodes"},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get events related to customer","tags":["API Nodes"],"x-excluded":true}},"/customers/{customer_id}/usage":{"post":{"description":"Manually track usage for a customer in Metronome. This endpoint is for admin use to record usage events.","operationId":"TrackCustomerUsage","parameters":[{"description":"The ID of the customer to track usage for","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Admin API secret used to authorize this request","in":"header","name":"X-Comfy-Admin-Secret","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"params":{"additionalProperties":true,"description":"Custom parameters for the usage event","type":"object"},"timestamp":{"description":"Timestamp of the usage event (RFC3339 format)","format":"date-time","type":"string"},"transaction_id":{"description":"Unique transaction ID for this usage event","format":"uuid","type":"string"}},"required":["transaction_id","params"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"Success message","type":"string"}},"type":"object"}}},"description":"Usage tracked successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized or invalid token"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Customer not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Track usage for a customer (Admin only)","tags":["API Nodes","Admin"],"x-excluded":true}},"/features":{"get":{"description":"Returns the server's feature capabilities","operationId":"GetFeatures","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeaturesResponse"}}},"description":"Success"}},"summary":"Get server feature flags","tags":["Registry"]}},"/gitcommit":{"get":{"description":"Returns all runs, jobs, job results, and storage files associated with a given commit.","operationId":"GetGitcommit","parameters":[{"description":"The ID of the commit to fetch data for.","in":"query","name":"commitId","schema":{"type":"string"}},{"description":"The operating system to filter the CI data by.","in":"query","name":"operatingSystem","schema":{"type":"string"}},{"description":"The name of the workflow to filter the CI data by.","in":"query","name":"workflowName","schema":{"type":"string"}},{"description":"The branch of the gitcommit to filter the CI data by.","in":"query","name":"branch","schema":{"type":"string"}},{"description":"The page number to retrieve.","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"The number of items to include per page.","in":"query","name":"pageSize","schema":{"default":10,"type":"integer"}},{"description":"The repo to filter by.","in":"query","name":"repoName","schema":{"default":"comfyanonymous/ComfyUI","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"jobResults":{"items":{"$ref":"#/components/schemas/ActionJobResult"},"type":"array"},"totalNumberOfPages":{"type":"integer"}},"type":"object"}}},"description":"An object containing runs, jobs, job results, and storage files"},"404":{"description":"Commit not found"},"500":{"description":"Internal server error"}},"summary":"Retrieve CI data for a given commit","tags":["ComfyUI CI"],"x-excluded":true}},"/gitcommitsummary":{"get":{"description":"Returns a summary of git commits, including status, start time, and end time.","operationId":"GetGitcommitsummary","parameters":[{"description":"The repository name to filter the git commits by.","in":"query","name":"repoName","schema":{"default":"comfyanonymous/ComfyUI","type":"string"}},{"description":"The branch name to filter the git commits by.","in":"query","name":"branchName","schema":{"type":"string"}},{"description":"The page number to retrieve.","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"The number of items to include per page.","in":"query","name":"pageSize","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"commitSummaries":{"items":{"$ref":"#/components/schemas/GitCommitSummary"},"type":"array"},"totalNumberOfPages":{"type":"integer"}},"type":"object"}}},"description":"Successfully retrieved git commit summaries"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Internal server error"}},"summary":"Retrieve a summary of git commits","tags":["ComfyUI CI"],"x-excluded":true}},"/nodes":{"get":{"description":"Returns a paginated list of nodes across all publishers.","operationId":"ListAllNodes","parameters":[{"description":"Page number of the nodes list","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Number of nodes to return per page","in":"query","name":"limit","schema":{"default":10,"type":"integer"}},{"description":"Filter nodes by supported operating systems","examples":{"linux":{"value":"POSIX :: Linux"},"macos":{"value":"MacOS"},"macosx":{"value":"MacOS :: MacOS X"},"osIndependent":{"value":"OS Independent"},"ubuntu":{"value":"POSIX :: Linux :: Ubuntu"},"windows":{"value":"Microsoft :: Windows"},"windows10":{"value":"Microsoft :: Windows :: Windows 10"}},"in":"query","name":"supported_os","schema":{"type":"string"}},{"description":"Filter nodes by supported accelerator","in":"query","name":"supported_accelerator","schema":{"type":"string"}},{"description":"Number of nodes to return per page","in":"query","name":"include_banned","schema":{"type":"boolean"}},{"description":"Retrieve nodes created or updated after this timestamp (ISO 8601 format)","in":"query","name":"timestamp","schema":{"format":"date-time","type":"string"}},{"description":"Whether to fetch fresh result from database or use cached one if false","in":"query","name":"latest","schema":{"type":"boolean"}},{"description":"Database column to use as ascending ordering. Add `;desc` as suffix on each column for descending sort","in":"query","name":"sort","schema":{"items":{"type":"string"},"type":"array"}},{"description":"node_id to use as filter","in":"query","name":"node_id","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Comfy UI version","in":"query","name":"comfyui_version","schema":{"type":"string"}},{"description":"The platform requesting the nodes","in":"query","name":"form_factor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"limit":{"description":"Maximum number of nodes per page","type":"integer"},"nodes":{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},"page":{"description":"Current page number","type":"integer"},"total":{"description":"Total number of nodes available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"}},"type":"object"}}},"description":"A paginated list of nodes"},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieves a list of nodes","tags":["Registry"]}},"/nodes/reindex":{"post":{"operationId":"ReindexNodes","parameters":[{"description":"Maximum number of nodes to send to algolia at a time","in":"query","name":"max_batch","schema":{"type":"integer"}}],"responses":{"200":{"description":"Reindex completed successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Reindex all nodes for searching.","tags":["Registry"],"x-excluded":true}},"/nodes/search":{"get":{"description":"Returns a paginated list of nodes across all publishers.","operationId":"SearchNodes","parameters":[{"description":"Page number of the nodes list","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Number of nodes to return per page","in":"query","name":"limit","schema":{"default":10,"type":"integer"}},{"description":"Keyword to search the nodes","in":"query","name":"search","schema":{"type":"string"}},{"description":"Keyword to search the nodes by repository URL","in":"query","name":"repository_url_search","schema":{"type":"string"}},{"description":"Keyword to search the nodes by comfy node name","in":"query","name":"comfy_node_search","schema":{"type":"string"}},{"description":"Filter nodes by supported operating systems","examples":{"linux":{"value":"POSIX :: Linux"},"macos":{"value":"MacOS"},"macosx":{"value":"MacOS :: MacOS X"},"osIndependent":{"value":"OS Independent"},"ubuntu":{"value":"POSIX :: Linux :: Ubuntu"},"windows":{"value":"Microsoft :: Windows"},"windows10":{"value":"Microsoft :: Windows :: Windows 10"}},"in":"query","name":"supported_os","schema":{"type":"string"}},{"description":"Filter nodes by supported accelerator","in":"query","name":"supported_accelerator","schema":{"type":"string"}},{"description":"Number of nodes to return per page","in":"query","name":"include_banned","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"limit":{"description":"Maximum number of nodes per page","type":"integer"},"nodes":{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},"page":{"description":"Current page number","type":"integer"},"total":{"description":"Total number of nodes available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"}},"type":"object"}}},"description":"A paginated list of nodes"},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieves a list of nodes","tags":["Registry"]}},"/nodes/update-github-stars":{"post":{"operationId":"UpdateGithubStars","parameters":[{"description":"Maximum number of nodes to update in one batch","in":"query","name":"max_batch","schema":{"default":100,"type":"integer"}}],"responses":{"200":{"description":"Update GithubStars request triggered successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update GitHub stars for nodes","tags":["Registry"],"x-excluded":true}},"/nodes/{nodeId}":{"get":{"description":"Returns the details of a specific node.","operationId":"GetNode","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"description":"Whether to include the translation or not","in":"query","name":"include_translations","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Node details"},"302":{"description":"Redirect to node with normalized name match","headers":{"Location":{"description":"URL of the node with the correct ID","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve a specific node by ID","tags":["Registry"]}},"/nodes/{nodeId}/install":{"get":{"description":"Retrieves the node data for installation, either the latest or a specific version.","operationId":"InstallNode","parameters":[{"description":"The unique identifier of the node.","in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"description":"Specific version of the node to retrieve. If omitted, the latest version is returned.","in":"query","name":"version","schema":{"pattern":"^\\d+\\.\\d+\\.\\d+$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeVersion"}}},"description":"Node data returned successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid input, such as a bad version format."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Returns a node version to be installed.","tags":["Registry"]}},"/nodes/{nodeId}/reviews":{"post":{"operationId":"PostNodeReview","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"description":"number of star given to the node version","in":"query","name":"star","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Detailed information about a specific node"},"400":{"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Node version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Add review to a specific version of a node","tags":["Registry"]}},"/nodes/{nodeId}/translations":{"post":{"operationId":"CreateNodeTranslations","parameters":[{"description":"The unique identifier of the node.","in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object"}},"type":"object"}}},"required":true},"responses":{"201":{"description":"Detailed information about a specific node"},"400":{"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Node version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Create Node Translations","tags":["Registry"]}},"/nodes/{nodeId}/versions":{"get":{"operationId":"ListNodeVersions","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"query","name":"statuses","schema":{"items":{"$ref":"#/components/schemas/NodeVersionStatus"},"type":"array"}},{"in":"query","name":"include_status_reason","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NodeVersion"},"type":"array"}}},"description":"List of all node versions"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node banned"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Node not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List all versions of a node","tags":["Registry"]}},"/nodes/{nodeId}/versions/{versionId}":{"get":{"operationId":"GetNodeVersion","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"description":"The version of the node. (Not a UUID).","in":"path","name":"versionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeVersion"}}},"description":"Detailed information about a specific node version"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Node version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve a specific version of a node","tags":["Registry"]}},"/nodes/{nodeId}/versions/{version}/comfy-nodes":{"get":{"operationId":"ListComfyNodes","parameters":[{"description":"The page number to retrieve.","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"The number of items to include per page.","in":"query","name":"limit","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"comfy_nodes":{"items":{"$ref":"#/components/schemas/ComfyNode"},"type":"array"},"totalNumberOfPages":{"type":"integer"}},"type":"object"}}},"description":"Comy Nodes obtained successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"list comfy-nodes for node version","tags":["Registry"]},"parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"operationId":"CreateComfyNodes","requestBody":{"content":{"application/json":{"schema":{"properties":{"cloud_build_info":{"$ref":"#/components/schemas/ComfyNodeCloudBuildInfo"},"nodes":{"additionalProperties":{"$ref":"#/components/schemas/ComfyNode"}},"reason":{"type":"string"},"status":{"type":"string"},"success":{"type":"boolean"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Comy Nodes created successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Existing Comfy Nodes exists"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"create comfy-nodes for certain node","tags":["Registry"]}},"/nodes/{nodeId}/versions/{version}/comfy-nodes/{comfyNodeName}":{"get":{"operationId":"GetComfyNode","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}},{"in":"path","name":"comfyNodeName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComfyNode"}}},"description":"Comy Nodes created successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"get specify comfy-node based on its id","tags":["Registry"]},"put":{"operationId":"UpdateComfyNode","parameters":[{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}},{"in":"path","name":"comfyNodeName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComfyNodeUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComfyNode"}}},"description":"Comfy Node updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"ComfyNode not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update a specific comfy-node","tags":["Registry"]}},"/proxy/bfl/flux-2-max/generate":{"post":{"description":"Forwards image generation requests to BFL's Flux 2 Max API and returns the results. Supports image-to-image generation with up to 8 input images.","operationId":"BflFlux2MaxGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFlux2ProGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxProGenerateResponse"}}},"description":"Successful response from BFL Flux 2 Max proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or BFL)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with BFL)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (BFL took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to BFL Flux 2 Max for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-2-pro/generate":{"post":{"description":"Forwards image generation requests to BFL's Flux 2 Pro API and returns the results. Supports image-to-image generation with up to 5 input images.","operationId":"BflFlux2ProGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFlux2ProGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxProGenerateResponse"}}},"description":"Successful response from BFL Flux 2 Pro proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or BFL)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with BFL)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (BFL took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to BFL Flux 2 Pro for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-kontext-max/generate":{"post":{"description":"Forwards image editing requests to BFL's Flux Kontext Max API and returns the results.","operationId":"BflFluxKontextMaxGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxKontextMaxGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxKontextMaxGenerateResponse"}}},"description":"Successful response from BFL Flux Kontext Max proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or BFL)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with BFL)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (BFL took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to BFL Flux Kontext Max for image editing","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-kontext-pro/generate":{"post":{"description":"Forwards image editing requests to BFL's Flux Kontext Pro API and returns the results.","operationId":"BflFluxKontextProGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxKontextProGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxKontextProGenerateResponse"}}},"description":"Successful response from BFL Flux Kontext Pro proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or BFL)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with BFL)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (BFL took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to BFL Flux Kontext Pro for image editing","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-pro-1.0-canny/generate":{"post":{"description":"Submits an image generation task with FLUX.1 Canny [pro].","operationId":"BFLProCannyV1FluxPro10CannyPost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLCannyInputs"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BFLAsyncResponse"},{"$ref":"#/components/schemas/BFLAsyncWebhookResponse"}],"title":"Response Pro Canny V1 Flux Pro 1 0 Canny Post"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate an image with FLUX.1 Canny [pro] using a control image.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-pro-1.0-depth/generate":{"post":{"description":"Submits an image generation task with FLUX.1 Depth [pro].","operationId":"BFLProDepthV1FluxPro10DepthPost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLDepthInputs"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BFLAsyncResponse"},{"$ref":"#/components/schemas/BFLAsyncWebhookResponse"}],"title":"Response Pro Depth V1 Flux Pro 1 0 Depth Post"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate an image with FLUX.1 Depth [pro] using a control image.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-pro-1.0-expand/generate":{"post":{"description":"Submits an image expansion task that adds the specified number of pixels to any combination of sides (top, bottom, left, right) while maintaining context.","operationId":"BFLExpandV1FluxPro10ExpandPost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxProExpandInputs"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BFLAsyncResponse"},{"$ref":"#/components/schemas/BFLAsyncWebhookResponse"}],"title":"Response Expand V1 Flux Pro 1 0 Expand Post"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Expand an image by adding pixels on any side.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-pro-1.0-fill/generate":{"post":{"description":"Submits an image generation task with the FLUX.1 Fill [pro] model using an input image and mask. Mask can be applied to alpha channel or submitted as a separate image.","operationId":"BFLFillV1FluxPro10FillPost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxProFillInputs"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BFLAsyncResponse"},{"$ref":"#/components/schemas/BFLAsyncWebhookResponse"}],"title":"Response Fill V1 Flux Pro 1 0 Fill Post"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate an image with FLUX.1 Fill [pro] using an input image and mask.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-pro-1.1-ultra/generate":{"post":{"description":"Forwards image generation requests to BFL's Flux Pro 1.1 Ultra API and returns the results.","operationId":"BflFluxProGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxProGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxProGenerateResponse"}}},"description":"Successful response from BFL Flux Pro proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or BFL)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with BFL)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (BFL took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to BFL Flux Pro 1.1 Ultra for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bfl/flux-pro-1.1/generate":{"post":{"description":"Forwards image generation requests to BFL's Flux Pro 1.1 API and returns the results.","operationId":"BflFluxPro11Generate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxPro1_1GenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BFLFluxPro1_1GenerateResponse"}}},"description":"Successful response from BFL Flux Pro proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or BFL)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with BFL)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (BFL took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to BFL Flux Pro 1.1 for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bria/v2/image/edit":{"post":{"description":"Edit an existing image using Bria's FIBO Edit API. You can provide:\n1. A source image and a text-based instruction (prompt)\n2. A source image and a structured_instruction\n3. A source image, a mask, and a text-based instruction\n4. A source image, a mask, and a structured_instruction\n\nThis endpoint always uses async mode (sync: false) and returns a status_url to poll for results.\n","operationId":"BriaFiboEdit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaFiboEditRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaAsyncResponse"}}},"description":"Request accepted, processing asynchronously"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaErrorResponse"}}},"description":"Content moderation failure"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Edit an image using Bria FIBO","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bria/v2/image/edit/remove_background":{"post":{"description":"Remove the background of an image using Bria's RMBG 2.0 model.\n\nReturns HTTP 202 with request_id and status_url when async (default).\nCan return 200 with result directly when sync is true.\n\nAccepted image formats: JPEG, JPG, PNG, WEBP.\n","operationId":"BriaImageRemoveBackground","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaImageRemoveBackgroundRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaAsyncResponse"}}},"description":"Request accepted, processing asynchronously"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaErrorResponse"}}},"description":"Content moderation failure"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Remove background from an image using Bria","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bria/v2/status/{request_id}":{"get":{"description":"Retrieves the current status of an asynchronous Bria request.\n\nPoll this endpoint until the status is COMPLETED or ERROR.\n\nStatus values:\n- `IN_PROGRESS` – Request is being processed. Continue polling.\n- `COMPLETED` – Success. Response includes `result.image_url` for images, `result.video_url` for videos, or `result.structured_prompt` for structured prompt generation. Additional optional fields (seed, prompt, refined_prompt) may be included.\n- `ERROR` – Processing failed. Check error object for details.\n- `UNKNOWN` – Unexpected internal error.\n","operationId":"BriaGetStatus","parameters":[{"description":"Unique identifier of the request (returned from edit, generate, or remove_background endpoints)","in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaStatusResponse"}}},"description":"Status retrieved successfully"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaStatusNotFoundResponse"}}},"description":"Request ID not found or expired"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get Bria request status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bria/v2/structured_instruction/generate":{"post":{"description":"Translates a user's text-based edit instruction and source image/mask into a detailed, \nmachine-readable structured edit instruction in JSON format.\n\nThis endpoint uses Gemini 2.5 Flash VLM to understand the edit context and returns only \nthe JSON string without generating an image.\n\nThe resulting structured_instruction can be used as input for the /proxy/bria/v2/image/edit endpoint.\n\nThis endpoint always uses async mode (sync: false) and returns a status_url to poll for results.\n","operationId":"BriaStructuredInstructionGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaStructuredInstructionRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaAsyncResponse"}}},"description":"Request accepted, processing asynchronously"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaErrorResponse"}}},"description":"Content moderation failure"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Generate a structured instruction from text","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/bria/v2/video/edit/remove_background":{"post":{"description":"Initiates an asynchronous background removal job for a video using Bria's API.\n\nReturns HTTP 202 with request_id and status_url. Poll the status endpoint for results.\n\nSupported input containers: .mp4, .mov, .webm, .avi, .gif\nSupported input codecs: H.264, H.265 (HEVC), VP9, AV1, PhotoJPEG\nMax input duration: 60 seconds. Input resolution up to 16000x16000.\n","operationId":"BriaVideoRemoveBackground","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaVideoRemoveBackgroundRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaAsyncResponse"}}},"description":"Request accepted, processing asynchronously"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriaErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Remove background from a video using Bria","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/byteplus-seedance2/api/v3/contents/generations/tasks/{task_id}":{"get":{"operationId":"ByteplusSeedance2VideoGenerationQuery","parameters":[{"description":"The ID of the Seedance 2.0 video generation task to query","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BytePlusVideoGenerationQueryResponse"}}},"description":"Video generation task information retrieved successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/byteplus/api/v3/contents/generations/tasks":{"post":{"operationId":"ByteplusVideoGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BytePlusVideoGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BytePlusVideoGenerationResponse"}}},"description":"Video generation task created successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/byteplus/api/v3/contents/generations/tasks/{task_id}":{"get":{"operationId":"ByteplusVideoGenerationQuery","parameters":[{"description":"The ID of the video generation task to query","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BytePlusVideoGenerationQueryResponse"}}},"description":"Video generation task information retrieved successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/byteplus/api/v3/images/generations":{"post":{"operationId":"ByteplusImageGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BytePlusImageGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BytePlusImageGenerationResponse"}}},"description":"Image generation completed successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/dummy":{"post":{"description":"Dummy proxy endpoint that returns a simple string","operationId":"DummyProxy","requestBody":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Reindex completed successfully."}},"summary":"Dummy proxy","tags":["API Nodes"],"x-excluded":true}},"/proxy/elevenlabs/v1/audio-isolation":{"post":{"description":"Removes background noise from audio. Isolates vocals/speech from background sounds.\n","operationId":"ElevenLabsAudioIsolation","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ElevenLabsAudioIsolationRequest"}}},"required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}},"audio/mpeg":{"schema":{"format":"binary","type":"string"}}},"description":"The isolated audio file"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"Audio Isolation","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/shared-voices":{"get":{"description":"Retrieves a list of shared voices from the ElevenLabs voice library.\n","operationId":"ElevenLabsGetSharedVoices","parameters":[{"description":"How many shared voices to return at maximum. Can not exceed 100, defaults to 30.","in":"query","name":"page_size","schema":{"default":30,"type":"integer"}},{"description":"Voice category used for filtering. One of: professional, famous, high_quality.","in":"query","name":"category","schema":{"type":"string"}},{"description":"Gender used for filtering","in":"query","name":"gender","schema":{"type":"string"}},{"description":"Age used for filtering","in":"query","name":"age","schema":{"type":"string"}},{"description":"Accent used for filtering","in":"query","name":"accent","schema":{"type":"string"}},{"description":"Language used for filtering","in":"query","name":"language","schema":{"type":"string"}},{"description":"Locale used for filtering","in":"query","name":"locale","schema":{"type":"string"}},{"description":"Search term used for filtering","in":"query","name":"search","schema":{"type":"string"}},{"description":"Use-case used for filtering","in":"query","name":"use_cases","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Descriptives used for filtering","in":"query","name":"descriptives","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Filter featured voices","in":"query","name":"featured","schema":{"default":false,"type":"boolean"}},{"description":"Filter voices with a minimum notice period of the given number of days.","in":"query","name":"min_notice_period_days","schema":{"type":"integer"}},{"description":"Include/exclude voices with custom rates","in":"query","name":"include_custom_rates","schema":{"type":"boolean"}},{"description":"Include/exclude voices that are live moderated","in":"query","name":"include_live_moderated","schema":{"type":"boolean"}},{"description":"Filter voices that are enabled for the reader app","in":"query","name":"reader_app_enabled","schema":{"default":false,"type":"boolean"}},{"description":"Filter voices by public owner ID","in":"query","name":"owner_id","schema":{"type":"string"}},{"description":"Sort criteria","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Page number","in":"query","name":"page","schema":{"default":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsSharedVoicesPaginatedResponse"}}},"description":"Shared voices retrieved successfully"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"List Shared Voices","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/sound-generation":{"post":{"description":"Turn text into sound effects for your videos, voice-overs or video games\nusing the most advanced sound effects models in the world.\n","operationId":"ElevenLabsSoundGeneration","parameters":[{"description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate.\nExamples: mp3_22050_32, mp3_44100_128, pcm_16000, ulaw_8000\n","in":"query","name":"output_format","schema":{"default":"mp3_44100_128","enum":["mp3_22050_32","mp3_24000_48","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsSoundGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}},"audio/mpeg":{"schema":{"format":"binary","type":"string"}}},"description":"The generated sound effect audio file"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"Create Sound Effect","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/speech-to-speech/{voice_id}":{"post":{"description":"Transform audio from one voice to another. Maintain full control over emotion, timing and delivery.\n","operationId":"ElevenLabsSpeechToSpeech","parameters":[{"description":"ID of the voice to be used. Use the Get voices endpoint to list all available voices.","in":"path","name":"voice_id","required":true,"schema":{"type":"string"}},{"description":"When enable_logging is set to false zero retention mode will be used for the request.\nThis will mean history features are unavailable for this request, including request stitching.\nZero retention mode may only be used by enterprise customers.\n","in":"query","name":"enable_logging","schema":{"default":true,"type":"boolean"}},{"description":"Latency optimization levels (0-4):\n0 - default mode (no latency optimizations)\n1 - normal latency optimizations (~50% improvement)\n2 - strong latency optimizations (~75% improvement)\n3 - max latency optimizations\n4 - max latency with text normalizer off (best latency but may mispronounce)\n","in":"query","name":"optimize_streaming_latency","schema":{"nullable":true,"type":"integer"}},{"description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate.\nExamples: mp3_22050_32, mp3_44100_128, pcm_16000, ulaw_8000\n","in":"query","name":"output_format","schema":{"default":"mp3_44100_128","enum":["mp3_22050_32","mp3_24000_48","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192"],"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ElevenLabsSpeechToSpeechRequest"}}},"required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}},"audio/mpeg":{"schema":{"format":"binary","type":"string"}},"audio/ogg":{"schema":{"format":"binary","type":"string"}},"audio/wav":{"schema":{"format":"binary","type":"string"}}},"description":"The generated audio file"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"Voice Changer (Speech-to-Speech)","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/speech-to-text":{"post":{"description":"Transcribe an audio or video file. If webhook is set to true, the request will be processed \nasynchronously and results sent to configured webhooks. When use_multi_channel is true and \nthe provided audio has multiple channels, a 'transcripts' object with separate transcripts \nfor each channel is returned. Otherwise, returns a single transcript. The optional \nwebhook_metadata parameter allows you to attach custom data that will be included in \nwebhook responses for request correlation and tracking.\n","operationId":"ElevenLabsSpeechToText","parameters":[{"description":"When enable_logging is set to false zero retention mode will be used for the request. \nThis will mean log and transcript storage features are unavailable for this request. \nZero retention mode may only be used by enterprise customers.\n","in":"query","name":"enable_logging","schema":{"default":true,"type":"boolean"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ElevenLabsSTTRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsSTTResponse"}}},"description":"Synchronous transcription result"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"Create transcript (Speech-to-Text)","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/text-to-dialogue":{"post":{"description":"Converts a list of text and voice ID pairs into speech (dialogue) and returns audio.\nUseful for generating conversations between multiple characters.\n","operationId":"ElevenLabsTextToDialogue","parameters":[{"description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate.\nExamples: mp3_22050_32, mp3_44100_128, pcm_16000, ulaw_8000\n","in":"query","name":"output_format","schema":{"default":"mp3_44100_128","enum":["mp3_22050_32","mp3_24000_48","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsTextToDialogueRequest"}}},"required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}},"audio/mpeg":{"schema":{"format":"binary","type":"string"}},"audio/ogg":{"schema":{"format":"binary","type":"string"}},"audio/wav":{"schema":{"format":"binary","type":"string"}}},"description":"The generated audio file"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"Create dialogue (Multi-voice TTS)","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/text-to-speech/{voice_id}":{"post":{"description":"Converts text into speech using a specified voice and returns audio.\n\nThe output format can be specified via the output_format query parameter.\nSupported formats include MP3, PCM, μ-law, and Opus with various sample rates and bitrates.\n","operationId":"ElevenLabsTextToSpeech","parameters":[{"description":"ID of the voice to use. Use the Get voices endpoint to list all available voices.","in":"path","name":"voice_id","required":true,"schema":{"type":"string"}},{"description":"When set to false, enables zero retention mode (enterprise only). History features will be unavailable.","in":"query","name":"enable_logging","schema":{"default":true,"type":"boolean"}},{"description":"Deprecated. Latency optimization levels (0-4):\n0 - default mode (no latency optimizations)\n1 - normal latency optimizations (~50% improvement)\n2 - strong latency optimizations (~75% improvement)\n3 - max latency optimizations\n4 - max latency with text normalizer off (best latency but may mispronounce)\n","in":"query","name":"optimize_streaming_latency","schema":{"maximum":4,"minimum":0,"type":"integer"}},{"description":"Output format of the generated audio. Formatted as codec_sample_rate_bitrate.\nExamples: mp3_22050_32, mp3_44100_128, pcm_16000, pcm_22050, ulaw_8000\n","in":"query","name":"output_format","schema":{"default":"mp3_44100_128","enum":["mp3_22050_32","mp3_44100_32","mp3_44100_64","mp3_44100_96","mp3_44100_128","mp3_44100_192","pcm_8000","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","ulaw_8000","alaw_8000","opus_48000_32","opus_48000_64","opus_48000_96","opus_48000_128","opus_48000_192","wav_8000","wav_16000","wav_22050","wav_24000","wav_32000","wav_44100","wav_48000"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsTTSRequest"}}},"required":true},"responses":{"200":{"content":{"audio/mpeg":{"schema":{"format":"binary","type":"string"}},"audio/ogg":{"schema":{"format":"binary","type":"string"}},"audio/wav":{"schema":{"format":"binary","type":"string"}}},"description":"The generated audio file"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"ElevenLabs Text to Speech","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v1/voices/add":{"post":{"description":"Create an instant voice clone and add it to your Voices.\n","operationId":"ElevenLabsCreateVoice","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ElevenLabsCreateVoiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"requires_verification":{"type":"boolean"},"voice_id":{"type":"string"}},"type":"object"}}},"description":"Voice created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsValidationError"}}},"description":"Validation Error"}},"security":[{"BearerAuth":[]}],"summary":"Create Voice Clone","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/elevenlabs/v2/voices":{"get":{"description":"Proxies ElevenLabs `GET /v2/voices` (the paginated voice search endpoint)\nwith the `category` query parameter pinned to `premade`, so only premade\nvoices from the ElevenLabs voice library are ever returned.\n","operationId":"ElevenLabsGetVoices","parameters":[{"description":"Search term used to filter voices by name or description.","in":"query","name":"search","schema":{"type":"string"}},{"description":"How many voices to return per page. Max 100, defaults to 10.","in":"query","name":"page_size","schema":{"type":"integer"}},{"description":"Pagination cursor returned by a previous call.","in":"query","name":"next_page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElevenLabsVoicesPaginatedResponse"}}},"description":"Voices retrieved successfully"},"401":{"description":"Unauthorized"}},"security":[{"BearerAuth":[]}],"summary":"List Voices","tags":["API Nodes","ElevenLabs"],"x-excluded":true}},"/proxy/freepik/v1/ai/image-relight":{"post":{"description":"Relight an image using AI. This endpoint accepts a variety of parameters to customize the generated images.\n","operationId":"FreepikMagnificRelight","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikMagnificRelightRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The relight process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Relight an image","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-relight/{task_id}":{"get":{"description":"Get the status of the relight task","operationId":"FreepikMagnificRelightGetStatus","parameters":[{"description":"ID of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The task status is returned"},"404":{"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get the status of the relight task","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-style-transfer":{"post":{"description":"Style transfer an image using AI.","operationId":"FreepikMagnificStyleTransfer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikMagnificStyleTransferRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskData"}}},"description":"OK - The style transfer process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Style transfer an image","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-style-transfer/{task_id}":{"get":{"description":"Get the status of the style transfer task","operationId":"FreepikMagnificStyleTransferGetStatus","parameters":[{"description":"ID of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The task status is returned"},"404":{"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get the status of the style transfer task","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-upscaler":{"post":{"description":"This asynchronous endpoint enables image upscaling using advanced AI algorithms.\nUpon submission, it returns a unique task_id which can be used to track the progress.\nFor real-time production use, include the optional webhook_url parameter to receive\nan automated notification once the task has been completed.\n","operationId":"FreepikMagnificUpscalerCreative","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikMagnificUpscalerCreativeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The upscaling process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Upscale an image with Magnific","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-upscaler-precision-v2":{"post":{"description":"Upscales an image while adding new visual elements or details (V2).\nThis endpoint may modify the original image content based on the prompt and inferred context.\nUpon submission, it returns a unique task_id which can be used to track the progress.\n","operationId":"FreepikMagnificUpscalerPrecisionV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikMagnificUpscalerPrecisionV2Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The upscaling process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Upscale an image with Precision V2","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-upscaler-precision-v2/{task_id}":{"get":{"description":"Returns the current status and output URL of a specific precision upscaler V2 task.","operationId":"FreepikMagnificUpscalerPrecisionV2GetStatus","parameters":[{"description":"ID of the task","in":"path","name":"task_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The task status is returned"},"404":{"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get the status of the Precision V2 upscaling task","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/image-upscaler/{task_id}":{"get":{"description":"Get the status of the upscaling task","operationId":"FreepikMagnificUpscalerCreativeGetStatus","parameters":[{"description":"ID of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The task status is returned"},"404":{"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get the status of the upscaling task","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/skin-enhancer/creative":{"post":{"description":"Enhance skin in images using AI with the Creative mode. This mode provides more artistic and stylized enhancements.","operationId":"FreepikSkinEnhancerCreative","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikSkinEnhancerCreativeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The skin enhancer process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Skin enhancer using AI (Creative)","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/skin-enhancer/faithful":{"post":{"description":"Enhance skin in images using AI with the Faithful mode. This mode preserves the original appearance while improving skin quality.","operationId":"FreepikSkinEnhancerFaithful","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikSkinEnhancerFaithfulRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The skin enhancer process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Skin enhancer using AI (Faithful)","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/skin-enhancer/flexible":{"post":{"description":"Enhance skin in images using AI with the Flexible mode. This mode allows you to choose the optimization target for the enhancement.","operationId":"FreepikSkinEnhancerFlexible","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikSkinEnhancerFlexibleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The skin enhancer process has started"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Skin enhancer using AI (Flexible)","tags":["Freepik","Proxy"]}},"/proxy/freepik/v1/ai/skin-enhancer/{task_id}":{"get":{"description":"Get the status of a skin enhancer task (works for both Creative and Faithful modes)","operationId":"FreepikSkinEnhancerGetStatus","parameters":[{"description":"ID of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikTaskResponse"}}},"description":"OK - The task status is returned"},"404":{"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreepikErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get the status of one skin enhancer task","tags":["Freepik","Proxy"]}},"/proxy/hitpaw/api/photo-enhancer":{"post":{"description":"Submit an image processing task using HitPaw Photo Enhancement API.\nSupports multiple enhancement models for image super-resolution processing.\n\nThe returned job_id can be used with the task-status endpoint to check processing results.\n\n**Available Models:**\n- Enhancement \u0026 Denoise Models (face_2x/4x, face_v2_2x/4x, general_2x/4x, high_fidelity_2x/4x, sharpen_denoise, detail_denoise):\n  - Max input: 67 MP, Max output: 600 MP\n  - Supported formats: bmp, jpeg, jpg, png, jfif, tga, tiff, webp, heif\n- Generative Models (generative_portrait, generative):\n  - No input limit, Max output: 8K (33 MP)\n  - Supported formats: bmp, jpeg, jpg, png, jfif, tga, tiff, webp, heif\n","operationId":"HitpawPhotoEnhancer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawPhotoEnhancerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawJobResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit HitPaw Photo Enhancement Task","tags":["API Nodes","HitPaw"],"x-excluded":true}},"/proxy/hitpaw/api/task-status":{"post":{"description":"Query the status and result of a previously submitted photo or video enhancement task.\nPoll this endpoint until the task status indicates completion (COMPLETED).\n\n**Status Codes:**\n- CONVERTING: Job is currently being processed\n- COMPLETED: Job has completed successfully, result is available\n- ERROR: Job failed due to an error\n","operationId":"HitpawTaskStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawTaskStatusRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawTaskStatusResponse"}}},"description":"Task status retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Query HitPaw Task Status","tags":["API Nodes","HitPaw"],"x-excluded":true}},"/proxy/hitpaw/api/video-enhancer":{"post":{"description":"Submit a video processing task using HitPaw Video Enhancement API.\nUses AI technology to upscale low-resolution videos to high resolution,\neliminate artifacts and noise, and improve clarity and details.\n\nThe returned job_id can be used with the task-status endpoint to check processing results.\n\n**Video Constraints:**\n- Duration: 0.5 seconds to 1 hour\n- Maximum output resolution: 36 MP (Total Pixels)\n- Supported input formats: dv, mlv, m2ts, m2t, m2v, nut, ser, 3g2, 3gp, asf, divx, f4v, h261, h263, m4v, mkv, mov, mp4, mpeg, mpeg4, mpg, mxf, ogv, rm, rmvb, webm, wmv, dmsm, dvdmedia, dvr-ms, mts, trp, ts, vob, vro, gif, xvid\n- Supported output formats: mp4, mov, mkv, m4v, avi, gif\n","operationId":"HitpawVideoEnhancer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawVideoEnhancerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawJobResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Payment Required - Insufficient credits"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HitPawErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit HitPaw Video Enhancement Task","tags":["API Nodes","HitPaw"],"x-excluded":true}},"/proxy/ideogram/generate":{"post":{"description":"Forwards image generation requests to Ideogram's API and returns the results.","operationId":"IdeogramGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramGenerateResponse"}}},"description":"Successful response from Ideogram proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or Ideogram)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with Ideogram)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (Ideogram took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to Ideogram for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ideogram/ideogram-v3/edit":{"post":{"description":"Forwards image editing requests to Ideogram's API and returns the results.","operationId":"IdeogramV3Edit","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/IdeogramV3EditRequest"}}},"description":"Parameters for Ideogram V3 image editing","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramGenerateResponse"}}},"description":"Successful response from Ideogram proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Prompt or Initial Image failed the safety checks."},"429":{"description":"Rate limit exceeded (either from proxy or Ideogram)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Proxy request to Ideogram for image editing","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ideogram/ideogram-v3/generate":{"post":{"description":"Forwards image generation requests to Ideogram's API and returns the results.","operationId":"IdeogramV3Generate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramV3Request"}}},"description":"Parameters for Ideogram V3 image generation","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramGenerateResponse"}}},"description":"Successful response from Ideogram proxy"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Proxy request to Ideogram for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ideogram/ideogram-v3/reframe":{"post":{"operationId":"IdeogramV3Reframe","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/IdeogramV3ReframeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramV3IdeogramResponse"}}},"description":"Reframed image successfully returned"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"429":{"description":"Too Many Requests"}},"summary":"Reframe an image to a chosen resolution","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ideogram/ideogram-v3/remix":{"post":{"operationId":"IdeogramV3Remix","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/IdeogramV3RemixRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramV3IdeogramResponse"}}},"description":"Remix generated successfully"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity"},"429":{"description":"Too Many Requests"}},"summary":"Remix an image using a prompt","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ideogram/ideogram-v3/replace-background":{"post":{"operationId":"IdeogramV3ReplaceBackground","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/IdeogramV3ReplaceBackgroundRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramV3IdeogramResponse"}}},"description":"Background replaced successfully"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"429":{"description":"Too Many Requests"}},"summary":"Replace background of an image using a prompt","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/account/costs":{"get":{"operationId":"KlingQueryResourcePackages","parameters":[{"in":"query","name":"start_time","required":true,"schema":{"description":"Start time for the query, Unix timestamp in ms","type":"integer"}},{"in":"query","name":"end_time","required":true,"schema":{"description":"End time for the query, Unix timestamp in ms","type":"integer"}},{"in":"query","name":"resource_pack_name","schema":{"description":"Resource package name for precise querying of a specific package","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingResourcePackageResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Resource Package Information","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/general/advanced-presets-elements":{"get":{"description":"Retrieves a list of advanced preset elements from Kling AI.\n","operationId":"KlingGetPresetsElements","parameters":[{"description":"Page number. Value range: [1, 1000].","in":"query","name":"pageNum","schema":{"default":1,"type":"integer"}},{"description":"Data volume per page. Value range: [1, 500].","in":"query","name":"pageSize","schema":{"default":30,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingPresetsElementsResponse"}}},"description":"Presets elements retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"KlingAI Query Presets Elements","tags":["API Nodes","Kling"],"x-excluded":true}},"/proxy/kling/v1/images/generations":{"get":{"operationId":"KlingImageGenerationsQueryTaskList","parameters":[{"description":"Page number","in":"query","name":"pageNum","schema":{"default":1,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Data volume per page","in":"query","name":"pageSize","schema":{"default":30,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingImageGenerationsResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Image Generation Task List","tags":["API Nodes","Released"],"x-excluded":true},"post":{"operationId":"KlingCreateImageGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingImageGenerationsRequest"}}},"description":"Create task for generating images","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingImageGenerationsResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Image Generation Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/images/generations/{id}":{"get":{"operationId":"KlingImageGenerationsQuerySingleTask","parameters":[{"description":"Task ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingImageGenerationsResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Image Generation Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/images/kolors-virtual-try-on":{"get":{"operationId":"KlingVirtualTryOnQueryTaskList","parameters":[{"description":"Page number","in":"query","name":"pageNum","schema":{"default":1,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Data volume per page","in":"query","name":"pageSize","schema":{"default":30,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVirtualTryOnResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Virtual Try-On Task List","tags":["API Nodes","Released"],"x-excluded":true},"post":{"operationId":"KlingCreateVirtualTryOn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVirtualTryOnRequest"}}},"description":"Create task for virtual try-on of clothing on human images","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVirtualTryOnResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Virtual Try-On Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/images/kolors-virtual-try-on/{id}":{"get":{"operationId":"KlingVirtualTryOnQuerySingleTask","parameters":[{"description":"Task ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVirtualTryOnResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Virtual Try-On Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/images/omni-image":{"post":{"operationId":"KlingCreateOmniImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingOmniImageRequest"}}},"description":"Create task for generating omni-image","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingOmniImageResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Omni-Image Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/images/omni-image/{id}":{"get":{"operationId":"KlingOmniImageQuerySingleTask","parameters":[{"description":"Task ID or External Task ID. Can query by either task_id (generated by system) or external_task_id (customized task ID)","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingOmniImageResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Omni-Image Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/avatar/image2video":{"post":{"operationId":"KlingCreateAvatarVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingAvatarRequest"}}},"description":"Create task for generating avatar video from image and audio","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingAvatarResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Avatar Video","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/avatar/image2video/{id}":{"get":{"operationId":"KlingAvatarQueryTask","parameters":[{"description":"Task ID or external_task_id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingAvatarResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Avatar Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/effects":{"get":{"operationId":"KlingVideoEffectsQueryTaskList","parameters":[{"description":"Page number","in":"query","name":"pageNum","schema":{"default":1,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Data volume per page","in":"query","name":"pageSize","schema":{"default":30,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoEffectsResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Video Effects Task List","tags":["API Nodes","Released"],"x-excluded":true},"post":{"operationId":"KlingCreateVideoEffects","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoEffectsRequest"}}},"description":"Create task for generating video with effects","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoEffectsResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Video Effects Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/effects/{id}":{"get":{"operationId":"KlingVideoEffectsQuerySingleTask","parameters":[{"description":"Task ID or external_task_id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoEffectsResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Video Effects Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/image2video":{"post":{"operationId":"KlingCreateVideoFromImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingImage2VideoRequest"}}},"description":"Create task for generating video from image","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingQueryTaskResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Video from Image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/image2video/{id}":{"get":{"operationId":"KlingImage2VideoQuerySingleTask","parameters":[{"description":"Task ID or external_task_id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingQueryTaskResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Image2Video Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/lip-sync":{"get":{"operationId":"KlingLipSyncQueryTaskList","parameters":[{"description":"Page number","in":"query","name":"pageNum","schema":{"default":1,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Data volume per page","in":"query","name":"pageSize","schema":{"default":30,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingLipSyncResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Lip-Sync Task List","tags":["API Nodes","Released"],"x-excluded":true},"post":{"operationId":"KlingCreateLipSyncVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingLipSyncRequest"}}},"description":"Create task for generating lip-sync video","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingLipSyncResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Lip-Sync Video","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/lip-sync/{id}":{"get":{"operationId":"KlingLipSyncQuerySingleTask","parameters":[{"description":"Task ID or external_task_id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingLipSyncResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Lip-Sync Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/motion-control":{"post":{"operationId":"KlingCreateMotionControl","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingMotionControlRequest"}}},"description":"Create task for generating motion control video","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingMotionControlResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Motion Control Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/motion-control/{id}":{"get":{"operationId":"KlingMotionControlQuerySingleTask","parameters":[{"description":"Task ID or external_task_id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingMotionControlResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Motion Control Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/omni-video":{"post":{"operationId":"KlingCreateOmniVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingOmniVideoRequest"}}},"description":"Create task for generating omni-video","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingQueryTaskResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Omni-Video Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/omni-video/{id}":{"get":{"operationId":"KlingOmniVideoQuerySingleTask","parameters":[{"description":"Task ID or External Task ID. Can query by either task_id (generated by system) or external_task_id (customized task ID)","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingQueryTaskResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Omni-Video Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/text2video":{"post":{"operationId":"KlingCreateVideoFromText","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingText2VideoRequest"}}},"description":"Create task for generating video from text","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingQueryTaskResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Create Video from Text","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/text2video/{id}":{"get":{"operationId":"KlingText2VideoQuerySingleTask","parameters":[{"description":"Task ID or external_task_id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingQueryTaskResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/video-extend":{"get":{"operationId":"KlingVideoExtendQueryTaskList","parameters":[{"description":"Page number","in":"query","name":"pageNum","schema":{"default":1,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Data volume per page","in":"query","name":"pageSize","schema":{"default":30,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoExtendResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Video-Extend Task List","tags":["API Nodes","Released"],"x-excluded":true},"post":{"operationId":"KlingExtendVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoExtendRequest"}}},"description":"Create task for extending video duration","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoExtendResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Extend Video Duration","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/kling/v1/videos/video-extend/{id}":{"get":{"operationId":"KlingVideoExtendQuerySingleTask","parameters":[{"description":"Task ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingVideoExtendResponse"}}},"description":"Successful response (Request successful)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KlingErrorResponse"}}},"description":"Server timeout"}},"summary":"KlingAI Query Single Video-Extend Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ltx/v1/image-to-video":{"post":{"description":"Transform a static image into a dynamic video using LTX Video AI models","operationId":"LtxCreateVideoFromImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LTXImage2VideoRequest"}}},"description":"Create video from image","required":true},"responses":{"200":{"content":{"video/mp4":{"schema":{"format":"binary","type":"string"}}},"description":"Video generated successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"summary":"LTX Video Generate Video from Image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/ltx/v1/text-to-video":{"post":{"description":"Generate a video from a text prompt using LTX Video AI models","operationId":"LtxCreateVideoFromText","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LTXText2VideoRequest"}}},"description":"Create video from text prompt","required":true},"responses":{"200":{"content":{"video/mp4":{"schema":{"format":"binary","type":"string"}}},"description":"Video generated successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"summary":"LTX Video Generate Video from Text","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/luma/generations":{"post":{"description":"Initiate a new generation with the provided prompt","operationId":"LumaCreateGeneration","requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"aspect_ratio":"16:9","keyframes":{"frame0":{"type":"image","url":"https://example.com/image.jpg"},"frame1":{"id":"123e4567-e89b-12d3-a456-426614174000","type":"generation"}},"loop":true,"prompt":"A serene lake surrounded by mountains at sunset"}}},"schema":{"$ref":"#/components/schemas/LumaGenerationRequest"}}},"description":"The generation request object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaGeneration"}}},"description":"Generation created"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaError"}}},"description":"Error"}},"summary":"Create a generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/luma/generations/image":{"post":{"description":"Generate an image with the provided prompt","operationId":"LumaGenerateImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaImageGenerationRequest"}}},"description":"The image generation request object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaGeneration"}}},"description":"Image generated"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaError"}}},"description":"Error"}},"summary":"Generate an image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/luma/generations/{id}":{"get":{"description":"Retrieve details of a specific generation by its ID","operationId":"LumaGetGeneration","parameters":[{"description":"The ID of the generation","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaGeneration"}}},"description":"Generation found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaError"}}},"description":"Error"}},"summary":"Get a generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/luma_2/generations":{"post":{"description":"Submit an image generation or edit job. Returns immediately with an opaque job ID to poll via GET /proxy/luma_2/generations/{id}.","operationId":"LumaAgentsCreateGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaAgentsGenerationRequest"}}},"description":"The generation request object","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaAgentsGeneration"}}},"description":"Generation accepted"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaAgentsError"}}},"description":"Error"}},"summary":"Create a Luma Agents generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/luma_2/generations/{generation_id}":{"get":{"description":"Poll for generation status and output. On completion, the response includes presigned URLs to download the generated images.","operationId":"LumaAgentsGetGeneration","parameters":[{"description":"The ID of the generation","in":"path","name":"generation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaAgentsGeneration"}}},"description":"Generation found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LumaAgentsError"}}},"description":"Error"}},"summary":"Get a Luma Agents generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/animations":{"post":{"description":"Create a new task to apply a specific animation action to a previously rigged character. Includes post-processing options.\n","operationId":"MeshyAnimationCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyAnimationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyAnimationCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create an Animation Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/animations/{task_id}":{"get":{"description":"Retrieve the status and result of an Animation task.","operationId":"MeshyAnimationGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyAnimationTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Animation Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/image-to-3d":{"post":{"description":"Create a new Image to 3D task. This task generates a 3D model from an image input.\n","operationId":"MeshyImageTo3DCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyImageTo3DRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyImageTo3DCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create an Image to 3D Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/image-to-3d/{task_id}":{"get":{"description":"Retrieve the status and result of an Image to 3D task.","operationId":"MeshyImageTo3DGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyImageTo3DTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Image to 3D Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/multi-image-to-3d":{"post":{"description":"Create a new Multi-Image to 3D task. This task generates a 3D model from 1 to 4 images of the same object from different angles.\nMesh generation uses Meshy-5 model, while texture generation supports Meshy-6-preview model.\n","operationId":"MeshyMultiImageTo3DCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyMultiImageTo3DRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyMultiImageTo3DCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create a Multi-Image to 3D Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/multi-image-to-3d/{task_id}":{"get":{"description":"Retrieve the status and result of a Multi-Image to 3D task.","operationId":"MeshyMultiImageTo3DGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyMultiImageTo3DTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Multi-Image to 3D Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/remesh":{"post":{"description":"Create a new remesh task to remesh and export an existing 3D model into various formats.\n","operationId":"MeshyRemeshCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRemeshRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRemeshCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create a Remesh Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/remesh/{task_id}":{"get":{"description":"Retrieve the status and result of a Remesh task.","operationId":"MeshyRemeshGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRemeshTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Remesh Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/retexture":{"post":{"description":"Create a new Retexture task to generate 3D texture from text or image inputs.\n","operationId":"MeshyRetextureCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRetextureRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRetextureCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create a Retexture Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/retexture/{task_id}":{"get":{"description":"Retrieve the status and result of a Retexture task.","operationId":"MeshyRetextureGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRetextureTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Retexture Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/rigging":{"post":{"description":"Create a new rigging task for a given 3D model. Upon successful completion, provides a rigged character in standard formats and optionally basic walking/running animations.\n","operationId":"MeshyRiggingCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRiggingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRiggingCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create a Rigging Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v1/rigging/{task_id}":{"get":{"description":"Retrieve the status and result of a Rigging task.","operationId":"MeshyRiggingGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyRiggingTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Rigging Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v2/text-to-3d":{"post":{"description":"Create a new Text to 3D Preview task. This task costs 20 credits for Meshy-6 models and 5 credits for other models.\n","operationId":"MeshyTextTo3DCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyTextTo3DRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyTextTo3DCreateResponse"}}},"description":"Task created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication failed"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Create a Text to 3D Preview Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/meshy/openapi/v2/text-to-3d/{task_id}":{"get":{"description":"Retrieve the status and result of a Text to 3D task.","operationId":"MeshyTextTo3DGetTask","parameters":[{"description":"The unique identifier of the task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshyTextTo3DTask"}}},"description":"Task retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Task not found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Get Text to 3D Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/minimax/files/retrieve":{"post":{"description":"Proxies a request to Minimax to get the download URL for a file","operationId":"RetrieveMinimaxFile","parameters":[{"description":"Unique identifier for the file, obtained from the generation response","in":"query","name":"file_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinimaxFileRetrieveResponse"}}},"description":"Successful response with file download URL"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or Minimax)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with Minimax)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (Minimax took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Retrieve download URL for a Minimax file","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/minimax/query/video_generation":{"get":{"description":"Proxies a request to Minimax to check the status of a video generation task","operationId":"GetMinimaxVideoGeneration","parameters":[{"description":"The task ID to be queried","in":"query","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinimaxTaskResultResponse"}}},"description":"Successful response with task status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or Minimax)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with Minimax)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (Minimax took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Query status of a Minimax video generation task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/minimax/video_generation":{"post":{"description":"Forwards video generation requests to Minimax's API and returns the task ID for asynchronous processing.","operationId":"MinimaxVideoGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinimaxVideoGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinimaxVideoGenerationResponse"}}},"description":"Successful response from Minimax proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded (either from proxy or Minimax)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with Minimax)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (Minimax took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to Minimax for video generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/moonvalley/prompts/image-to-video":{"post":{"operationId":"MoonvalleyImageToVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyImageToVideoRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyPromptResponse"}}},"description":"Prompt created"}},"summary":"Create Image to Video Prompt","tags":["API Nodes"],"x-excluded":true}},"/proxy/moonvalley/prompts/text-to-image":{"post":{"operationId":"MoonvalleyTextToImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyTextToImageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyPromptResponse"}}},"description":"Prompt created"}},"summary":"Create Text to Image Prompt","tags":["API Nodes"],"x-excluded":true}},"/proxy/moonvalley/prompts/text-to-video":{"post":{"operationId":"MoonvalleyTextToVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyTextToVideoRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyPromptResponse"}}},"description":"Prompt created"}},"summary":"Create Text to Video Prompt","tags":["API Nodes"],"x-excluded":true}},"/proxy/moonvalley/prompts/video-to-video":{"post":{"operationId":"MoonvalleyVideoToVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyVideoToVideoRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyPromptResponse"}}},"description":"Prompt created"}},"summary":"Create Video to Video Prompt","tags":["API Nodes"],"x-excluded":true}},"/proxy/moonvalley/prompts/video-to-video/resize":{"post":{"operationId":"MoonvalleyVideoToVideoResize","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyResizeVideoRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyPromptResponse"}}},"description":"Prompt created"}},"summary":"Resize a video","tags":["API Nodes"],"x-excluded":true}},"/proxy/moonvalley/prompts/{prompt_id}":{"get":{"operationId":"MoonvalleyGetPrompt","parameters":[{"in":"path","name":"prompt_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyPromptResponse"}}},"description":"Prompt details retrieved"}},"summary":"Get Prompt Details","tags":["API Nodes"],"x-excluded":true}},"/proxy/moonvalley/uploads":{"post":{"operationId":"MoonvalleyUpload","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MoonvalleyUploadFileRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoonvalleyUploadFileResponse"}}},"description":"File uploaded successfully"}},"summary":"Upload Files","tags":["API Nodes"],"x-excluded":true}},"/proxy/openai/images/edits":{"post":{"operationId":"OpenAIEditImage","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/OpenAIImageEditRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIImageGenerationResponse"}}},"description":"Image edited successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Edit an image using OpenAI's DALL-E model","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/openai/images/generations":{"post":{"operationId":"OpenAIGenerateImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIImageGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIImageGenerationResponse"}}},"description":"Image generated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Generate an image using OpenAI's models","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/openai/v1/responses":{"post":{"operationId":"CreateOpenAIResponse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAICreateResponse"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIResponse"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/OpenAIResponseStreamEvent"}}},"description":"OK"}},"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/openai/v1/responses/{id}":{"get":{"operationId":"GetOpenAIResponse","parameters":[{"description":"The ID of the response to retrieve.","in":"path","name":"id","required":true,"schema":{"example":"resp_677efb5139a88190b512bc3fef8e535d","type":"string"}},{"description":"Additional fields to include in the response. See the `include`\nparameter for Response creation above for more information.\n","in":"query","name":"include","schema":{"items":{"$ref":"#/components/schemas/Includable"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIResponse"}}},"description":"OK"}},"summary":"Retrieves a model response with the given ID.\n","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/openai/v1/videos":{"post":{"operationId":"OpenAICreateVideo","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/OpenAIVideoCreateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIVideoJob"}}},"description":"Video generation job created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a video using OpenAI's Sora model","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/openai/v1/videos/{video_id}":{"get":{"operationId":"OpenAIGetVideo","parameters":[{"description":"The identifier of the video to retrieve","in":"path","name":"video_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIVideoJob"}}},"description":"Video job details"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Video not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Retrieve a video","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/openai/v1/videos/{video_id}/content":{"get":{"operationId":"OpenAIDownloadVideoContent","parameters":[{"description":"The identifier of the video whose media to download","in":"path","name":"video_id","required":true,"schema":{"type":"string"}},{"description":"Which downloadable asset to return","in":"query","name":"variant","schema":{"type":"string"}}],"responses":{"200":{"content":{"video/mp4":{"schema":{"format":"binary","type":"string"}}},"description":"Video content stream"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Video not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Download video content","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/2.2/i2v":{"post":{"operationId":"PikaGenerate22I2vGenerate22I2vPost","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_2_2_i2v_generate_2_2_i2v_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate 2 2 I2V","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/2.2/pikaframes":{"post":{"operationId":"PikaGenerate22KeyframeGenerate22PikaframesPost","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_2_2_keyframe_generate_2_2_pikaframes_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate 2 2 Keyframe","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/2.2/pikascenes":{"post":{"operationId":"PikaGenerate22C2vGenerate22PikascenesPost","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_2_2_c2v_generate_2_2_pikascenes_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate 2 2 C2V","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/2.2/t2v":{"post":{"operationId":"PikaGenerate22T2vGenerate22T2vPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_2_2_t2v_generate_2_2_t2v_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate 2 2 T2V","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/pikadditions":{"post":{"operationId":"PikaGeneratePikadditionsGeneratePikadditionsPost","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_pikadditions_generate_pikadditions_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate Pikadditions","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/pikaffects":{"post":{"description":"Generate a video with a specific Pikaffect. Supported Pikaffects: Cake-ify, Crumble, Crush, Decapitate, Deflate, Dissolve, Explode, Eye-pop, Inflate, Levitate, Melt, Peel, Poke, Squish, Ta-da, Tear","operationId":"PikaGeneratePikaffectsGeneratePikaffectsPost","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_pikaffects_generate_pikaffects_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate Pikaffects","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/generate/pikaswaps":{"post":{"description":"Exactly one of `modifyRegionMask` and `modifyRegionRoi` must be provided.","operationId":"PikaGeneratePikaswapsGeneratePikaswapsPost","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PikaBody_generate_pikaswaps_generate_pikaswaps_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaGenerateResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Generate Pikaswaps","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pika/videos/{video_id}":{"get":{"operationId":"PikaGetVideoVideosVideoIdGet","parameters":[{"in":"path","name":"video_id","required":true,"schema":{"title":"Video Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaVideoResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PikaHTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Video","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pixverse/image/upload":{"post":{"operationId":"PixverseUploadImage","parameters":[{"$ref":"#/components/parameters/PixverseAiTraceId"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"image":{"format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseImageUploadResponse"}}},"description":"Image uploaded"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Upload an image to the server.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pixverse/video/img/generate":{"post":{"operationId":"PixverseGenerateImageVideo","parameters":[{"$ref":"#/components/parameters/PixverseAiTraceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseImageVideoRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseVideoResponse"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Generate video from image.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pixverse/video/result/{id}":{"get":{"operationId":"PixverseGetVideoResult","parameters":[{"$ref":"#/components/parameters/PixverseAiTraceId"},{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseVideoResultResponse"}}},"description":"Result fetched"}},"summary":"Get the result of a video generation.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pixverse/video/text/generate":{"post":{"operationId":"PixverseGenerateTextVideo","parameters":[{"$ref":"#/components/parameters/PixverseAiTraceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseTextVideoRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseVideoResponse"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Generate video from text prompt.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/pixverse/video/transition/generate":{"post":{"operationId":"PixverseGenerateTransitionVideo","parameters":[{"$ref":"#/components/parameters/PixverseAiTraceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseTransitionVideoRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixverseVideoResponse"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Generate transition video between two images.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/quiver/v1/svgs/generations":{"post":{"description":"Generate one or more SVGs from a text prompt using the Quiver AI Arrow model.","operationId":"QuiverTextToSVG","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuiverTextToSVGRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuiverSVGResponse"}}},"description":"SVG generated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required - Insufficient credits"},"429":{"description":"Too Many Requests - Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Generate SVG from text using Quiver AI","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/quiver/v1/svgs/vectorizations":{"post":{"description":"Vectorize an image into one or more SVGs using the Quiver AI Arrow model.","operationId":"QuiverImageToSVG","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuiverImageToSVGRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuiverSVGResponse"}}},"description":"SVG vectorization completed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required - Insufficient credits"},"429":{"description":"Too Many Requests - Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Convert image to SVG using Quiver AI","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/image_generation":{"post":{"description":"Forwards image generation requests to Recraft's API and returns the generated images.","operationId":"RecraftImageGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftImageGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftImageGenerationResponse"}}},"description":"Successful response from Recraft proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request (invalid input to proxy)"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Gateway (error communicating with Recraft)"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Gateway Timeout (Recraft took too long to respond)"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to Recraft for image generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/creativeUpscale":{"post":{"operationId":"RecraftCreativeUpscale","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RecraftProcessImageRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftProcessImageResponse"}}},"description":"OK"}},"summary":"Creative Upscale","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/crispUpscale":{"post":{"operationId":"RecraftCrispUpscale","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Image file to process","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftImageGenerationResponse"}}},"description":"Background removed successfully"},"400":{"description":"Bad request - Invalid parameters or file"},"401":{"description":"Unauthorized - Invalid or missing API token"}},"security":[],"summary":"Upscale an image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/imageToImage":{"post":{"operationId":"RecraftImageToImage","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RecraftImageToImageRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftGenerateImageResponse"}}},"description":"OK"}},"summary":"Generate image from image and prompt","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/inpaint":{"post":{"operationId":"RecraftInpaintImage","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RecraftTransformImageWithMaskRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftGenerateImageResponse"}}},"description":"OK"}},"summary":"Inpaint Image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/removeBackground":{"post":{"operationId":"RecraftRemoveBackground","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Image file to process","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"image":{"properties":{"url":{"description":"URL of the processed image","format":"uri","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Background removed successfully"},"400":{"description":"Bad request - Invalid parameters or file"},"401":{"description":"Unauthorized - Invalid or missing API token"}},"security":[],"summary":"Remove background from an image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/replaceBackground":{"post":{"operationId":"RecraftReplaceBackground","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RecraftTransformImageWithMaskRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftGenerateImageResponse"}}},"description":"OK"}},"summary":"Replace Background","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/images/vectorize":{"post":{"operationId":"RecraftVectorize","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Image file to process","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftImageGenerationResponse"}}},"description":"Background removed successfully"},"400":{"description":"Bad request - Invalid parameters or file"},"401":{"description":"Unauthorized - Invalid or missing API token"}},"security":[],"summary":"Vectorize an image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/recraft/styles":{"post":{"description":"Upload a set of images to create a style reference.","operationId":"RecraftCreateStyle","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RecraftCreateStyleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecraftCreateStyleResponse"}}},"description":"OK"}},"summary":"Create Style","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/reve/v1/image/create":{"post":{"description":"Forwards image creation requests to the Reve API and returns the generated image.","operationId":"ReveImageCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReveImageCreateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReveImageResponse"}}},"description":"Successful response from Reve proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Generate an image using Reve","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/reve/v1/image/edit":{"post":{"description":"Forwards image editing requests to the Reve API with an edit instruction and reference image.","operationId":"ReveImageEdit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReveImageEditRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReveImageResponse"}}},"description":"Successful response from Reve proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Edit an image using Reve","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/reve/v1/image/remix":{"post":{"description":"Forwards image remix requests to the Reve API with reference images and a text prompt.","operationId":"ReveImageRemix","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReveImageRemixRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReveImageResponse"}}},"description":"Successful response from Reve proxy"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Remix images using Reve","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/rodin/api/v2/download":{"post":{"operationId":"RodinDownload","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Rodin3DDownloadRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rodin3DDownloadResponse"}}},"description":"Get the download list for the Rodin 3D Assets."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get rodin 3D Assets download list.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/rodin/api/v2/rodin":{"post":{"operationId":"RodinGenerate3DAsset","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Rodin3DGenerateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rodin3DGenerateResponse"}}},"description":"3D generate Task submitted successfully."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Create 3D generate Task using Rodin API.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/rodin/api/v2/status":{"post":{"operationId":"RodinCheckStatus","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Rodin3DCheckStatusRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rodin3DCheckStatusResponse"}}},"description":"Get the status of the 3D Assets generation."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Check Rodin 3D Generate Status.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/runway/image_to_video":{"post":{"description":"Converts an image to a video using Runway's API","operationId":"RunwayImageToVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunwayImageToVideoRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunwayImageToVideoResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Runway Image to Video Generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/runway/tasks/{task_id}":{"get":{"description":"Get the status and output of a Runway task","operationId":"RunwayGetTaskStatus","parameters":[{"description":"ID of the task to check","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunwayTaskStatusResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get Runway Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/runway/text_to_image":{"post":{"description":"Generates an image from text using Runway's API","operationId":"RunwayTextToImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunwayTextToImageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunwayTextToImageResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Runway Text to Image Generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/seedance/assets":{"get":{"description":"Fans out to BytePlus ListAssets across the caller's completed verification groups, denormalizes the group label into each row, and returns a single flat list. Result is post-filtered by asset_type. Optional group_id narrows to one group. Hard caps: 5 pages × 100 assets per group, 1000 total assets.\n","operationId":"SeedanceListUserAssets","parameters":[{"description":"Asset type to return.","in":"query","name":"asset_type","required":true,"schema":{"enum":["Image","Video"],"type":"string"}},{"description":"Narrow the listing to one group. Caller must own it.","in":"query","name":"group_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceListUserAssetsResponse"}}},"description":"Assets owned by the caller"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"List the caller's assets across all owned groups","tags":["API Nodes","Released"],"x-excluded":true},"post":{"operationId":"SeedanceCreateAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceCreateAssetRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceCreateAssetResponse"}}},"description":"Asset creation accepted (asynchronous — poll seedanceGetAsset)"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/seedance/assets/{asset_id}":{"get":{"operationId":"SeedanceGetAsset","parameters":[{"description":"BytePlus-issued asset id returned by seedanceCreateAsset","in":"path","name":"asset_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceGetAssetResponse"}}},"description":"Asset state"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/seedance/virtual-library/assets":{"post":{"operationId":"SeedanceVirtualLibraryCreateAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceVirtualLibraryCreateAssetRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceVirtualLibraryCreateAssetResponse"}}},"description":"Asset creation accepted (asynchronous — poll seedanceGetAsset)"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/seedance/visual-validate/groups":{"get":{"description":"Returns the caller's completed visual-validation groups (real-person H5 verification). Used to power the group selector in client UIs. Excludes virtual-library (AIGC) groups, which are not part of the public API surface.\n","operationId":"SeedanceListVisualValidationGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceListVisualValidationGroupsResponse"}}},"description":"Visual-validation groups owned by the caller"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"List the caller's completed visual-validation groups","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/seedance/visual-validate/sessions":{"post":{"operationId":"SeedanceCreateVisualValidateSession","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceCreateVisualValidateSessionRequest"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceCreateVisualValidateSessionResponse"}}},"description":"Verification session created"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/seedance/visual-validate/sessions/{session_id}":{"get":{"operationId":"SeedanceGetVisualValidateSession","parameters":[{"description":"The session id returned by seedanceCreateVisualValidateSession","in":"path","name":"session_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedanceGetVisualValidateSessionResponse"}}},"description":"Session state"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/sonilo/t2m/generate":{"post":{"description":"Generate music from a text prompt using Sonilo text-to-music AI.\nRequires a prompt describing the desired music. Duration is optional and will be inferred if not provided.\nReturns a streaming NDJSON response with duration, titles, audio chunks, and completion events.\n","operationId":"SoniloTextToMusicGenerate","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SoniloTextToMusicRequest"}}},"required":true},"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/SoniloStreamEvent"}}},"description":"OK - Streaming NDJSON response with audio generation events"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Unauthorized - Invalid or missing API key"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Generate music from text prompt","tags":["Sonilo","Proxy"]}},"/proxy/sonilo/v2m/generate":{"post":{"description":"Generate music from a video using Sonilo video-to-music AI.\nAccepts either a video file upload or a video URL, with an optional prompt.\nReturns a streaming NDJSON response with duration, titles, audio chunks, and completion events.\nMax video duration: 6 minutes. Max upload size: 1024MB.\n","operationId":"SoniloVideoToMusicGenerate","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SoniloVideoToMusicRequest"}}},"required":true},"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/SoniloStreamEvent"}}},"description":"OK - Streaming NDJSON response with audio generation events"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Unauthorized - Invalid or missing API key"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Payload Too Large - Video exceeds size limit"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoniloErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Generate music from video","tags":["Sonilo","Proxy"]}},"/proxy/stability/v2beta/audio/stable-audio-2/audio-to-audio":{"post":{"operationId":"StableAudio25AudioToAudio","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StableAudio25AudioToAudioRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StableAudio25AudioResponse"}}},"description":"Successful response from Stable Audio proxy"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to Stable Audio for audio-to-audio transformation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/stability/v2beta/audio/stable-audio-2/inpaint":{"post":{"operationId":"StableAudio25Inpaint","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StableAudio25InpaintRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StableAudio25AudioResponse"}}},"description":"Successful response from Stable Audio proxy"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to Stable Audio 2.5 for audio inpainting","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/stability/v2beta/audio/stable-audio-2/text-to-audio":{"post":{"operationId":"StableAudio25TextToAudio","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StableAudio25TextToAudioRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StableAudio25AudioResponse"}}},"description":"Successful response from Stable Audio proxy"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Proxy request to Stable Audio 2.5 for text-to-audio generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/stability/v2beta/results/{id}":{"get":{"description":"Get the result of a generation","operationId":"StabilityGetResult","parameters":[{"description":"The ID of the generation result to retrieve.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Set to image/* to receive image bytes.","in":"header","name":"Accept","schema":{"default":"image/*","type":"string"}}],"responses":{"200":{"content":{"application/json; type=image/jpeg":{"schema":{"properties":{"finish_reason":{"description":"The reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\n  policy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"}},"application/json; type=image/png":{"schema":{"properties":{"finish_reason":{"description":"The reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\n  policy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"}},"application/json; type=image/webp":{"schema":{"properties":{"finish_reason":{"description":"The reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\n  policy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"}},"image/jpeg":{"schema":{"format":"binary","type":"string"}},"image/png":{"example":"The bytes of the generated png","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/webp":{"example":"The bytes of the generated webp","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}}},"description":"The generated image as JPEG bytes."},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityGetResultResponse_202"}}},"description":"The generation is still in progress."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityError"}}},"description":"Invalid result ID."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityError"}}},"description":"Result not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityError"}}},"description":"An internal error occurred. If the problem persists [contact support](https://kb.stability.ai/knowledge-base/kb-tickets/new)."}},"summary":"Get Result","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/stability/v2beta/stable-image/generate/sd3":{"post":{"description":"Generate using Stable Diffusion 3.5 models, Stability AI latest base model:\n\n- **Stable Diffusion 3.5 Large**: At 8 billion parameters, with superior quality and\n\n\n\n  prompt adherence, this base model is the most powerful in the Stable Diffusion\n  family. This model is ideal for professional use cases at 1 megapixel resolution.\n\n- **Stable Diffusion 3.5 Large Turbo**: A distilled version of Stable Diffusion 3.5 Large.\n\n\n\n  SD3.5 Large Turbo generates high-quality images with exceptional prompt adherence\n  in just 4 steps, making it considerably faster than Stable Diffusion 3.5 Large.\n\n- **Stable Diffusion 3.5 Medium**: With 2.5 billion parameters, the model delivers an\n\n\n\n  optimal balance between prompt accuracy and image quality, making it an efficient\n  choice for fast high-performance image generation.\n\nRead more about the model capabilities [here](https://stability.ai/news/introducing-stable-diffusion-3-5).\n\nAs of April 17, 2025, we have deprecated the Stable Diffusion 3.0 APIs and will be automatically\nre-routing calls to Stable Diffusion 3.0 models to Stable Diffusion 3.5 APIs at no extra cost.\nYou can read more in the [release notes](/docs/release-notes#api-deprecation-notice).\n\n### Try it out\nGrab your [API key](https://platform.stability.ai/account/keys) and head over to [![Open Google Colab](https://platform.stability.ai/svg/google-colab.svg)](https://colab.research.google.com/github/stability-ai/stability-sdk/blob/main/nbs/SD3_API.ipynb)\n\n### How to use\nPlease invoke this endpoint with a `POST` request.\n\nThe headers of the request must include an API key in the `authorization` field. The body of the request must be\n`multipart/form-data`.  The accept header should be set to one of the following:\n- `image/*` to receive the image in the format specified by the `output_format` parameter.\n- `application/json` to receive the image encoded as base64 in a JSON response.\n\n#### **Generating with a prompt**\nCommonly referred to as **text-to-image**, this mode generates an image from text alone. While the only required\nparameter is the `prompt`, it also supports an `aspect_ratio` parameter which can be used to control the\naspect ratio of the generated image.\n\n#### **Generating with a prompt *and* an image**\nCommonly referred to as **image-to-image**, this mode also generates an image from text but uses an existing image as the\nstarting point. The required parameters are:\n- `prompt` - text to generate the image from\n- `image` - the image to use as the starting point for the generation\n- `strength` - controls how much influence the `image` parameter has on the output image\n- `mode` - must be set to `image-to-image`\n\n\u003e **Note:** maximum request size is 10MiB.\n\n#### **Optional Parameters:**\nBoth modes support the following optional parameters:\n- `model` - the model to use (SD3.5 Large, SD3.5 Large Turbo, SD3.5 Medium)\n- `output_format` - the the format of the output image\n- `seed` - the randomness seed to use for the generation\n- `negative_prompt` - keywords of what you **do not** wish to see in the output image\n- `cfg_scale` - controls how strictly the diffusion process adheres to the prompt text\n- `style_preset` - guides the image model towards a particular style\n\n\u003e **Note:** for more details about these parameters please see the request schema below.\n\n### Output\nThe resolution of the generated image will be 1MP. The default resolution is 1024x1024.\n\n### Credits\n- **SD 3.5 Large**: Flat rate of 6.5 credits per successful generation.\n- **SD 3.5 Large Turbo**: Flat rate of 4 credits per successful generation.\n- **SD 3.5 Medium**: Flat rate of 3.5 credits per successful generation.\n\nAs always, you will not be charged for failed generations.","operationId":"StabilityImageGenrationSD3","parameters":[{"in":"header","name":"authorization","required":true,"schema":{"description":"Your [Stability API key](https://platform.stability.ai/account/keys), used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.","minLength":1,"type":"string"}},{"in":"header","name":"content-type","required":true,"schema":{"description":"The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.","example":"multipart/form-data","minLength":1,"type":"string"}},{"in":"header","name":"accept","schema":{"default":"image/*","description":"Specify `image/*` to receive the bytes of the image directly. Otherwise specify `application/json` to receive the image as base64 encoded JSON.","enum":["image/*","application/json"],"type":"string"}},{"in":"header","name":"stability-client-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientID"}},{"in":"header","name":"stability-client-user-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientUserID"}},{"in":"header","name":"stability-client-version","schema":{"$ref":"#/components/schemas/StabilityStabilityClientVersion"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StabilityImageGenerationSD3_Request"}}}},"responses":{"200":{"content":{"application/json; type=image/jpeg":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_200"}},"application/json; type=image/png":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_200"}},"image/jpeg":{"example":"The bytes of the generated jpeg","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/png":{"example":"The bytes of the generated png","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}}},"description":"Generation was successful.","headers":{"content-type":{"description":"The format of the generated image.\n\n To receive the bytes of the image directly, specify `image/*` in the accept header. To receive the bytes base64 encoded inside of a JSON payload, specify `application/json`.","examples":{"jpeg":{"description":"raw bytes","value":"image/jpeg"},"jpegJSON":{"description":"base64 encoded","value":"application/json; type=image/jpeg"},"png":{"description":"raw bytes","value":"image/png"},"pngJSON":{"description":"base64 encoded","value":"application/json; type=image/png"}},"schema":{"type":"string"}},"finish-reason":{"description":"Indicates the reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\npolicy and has been blurred as a result.\n\n\u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `finish_reason`.","schema":{"enum":["SUCCESS","CONTENT_FILTERED"],"type":"string"}},"seed":{"description":"The seed used as random noise for this generation.\n\n\u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `seed`.","example":"343940597","schema":{"type":"string"}},"x-request-id":{"description":"A unique identifier for this request.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_400"}}},"description":"Invalid parameter(s), see the `errors` field for details."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityContentModerationResponse"}}},"description":"Your request was flagged by our content moderation system."},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_413"}}},"description":"Your request was larger than 10MiB."},"422":{"content":{"application/json":{"examples":{"Invalid Language":{"value":{"errors":["English is the only supported language for this service."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"invalid_language"}},"Public Figure Detected":{"value":{"errors":["Our system detected the likeness of a public figure in your image. To comply with our guidelines, this request cannot be processed. Please upload a different image."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"public_figure"}}},"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_422"}}},"description":"Your request was well-formed, but rejected. See the `errors` field for details."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_429"}}},"description":"You have made more than 150 requests in 10 seconds."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationSD3_Response_500"}}},"description":"An internal error occurred. If the problem persists [contact support](https://kb.stability.ai/knowledge-base/kb-tickets/new)."}},"summary":"Stable Diffusion 3.5","tags":["API Nodes","Released"],"x-codeSamples":[{"label":"Python","lang":"python","source":"import requests\n\nresponse = requests.post(\n    f\"https://api.stability.ai/v2beta/stable-image/generate/sd3\",\n    headers={\n        \"authorization\": f\"Bearer sk-MYAPIKEY\",\n        \"accept\": \"image/*\"\n    },\n    files={\"none\": ''},\n    data={\n        \"prompt\": \"Lighthouse on a cliff overlooking the ocean\",\n        \"output_format\": \"jpeg\",\n    },\n)\n\nif response.status_code == 200:\n    with open(\"./lighthouse.jpeg\", 'wb') as file:\n        file.write(response.content)\nelse:\n    raise Exception(str(response.json()))"},{"label":"JavaScript","lang":"javascript","source":"import fs from \"node:fs\";\nimport axios from \"axios\";\nimport FormData from \"form-data\";\n\nconst payload = {\n  prompt: \"Lighthouse on a cliff overlooking the ocean\",\n  output_format: \"jpeg\"\n};\n\nconst response = await axios.postForm(\n  `https://api.stability.ai/v2beta/stable-image/generate/sd3`,\n  axios.toFormData(payload, new FormData()),\n  {\n    validateStatus: undefined,\n    responseType: \"arraybuffer\",\n    headers: { \n      Authorization: `Bearer sk-MYAPIKEY`, \n      Accept: \"image/*\" \n    },\n  },\n);\n\nif(response.status === 200) {\n  fs.writeFileSync(\"./lighthouse.jpeg\", Buffer.from(response.data));\n} else {\n  throw new Error(`${response.status}: ${response.data.toString()}`);\n}"},{"label":"cURL","lang":"terminal","source":"curl -f -sS \"https://api.stability.ai/v2beta/stable-image/generate/sd3\" \\\n\n\n\n\n\n\n  -H \"authorization: Bearer sk-MYAPIKEY\" \\\n  -H \"accept: image/*\" \\\n  -F prompt=\"Lighthouse on a cliff overlooking the ocean\" \\\n  -F output_format=\"jpeg\" \\\n  -o \"./lighthouse.jpeg\""}],"x-excluded":true}},"/proxy/stability/v2beta/stable-image/generate/ultra":{"post":{"description":"Our most advanced text to image generation service, Stable Image Ultra creates the highest quality images with unprecedented prompt understanding. Ultra excels in typography, complex compositions, dynamic lighting, vibrant hues, and overall cohesion and structure of an art piece. Made from the most advanced models, including Stable Diffusion 3.5, Ultra offers the best of the Stable Diffusion ecosystem. ### Try it out Grab your [API key](https://platform.stability.ai/account/keys) and head over to [![Open Google Colab](https://platform.stability.ai/svg/google-colab.svg)](https://colab.research.google.com/github/stability-ai/stability-sdk/blob/main/nbs/Stable_Image_API_Public.ipynb#scrollTo=yXhs626oZdr1) ### How to use Please invoke this endpoint with a `POST` request. The headers of the request must include an API key in the `authorization` field. The body of the request must be `multipart/form-data`.  The accept header should be set to one of the following: - `image/*` to receive the image in the format specified by the `output_format` parameter. - `application/json` to receive the image in the format specified by the `output_format` parameter, but encoded to base64 in a JSON response. The only required parameter is the `prompt` field, which should contain the text prompt for the image generation. The body of the request should include: - `prompt` - text to generate the image from The body may optionally include: - `image` - the image to use as the starting point for the generation - `strength` - controls how much influence the `image` parameter has on the output image - `aspect_ratio` - the aspect ratio of the output image - `negative_prompt` - keywords of what you **do not** wish to see in the output image - `seed` - the randomness seed to use for the generation - `output_format` - the the format of the output image \u003e **Note:** for the full list of optional parameters, please see the request schema below. ### Output The resolution of the generated image will be 1 megapixel. The default resolution is 1024x1024. ### Credits The Ultra service uses 8 credits per successful result. You will not be charged for failed results.","operationId":"StabilityImageGenrationUltra","parameters":[{"in":"header","name":"authorization","required":true,"schema":{"description":"Your [Stability API key](https://platform.stability.ai/account/keys), used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.","minLength":1,"type":"string"}},{"in":"header","name":"content-type","required":true,"schema":{"description":"The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.","example":"multipart/form-data","minLength":1,"type":"string"}},{"in":"header","name":"accept","schema":{"default":"image/*","description":"Specify `image/*` to receive the bytes of the image directly. Otherwise specify `application/json` to receive the image as base64 encoded JSON.","enum":["image/*","application/json"],"type":"string"}},{"in":"header","name":"stability-client-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientID"}},{"in":"header","name":"stability-client-user-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientUserID"}},{"in":"header","name":"stability-client-version","schema":{"$ref":"#/components/schemas/StabilityStabilityClientVersion"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"aspect_ratio":{"default":"1:1","description":"Controls the aspect ratio of the generated image.","enum":["21:9","16:9","3:2","5:4","1:1","4:5","2:3","9:16","9:21"],"type":"string"},"image":{"description":"The image to use as the starting point for the generation. \u003e **Important:** The `strength` parameter is required when `image` is provided. Supported Formats: - jpeg - png - webp Validation Rules: - Width must be between 64 and 16,384 pixels - Height must be between 64 and 16,384 pixels - Total pixel count must be at least 4,096 pixels","example":"./some/image.png","format":"binary","type":"string"},"negative_prompt":{"description":"A blurb of text describing what you **do not** wish to see in the output image. This is an advanced feature.","maxLength":10000,"type":"string"},"output_format":{"default":"png","description":"Dictates the `content-type` of the generated image.","enum":["jpeg","png","webp"],"type":"string"},"prompt":{"description":"What you wish to see in the output image. A strong, descriptive prompt that clearly defines elements, colors, and subjects will lead to better results. To control the weight of a given word use the format `(word:weight)`, where `word` is the word you'd like to control the weight of and `weight` is a value between 0 and 1. For example: `The sky was a crisp (blue:0.3) and (green:0.8)` would convey a sky that was blue and green, but more green than blue.","maxLength":10000,"minLength":1,"type":"string"},"seed":{"default":0,"description":"A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass `0` to use a random seed.)","maximum":4294967294,"minimum":0,"type":"number"},"strength":{"description":"Sometimes referred to as _denoising_, this parameter controls how much influence the \n`image` parameter has on the generated image.  A value of 0 would yield an image that \nis identical to the input.  A value of 1 would be as if you passed in no image at all.\n\n\u003e **Important:** This parameter is required when `image` is provided.","maximum":1,"minimum":0,"type":"number"},"style_preset":{"description":"Guides the image model towards a particular style.","enum":["enhance","anime","photographic","digital-art","comic-book","fantasy-art","line-art","analog-film","neon-punk","isometric","low-poly","origami","modeling-compound","cinematic","3d-model","pixel-art","tile-texture"],"type":"string"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json; type=image/jpeg":{"schema":{"properties":{"finish_reason":{"description":"The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"}},"application/json; type=image/png":{"schema":{"properties":{"finish_reason":{"description":"The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"}},"application/json; type=image/webp":{"schema":{"properties":{"finish_reason":{"description":"The reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result.","enum":["SUCCESS","CONTENT_FILTERED"],"example":"SUCCESS","type":"string"},"image":{"description":"The generated image, encoded to base64.","example":"AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1...","type":"string"},"seed":{"default":0,"description":"The seed used as random noise for this generation.","example":343940597,"maximum":4294967294,"minimum":0,"type":"number"}},"required":["image","finish_reason"],"type":"object"}},"image/jpeg":{"example":"The bytes of the generated jpeg","schema":{"description":"The bytes of the generated image.\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/png":{"example":"The bytes of the generated png","schema":{"description":"The bytes of the generated image.\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/webp":{"example":"The bytes of the generated webp","schema":{"description":"The bytes of the generated image.\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}}},"description":"Generation was successful.","headers":{"content-type":{"description":"The format of the generated image.\n  To receive the bytes of the image directly, specify `image/*` in the accept header. To receive the bytes base64 encoded inside of a JSON payload, specify `application/json`.","examples":{"jpeg":{"description":"raw bytes","value":"image/jpeg"},"jpegJSON":{"description":"base64 encoded","value":"application/json; type=image/jpeg"},"png":{"description":"raw bytes","value":"image/png"},"pngJSON":{"description":"base64 encoded","value":"application/json; type=image/png"},"webp":{"description":"raw bytes","value":"image/webp"},"webpJSON":{"description":"base64 encoded","value":"application/json; type=image/webp"}},"schema":{"type":"string"}},"finish-reason":{"description":"Indicates the reason the generation finished. - `SUCCESS` = successful generation. - `CONTENT_FILTERED` = successful generation, however the output violated our content moderation policy and has been blurred as a result. \u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `finish_reason`.","schema":{"enum":["SUCCESS","CONTENT_FILTERED"],"type":"string"}},"seed":{"description":"The seed used as random noise for this generation. \u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `seed`.","example":"343940597","schema":{"type":"string"}},"x-request-id":{"description":"A unique identifier for this request.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"}}},"description":"Invalid parameter(s), see the `errors` field for details."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityContentModerationResponse"}}},"description":"Your request was flagged by our content moderation system."},"413":{"content":{"application/json":{"schema":{"example":{"errors":["body: payloads cannot be larger than 10MiB in size"],"id":"4212a4b66fbe1cedca4bf2133d35dca5","name":"payload_too_large"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"}}},"description":"Your request was larger than 10MiB."},"422":{"content":{"application/json":{"examples":{"Invalid Language":{"value":{"errors":["English is the only supported language for this service."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"invalid_language"}},"Public Figure Detected":{"value":{"errors":["Our system detected the likeness of a public figure in your image. To comply with our guidelines, this request cannot be processed. Please upload a different image."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"public_figure"}}},"schema":{"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"}}},"description":"Your request was well-formed, but rejected. See the `errors` field for details."},"429":{"content":{"application/json":{"schema":{"example":{"errors":["You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."],"id":"rate_limit_exceeded","name":"rate_limit_exceeded"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"}}},"description":"You have made more than 150 requests in 10 seconds."},"500":{"content":{"application/json":{"schema":{"example":{"errors":["An unexpected server error has occurred, please try again later."],"id":"2a1b2d4eafe2bc6ab4cd4d5c6133f513","name":"internal_error"},"properties":{"errors":{"description":"One or more error messages indicating what went wrong.","example":["some-field: is required"],"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"description":"A unique identifier associated with this error. Please include this in any [support tickets](https://kb.stability.ai/knowledge-base/kb-tickets/new) you file, as it will greatly assist us in diagnosing the root cause of the problem.","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","minLength":1,"type":"string"},"name":{"description":"Short-hand name for an error, useful for discriminating between errors with the same status code.","example":"bad_request","minLength":1,"type":"string"}},"required":["id","name","errors"],"type":"object"}}},"description":"An internal error occurred. If the problem persists [contact support](https://kb.stability.ai/knowledge-base/kb-tickets/new)."}},"summary":"Stable Image Ultra","tags":["API Nodes","Released"],"x-codeSamples":[{"label":"Python","lang":"python","source":"import requests\nresponse = requests.post(\n    f\"https://api.stability.ai/v2beta/stable-image/generate/ultra\",\n    headers={\n        \"authorization\": f\"Bearer sk-MYAPIKEY\",\n        \"accept\": \"image/*\"\n    },\n    files={\"none\": ''},\n    data={\n        \"prompt\": \"Lighthouse on a cliff overlooking the ocean\",\n        \"output_format\": \"webp\",\n    },\n)\nif response.status_code == 200:\n    with open(\"./lighthouse.webp\", 'wb') as file:\n        file.write(response.content)\nelse:\n    raise Exception(str(response.json()))"},{"label":"JavaScript","lang":"javascript","source":"import fs from \"node:fs\";\nimport axios from \"axios\";\nimport FormData from \"form-data\";\n\nconst payload = {\n  prompt: \"Lighthouse on a cliff overlooking the ocean\",\n  output_format: \"webp\"\n};\n\nconst response = await axios.postForm(\n  `https://api.stability.ai/v2beta/stable-image/generate/ultra`,\n  axios.toFormData(payload, new FormData()),\n  {\n    validateStatus: undefined,\n    responseType: \"arraybuffer\",\n    headers: { \n      Authorization: `Bearer sk-MYAPIKEY`, \n      Accept: \"image/*\" \n    },\n  },\n);\n\nif(response.status === 200) {\n  fs.writeFileSync(\"./lighthouse.webp\", Buffer.from(response.data));\n} else {\n  throw new Error(`${response.status}: ${response.data.toString()}`);\n}"},{"label":"cURL","lang":"terminal","source":"curl -f -sS \"https://api.stability.ai/v2beta/stable-image/generate/ultra\" \\\n  -H \"authorization: Bearer sk-MYAPIKEY\" \\\n  -H \"accept: image/*\" \\\n  -F prompt=\"Lighthouse on a cliff overlooking the ocean\" \\\n  -F output_format=\"webp\" \\\n  -o \"./lighthouse.webp\""}],"x-excluded":true}},"/proxy/stability/v2beta/stable-image/upscale/conservative":{"post":{"description":"Takes images between 64x64 and 1 megapixel and upscales them all the way to 4K resolution. Put more generally, it can upscale images ~20-40x times while preserving all aspects. Conservative Upscale minimizes alterations to the image and should not be used to reimagine an image.\n\n### Try it out\nGrab your [API key](https://platform.stability.ai/account/keys) and head over to [![Open Google Colab](https://platform.stability.ai/svg/google-colab.svg)](https://colab.research.google.com/github/stability-ai/stability-sdk/blob/main/nbs/Stable_Image_API_Public.ipynb#scrollTo=t1Q4w2uvvza0)\n\n### How to use\n\nPlease invoke this endpoint with a `POST` request.\n\nThe headers of the request must include an API key in the `authorization` field. The body of the request must be\n`multipart/form-data`, and the `accept` header should be set to one of the following:\n\n\n\n  - `image/*` to receive the image in the format specified by the `output_format` parameter.\n  - `application/json` to receive the image encoded as base64 in a JSON response.\n\nThe body of the request must include:\n- `image`\n- `prompt`\n\nOptionally, the body of the request may also include:\n- `negative_prompt`\n- `seed`\n- `output_format`\n- `creativity`\n\n\u003e **Note:** for more details about these parameters please see the request schema below.\n\n### Output\nThe resolution of the generated image will be 4 megapixels.\n\n### Credits\nFlat rate of 25 credits per successful generation.  You will not be charged for failed generations.","operationId":"StabilityImageGenrationUpscaleConservative","parameters":[{"in":"header","name":"authorization","required":true,"schema":{"description":"Your [Stability API key](https://platform.stability.ai/account/keys), used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.","minLength":1,"type":"string"}},{"in":"header","name":"content-type","required":true,"schema":{"description":"The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.","example":"multipart/form-data","minLength":1,"type":"string"}},{"in":"header","name":"accept","schema":{"default":"image/*","description":"Specify `image/*` to receive the bytes of the image directly. Otherwise specify `application/json` to receive the image as base64 encoded JSON.","enum":["image/*","application/json"],"type":"string"}},{"in":"header","name":"stability-client-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientID"}},{"in":"header","name":"stability-client-user-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientUserID"}},{"in":"header","name":"stability-client-version","schema":{"$ref":"#/components/schemas/StabilityStabilityClientVersion"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Request"}}}},"responses":{"200":{"content":{"application/json; type=image/jpeg":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_200"}},"application/json; type=image/png":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_200"}},"application/json; type=image/webp":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_200"}},"image/jpeg":{"example":"The bytes of the generated jpeg","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/png":{"example":"The bytes of the generated png","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/webp":{"example":"The bytes of the generated webp","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}}},"description":"Upscale was successful.","headers":{"content-type":{"description":"The format of the generated image.\n\n To receive the bytes of the image directly, specify `image/*` in the accept header. To receive the bytes base64 encoded inside of a JSON payload, specify `application/json`.","examples":{"jpeg":{"description":"raw bytes","value":"image/jpeg"},"jpegJSON":{"description":"base64 encoded","value":"application/json; type=image/jpeg"},"png":{"description":"raw bytes","value":"image/png"},"pngJSON":{"description":"base64 encoded","value":"application/json; type=image/png"},"webp":{"description":"raw bytes","value":"image/webp"},"webpJSON":{"description":"base64 encoded","value":"application/json; type=image/webp"}},"schema":{"type":"string"}},"finish-reason":{"description":"Indicates the reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\npolicy and has been blurred as a result.\n\n\u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `finish_reason`.","schema":{"enum":["SUCCESS","CONTENT_FILTERED"],"type":"string"}},"seed":{"description":"The seed used as random noise for this generation.\n\n\u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `seed`.","example":"343940597","schema":{"type":"string"}},"x-request-id":{"description":"A unique identifier for this request.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_400"}}},"description":"Invalid parameter(s), see the `errors` field for details."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityContentModerationResponse"}}},"description":"Your request was flagged by our content moderation system."},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_413"}}},"description":"Your request was larger than 10MiB."},"422":{"content":{"application/json":{"examples":{"Invalid Language":{"value":{"errors":["English is the only supported language for this service."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"invalid_language"}},"Public Figure Detected":{"value":{"errors":["Our system detected the likeness of a public figure in your image. To comply with our guidelines, this request cannot be processed. Please upload a different image."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"public_figure"}}},"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_422"}}},"description":"Your request was well-formed, but rejected. See the `errors` field for details."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_429"}}},"description":"You have made more than 150 requests in 10 seconds."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleConservative_Response_500"}}},"description":"An internal error occurred. If the problem persists [contact support](https://kb.stability.ai/knowledge-base/kb-tickets/new)."}},"summary":"Conservative","tags":["API Nodes","Released"],"x-codeSamples":[{"label":"Python","lang":"python","source":"import requests\n\nresponse = requests.post(\n    f\"https://api.stability.ai/v2beta/stable-image/upscale/conservative\",\n    headers={\n        \"authorization\": f\"Bearer sk-MYAPIKEY\",\n        \"accept\": \"image/*\"\n    },\n    files={\n        \"image\": open(\"./low-res-flower.jpg\", \"rb\"),\n    },\n    data={\n        \"prompt\": \"a flower\",\n        \"output_format\": \"webp\",\n    },\n)\n\nif response.status_code == 200:\n    with open(\"./flower.webp\", 'wb') as file:\n        file.write(response.content)\nelse:\n    raise Exception(str(response.json()))"},{"label":"JavaScript","lang":"javascript","source":"import fs from \"node:fs\";\nimport axios from \"axios\";\nimport FormData from \"form-data\";\n\nconst payload = {\n  image: fs.createReadStream(\"./low-res-flower.jpg\"),\n  prompt: \"a flower\",\n  output_format: \"webp\"\n};\n\nconst response = await axios.postForm(\n  `https://api.stability.ai/v2beta/stable-image/upscale/conservative`,\n  axios.toFormData(payload, new FormData()),\n  {\n    validateStatus: undefined,\n    responseType: \"arraybuffer\",\n    headers: { \n      Authorization: `Bearer sk-MYAPIKEY`, \n      Accept: \"image/*\" \n    },\n  },\n);\n\nif(response.status === 200) {\n  fs.writeFileSync(\"./flower.webp\", Buffer.from(response.data));\n} else {\n  throw new Error(`${response.status}: ${response.data.toString()}`);\n}"},{"label":"cURL","lang":"terminal","source":"curl -f -sS \"https://api.stability.ai/v2beta/stable-image/upscale/conservative\" \\\n\n\n\n\n\n\n  -H \"authorization: Bearer sk-MYAPIKEY\" \\\n  -H \"accept: image/*\" \\\n  -F image=@\"./low-res-flower.jpg\" \\\n  -F prompt=\"a flower\" \\\n  -F output_format=\"webp\" \\\n  -o \"./flower.webp\""}],"x-excluded":true}},"/proxy/stability/v2beta/stable-image/upscale/creative":{"post":{"description":"Takes images between 64x64 and 1 megapixel and upscales them all the way to **4K** resolution.  Put more\ngenerally, it can upscale images ~20-40x times while preserving, and often enhancing, quality.\nCreative Upscale **works best on highly degraded images and is not for photos of 1mp or above** as it performs\nheavy reimagining (controlled by creativity scale).\n\n### Try it out\nGrab your [API key](https://platform.stability.ai/account/keys) and head over to [![Open Google Colab](https://platform.stability.ai/svg/google-colab.svg)](https://colab.research.google.com/github/stability-ai/stability-sdk/blob/main/nbs/Stable_Image_API_Public.ipynb#scrollTo=QXxi9tfI425t)\n\n\n### How to use\nPlease invoke this endpoint with a `POST` request.\n\nThe headers of the request must include an API key in the `authorization` field. The body of the request must be\n`multipart/form-data`.\n\nThe body of the request should include:\n- `image`\n- `prompt`\n\nThe body may optionally include:\n- `seed`\n- `negative_prompt`\n- `output_format`\n- `creativity`\n- `style_preset`\n\n\u003e **Note:** for more details about these parameters please see the request schema below.\n\n### Results\nAfter invoking this endpoint with the required parameters, use the `id` in the response to poll for results at the\n[results/{id} endpoint](#tag/Results/paths/~1v2beta~1results~1%7Bid%7D/get).  Rate-limiting or other errors may occur if you poll more than once every 10 seconds.\n\n### Credits\nFlat rate of 25 credits per successful generation.  You will not be charged for failed generations.","operationId":"StabilityImageGenrationUpscaleCreative","parameters":[{"in":"header","name":"authorization","required":true,"schema":{"description":"Your [Stability API key](https://platform.stability.ai/account/keys), used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.","minLength":1,"type":"string"}},{"in":"header","name":"content-type","required":true,"schema":{"description":"The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.","example":"multipart/form-data","minLength":1,"type":"string"}},{"in":"header","name":"stability-client-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientID"}},{"in":"header","name":"stability-client-user-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientUserID"}},{"in":"header","name":"stability-client-version","schema":{"$ref":"#/components/schemas/StabilityStabilityClientVersion"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Request"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Response_200"}}},"description":"Upscale was started."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Response_400"}}},"description":"Invalid parameter(s), see the `errors` field for details."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityContentModerationResponse"}}},"description":"Your request was flagged by our content moderation system."},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Response_413"}}},"description":"Your request was larger than 10MiB."},"422":{"content":{"application/json":{"examples":{"Invalid Language":{"value":{"errors":["English is the only supported language for this service."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"invalid_language"}},"Public Figure Detected":{"value":{"errors":["Our system detected the likeness of a public figure in your image. To comply with our guidelines, this request cannot be processed. Please upload a different image."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"public_figure"}}},"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Response_422"}}},"description":"Your request was well-formed, but rejected. See the `errors` field for details."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Response_429"}}},"description":"You have made more than 150 requests in 10 seconds."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleCreative_Response_500"}}},"description":"An internal error occurred. If the problem persists [contact support](https://kb.stability.ai/knowledge-base/kb-tickets/new)."}},"summary":"Creative Upscale (async)","tags":["API Nodes","Released"],"x-codeSamples":[{"label":"Python","lang":"python","source":"import requests\n\nresponse = requests.post(\n    f\"https://api.stability.ai/v2beta/stable-image/upscale/creative\",\n    headers={\n        \"authorization\": f\"Bearer sk-MYAPIKEY\",\n        \"accept\": \"image/*\"\n    },\n    files={\n        \"image\": open(\"./kitten-in-space.png\", \"rb\")\n    },\n    data={\n        \"prompt\": \"cute fluffy white kitten floating in space, pastel colors\",\n        \"output_format\": \"webp\",\n    },\n)\n\nprint(\"Generation ID:\", response.json().get('id'))"},{"label":"JavaScript","lang":"javascript","source":"import fs from \"node:fs\";\nimport axios from \"axios\";\nimport FormData from \"form-data\";\n\nconst payload = {\n  image: fs.createReadStream(\"./kitten-in-space.png\"),\n  prompt: \"cute fluffy white kitten floating in space, pastel colors\",\n  output_format: \"webp\"\n};\n\nconst response = await axios.postForm(\n  `https://api.stability.ai/v2beta/stable-image/upscale/creative`,\n  axios.toFormData(payload, new FormData()),\n  {\n    validateStatus: undefined,\n    headers: { \n      Authorization: `Bearer sk-MYAPIKEY`\n    },\n  },\n);\n\nconsole.log(\"Generation ID:\", response.data.id);"},{"label":"cURL","lang":"terminal","source":"curl -f -sS \"https://api.stability.ai/v2beta/stable-image/upscale/creative\" \\\n\n\n\n\n\n\n  -H \"authorization: Bearer sk-MYAPIKEY\" \\\n  -F image=@\"./kitten-in-rainforest.png\" \\\n  -F prompt=\"cute fluffy white kitten sitting in a rainforest, pastel colors\" \\\n  -F output_format=webp \\\n  -o \"./output.json\""}],"x-excluded":true}},"/proxy/stability/v2beta/stable-image/upscale/fast":{"post":{"description":"Our Fast Upscaler service enhances image resolution by 4x using predictive and generative AI. This lightweight and fast service (processing in ~1 second) is ideal for enhancing the quality of compressed images, making it suitable for social media posts and other applications.\n\n### Try it out\nGrab your [API key](https://platform.stability.ai/account/keys) and head over to [![Open Google Colab](https://platform.stability.ai/svg/google-colab.svg)](https://colab.research.google.com/github/stability-ai/stability-sdk/blob/main/nbs/Stable_Image_API_Public.ipynb#scrollTo=t1Q4w2uvvza0)\n\n### How to use\n\nPlease invoke this endpoint with a `POST` request.\n\nThe headers of the request must include an API key in the `authorization` field. The body of the request must be\n`multipart/form-data`, and the `accept` header should be set to one of the following:\n\n\n\n  - `image/*` to receive the image in the format specified by the `output_format` parameter.\n  - `application/json` to receive the image encoded as base64 in a JSON response.\n\nThe body of the request must include:\n- `image`\n\nOptionally, the body of the request may also include:\n- `output_format`\n\n\u003e **Note:** for more details about these parameters please see the request schema below.\n\n### Output\nThe resolution of the generated image is 4 times that of the input image with a maximum size of 16 megapixels.\n\n### Credits\nFlat rate of 1 credit per successful generation. You will not be charged for failed generations.","operationId":"StabilityImageGenerationUpscaleFast","parameters":[{"in":"header","name":"authorization","required":true,"schema":{"description":"Your [Stability API key](https://platform.stability.ai/account/keys), used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.","minLength":1,"type":"string"}},{"in":"header","name":"content-type","required":true,"schema":{"description":"The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.","example":"multipart/form-data","minLength":1,"type":"string"}},{"in":"header","name":"accept","schema":{"default":"image/*","description":"Specify `image/*` to receive the bytes of the image directly. Otherwise specify `application/json` to receive the image as base64 encoded JSON.","enum":["image/*","application/json"],"type":"string"}},{"in":"header","name":"stability-client-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientID"}},{"in":"header","name":"stability-client-user-id","schema":{"$ref":"#/components/schemas/StabilityStabilityClientUserID"}},{"in":"header","name":"stability-client-version","schema":{"$ref":"#/components/schemas/StabilityStabilityClientVersion"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Request"}}}},"responses":{"200":{"content":{"application/json; type=image/jpeg":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_200"}},"application/json; type=image/png":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_200"}},"application/json; type=image/webp":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_200"}},"image/jpeg":{"example":"The bytes of the generated jpeg","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/png":{"example":"The bytes of the generated png","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}},"image/webp":{"example":"The bytes of the generated webp","schema":{"description":"The bytes of the generated image.\n\nThe `finish-reason` and `seed` will be present as headers.","format":"binary","type":"string"}}},"description":"Upscale was successful.","headers":{"content-type":{"description":"The format of the generated image.\n\n To receive the bytes of the image directly, specify `image/*` in the accept header. To receive the bytes base64 encoded inside of a JSON payload, specify `application/json`.","examples":{"jpeg":{"description":"raw bytes","value":"image/jpeg"},"jpegJSON":{"description":"base64 encoded","value":"application/json; type=image/jpeg"},"png":{"description":"raw bytes","value":"image/png"},"pngJSON":{"description":"base64 encoded","value":"application/json; type=image/png"},"webp":{"description":"raw bytes","value":"image/webp"},"webpJSON":{"description":"base64 encoded","value":"application/json; type=image/webp"}},"schema":{"type":"string"}},"finish-reason":{"description":"Indicates the reason the generation finished.\n\n- `SUCCESS` = successful generation.\n- `CONTENT_FILTERED` = successful generation, however the output violated our content moderation\npolicy and has been blurred as a result.\n\n\u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `finish_reason`.","schema":{"enum":["SUCCESS","CONTENT_FILTERED"],"type":"string"}},"seed":{"description":"The seed used as random noise for this generation.\n\n\u003e **NOTE:** This header is absent on JSON encoded responses because it is present in the body as `seed`.","example":"343940597","schema":{"type":"string"}},"x-request-id":{"description":"A unique identifier for this request.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_400"}}},"description":"Invalid parameter(s), see the `errors` field for details."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityContentModerationResponse"}}},"description":"Your request was flagged by our content moderation system."},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_413"}}},"description":"Your request was larger than 10MiB."},"422":{"content":{"application/json":{"examples":{"Invalid Language":{"value":{"errors":["English is the only supported language for this service."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"invalid_language"}},"Public Figure Detected":{"value":{"errors":["Our system detected the likeness of a public figure in your image. To comply with our guidelines, this request cannot be processed. Please upload a different image."],"id":"ff54b236a3acdde1522cb1ba641c43ed","name":"public_figure"}}},"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_422"}}},"description":"Your request was well-formed, but rejected. See the `errors` field for details."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_429"}}},"description":"You have made more than 150 requests in 10 seconds."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StabilityImageGenrationUpscaleFast_Response_500"}}},"description":"An internal error occurred. If the problem persists [contact support](https://kb.stability.ai/knowledge-base/kb-tickets/new)."}},"summary":"Fast","tags":["API Nodes","Released"],"x-codeSamples":[{"label":"Python","lang":"python","source":"import requests\n\nresponse = requests.post(\n    f\"https://api.stability.ai/v2beta/stable-image/upscale/fast\",\n    headers={\n        \"authorization\": f\"Bearer sk-MYAPIKEY\",\n        \"accept\": \"image/*\"\n    },\n    files={\n        \"image\": open(\"./low-res-flower.jpg\", \"rb\"),\n    },\n    data={\n        \"output_format\": \"webp\",\n    },\n)\n\nif response.status_code == 200:\n    with open(\"./flower.webp\", 'wb') as file:\n        file.write(response.content)\nelse:\n    raise Exception(str(response.json()))"},{"label":"JavaScript","lang":"javascript","source":"import fs from \"node:fs\";\nimport axios from \"axios\";\nimport FormData from \"form-data\";\n\nconst payload = {\n  image: fs.createReadStream(\"./low-res-flower.jpg\"),\n  output_format: \"webp\"\n};\n\nconst response = await axios.postForm(\n  `https://api.stability.ai/v2beta/stable-image/upscale/fast`,\n  axios.toFormData(payload, new FormData()),\n  {\n    validateStatus: undefined,\n    responseType: \"arraybuffer\",\n    headers: { \n      Authorization: `Bearer sk-MYAPIKEY`, \n      Accept: \"image/*\" \n    },\n  },\n);\n\nif(response.status === 200) {\n  fs.writeFileSync(\"./flower.webp\", Buffer.from(response.data));\n} else {\n  throw new Error(`${response.status}: ${response.data.toString()}`);\n}"},{"label":"cURL","lang":"terminal","source":"curl -f -sS \"https://api.stability.ai/v2beta/stable-image/upscale/fast\" \\\n\n\n\n\n\n\n  -H \"authorization: Bearer sk-MYAPIKEY\" \\\n  -H \"accept: image/*\" \\\n  -F image=@\"./low-res-flower.jpg\" \\\n  -F output_format=\"webp\" \\\n  -o \"./flower.webp\""}],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-part":{"post":{"description":"Submit a component identification and generation task using Tencent Hunyuan.\nAutomatically performs component splitting based on the model structure after inputting a 3D model file.\nRecommends inputting 3D models generated by AIGC. File size not greater than 100MB, face count not greater than 30,000. FBX format only.\n\nThe returned JobId can be used with the query endpoint to check task status.\n","operationId":"TencentHunyuan3DPartSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DUVRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DUVResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit Tencent Hunyuan 3D Part (Component Splitting) Task","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-part/query":{"post":{"description":"Query the status and result of a previously submitted 3D part (component splitting) task.\n\nPoll this endpoint until the task status indicates completion.\n","operationId":"TencentHunyuan3DPartQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryResponse"}}},"description":"Task status retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Query Tencent Hunyuan 3D Part Task Status","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-pro":{"post":{"description":"Submit a task to generate 3D content using Tencent HunYuan Large Model.\nSupports text-to-3D and image-to-3D generation.\n\nThis API provides 3 concurrent tasks by default. A new task can be processed \nonly after the previous one is completed.\n\nThe returned JobId can be used with the query endpoint to check task status.\n","operationId":"TencentHunyuan3DProSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DProRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DProResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit Tencent Hunyuan 3D Pro Generation Task","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-pro/query":{"post":{"description":"Query the status and result of a previously submitted 3D generation task.\n\nPoll this endpoint until the task status indicates completion.\n","operationId":"TencentHunyuan3DProQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryResponse"}}},"description":"Task status retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Query Tencent Hunyuan 3D Pro Task Status","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-smart-topology":{"post":{"description":"Submit a 3D smart topology (retopology/polygon reduction) task using Tencent Hunyuan.\nTakes an input 3D model and performs intelligent topology optimization.\nSupported input formats: GLB, OBJ. File size max 200MB.\n\nThe returned JobId can be used with the query endpoint to check task status.\n","operationId":"TencentHunyuan3DSmartTopologySubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DSmartTopologyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DUVResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit Tencent Hunyuan 3D Smart Topology Task","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-smart-topology/query":{"post":{"description":"Query the status and result of a previously submitted 3D smart topology task.\n\nPoll this endpoint until the task status indicates completion.\n","operationId":"TencentHunyuan3DSmartTopologyQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryResponse"}}},"description":"Task status retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Query Tencent Hunyuan 3D Smart Topology Task Status","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-texture-edit":{"post":{"description":"Submit a 3D model texture redrawing task using Tencent Hunyuan.\nAfter inputting the 3D model, perform 3D model texture redrawing based on semantics or images.\nSupported format: FBX. 3D model limit: less than 100000 faces.\nEither Image or Prompt is required; they cannot coexist. EnablePBR only supports enabling when using Prompt.\n\nThe returned JobId can be used with the query endpoint to check task status.\n","operationId":"TencentHunyuan3DTextureEditSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DTextureEditRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DUVResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit Tencent Hunyuan 3D Texture Edit Task","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-texture-edit/query":{"post":{"description":"Query the status and result of a previously submitted 3D texture edit task.\n\nPoll this endpoint until the task status indicates completion.\n","operationId":"TencentHunyuan3DTextureEditQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryResponse"}}},"description":"Task status retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Query Tencent Hunyuan 3D Texture Edit Task Status","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-uv":{"post":{"description":"Submit a UV unwrapping task for a 3D model using Tencent Hunyuan.\nAfter inputting the model, UV unwrapping can be performed based on the \nmodel texture to output the corresponding UV map.\n\nThe returned JobId can be used with the query endpoint to check task status.\n","operationId":"TencentHunyuan3DUVSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DUVRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DUVResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit Tencent Hunyuan 3D UV Unfolding Task","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/tencent/hunyuan/3d-uv/query":{"post":{"description":"Query the status and result of a previously submitted UV unwrapping task.\n\nPoll this endpoint until the task status indicates completion.\n","operationId":"TencentHunyuan3DUVQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentHunyuan3DQueryResponse"}}},"description":"Task status retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TencentErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Query Tencent Hunyuan 3D UV Unfolding Task Status","tags":["API Nodes","Tencent"],"x-excluded":true}},"/proxy/topaz/image/v1/download/{process_id}":{"get":{"operationId":"TopazDownloadResult","parameters":[{"description":"The process ID returned from the enhance-gen request","in":"path","name":"process_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazDownloadResponse"}}},"description":"Presigned download URL for the processed image"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/topaz/image/v1/enhance-gen/async":{"post":{"operationId":"TopazEnhanceGenAsync","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/TopazEnhanceGenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazEnhanceGenResponse"}}},"description":"Image processing request has been successfully created"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/topaz/image/v1/status/{process_id}":{"get":{"operationId":"TopazGetStatus","parameters":[{"description":"The process ID returned from the enhance-gen request","in":"path","name":"process_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazStatusResponse"}}},"description":"Status retrieved successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/topaz/video/":{"post":{"operationId":"TopazVideoCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazVideoCreateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazVideoCreateResponse"}}},"description":"Video enhancement request created successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/topaz/video/{request_id}/accept":{"patch":{"operationId":"TopazVideoAccept","parameters":[{"description":"The request ID returned from the video create request","in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazVideoAcceptResponse"}}},"description":"Video request accepted successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/topaz/video/{request_id}/complete-upload":{"patch":{"description":"Send metadata of the multi-part uploads to complete the upload and begin processing the video.\n\nOptionally include the MD5 hash of the source video file to validate successful upload before processing.\n","operationId":"TopazVideoCompleteUpload","parameters":[{"description":"The request ID returned from the video create request","in":"path","name":"request_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazVideoCompleteUploadRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazVideoCompleteUploadResponse"}}},"description":"Video upload completed successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"summary":"Complete Video Upload","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/topaz/video/{request_id}/status":{"get":{"operationId":"TopazVideoGetStatus","parameters":[{"description":"The request ID returned from the video create request","in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopazVideoStatusResponse"}}},"description":"Video status retrieved successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/tripo/v2/openapi/task":{"post":{"operationId":"TripoCreateTask","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"auto_size":{"default":false,"type":"boolean"},"face_limit":{"type":"integer"},"geometry_quality":{"$ref":"#/components/schemas/TripoGeometryQuality"},"model_seed":{"type":"integer"},"model_version":{"$ref":"#/components/schemas/TripoModelVersion"},"negative_prompt":{"maxLength":1024,"type":"string"},"pbr":{"default":true,"type":"boolean"},"prompt":{"maxLength":1024,"type":"string"},"quad":{"default":false,"type":"boolean"},"style":{"$ref":"#/components/schemas/TripoModelStyle"},"text_seed":{"type":"integer"},"texture":{"default":true,"type":"boolean"},"texture_quality":{"$ref":"#/components/schemas/TripoTextureQuality"},"texture_seed":{"type":"integer"},"type":{"$ref":"#/components/schemas/TripoTextToModel"}},"required":["type","prompt"],"type":"object"},{"properties":{"auto_size":{"default":false,"type":"boolean"},"face_limit":{"type":"integer"},"file":{"properties":{"file_token":{"type":"string"},"type":{"type":"string"}},"required":["type","file_token"],"type":"object"},"geometry_quality":{"$ref":"#/components/schemas/TripoGeometryQuality"},"model_seed":{"type":"integer"},"model_version":{"$ref":"#/components/schemas/TripoModelVersion"},"orientation":{"$ref":"#/components/schemas/TripoOrientation"},"pbr":{"default":true,"type":"boolean"},"quad":{"default":false,"type":"boolean"},"style":{"$ref":"#/components/schemas/TripoModelStyle"},"texture":{"default":true,"type":"boolean"},"texture_alignment":{"$ref":"#/components/schemas/TripoTextureAlignment"},"texture_quality":{"$ref":"#/components/schemas/TripoTextureQuality"},"texture_seed":{"type":"integer"},"type":{"$ref":"#/components/schemas/TripoImageToModel"}},"required":["type","file"],"type":"object"},{"properties":{"auto_size":{"default":false,"type":"boolean"},"face_limit":{"type":"integer"},"files":{"items":{"properties":{"file_token":{"type":"string"},"type":{"type":"string"}},"required":["type","file_token"],"type":"object"},"type":"array"},"geometry_quality":{"$ref":"#/components/schemas/TripoGeometryQuality"},"mode":{"$ref":"#/components/schemas/TripoMultiviewMode"},"model_seed":{"type":"integer"},"model_version":{"$ref":"#/components/schemas/TripoModelVersion"},"orientation":{"$ref":"#/components/schemas/TripoOrientation"},"orthographic_projection":{"default":false,"type":"boolean"},"pbr":{"default":true,"type":"boolean"},"quad":{"default":false,"type":"boolean"},"texture":{"default":true,"type":"boolean"},"texture_alignment":{"$ref":"#/components/schemas/TripoTextureAlignment"},"texture_quality":{"$ref":"#/components/schemas/TripoTextureQuality"},"texture_seed":{"type":"integer"},"type":{"$ref":"#/components/schemas/TripoMultiviewToModel"}},"required":["type","files"],"type":"object"},{"properties":{"model_seed":{"type":"integer"},"original_model_task_id":{"type":"string"},"pbr":{"default":true,"type":"boolean"},"texture":{"default":true,"type":"boolean"},"texture_alignment":{"$ref":"#/components/schemas/TripoTextureAlignment"},"texture_quality":{"$ref":"#/components/schemas/TripoTextureQuality"},"texture_seed":{"type":"integer"},"type":{"$ref":"#/components/schemas/TripoTypeTextureModel"}},"required":["type","original_model_task_id"],"type":"object"},{"properties":{"draft_model_task_id":{"type":"string"},"type":{"$ref":"#/components/schemas/TripoTypeRefineModel"}},"required":["type","draft_model_task_id"],"type":"object"},{"properties":{"original_model_task_id":{"type":"string"},"type":{"$ref":"#/components/schemas/TripoTypeAnimatePrerigcheck"}},"required":["type","original_model_task_id"],"type":"object"},{"properties":{"original_model_task_id":{"type":"string"},"out_format":{"$ref":"#/components/schemas/TripoStandardFormat"},"spec":{"$ref":"#/components/schemas/TripoSpec"},"topology":{"$ref":"#/components/schemas/TripoTopology"},"type":{"$ref":"#/components/schemas/TripoTypeAnimateRig"}},"required":["type","original_model_task_id"],"type":"object"},{"properties":{"animation":{"$ref":"#/components/schemas/TripoAnimation"},"bake_animation":{"default":true,"type":"boolean"},"original_model_task_id":{"type":"string"},"out_format":{"$ref":"#/components/schemas/TripoStandardFormat"},"type":{"$ref":"#/components/schemas/TripoTypeAnimateRetarget"}},"required":["type","original_model_task_id","animation"],"type":"object"},{"properties":{"block_size":{"default":80,"type":"integer"},"original_model_task_id":{"type":"string"},"style":{"$ref":"#/components/schemas/TripoStylizeOptions"},"type":{"$ref":"#/components/schemas/TripoTypeStylizeModel"}},"required":["type","style","original_model_task_id"],"type":"object"},{"properties":{"face_limit":{"default":10000,"type":"integer"},"flatten_bottom":{"default":false,"type":"boolean"},"flatten_bottom_threshold":{"default":0.01,"type":"number"},"force_symmetry":{"default":false,"type":"boolean"},"format":{"$ref":"#/components/schemas/TripoConvertFormat"},"original_model_task_id":{"type":"string"},"pivot_to_center_bottom":{"default":false,"type":"boolean"},"quad":{"default":false,"type":"boolean"},"texture_format":{"$ref":"#/components/schemas/TripoTextureFormat"},"texture_size":{"default":4096,"type":"integer"},"type":{"$ref":"#/components/schemas/TripoTypeConvertModel"}},"required":["type","format","original_model_task_id"],"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoSuccessTask"}}},"description":"Request successful"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Server timeout"}},"summary":"Create 3D Generation Task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/tripo/v2/openapi/task/{task_id}":{"get":{"operationId":"TripoGetTask","parameters":[{"in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"$ref":"#/components/schemas/TripoResponseSuccessCode"},"data":{"$ref":"#/components/schemas/TripoTask"}},"required":["code","data"],"type":"object"}}},"description":"Request successful"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Server timeout"}},"summary":"Get Task Status","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/tripo/v2/openapi/upload":{"post":{"operationId":"TripoUploadFile","requestBody":{"content":{"multipart/form-data":{"encoding":{"profileImage":{"contentType":"image/png, image/jpeg"}},"schema":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"$ref":"#/components/schemas/TripoResponseSuccessCode"},"data":{"properties":{"image_token":{"type":"string"}},"required":["image_token"],"type":"object"}},"required":["code","data"],"type":"object"}}},"description":"Request successful"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Server timeout"}},"summary":"Upload File for 3D Generation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/tripo/v2/openapi/user/balance":{"get":{"operationId":"TripoGetBalance","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"$ref":"#/components/schemas/TripoResponseSuccessCode"},"data":{"$ref":"#/components/schemas/TripoBalance"}},"required":["code","data"],"type":"object"}}},"description":"Request successful"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Unauthorized access to requested resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Resource not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Account exception or Rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Service temporarily unavailable"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripoErrorResponse"}}},"description":"Server timeout"}},"summary":"Query Account Balance","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/veo/generate":{"post":{"operationId":"VeoGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Veo2GenVidRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Veo2GenVidResponse"}}},"description":"Video generation successful"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}},"summary":"Generate a video from a text prompt and optional image. Deprecated. Use /proxy/veo/{modelId}/generate instead.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/veo/poll":{"post":{"operationId":"VeoPoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Veo2GenVidPollRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Veo2GenVidPollResponse"}}},"description":"Operation status and result"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Operation not found"},"500":{"description":"Internal error"}},"summary":"Poll the status of a Veo prediction operation. Deprecated. Use /proxy/veo/{modelId}/poll instead.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/veo/{modelId}/generate":{"post":{"operationId":"VeoGenerateNew","parameters":[{"description":"The Veo model ID to use for generation","in":"path","name":"modelId","required":true,"schema":{"enum":["veo-2.0-generate-001","veo-3.0-generate-001","veo-3.0-fast-generate-001","veo-3.1-generate-001","veo-3.1-fast-generate-001","veo-3.1-lite-generate-001"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VeoGenVidRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VeoGenVidResponse"}}},"description":"Video generation successful"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}},"summary":"Generate a video from a text prompt and optional image","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/veo/{modelId}/poll":{"post":{"operationId":"VeoPollNew","parameters":[{"description":"The Veo model ID","in":"path","name":"modelId","required":true,"schema":{"enum":["veo-2.0-generate-001","veo-3.0-generate-001","veo-3.0-fast-generate-001","veo-3.1-generate-001","veo-3.1-fast-generate-001","veo-3.1-lite-generate-001"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VeoGenVidPollRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VeoGenVidPollResponse"}}},"description":"Operation status and result"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Operation not found"},"500":{"description":"Internal error"}},"summary":"Poll the status of a Veo prediction operation","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/vertexai/gemini/{model}":{"post":{"operationId":"GeminiGenerateContent","parameters":[{"description":"Full resource name of the model.","in":"path","name":"model","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeminiGenerateContentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeminiGenerateContentResponse"}}},"description":"Generated content response."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Generate content using a specified model.","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/vertexai/imagen/{model}":{"parameters":[{"description":"image generation model","in":"path","name":"model","required":true,"schema":{"enum":["imagen-3.0-generate-002","imagen-3.0-generate-001","imagen-3.0-fast-generate-001","imagegeneration@006","imagegeneration@005","imagegeneration@002"],"type":"string"}}],"post":{"operationId":"ImagenGenerateImages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagenGenerateImageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagenGenerateImageResponse"}}},"description":"Successful image generation"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}},"summary":"Generate images from a text prompt","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/vidu/extend":{"post":{"operationId":"ViduExtend","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduExtendRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduExtendReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/vidu/img2video":{"post":{"operationId":"ViduImg2Video","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/vidu/multiframe":{"post":{"operationId":"ViduMultiframe","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduMultiframeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduMultiframeReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/vidu/reference2video":{"post":{"operationId":"ViduReference2Video","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/vidu/start-end2video":{"post":{"operationId":"ViduStartEnd2Video","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/vidu/tasks/{id}/creations":{"get":{"operationId":"ViduGetCreations","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduGetCreationsReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/vidu/text2video":{"post":{"operationId":"ViduText2Video","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViduTaskReply"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error 4xx/5xx"}},"tags":["API Nodes","Released"]}},"/proxy/wan/api/v1/services/aigc/image2image/image-synthesis":{"post":{"operationId":"WanImage2ImageGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanImage2ImageGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanImage2ImageGenerationResponse"}}},"description":"Image-to-image generation task created successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wan/api/v1/services/aigc/text2image/image-synthesis":{"post":{"operationId":"WanImageGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanImageGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanImageGenerationResponse"}}},"description":"Image generation task created successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wan/api/v1/services/aigc/video-generation/video-synthesis":{"post":{"operationId":"WanVideoGeneration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanVideoGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanVideoGenerationResponse"}}},"description":"Video generation task created successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wan/api/v1/tasks/{task_id}":{"get":{"operationId":"WanTaskQueryProxy","parameters":[{"description":"The ID of the generation task to query","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanTaskQueryResponse"}}},"description":"Generation task information retrieved successfully"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error 4xx/5xx"}},"security":[{"BearerAuth":[]}],"tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wavespeed/api/v3/predictions/{prediction_id}/result":{"get":{"description":"Retrieve the status and result of a FlashVSR video upscaling task.\n\nPoll this endpoint until status is \"completed\" or \"failed\".\n\nStatus values:\n- `created` - Task has been created\n- `processing` - Task is being processed\n- `completed` - Task completed successfully, outputs array contains result URLs\n- `failed` - Task failed, check error field for details\n","operationId":"WavespeedFlashVSRGetResult","parameters":[{"description":"The unique identifier of the prediction/task","in":"path","name":"prediction_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedTaskResultResponse"}}},"description":"Task result retrieved successfully"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Task not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Get FlashVSR task result","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wavespeed/api/v3/wavespeed-ai/flashvsr":{"post":{"description":"Submit a video for upscaling using WavespeedAI's FlashVSR model.\nFlashVSR is a fast, high-quality video upscaler that boosts resolution and restores clarity\nfor low-resolution or blurry footage.\n\nSupported target resolutions: 720p, 1080p, 2k, 4k\n\nMax clip length: up to 10 minutes\nProcessing speed: approximately 3-20 seconds of wall time to process 1 second of video\n\nReturns a task ID that can be used to poll for the result.\n","operationId":"WavespeedFlashVSRSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedFlashVSRRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedTaskResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit a FlashVSR video upscaling task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wavespeed/api/v3/wavespeed-ai/seedvr2/image":{"post":{"description":"Upscale an image using WavespeedAI's SeedVR2 Image Upscaler.\nSeedVR2 boosts image resolution and quality, upscaling photos to 2K, 4K, or 8K\nfor sharp, detailed results.\n","operationId":"WavespeedSeedVR2ImageSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedSeedVR2ImageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedTaskResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit a SeedVR2 image upscaling task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/wavespeed/api/v3/wavespeed-ai/ultimate-image-upscaler":{"post":{"description":"Upscale an image using WavespeedAI's Ultimate Image Upscaler.\nThe most advanced AI enhancer that reimagines fine detail while upscaling images to 2K, 4K, or 8K.\n","operationId":"WavespeedUltimateImageUpscalerSubmit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedSeedVR2ImageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WavespeedTaskResponse"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"BearerAuth":[]}],"summary":"Submit an Ultimate Image Upscaler task","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/xai/v1/images/edits":{"post":{"description":"Modify an existing image based on a text prompt using the Grok Imagine API.","operationId":"XaiImageEdit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIImageEditRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIImageGenerationResponse"}}},"description":"Image edited successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Edit images using xAI Grok Imagine","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/xai/v1/images/generations":{"post":{"description":"Generate one or more images from a text prompt using the Grok Imagine API.","operationId":"XaiImageGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIImageGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIImageGenerationResponse"}}},"description":"Images generated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Generate images using xAI Grok Imagine","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/xai/v1/videos/edits":{"post":{"description":"Edit an existing video based on a text prompt (video-to-video editing).\nVideo editing is asynchronous. Returns a request_id to poll for the completed video.\nInput video limit is 8 seconds. Audio will not be modified.\n","operationId":"XaiVideoEdit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoEditRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoAsyncResponse"}}},"description":"Video editing job created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Edit videos using xAI Grok Imagine","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/xai/v1/videos/extensions":{"post":{"description":"Generate a seamless continuation of an existing video. You provide a source video and a text prompt\ndescribing what should happen next. The API produces a new video that extends naturally from the end\nof the input video.\nVideo extension is asynchronous. Returns a request_id to poll for the completed video.\n","operationId":"XaiVideoExtension","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoExtensionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoAsyncResponse"}}},"description":"Video extension job created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Extend videos using xAI Grok Imagine","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/xai/v1/videos/generations":{"post":{"description":"Generate a video from a text prompt (text-to-video), from an image with optional text (image-to-video),\nor from reference images with text (reference-to-video). The mode is determined by which optional fields\nare provided. Video generation is asynchronous. Returns a request_id to poll for the completed video.\n\nConflict rules: image + reference_images, video + reference_images, and image + video cannot be combined.\n","operationId":"XaiVideoGenerate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoGenerationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoAsyncResponse"}}},"description":"Video generation job created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Generate videos using xAI Grok Imagine","tags":["API Nodes","Released"],"x-excluded":true}},"/proxy/xai/v1/videos/{request_id}":{"get":{"description":"Retrieve the result of a video generation or editing request.\nPoll this endpoint until the response includes a video object with the completed video URL.\n","operationId":"XaiVideoGetResult","parameters":[{"description":"The request ID returned by the video generation or editing endpoint","in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoResultResponse"}}},"description":"Video generation result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XAIVideoResultResponse"}}},"description":"Video generation still pending"},"401":{"description":"Unauthorized"},"402":{"description":"Payment Required"},"404":{"description":"Request ID not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Get xAI video generation result","tags":["API Nodes","Released"],"x-excluded":true}},"/publishers":{"get":{"operationId":"ListPublishers","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Publisher"},"type":"array"}}},"description":"A list of publishers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve all publishers","tags":["Registry"]},"post":{"operationId":"CreatePublisher","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Publisher"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Publisher"}}},"description":"Publisher created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a new publisher","tags":["Registry"]}},"/publishers/validate":{"get":{"description":"Checks if the publisher username is already taken.","operationId":"ValidatePublisher","parameters":[{"description":"The publisher username to validate.","in":"query","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"isAvailable":{"description":"True if the username is available, false otherwise.","type":"boolean"}},"type":"object"}}},"description":"Username validation result"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid input, such as missing username in the query."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Validate if a publisher username is available","tags":["Registry"]}},"/publishers/{publisherId}":{"delete":{"operationId":"DeletePublisher","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Publisher deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Publisher not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Delete a publisher","tags":["Registry"]},"get":{"operationId":"GetPublisher","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Publisher"}}},"description":"Publisher retrieved successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Publisher not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve a publisher by ID","tags":["Registry"]},"put":{"operationId":"UpdatePublisher","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Publisher"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Publisher"}}},"description":"Publisher updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"401":{"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Publisher not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Update a publisher","tags":["Registry"]}},"/publishers/{publisherId}/ban":{"post":{"operationId":"BanPublisher","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Publisher Banned Successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Publisher not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Ban a publisher","tags":["Registry"],"x-excluded":true}},"/publishers/{publisherId}/nodes":{"get":{"operationId":"ListNodesForPublisher","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"description":"Number of nodes to return per page","in":"query","name":"include_banned","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Node"},"type":"array"}}},"description":"List of all nodes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Retrieve all nodes","tags":["Registry"]},"post":{"operationId":"CreateNode","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Node created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a new custom node","tags":["Registry"]}},"/publishers/{publisherId}/nodes/v2":{"get":{"operationId":"ListNodesForPublisherV2","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"description":"Number of nodes to return per page","in":"query","name":"include_banned","schema":{"type":"boolean"}},{"description":"Page number of the nodes list","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Number of nodes to return per page","in":"query","name":"limit","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"limit":{"description":"Maximum number of nodes per page","type":"integer"},"nodes":{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},"page":{"description":"Current page number","type":"integer"},"total":{"description":"Total number of nodes available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"}},"type":"object"}}},"description":"List of all nodes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Retrieve all nodes","tags":["Registry"]}},"/publishers/{publisherId}/nodes/{nodeId}":{"delete":{"operationId":"DeleteNode","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node deleted successfully"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Delete a specific node","tags":["Registry"]},"put":{"operationId":"UpdateNode","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}},"description":"Node updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Update a specific node","tags":["Registry"]}},"/publishers/{publisherId}/nodes/{nodeId}/ban":{"post":{"operationId":"BanPublisherNode","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node Banned Successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Publisher or Node not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Ban a publisher's Node","tags":["Registry"],"x-excluded":true}},"/publishers/{publisherId}/nodes/{nodeId}/claim-my-node":{"post":{"description":"This endpoint allows a publisher to claim an unclaimed node that they own the repo, which is identified by the nodeId. The unclaimed node's repository must be owned by the authenticated user.\n","operationId":"ClaimMyNode","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimMyNodeRequest"}}},"required":true},"responses":{"204":{"description":"Node claimed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden - various authorization and permission issues\nIncludes:\n- The authenticated user does not have permission to claim the node\n- The node is already claimed by another publisher\n- The GH_TOKEN is invalid\n- The repository is not owned by the authenticated GitHub user\n"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests - GitHub API rate limit exceeded"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service unavailable - GitHub API is currently unavailable"}},"security":[{"BearerAuth":[]}],"summary":"Claim nodeId into publisherId for the authenticated publisher","tags":["Registry"]}},"/publishers/{publisherId}/nodes/{nodeId}/permissions":{"get":{"operationId":"GetPermissionOnPublisherNodes","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"canEdit":{"type":"boolean"}},"type":"object"}}},"description":"A list of permissions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve permissions the user has for a given publisher","tags":["Registry"]}},"/publishers/{publisherId}/nodes/{nodeId}/versions":{"post":{"operationId":"PublishNodeVersion","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"node":{"$ref":"#/components/schemas/Node"},"node_version":{"$ref":"#/components/schemas/NodeVersion"},"personal_access_token":{"type":"string"}},"required":["node","node_version","personal_access_token"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"node_version":{"$ref":"#/components/schemas/NodeVersion"},"signedUrl":{"description":"The signed URL to upload the node version token.","type":"string"}},"type":"object"}}},"description":"New version published successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Publish a new version of a node","tags":["Registry"]}},"/publishers/{publisherId}/nodes/{nodeId}/versions/{versionId}":{"delete":{"operationId":"DeleteNodeVersion","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"path","name":"versionId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Version unpublished (deleted) successfully"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version does not belong to the publisher"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version not found"}},"security":[{"BearerAuth":[]}],"summary":"Unpublish (delete) a specific version of a node","tags":["Registry"]},"put":{"description":"Update only the changelog and deprecated status of a specific version of a node.","operationId":"UpdateNodeVersion","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"in":"path","name":"versionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeVersionUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeVersion"}}},"description":"Version updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Version not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Update changelog and deprecation status of a node version","tags":["Registry"]}},"/publishers/{publisherId}/permissions":{"get":{"operationId":"GetPermissionOnPublisher","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"canEdit":{"type":"boolean"}},"type":"object"}}},"description":"A list of permissions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve permissions the user has for a given publisher","tags":["Registry"]}},"/publishers/{publisherId}/tokens":{"get":{"operationId":"ListPersonalAccessTokens","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PersonalAccessToken"},"type":"array"}}},"description":"List of all personal access tokens"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"No tokens found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Retrieve all personal access tokens for a publisher","tags":["Registry"],"x-excluded":true},"post":{"operationId":"CreatePersonalAccessToken","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalAccessToken"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"token":{"description":"The newly created personal access token.","type":"string"}},"type":"object"}}},"description":"Token created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Create a new personal access token","tags":["Registry"]}},"/publishers/{publisherId}/tokens/{tokenId}":{"delete":{"operationId":"DeletePersonalAccessToken","parameters":[{"in":"path","name":"publisherId","required":true,"schema":{"type":"string"}},{"in":"path","name":"tokenId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Token deleted successfully"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Token not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"summary":"Delete a specific personal access token","tags":["Registry"]}},"/releases":{"get":{"description":"Fetch release notes from Strapi with caching","operationId":"GetReleaseNotes","parameters":[{"description":"The project to get release notes for","in":"query","name":"project","required":true,"schema":{"enum":["comfyui","comfyui_frontend","desktop","cloud"],"type":"string"}},{"description":"The current version to filter release notes","in":"query","name":"current_version","schema":{"type":"string"}},{"description":"The locale for the release notes","in":"query","name":"locale","schema":{"default":"en","enum":["en","es","fr","ja","ko","ru","zh"],"type":"string"}},{"description":"The platform requesting the release notes","in":"query","name":"form_factor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReleaseNote"},"type":"array"}}},"description":"Release notes retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get release notes","tags":["Releases"]},"post":{"description":"Webhook endpoint to process Github release events and generate release notes","operationId":"ProcessReleaseWebhook","parameters":[{"description":"The name of the event that triggered the delivery","in":"header","name":"X-GitHub-Event","required":true,"schema":{"enum":["release"],"type":"string"}},{"description":"A globally unique identifier (GUID) to identify the event","in":"header","name":"X-GitHub-Delivery","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the webhook","in":"header","name":"X-GitHub-Hook-ID","required":true,"schema":{"type":"string"}},{"description":"HMAC hex digest of the request body using SHA-256 hash function","in":"header","name":"X-Hub-Signature-256","schema":{"type":"string"}},{"description":"The type of resource where the webhook was created","in":"header","name":"X-GitHub-Hook-Installation-Target-Type","schema":{"type":"string"}},{"description":"The unique identifier of the resource where the webhook was created","in":"header","name":"X-GitHub-Hook-Installation-Target-ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GithubReleaseWebhook"}}},"required":true},"responses":{"200":{"description":"Webhook processed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Validation failed or endpoint has been spammed"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Process Github release webhook","tags":["Releases"],"x-excluded":true}},"/security-scan":{"get":{"description":"Pull all pending node versions and conduct security scans.","operationId":"SecurityScan","parameters":[{"in":"query","name":"minAge","schema":{"type":"string","x-go-type":"time.Duration"}},{"in":"query","name":"minSecurityScanAge","schema":{"type":"string","x-go-type":"time.Duration"}},{"in":"query","name":"maxNodes","schema":{"type":"integer"}}],"responses":{"200":{"description":"Scan completed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Security Scan","tags":["Registry"],"x-excluded":true}},"/seedance/complete":{"get":{"description":"Browser-facing landing page that BytePlus redirects the end user to after H5 liveness is complete. Logs the callback parameters and returns plain HTML the user sees in their browser. Client polls seedanceGetVisualValidateSession to observe the actual result.\n","operationId":"SeedanceVisualValidateCallback","parameters":[{"in":"query","name":"bytedToken","required":true,"schema":{"type":"string"}},{"in":"query","name":"resultCode","required":true,"schema":{"type":"string"}},{"in":"query","name":"algorithmBaseRespCode","schema":{"type":"string"}},{"in":"query","name":"reqMeasureInfoValue","schema":{"type":"string"}},{"in":"query","name":"verify_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"Landing page shown to the user's browser"}},"security":[],"summary":"BytePlus real-person verification callback landing page","tags":["API Nodes","Released"],"x-excluded":true}},"/upload-artifact":{"post":{"description":"Receive artifacts (output files) from the ComfyUI GitHub Action","operationId":"PostUploadArtifact","requestBody":{"content":{"application/json":{"schema":{"properties":{"author":{"description":"The author of the commit","type":"string"},"avg_vram":{"description":"The average amount of VRAM used in the run.","type":"integer"},"branch_name":{"type":"string"},"bucket_name":{"description":"The name of the bucket where the output files are stored","type":"string"},"comfy_logs_gcs_path":{"description":"The path to ComfyUI logs. eg. gs://bucket-name/logs","type":"string"},"comfy_run_flags":{"description":"The flags used in the comfy run","type":"string"},"commit_hash":{"type":"string"},"commit_message":{"description":"The commit message","type":"string"},"commit_time":{"description":"The time of the commit in the format of \"YYYY-MM-DDTHH:MM:SSZ\" (2016-10-10T00:00:00Z)","type":"string"},"cuda_version":{"description":"Cuda version.","type":"string"},"end_time":{"description":"The end time of the job as a Unix timestamp.","format":"int64","type":"integer"},"job_id":{"description":"Unique identifier for the job","type":"string"},"job_trigger_user":{"description":"The user who triggered the job","type":"string"},"machine_stats":{"$ref":"#/components/schemas/MachineStats"},"os":{"description":"Operating system used in the run","type":"string"},"output_files_gcs_paths":{"description":"A comma separated string that contains GCS path(s) to output files. eg. gs://bucket-name/output, gs://bucket-name/output2","type":"string"},"peak_vram":{"description":"The peak amount of VRAM used in the run.","type":"integer"},"pr_number":{"description":"The pull request number","type":"string"},"python_version":{"description":"The python version used in the run","type":"string"},"pytorch_version":{"description":"The pytorch version used in the run","type":"string"},"repo":{"description":"Repository name","type":"string"},"run_id":{"description":"Unique identifier for the run","type":"string"},"start_time":{"description":"The start time of the job as a Unix timestamp.","format":"int64","type":"integer"},"status":{"$ref":"#/components/schemas/WorkflowRunStatus"},"workflow_name":{"description":"The name of the workflow","type":"string"}},"required":["repo","job_id","run_id","os","commit_hash","commit_time","commit_message","branch_name","workflow_name","start_time","end_time","pr_number","python_version","job_trigger_user","author","status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Successfully received the artifact details"},"400":{"description":"Invalid request"},"500":{"description":"Internal server error"}},"summary":"Receive artifacts (output files) from the ComfyUI GitHub Action","tags":["ComfyUI CI"],"x-excluded":true}},"/users":{"get":{"operationId":"GetUser","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"BearerAuth":[]}],"summary":"Get information about the calling user.","tags":["Registry"]}},"/users/publishers/":{"get":{"operationId":"ListPublishersForUser","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Publisher"},"type":"array"}}},"description":"A list of publishers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request, invalid input data"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve all publishers for a given user","tags":["Registry"]}},"/versions":{"get":{"operationId":"ListAllNodeVersions","parameters":[{"in":"query","name":"nodeId","schema":{"type":"string"}},{"explode":true,"in":"query","name":"statuses","schema":{"items":{"$ref":"#/components/schemas/NodeVersionStatus"},"type":"array"},"style":"form"},{"in":"query","name":"include_status_reason","schema":{"default":false,"type":"boolean"}},{"description":"The page number to retrieve.","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"The number of items to include per page.","in":"query","name":"pageSize","schema":{"default":10,"type":"integer"}},{"description":"search for status_reason, case insensitive","in":"query","name":"status_reason","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"page":{"description":"Current page number","type":"integer"},"pageSize":{"description":"Maximum number of node versions per page. Maximum is 100.","type":"integer"},"total":{"description":"Total number of node versions available","type":"integer"},"totalPages":{"description":"Total number of pages available","type":"integer"},"versions":{"items":{"$ref":"#/components/schemas/NodeVersion"},"type":"array"}},"type":"object"}}},"description":"List of all node versions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid input, object invalid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Node banned"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List all node versions given some filters.","tags":["Registry"]}},"/webhook/metronome/zero-balance":{"post":{"operationId":"MetronomeZeroBalance","requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"the id of the webhook","type":"string"},"properties":{"properties":{"customer_id":{"description":"the metronome customer id","type":"string"},"remaining_balance":{"description":"the customer remaining balance","type":"number"}},"type":"object"},"type":{"description":"the type of the webhook","type":"string"}},"required":["id","type","properties"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeogramGenerateResponse"}}},"description":"Webhook processed succesfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"receive alert on remaining balance is 0","tags":["Webhook","Metronome"],"x-excluded":true}},"/webhook/stripe/invoice-status":{"post":{"operationId":"StripeInvoiceStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StripeEvent"}}},"required":true},"responses":{"200":{"description":"Webhook processed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Handle Stripe invoice.paid webhook event","tags":["Billing","Stripe"],"x-excluded":true}},"/webhook/stripe/subscription":{"post":{"operationId":"StripeSubscriptionWebhook","requestBody":{"content":{"application/json":{"schema":{"description":"Generic Stripe webhook event payload","type":"object"}}},"required":true},"responses":{"200":{"description":"Webhook processed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error (proxy or upstream issue)"}},"summary":"Handle Stripe subscription webhook events","tags":["Billing","Stripe"],"x-excluded":true}},"/workflowresult/{workflowResultId}":{"get":{"operationId":"GetWorkflowResult","parameters":[{"in":"path","name":"workflowResultId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionJobResult"}}},"description":"Commit details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Commit not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Retrieve a specific commit by ID","tags":["ComfyUI CI"],"x-excluded":true}}},"servers":[{"url":"https://api.comfy.org"}]}