@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/meshy/index.json

@@ -0,0 +1,583 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "model": {
+          "title": "Model",
+          "description": "Identifier of the model to use for generation.",
+          "type": "string",
+          "const": "meshy:meshy@6"
+        },
+        "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). Used to guide the texturing process.",
+              "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": 1
+            },
+            "images": {
+              "title": "Images",
+              "description": "Array of image inputs (UUID, URL, Data URI, or Base64). For single image-to-3D, provide 1 image. For multi-image-to-3D, provide 2–4 images.",
+              "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": 4
+            }
+          },
+          "additionalProperties": false
+        },
+        "positivePrompt": {
+          "title": "Positive Prompt",
+          "description": "Text prompt describing elements to include in the generated output.",
+          "type": "string",
+          "maxLength": 600
+        },
+        "settings": {
+          "title": "Settings",
+          "description": "Global inference settings.",
+          "type": "object",
+          "properties": {
+            "autoSize": {
+              "type": "boolean",
+              "title": "Auto Size",
+              "description": "AI-based real-world height estimation to resize the model accordingly.",
+              "default": false
+            },
+            "decimation": {
+              "type": "integer",
+              "title": "Decimation",
+              "description": "Adaptive decimation level.",
+              "oneOf": [
+                {
+                  "description": "Ultra polycount.",
+                  "const": 1
+                },
+                {
+                  "description": "High polycount.",
+                  "const": 2
+                },
+                {
+                  "description": "Medium polycount.",
+                  "const": 3
+                },
+                {
+                  "description": "Low polycount.",
+                  "const": 4
+                }
+              ]
+            },
+            "hdTexture": {
+              "type": "boolean",
+              "title": "HD Texture",
+              "description": "Base colour texture at 4K (4096×4096) resolution. PBR maps are always generated at 2K regardless.",
+              "default": false
+            },
+            "imageEnhancement": {
+              "type": "boolean",
+              "title": "Image Enhancement",
+              "description": "Input image optimization for better generation results. Set to false to preserve the exact appearance of the input.",
+              "default": true
+            },
+            "meshType": {
+              "type": "string",
+              "title": "Mesh Type",
+              "description": "Mesh generation type for the output 3D model.",
+              "enum": [
+                "standard",
+                "lowpoly"
+              ],
+              "default": "standard"
+            },
+            "moderation": {
+              "type": "boolean",
+              "title": "Moderation",
+              "description": "Input content screening for potentially harmful material before generation proceeds.",
+              "default": false
+            },
+            "origin": {
+              "type": "string",
+              "title": "Origin",
+              "description": "Origin point position for the generated model.",
+              "enum": [
+                "bottom",
+                "center"
+              ],
+              "default": "bottom"
+            },
+            "pbr": {
+              "type": "boolean",
+              "title": "PBR",
+              "description": "PBR map generation (metallic, roughness, normal) in addition to base colour. Includes an emission map.",
+              "default": false
+            },
+            "polyCount": {
+              "type": "integer",
+              "title": "Poly Count",
+              "description": "Target polygon count. Actual count may deviate based on geometry complexity.",
+              "default": 30000,
+              "minimum": 100,
+              "maximum": 300000
+            },
+            "pose": {
+              "type": "string",
+              "title": "Pose",
+              "description": "Pose preset for the generated model.",
+              "enum": [
+                "none",
+                "a-pose",
+                "t-pose"
+              ],
+              "default": "none"
+            },
+            "remesh": {
+              "type": "boolean",
+              "title": "Remesh",
+              "description": "Remesh phase toggle. When false, returns the highest-precision triangular mesh without decimation.",
+              "default": false
+            },
+            "removeLighting": {
+              "type": "boolean",
+              "title": "Remove Lighting",
+              "description": "Highlight and shadow removal from the base colour texture, producing a cleaner result for custom lighting.",
+              "default": true
+            },
+            "symmetry": {
+              "type": "string",
+              "title": "Symmetry",
+              "description": "Symmetry behaviour during generation.",
+              "enum": [
+                "off",
+                "auto",
+                "on"
+              ],
+              "default": "auto"
+            },
+            "texture": {
+              "type": "boolean",
+              "title": "Texture",
+              "description": "Texture generation toggle. When false, returns a mesh only.",
+              "default": true
+            },
+            "texturePrompt": {
+              "type": "string",
+              "title": "Texture Prompt",
+              "description": "Additional text prompt to guide the texturing process.",
+              "maxLength": 600
+            },
+            "topology": {
+              "type": "string",
+              "title": "Topology",
+              "description": "Mesh topology for the output model.",
+              "enum": [
+                "triangle",
+                "quad"
+              ],
+              "default": "triangle"
+            }
+          },
+          "additionalProperties": false
+        },
+        "taskType": {
+          "title": "Task Type",
+          "description": "Identifier for the type of task being performed",
+          "type": "string",
+          "const": "3dInference"
+        },
+        "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": 4
+        },
+        "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": "3D output type.",
+          "type": "string",
+          "enum": [
+            "URL"
+          ],
+          "default": "URL"
+        },
+        "outputFormat": {
+          "title": "Output Format",
+          "description": "File format for the generated 3D model.",
+          "type": "string",
+          "enum": [
+            "GLB"
+          ],
+          "default": "GLB"
+        },
+        "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": "async"
+        }
+      },
+      "allOf": [
+        {
+          "anyOf": [
+            {
+              "required": [
+                "positivePrompt"
+              ]
+            },
+            {
+              "properties": {
+                "inputs": {
+                  "properties": {
+                    "images": {
+                      "minItems": 1
+                    }
+                  },
+                  "required": [
+                    "images"
+                  ]
+                }
+              },
+              "required": [
+                "inputs"
+              ]
+            }
+          ]
+        },
+        {
+          "not": {
+            "allOf": [
+              {
+                "properties": {
+                  "settings": {
+                    "required": [
+                      "polyCount"
+                    ]
+                  }
+                },
+                "required": [
+                  "settings"
+                ]
+              },
+              {
+                "properties": {
+                  "settings": {
+                    "required": [
+                      "decimation"
+                    ]
+                  }
+                },
+                "required": [
+                  "settings"
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "not": {
+            "allOf": [
+              {
+                "properties": {
+                  "settings": {
+                    "required": [
+                      "texturePrompt"
+                    ]
+                  }
+                },
+                "required": [
+                  "settings"
+                ]
+              },
+              {
+                "properties": {
+                  "inputs": {
+                    "required": [
+                      "referenceImages"
+                    ]
+                  }
+                },
+                "required": [
+                  "inputs"
+                ]
+              }
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "settings": {
+                "properties": {
+                  "meshType": {
+                    "const": "lowpoly"
+                  }
+                },
+                "required": [
+                  "meshType"
+                ]
+              }
+            },
+            "required": [
+              "settings"
+            ]
+          },
+          "then": {
+            "not": {
+              "anyOf": [
+                {
+                  "properties": {
+                    "settings": {
+                      "required": [
+                        "remesh"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "properties": {
+                    "settings": {
+                      "required": [
+                        "topology"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "properties": {
+                    "settings": {
+                      "required": [
+                        "polyCount"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "properties": {
+                    "settings": {
+                      "required": [
+                        "decimation"
+                      ]
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "settings": {
+                "properties": {
+                  "texture": {
+                    "const": false
+                  }
+                },
+                "required": [
+                  "texture"
+                ]
+              }
+            },
+            "required": [
+              "settings"
+            ]
+          },
+          "then": {
+            "not": {
+              "properties": {
+                "settings": {
+                  "required": [
+                    "pbr"
+                  ]
+                }
+              },
+              "required": [
+                "settings"
+              ]
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "settings": {
+                "required": [
+                  "origin"
+                ]
+              }
+            },
+            "required": [
+              "settings"
+            ]
+          },
+          "then": {
+            "properties": {
+              "settings": {
+                "properties": {
+                  "autoSize": {
+                    "const": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "settings": {
+                "anyOf": [
+                  {
+                    "required": [
+                      "topology"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "polyCount"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "decimation"
+                    ]
+                  }
+                ]
+              }
+            },
+            "required": [
+              "settings"
+            ]
+          },
+          "then": {
+            "properties": {
+              "settings": {
+                "properties": {
+                  "remesh": {
+                    "const": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "settings": {
+                "required": [
+                  "imageEnhancement"
+                ]
+              }
+            },
+            "required": [
+              "settings"
+            ]
+          },
+          "then": {
+            "properties": {
+              "inputs": {
+                "required": [
+                  "images"
+                ]
+              }
+            },
+            "required": [
+              "inputs"
+            ]
+          }
+        }
+      ],
+      "additionalProperties": false,
+      "required": [
+        "taskType",
+        "taskUUID",
+        "model"
+      ]
+    }
+  ]
+}