@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/bfl/bfl-flux-1-kontext-max.json

@@ -0,0 +1,345 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "type": "object",
+  "properties": {
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "const": "bfl:4@1"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "referenceImages": {
+          "title": "Reference Images",
+          "description": "List of reference images (UUID, URL, Data URI, or Base64).",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "title": "Image",
+            "description": "Image input (UUID, URL, Data URI, or Base64).",
+            "type": "string",
+            "anyOf": [
+              {
+                "format": "uuid"
+              },
+              {
+                "format": "uri"
+              },
+              {
+                "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$"
+              },
+              {
+                "pattern": "^[a-zA-Z0-9+/=]+$"
+              }
+            ]
+          },
+          "maxItems": 2
+        }
+      },
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 3000
+    },
+    "width": {
+      "title": "Width",
+      "description": "Width of the generated media in pixels.",
+      "type": "integer"
+    },
+    "height": {
+      "title": "Height",
+      "description": "Height of the generated media in pixels.",
+      "type": "integer"
+    },
+    "seed": {
+      "title": "Seed",
+      "description": "Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9223372036854776000
+    },
+    "providerSettings": {
+      "title": "Provider Settings",
+      "description": "Provider-specific configuration settings.",
+      "type": "object",
+      "properties": {
+        "bfl": {
+          "title": "BFL Settings",
+          "description": "Provider-specific settings for Black Forest Labs (Flux).",
+          "type": "object",
+          "properties": {
+            "promptUpsampling": {
+              "title": "Prompt Upsampling",
+              "description": "Enable automatic enhancement and expansion of the input prompt.",
+              "type": "boolean",
+              "default": false
+            },
+            "safetyTolerance": {
+              "title": "Safety Tolerance",
+              "description": "Tolerance level for content moderation. Lower values are stricter; higher values are more permissive.",
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 6,
+              "default": 2
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "imageInference"
+    },
+    "taskUUID": {
+      "title": "Task UUID",
+      "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.",
+      "type": "string",
+      "format": "uuid"
+    },
+    "webhookURL": {
+      "title": "Webhook URL",
+      "description": "Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.",
+      "type": "string",
+      "format": "uri"
+    },
+    "includeCost": {
+      "title": "Include Cost",
+      "description": "Include task cost in the response.",
+      "type": "boolean",
+      "default": false
+    },
+    "numberResults": {
+      "title": "Number of Results",
+      "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.",
+      "type": "integer",
+      "minimum": 1,
+      "default": 1,
+      "maximum": 20
+    },
+    "uploadEndpoint": {
+      "title": "Upload Endpoint",
+      "description": "URL to upload content via HTTP PUT. The request body will contain the raw binary data.",
+      "type": "string",
+      "format": "uri"
+    },
+    "ttl": {
+      "title": "TTL",
+      "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.",
+      "type": "integer",
+      "minimum": 60
+    },
+    "outputType": {
+      "title": "Output Type",
+      "description": "Image output type.",
+      "type": "string",
+      "enum": [
+        "URL",
+        "base64Data",
+        "dataURI"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated image.",
+      "type": "string",
+      "enum": [
+        "JPG",
+        "PNG",
+        "WEBP"
+      ],
+      "default": "JPG"
+    },
+    "outputQuality": {
+      "title": "Output Quality",
+      "description": "Compression quality of the output. Higher values preserve quality but increase file size.",
+      "type": "integer",
+      "minimum": 20,
+      "maximum": 99,
+      "default": 95
+    },
+    "deliveryMethod": {
+      "title": "Delivery Method",
+      "description": "Determines how the API delivers task results.",
+      "type": "string",
+      "oneOf": [
+        {
+          "const": "sync",
+          "description": "Returns complete results directly in the API response."
+        },
+        {
+          "const": "async",
+          "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse."
+        }
+      ],
+      "default": "sync"
+    },
+    "safety": {
+      "type": "object",
+      "title": "Safety Settings",
+      "description": "Content safety checking configuration for image generation.",
+      "properties": {
+        "checkContent": {
+          "title": "Check Content",
+          "description": "Enable or disable content safety checking. When enabled, defaults to `fast` mode.",
+          "type": "boolean",
+          "default": false
+        },
+        "mode": {
+          "description": "Safety checking mode for image generation.",
+          "type": "string",
+          "oneOf": [
+            {
+              "const": "none",
+              "title": "None",
+              "description": "Disables checking."
+            },
+            {
+              "const": "fast",
+              "title": "Fast",
+              "description": "Performs a single check."
+            }
+          ],
+          "default": "none"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "positivePrompt",
+    "width",
+    "height",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "dependentRequired": {
+        "width": [
+          "height"
+        ],
+        "height": [
+          "width"
+        ]
+      }
+    },
+    {
+      "oneOf": [
+        {
+          "title": "1K (21:9)",
+          "properties": {
+            "width": {
+              "const": 1568
+            },
+            "height": {
+              "const": 672
+            }
+          }
+        },
+        {
+          "title": "1K (16:9)",
+          "properties": {
+            "width": {
+              "const": 1392
+            },
+            "height": {
+              "const": 752
+            }
+          }
+        },
+        {
+          "title": "1K (4:3)",
+          "properties": {
+            "width": {
+              "const": 1184
+            },
+            "height": {
+              "const": 880
+            }
+          }
+        },
+        {
+          "title": "1K (3:2)",
+          "properties": {
+            "width": {
+              "const": 1248
+            },
+            "height": {
+              "const": 832
+            }
+          }
+        },
+        {
+          "title": "1K (1:1)",
+          "properties": {
+            "width": {
+              "const": 1024
+            },
+            "height": {
+              "const": 1024
+            }
+          }
+        },
+        {
+          "title": "1K (2:3)",
+          "properties": {
+            "width": {
+              "const": 832
+            },
+            "height": {
+              "const": 1248
+            }
+          }
+        },
+        {
+          "title": "1K (3:4)",
+          "properties": {
+            "width": {
+              "const": 880
+            },
+            "height": {
+              "const": 1184
+            }
+          }
+        },
+        {
+          "title": "1K (9:16)",
+          "properties": {
+            "width": {
+              "const": 752
+            },
+            "height": {
+              "const": 1392
+            }
+          }
+        },
+        {
+          "title": "1K (9:21)",
+          "properties": {
+            "width": {
+              "const": 672
+            },
+            "height": {
+              "const": 1568
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/requests/models/bfl/bfl-flux-1-kontext-pro.json

@@ -0,0 +1,345 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "type": "object",
+  "properties": {
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "const": "bfl:3@1"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "referenceImages": {
+          "title": "Reference Images",
+          "description": "List of reference images (UUID, URL, Data URI, or Base64).",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "title": "Image",
+            "description": "Image input (UUID, URL, Data URI, or Base64).",
+            "type": "string",
+            "anyOf": [
+              {
+                "format": "uuid"
+              },
+              {
+                "format": "uri"
+              },
+              {
+                "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$"
+              },
+              {
+                "pattern": "^[a-zA-Z0-9+/=]+$"
+              }
+            ]
+          },
+          "maxItems": 2
+        }
+      },
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 3000
+    },
+    "width": {
+      "title": "Width",
+      "description": "Width of the generated media in pixels.",
+      "type": "integer"
+    },
+    "height": {
+      "title": "Height",
+      "description": "Height of the generated media in pixels.",
+      "type": "integer"
+    },
+    "seed": {
+      "title": "Seed",
+      "description": "Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9223372036854776000
+    },
+    "providerSettings": {
+      "title": "Provider Settings",
+      "description": "Provider-specific configuration settings.",
+      "type": "object",
+      "properties": {
+        "bfl": {
+          "title": "BFL Settings",
+          "description": "Provider-specific settings for Black Forest Labs (Flux).",
+          "type": "object",
+          "properties": {
+            "promptUpsampling": {
+              "title": "Prompt Upsampling",
+              "description": "Enable automatic enhancement and expansion of the input prompt.",
+              "type": "boolean",
+              "default": false
+            },
+            "safetyTolerance": {
+              "title": "Safety Tolerance",
+              "description": "Tolerance level for content moderation. Lower values are stricter; higher values are more permissive.",
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 6,
+              "default": 2
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "imageInference"
+    },
+    "taskUUID": {
+      "title": "Task UUID",
+      "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.",
+      "type": "string",
+      "format": "uuid"
+    },
+    "webhookURL": {
+      "title": "Webhook URL",
+      "description": "Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.",
+      "type": "string",
+      "format": "uri"
+    },
+    "includeCost": {
+      "title": "Include Cost",
+      "description": "Include task cost in the response.",
+      "type": "boolean",
+      "default": false
+    },
+    "numberResults": {
+      "title": "Number of Results",
+      "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.",
+      "type": "integer",
+      "minimum": 1,
+      "default": 1,
+      "maximum": 20
+    },
+    "uploadEndpoint": {
+      "title": "Upload Endpoint",
+      "description": "URL to upload content via HTTP PUT. The request body will contain the raw binary data.",
+      "type": "string",
+      "format": "uri"
+    },
+    "ttl": {
+      "title": "TTL",
+      "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.",
+      "type": "integer",
+      "minimum": 60
+    },
+    "outputType": {
+      "title": "Output Type",
+      "description": "Image output type.",
+      "type": "string",
+      "enum": [
+        "URL",
+        "base64Data",
+        "dataURI"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated image.",
+      "type": "string",
+      "enum": [
+        "JPG",
+        "PNG",
+        "WEBP"
+      ],
+      "default": "JPG"
+    },
+    "outputQuality": {
+      "title": "Output Quality",
+      "description": "Compression quality of the output. Higher values preserve quality but increase file size.",
+      "type": "integer",
+      "minimum": 20,
+      "maximum": 99,
+      "default": 95
+    },
+    "deliveryMethod": {
+      "title": "Delivery Method",
+      "description": "Determines how the API delivers task results.",
+      "type": "string",
+      "oneOf": [
+        {
+          "const": "sync",
+          "description": "Returns complete results directly in the API response."
+        },
+        {
+          "const": "async",
+          "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse."
+        }
+      ],
+      "default": "sync"
+    },
+    "safety": {
+      "type": "object",
+      "title": "Safety Settings",
+      "description": "Content safety checking configuration for image generation.",
+      "properties": {
+        "checkContent": {
+          "title": "Check Content",
+          "description": "Enable or disable content safety checking. When enabled, defaults to `fast` mode.",
+          "type": "boolean",
+          "default": false
+        },
+        "mode": {
+          "description": "Safety checking mode for image generation.",
+          "type": "string",
+          "oneOf": [
+            {
+              "const": "none",
+              "title": "None",
+              "description": "Disables checking."
+            },
+            {
+              "const": "fast",
+              "title": "Fast",
+              "description": "Performs a single check."
+            }
+          ],
+          "default": "none"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "positivePrompt",
+    "width",
+    "height",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "dependentRequired": {
+        "width": [
+          "height"
+        ],
+        "height": [
+          "width"
+        ]
+      }
+    },
+    {
+      "oneOf": [
+        {
+          "title": "1K (21:9)",
+          "properties": {
+            "width": {
+              "const": 1568
+            },
+            "height": {
+              "const": 672
+            }
+          }
+        },
+        {
+          "title": "1K (16:9)",
+          "properties": {
+            "width": {
+              "const": 1392
+            },
+            "height": {
+              "const": 752
+            }
+          }
+        },
+        {
+          "title": "1K (4:3)",
+          "properties": {
+            "width": {
+              "const": 1184
+            },
+            "height": {
+              "const": 880
+            }
+          }
+        },
+        {
+          "title": "1K (3:2)",
+          "properties": {
+            "width": {
+              "const": 1248
+            },
+            "height": {
+              "const": 832
+            }
+          }
+        },
+        {
+          "title": "1K (1:1)",
+          "properties": {
+            "width": {
+              "const": 1024
+            },
+            "height": {
+              "const": 1024
+            }
+          }
+        },
+        {
+          "title": "1K (2:3)",
+          "properties": {
+            "width": {
+              "const": 832
+            },
+            "height": {
+              "const": 1248
+            }
+          }
+        },
+        {
+          "title": "1K (3:4)",
+          "properties": {
+            "width": {
+              "const": 880
+            },
+            "height": {
+              "const": 1184
+            }
+          }
+        },
+        {
+          "title": "1K (9:16)",
+          "properties": {
+            "width": {
+              "const": 752
+            },
+            "height": {
+              "const": 1392
+            }
+          }
+        },
+        {
+          "title": "1K (9:21)",
+          "properties": {
+            "width": {
+              "const": 672
+            },
+            "height": {
+              "const": 1568
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "additionalProperties": false
+}